Zefort API Reference (1.0.0)

Download OpenAPI specification:Download

Contracts

Trash > List

List all contracts in the trash.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

q
string

Search query string to search in document contents and textual metadata fields.

q_main_documents
string

Search query string to search in main document content.

q_attachments
string

Search query string to search in attachments content.

q_parties
string

Search query string to search in contract parties.

q_notes
string

Search query string to search in contract notes.

q_tags
string

Search query string to search in contract tags.

q_emails
string

Search query string to search in contract emails.

receive_time
string

A date range string.

activities_times
string

A date range string.

pending_activities_times
string

Search contracts by the deadlines of their pending activities.

status
string
Enum: "archived" "done" "error" "limited" "processing" "queued" "review"

Only list contracts that have a matching status.

cover_document_docai_task_status
string
Enum: "idle" "processing"

Only list contracts that have a cover document with matching docai task status.

esign_status
string
Enum: "canceled" "completed" "declined" "draft" "expired" "failed" "pending"

Search contract by esign process with given status.

owner
string

Only list contracts owned by this user.

binder
string

Only list contracts in the binder or it's children.

recursive
boolean

Search in sub-binders also. True by default.

language
string

Only list contracts with the given main language.

num_files
integer

Number of files

num_main_pages
integer

Number of pages in main document.

num_activities
integer

Number of activities defined.

num_emails
integer

Number of emails attached.

num_signed_documents
integer

Number of documents which have valid signature.

minimal
boolean

Return only minimal data about each hit.

permission
string
Enum: "edit" "full" "view"

Only list contracts where current user has this permission.

similar
string

Show contracts similar to this contract.

similarity_level
string

The level of similarity of shown contracts.

activity_user
string

Contracts with activities related to a user

favorite_of
string

Favorites of this user.

incomplete
boolean

List only incomplete contracts

search
string

Id of a stored search. Any stored param will be overriden by an explicitly set one.

trashed
boolean

Return only deleted contracts

failed_task
string

Only list contract which processing has failed in given task

Responses

Response samples

Content type
application/json
{}

Trash > Empty > Create

Permanently delete all contracts from the trash.

Request Body schema:

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": {
    },
  • "backend_status": "done",
  • "backend_status_info": "string",
  • "frontend_status": "done",
  • "description": "string",
  • "progress": 0.1,
  • "processing_started_at": "2019-08-24T14:15:22Z",
  • "processing_ended_at": "2019-08-24T14:15:22Z",
  • "failed_contracts": [
    ]
}

Trash > Delete

Permanently delete a single contract from the trash.

path Parameters
id
required
string

Responses

Trash > Partial update

Restore a single contract from the trash.

path Parameters
id
required
string
Request Body schema:

Responses

Request samples

Content type
{ }

Create

Upload a new contract.

Request Body schema:
blob
string <uri>

The main contract document file.

title
string

The title of the contract.

docai_skip
Array of strings (DocaiSkipEnum)
Items Enum: "effective_date" "end_date" "main_language" "parties" "taggings" "signed_date" "title"
binders
Array of strings

Responses

Request samples

Content type
{
  • "title": "string",
  • "docai_skip": [
    ],
  • "binders": [
    ]
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "cover_document": {
    },
  • "unverified_docai_attributes": "string",
  • "id": "string",
  • "incomplete": true,
  • "num_emails": 0,
  • "num_files": 0,
  • "num_users": 2147483647,
  • "matches": {
    },
  • "owner": {
    },
  • "parties": [
    ],
  • "permission": "string",
  • "receive_time": "2019-08-24T14:15:22Z",
  • "related_contracts": [
    ],
  • "status": "queued",
  • "is_duplicate": true,
  • "favorite_of": [
    ],
  • "last_modified": "2019-08-24T14:15:22Z",
  • "first_docai_result_time": "2019-08-24T14:15:22Z",
  • "trashed": true,
  • "esigns": [
    ],
  • "num_signed_documents": 0,
  • "docai_skip": [
    ],
  • "activities": [
    ],
  • "allow_emails": true,
  • "documents": [
    ],
  • "duplicates": [
    ],
  • "emails": [
    ],
  • "notes": [
    ],
  • "num_binders": 0,
  • "rated": true,
  • "taggings": [
    ],
  • "form": "string"
}

List

Retrieves a list of all contracts for the authenticated user.

A <date> is either:

  • YYYYMMDD[<offset>]: concrete date,
  • today[<offset>]: dynamic date referring to current date

where <offset> is

  • [+-]<num>d to offset in days,
  • [+-]<num>m to offset in months,
  • [+-]<num>y to offset in years,

where is a number between 1-9999.

Date ranges must be one of the following formats:

  • <date>-<date>: matches dates between the starting and ending date, inclusive.
  • <date>-: matches dates greater or equal.
  • -<date>: matches dates less or equal.

Examples:

  • YYYYMMDD-YYYYMMDD: matches dates between the starting date and ending date, inclusive
  • today-6m-: matches dates from 6 months ago forwards.
  • -today+5y: matches dates up to 5 years from now.
  • YYYYMMDD-30d-: matches dates from 30days ago forwards of given date YYYYMMDDD.
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

q
string

Search query string to search in document contents and textual metadata fields.

q_main_documents
string

Search query string to search in main document content.

q_attachments
string

Search query string to search in attachments content.

q_parties
string

Search query string to search in contract parties.

q_notes
string

Search query string to search in contract notes.

q_tags
string

Search query string to search in contract tags.

q_emails
string

Search query string to search in contract emails.

receive_time
string

A date range string.

activities_times
string

A date range string.

pending_activities_times
string

Search contracts by the deadlines of their pending activities.

status
string
Enum: "archived" "done" "error" "limited" "processing" "queued" "review"

Only list contracts that have a matching status.

cover_document_docai_task_status
string
Enum: "idle" "processing"

Only list contracts that have a cover document with matching docai task status.

esign_status
string
Enum: "canceled" "completed" "declined" "draft" "expired" "failed" "pending"

Search contract by esign process with given status.

owner
string

Only list contracts owned by this user.

binder
string

Only list contracts in the binder or it's children.

recursive
boolean

Search in sub-binders also. True by default.

language
string

Only list contracts with the given main language.

num_files
integer

Number of files

num_main_pages
integer

Number of pages in main document.

num_activities
integer

Number of activities defined.

num_emails
integer

Number of emails attached.

num_signed_documents
integer

Number of documents which have valid signature.

minimal
boolean

Return only minimal data about each hit.

permission
string
Enum: "edit" "full" "view"

Only list contracts where current user has this permission.

similar
string

Show contracts similar to this contract.

similarity_level
string

The level of similarity of shown contracts.

activity_user
string

Contracts with activities related to a user

favorite_of
string

Favorites of this user.

incomplete
boolean

List only incomplete contracts

search
string

Id of a stored search. Any stored param will be overriden by an explicitly set one.

trashed
boolean

Return only deleted contracts

failed_task
string

Only list contract which processing has failed in given task

Responses

Response samples

Content type
application/json
{
  • "page_size": 123,
  • "page": 123,
  • "last_page": 123,
  • "count": 123,
  • "results": [
    ]
}

Bulk contract party delete

Request Body schema:
required
required
object (ContractAttributes)
required
object (Document)
incomplete
boolean

The contract is missing some mandatory attributes.

num_users
integer [ 0 .. 2147483647 ]
status
string (StatusBc5Enum)
Enum: "queued" "processing" "review" "done" "archived" "error" "limited"
is_duplicate
boolean

The main document already exists as another main doc.

first_docai_result_time
string or null <date-time>

When was the contract first processed by DocAI

trashed
boolean

The contract has been moved to the trash can

docai_skip
Array of strings (DocaiSkipEnum)
Items Enum: "effective_date" "end_date" "main_language" "parties" "taggings" "signed_date" "title"
allow_emails
required
boolean

Responses

Request samples

Content type
{
  • "attributes": {
    },
  • "cover_document": {
    },
  • "incomplete": true,
  • "num_users": 2147483647,
  • "status": "queued",
  • "is_duplicate": true,
  • "first_docai_result_time": "2019-08-24T14:15:22Z",
  • "trashed": true,
  • "docai_skip": [
    ],
  • "allow_emails": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": {
    },
  • "backend_status": "done",
  • "backend_status_info": "string",
  • "frontend_status": "done",
  • "description": "string",
  • "progress": 0.1,
  • "processing_started_at": "2019-08-24T14:15:22Z",
  • "processing_ended_at": "2019-08-24T14:15:22Z",
  • "failed_contracts": [
    ]
}

Bulk contract party update

Request Body schema:
required
required
object (ContractAttributes)
required
object (Document)
incomplete
boolean

The contract is missing some mandatory attributes.

num_users
integer [ 0 .. 2147483647 ]
status
string (StatusBc5Enum)
Enum: "queued" "processing" "review" "done" "archived" "error" "limited"
is_duplicate
boolean

The main document already exists as another main doc.

first_docai_result_time
string or null <date-time>

When was the contract first processed by DocAI

trashed
boolean

The contract has been moved to the trash can

docai_skip
Array of strings (DocaiSkipEnum)
Items Enum: "effective_date" "end_date" "main_language" "parties" "taggings" "signed_date" "title"
allow_emails
required
boolean

Responses

Request samples

Content type
{
  • "attributes": {
    },
  • "cover_document": {
    },
  • "incomplete": true,
  • "num_users": 2147483647,
  • "status": "queued",
  • "is_duplicate": true,
  • "first_docai_result_time": "2019-08-24T14:15:22Z",
  • "trashed": true,
  • "docai_skip": [
    ],
  • "allow_emails": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": {
    },
  • "backend_status": "done",
  • "backend_status_info": "string",
  • "frontend_status": "done",
  • "description": "string",
  • "progress": 0.1,
  • "processing_started_at": "2019-08-24T14:15:22Z",
  • "processing_ended_at": "2019-08-24T14:15:22Z",
  • "failed_contracts": [
    ]
}

Bulk delete

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": {
    },
  • "backend_status": "done",
  • "backend_status_info": "string",
  • "frontend_status": "done",
  • "description": "string",
  • "progress": 0.1,
  • "processing_started_at": "2019-08-24T14:15:22Z",
  • "processing_ended_at": "2019-08-24T14:15:22Z",
  • "failed_contracts": [
    ]
}

Bulk docai process

Run docai processing for selected contracts.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": {
    },
  • "backend_status": "done",
  • "backend_status_info": "string",
  • "frontend_status": "done",
  • "description": "string",
  • "progress": 0.1,
  • "processing_started_at": "2019-08-24T14:15:22Z",
  • "processing_ended_at": "2019-08-24T14:15:22Z",
  • "failed_contracts": [
    ]
}

Bulk extract metadata

Extract given meta attribute to selected contracts with ChatGPT

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": {
    },
  • "backend_status": "done",
  • "backend_status_info": "string",
  • "frontend_status": "done",
  • "description": "string",
  • "progress": 0.1,
  • "processing_started_at": "2019-08-24T14:15:22Z",
  • "processing_ended_at": "2019-08-24T14:15:22Z",
  • "failed_contracts": [
    ]
}

Bulk update

Updates a large number of contracts.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": {
    },
  • "backend_status": "done",
  • "backend_status_info": "string",
  • "frontend_status": "done",
  • "description": "string",
  • "progress": 0.1,
  • "processing_started_at": "2019-08-24T14:15:22Z",
  • "processing_ended_at": "2019-08-24T14:15:22Z",
  • "failed_contracts": [
    ]
}

Delete

path Parameters
id
required
string

Responses

Partial update

path Parameters
id
required
string
Request Body schema:
object (ContractAttributes)
object (Document)
incomplete
boolean

The contract is missing some mandatory attributes.

num_users
integer [ 0 .. 2147483647 ]
owner
string

The owner's user ID. This can be updated only by the current owner, or superuser.

Array of objects
status
string
is_duplicate
boolean
first_docai_result_time
string or null <date-time>

When was the contract first processed by DocAI

trashed
boolean

The contract has been moved to the trash can

docai_skip
Array of strings (DocaiSkipEnum)
Items Enum: "effective_date" "end_date" "main_language" "parties" "taggings" "signed_date" "title"
allow_emails
boolean
object
favorite
boolean

Set this contract as a favorite of the requesting user.

Responses

Request samples

Content type
{
  • "attributes": {
    },
  • "cover_document": {
    },
  • "incomplete": true,
  • "num_users": 2147483647,
  • "owner": "string",
  • "parties": [
    ],
  • "status": "string",
  • "is_duplicate": true,
  • "first_docai_result_time": "2019-08-24T14:15:22Z",
  • "trashed": true,
  • "docai_skip": [
    ],
  • "allow_emails": true,
  • "set_defaults_for": {
    },
  • "favorite": true
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "cover_document": {
    },
  • "unverified_docai_attributes": "string",
  • "id": "string",
  • "incomplete": true,
  • "num_emails": 0,
  • "num_files": 0,
  • "num_users": 2147483647,
  • "matches": {
    },
  • "owner": {
    },
  • "parties": [
    ],
  • "permission": "string",
  • "receive_time": "2019-08-24T14:15:22Z",
  • "related_contracts": [
    ],
  • "status": "queued",
  • "is_duplicate": true,
  • "favorite_of": [
    ],
  • "last_modified": "2019-08-24T14:15:22Z",
  • "first_docai_result_time": "2019-08-24T14:15:22Z",
  • "trashed": true,
  • "esigns": [
    ],
  • "num_signed_documents": 0,
  • "docai_skip": [
    ],
  • "activities": [
    ],
  • "allow_emails": true,
  • "documents": [
    ],
  • "duplicates": [
    ],
  • "emails": [
    ],
  • "notes": [
    ],
  • "num_binders": 0,
  • "rated": true,
  • "taggings": [
    ],
  • "form": "string"
}

Read

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "cover_document": {
    },
  • "unverified_docai_attributes": "string",
  • "id": "string",
  • "incomplete": true,
  • "num_emails": 0,
  • "num_files": 0,
  • "num_users": 2147483647,
  • "matches": {
    },
  • "owner": {
    },
  • "parties": [
    ],
  • "permission": "string",
  • "receive_time": "2019-08-24T14:15:22Z",
  • "related_contracts": [
    ],
  • "status": "queued",
  • "is_duplicate": true,
  • "favorite_of": [
    ],
  • "last_modified": "2019-08-24T14:15:22Z",
  • "first_docai_result_time": "2019-08-24T14:15:22Z",
  • "trashed": true,
  • "esigns": [
    ],
  • "num_signed_documents": 0,
  • "docai_skip": [
    ],
  • "activities": [
    ],
  • "allow_emails": true,
  • "documents": [
    ],
  • "duplicates": [
    ],
  • "emails": [
    ],
  • "notes": [
    ],
  • "num_binders": 0,
  • "rated": true,
  • "taggings": [
    ],
  • "form": "string"
}

Add file

Uploads a new attachment of any type to a contract.

path Parameters
id
required
string
Request Body schema:
required
blob
required
string <uri>

New file to contract

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "cover_document": {
    },
  • "unverified_docai_attributes": "string",
  • "id": "string",
  • "incomplete": true,
  • "num_emails": 0,
  • "num_files": 0,
  • "num_users": 2147483647,
  • "matches": {
    },
  • "owner": {
    },
  • "parties": [
    ],
  • "permission": "string",
  • "receive_time": "2019-08-24T14:15:22Z",
  • "related_contracts": [
    ],
  • "status": "queued",
  • "is_duplicate": true,
  • "favorite_of": [
    ],
  • "last_modified": "2019-08-24T14:15:22Z",
  • "first_docai_result_time": "2019-08-24T14:15:22Z",
  • "trashed": true,
  • "esigns": [
    ],
  • "num_signed_documents": 0,
  • "docai_skip": [
    ],
  • "activities": [
    ],
  • "allow_emails": true,
  • "documents": [
    ],
  • "duplicates": [
    ],
  • "emails": [
    ],
  • "notes": [
    ],
  • "num_binders": 0,
  • "rated": true,
  • "taggings": [
    ],
  • "form": "string"
}

Subsume

Subsume given contracts to the primary contract

path Parameters
id
required
string
Request Body schema:
required
contracts
required
Array of strings

IDs of OWNED contracts to be subsumed into the main contract.

included_properties
required
Array of strings (IncludedPropertiesEnum)
Items Enum: "activities" "attributes" "documents" "emails" "esigns" "notes" "parties" "sharing" "tags"

List of properties include in the process.

Responses

Request samples

Content type
{
  • "contracts": [
    ],
  • "included_properties": [
    ]
}

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "cover_document": {
    },
  • "unverified_docai_attributes": "string",
  • "id": "string",
  • "incomplete": true,
  • "num_emails": 0,
  • "num_files": 0,
  • "num_users": 2147483647,
  • "matches": {
    },
  • "owner": {
    },
  • "parties": [
    ],
  • "permission": "string",
  • "receive_time": "2019-08-24T14:15:22Z",
  • "related_contracts": [
    ],
  • "status": "queued",
  • "is_duplicate": true,
  • "favorite_of": [
    ],
  • "last_modified": "2019-08-24T14:15:22Z",
  • "first_docai_result_time": "2019-08-24T14:15:22Z",
  • "trashed": true,
  • "esigns": [
    ],
  • "num_signed_documents": 0,
  • "docai_skip": [
    ],
  • "activities": [
    ],
  • "allow_emails": true,
  • "documents": [
    ],
  • "duplicates": [
    ],
  • "emails": [
    ],
  • "notes": [
    ],
  • "num_binders": 0,
  • "rated": true,
  • "taggings": [
    ],
  • "form": "string"
}

Users > Read

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "email": "string",
  • "name": "string",
  • "status": "active"
}

Activities > List

path Parameters
contract_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

q
string

Search query string to search in activity titles, descriptions and complete reasons.

title
string

Search query string to search in activity titles.

description
string

Search query string to search in descriptions.

complete_reason
string

Search query string to search in complete reasons.

time
string

Datetime 'a-b'; a, b in ['YYYYMMDDHHMM', 'now'] or empty.

completed
boolean

The 'completed' state of the activity.

sort
string
Enum: "-time" "-title" "time" "title"
contract_owner
string

Activities related to contracts owned by the user.

Responses

Response samples

Content type
application/json
{
  • "page_size": 123,
  • "page": 123,
  • "last_page": 123,
  • "count": 123,
  • "results": [
    ]
}

Binders > Create

Adds this contract to a binder.

path Parameters
contract_id
required
string
Request Body schema:
required
binder
required
string

Responses

Request samples

Content type
{
  • "binder": "string"
}

Response samples

Content type
application/json
{
  • "binder": {
    },
  • "date_added": "2019-08-24T14:15:22Z",
  • "added_by": {
    }
}

Binders > List

path Parameters
contract_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "page_size": 123,
  • "page": 123,
  • "last_page": 123,
  • "count": 123,
  • "results": [
    ]
}

Download

Creates a task to build a zip archive of contract documents.

path Parameters
contract_id
required
string
Request Body schema:
frontend_status
string (FrontendStatusEnum)
Enum: "done" "failed" "pending" "processing"

Responses

Request samples

Content type
{
  • "frontend_status": "done"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": {
    },
  • "backend_status": "done",
  • "backend_status_info": "string",
  • "frontend_status": "done",
  • "description": "string",
  • "progress": 0.1,
  • "processing_started_at": "2019-08-24T14:15:22Z",
  • "processing_ended_at": "2019-08-24T14:15:22Z",
  • "failed_contracts": [
    ]
}

Emails > Delete

path Parameters
contract_id
required
string
email_id
required
string

Responses

Emails > Read

path Parameters
contract_id
required
string
email_id
required
string

Responses

Emails > Download

Downloads the raw email file in given format.

path Parameters
contract_id
required
string
email_id
required
string

Responses

Memberships > Create

path Parameters
contract_id
required
string
Request Body schema:
required
permission
required
string
Enum: "view" "edit" "full"

The permissions granted to the member User for contracts in this binder.

  • view: View-only access to the Binder and Contracts under this binder.
  • edit: Full access to view and edit Contracts under this binder, as well as adding/removing/editing Members.
  • full: TODO
user
string
group
string
contract
required
string

Responses

Request samples

Content type
{
  • "permission": "view",
  • "user": "string",
  • "group": "string",
  • "contract": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "permission": "view",
  • "user": "string",
  • "group": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "added_by": {
    },
  • "contract": "string"
}

Memberships > List

path Parameters
contract_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

Memberships > Delete

path Parameters
contract_id
required
string
cryptid
required
string

Responses

Memberships > Partial update

path Parameters
contract_id
required
string
cryptid
required
string
Request Body schema:
permission
string
Enum: "view" "edit" "full"

The permissions granted to the member User for contracts in this binder.

  • view: View-only access to the Binder and Contracts under this binder.
  • edit: Full access to view and edit Contracts under this binder, as well as adding/removing/editing Members.
  • full: TODO
contract
string

Responses

Request samples

Content type
{
  • "permission": "view",
  • "contract": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "permission": "view",
  • "user": "string",
  • "group": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "added_by": {
    },
  • "contract": "string"
}

Memberships > Read

path Parameters
contract_id
required
string
cryptid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "permission": "view",
  • "user": "string",
  • "group": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "added_by": {
    },
  • "contract": "string"
}

Memberships > Update

path Parameters
contract_id
required
string
cryptid
required
string
Request Body schema:
required
permission
required
string
Enum: "view" "edit" "full"

The permissions granted to the member User for contracts in this binder.

  • view: View-only access to the Binder and Contracts under this binder.
  • edit: Full access to view and edit Contracts under this binder, as well as adding/removing/editing Members.
  • full: TODO
user
string
group
string
contract
required
string

Responses

Request samples

Content type
{
  • "permission": "view",
  • "user": "string",
  • "group": "string",
  • "contract": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "permission": "view",
  • "user": "string",
  • "group": "string",
  • "date_added": "2019-08-24T14:15:22Z",
  • "added_by": {
    },
  • "contract": "string"
}

Notes > Create

path Parameters
contract_id
required
string
Request Body schema:
content
string

The content of the note.

document
string

The id of the document associated with the note.

object

The highlighted section in the document.

Responses

Request samples

Content type
{
  • "content": "string",
  • "document": "string",
  • "highlight": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "contract_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "set_by": {
    },
  • "content": "string",
  • "document": "string",
  • "highlight": {
    }
}

Notes > Delete

path Parameters
contract_id
required
string
id
required
string

Responses

Notes > Partial update

path Parameters
contract_id
required
string
id
required
string
Request Body schema:
content
string

The content of the note.

document
string

The id of the document associated with the note.

object

The highlighted section in the document.

Responses

Request samples

Content type
{
  • "content": "string",
  • "document": "string",
  • "highlight": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "contract_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "set_by": {
    },
  • "content": "string",
  • "document": "string",
  • "highlight": {
    }
}

Notes > Read

path Parameters
contract_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "contract_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "set_by": {
    },
  • "content": "string",
  • "document": "string",
  • "highlight": {
    }
}

Parties > Create

path Parameters
contract_id
required
string
Request Body schema:
name
string <= 1024 characters

Name of party

org_id
string or null <= 128 characters

ID code

external_id
string or null <= 1000 characters

External ID for integration purposes

extra_text_field_1
string <= 1024 characters
extra_text_field_2
string <= 1024 characters
managed
boolean

Explicitly managed party (exists even without contracts)

public
boolean

If true, this Party is visible to all users on the account

country
string
contact
string <= 1024 characters
group
string <= 1024 characters
previous_names
string
role
string
party
string or null
docai_value_verified
boolean
Default: false

Responses

Request samples

Content type
{
  • "name": "string",
  • "org_id": "string",
  • "external_id": "string",
  • "extra_text_field_1": "string",
  • "extra_text_field_2": "string",
  • "managed": true,
  • "public": true,
  • "country": "string",
  • "contact": "string",
  • "group": "string",
  • "previous_names": "string",
  • "role": "string",
  • "party": "string",
  • "docai_value_verified": false
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "org_id": "string",
  • "external_id": "string",
  • "extra_text_field_1": "string",
  • "extra_text_field_2": "string",
  • "managed": true,
  • "public": true,
  • "country": "string",
  • "contact": "string",
  • "group": "string",
  • "previous_names": "string",
  • "role": "string",
  • "party": "string",
  • "docai_value_verified": false
}

Parties > Delete

path Parameters
contract_id
required
string
id
required
string

Responses

Parties > Partial update

path Parameters
contract_id
required
string
id
required
string
Request Body schema:
docai_value_verified
boolean or null
role
string

Responses

Request samples

Content type
{
  • "docai_value_verified": true,
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "docai_value_verified": true,
  • "role": "string"
}

Relationships > Create

path Parameters
contract_id
required
string
Request Body schema:
required
to_contract
required
string
TypeEnum (string) or BlankEnum (any)
Default: "related"

Responses

Request samples

Content type
{
  • "to_contract": "string",
  • "type": "related"
}

Response samples

Content type
application/json
{
  • "from_contract": "string",
  • "id": "string",
  • "to_contract": "string",
  • "type": "related"
}

Relationships > List

path Parameters
contract_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

Relationships > Delete

path Parameters
contract_id
required
string
cryptid
required
string

Responses

Relationships > Partial update

path Parameters
contract_id
required
string
cryptid
required
string
Request Body schema:
to_contract
string
TypeEnum (string) or BlankEnum (any)
Default: "related"

Responses

Request samples

Content type
{
  • "to_contract": "string",
  • "type": "related"
}

Response samples

Content type
application/json
{
  • "from_contract": "string",
  • "id": "string",
  • "to_contract": "string",
  • "type": "related"
}

Relationships > Read

path Parameters
contract_id
required
string
cryptid
required
string

Responses

Response samples

Content type
application/json
{
  • "from_contract": "string",
  • "id": "string",
  • "to_contract": "string",
  • "type": "related"
}

Relationships > Update

path Parameters
contract_id
required
string
cryptid
required
string
Request Body schema:
required
to_contract
required
string
TypeEnum (string) or BlankEnum (any)
Default: "related"

Responses

Request samples

Content type
{
  • "to_contract": "string",
  • "type": "related"
}

Response samples

Content type
application/json
{
  • "from_contract": "string",
  • "id": "string",
  • "to_contract": "string",
  • "type": "related"
}

Signatures > List

path Parameters
contract_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "page_size": 123,
  • "page": 123,
  • "last_page": 123,
  • "count": 123,
  • "results": [
    ]
}

Signatures > Read

path Parameters
contract_id
required
string
cryptid
required
string

Responses

Response samples

Content type
application/json
{
  • "contract_id": "string",
  • "document_id": "string",
  • "document_filename": "string",
  • "id": "string",
  • "integrity_digest_algorithm": "string",
  • "integrity_signature_mechanism": "string",
  • "modifications_coverage": "string",
  • "modifications_modification_level": "string",
  • "modifications_suspicious": true,
  • "ordinal": 32767,
  • "signature_field": "string",
  • "signed_at": "2019-08-24T14:15:22Z",
  • "signer_cert_cryptologically_sound": true,
  • "signer_cert_intact": true,
  • "signer_cert_not_valid_after": "2019-08-24T14:15:22Z",
  • "signer_cert_revoked": true,
  • "signer_cert_sha1": "string",
  • "signer_cert_subject": "string",
  • "signer_cert_trust_anchor": "string",
  • "signer_cert_trust_problem": "string",
  • "signer_cert_trusted": true,
  • "signer_cert_valid": true,
  • "signer_org": "string",
  • "signer_org_confidence": 100,
  • "status": "valid",
  • "tsa_cert_cryptologically_sound": true,
  • "tsa_cert_intact": true,
  • "tsa_cert_sha1": "string",
  • "tsa_cert_subject": "string",
  • "tsa_cert_timestamp": "2019-08-24T14:15:22Z",
  • "tsa_cert_trust_anchor": "string",
  • "tsa_cert_trusted": true,
  • "tsa_cert_valid": true,
  • "valid": true,
  • "validity_error": "timstamp"
}

Esigns

Validate > Create

Authorizations:
None
Request Body schema:
required
validation_id
required
string <uuid>

Validation id of the esign.

file_sha256
required
string

SHA-256 hash of the signed document.

Responses

Request samples

Content type
{
  • "validation_id": "4b787051-9941-4155-aa13-68df4d20d7bc",
  • "file_sha256": "string"
}

Response samples

Content type
application/json
{
  • "is_correct_file": true,
  • "parties": [
    ],
  • "status_text": "string"
}

Soft validate > Create

Authorizations:
None
Request Body schema:
required
validation_id
required
string <uuid>

Validation id of the esign.

Responses

Request samples

Content type
{
  • "validation_id": "4b787051-9941-4155-aa13-68df4d20d7bc"
}

Response samples

Content type
application/json
{
  • "status_text": "string"
}

Create

Request Body schema:
required
attachments
Array of any

List of attachment document IDs

contract
required
string

ID of the Contract to attach this esign to.

contract_binders
Array of strings

List of binders where signed contract is moved

deadline
string or null <date-time>

If no deadline set, default 14 days from activation will be used.

document
string

ID of the Document to attach this esign to

greetings
string or null
merge_documents
boolean
need_auth_to_view_documents
boolean

Does e-sign party need to authenticate before viewing documents

needs_to_be_viewed
boolean

Does attachments need to be viewed before signing

Array of objects (EsignParty)
sender_name
string or null
sign_order
string (SignOrderEnum)
Enum: "parallel" "consecutive" "flexible"
title
string <= 2014 characters

Name of signed document set

Responses

Request samples

Content type
{
  • "attachments": [
    ],
  • "contract": "string",
  • "contract_binders": [
    ],
  • "deadline": "2019-08-24T14:15:22Z",
  • "document": "string",
  • "greetings": "string",
  • "merge_documents": true,
  • "need_auth_to_view_documents": true,
  • "needs_to_be_viewed": true,
  • "parties": [
    ],
  • "sender_name": "string",
  • "sign_order": "parallel",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "activated": true,
  • "activated_at": "2019-08-24T14:15:22Z",
  • "available_until": "2019-08-24T14:15:22Z",
  • "contract": "string",
  • "contract_binders": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "deadline": "2019-08-24T14:15:22Z",
  • "documents": [
    ],
  • "form_submission": "string",
  • "greetings": "string",
  • "id": "string",
  • "merge_documents": true,
  • "need_auth_to_view_documents": true,
  • "owner": {
    },
  • "parties": [
    ],
  • "sender_name": "string",
  • "sign_order": "parallel",
  • "signed": true,
  • "status": "draft",
  • "status_saved_at": "2019-08-24T14:15:22Z",
  • "title": "string"
}

List

List e-signs

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

q
string

Search query string to search from esign titles, parties and documents.

status
string
Enum: "canceled" "completed" "declined" "draft" "expired" "pending" "processing_signing"

Status of the e-sign.

owner
string

E-signs owned by specific user

activated_at
string

Datetime 'a-b'; a, b in ['yyyymmdd', 'today'] or empty.

created_at
string

Datetime 'a-b'; a, b in ['yyyymmdd', 'today'] or empty.

deadline
string

Datetime 'a-b'; a, b in ['yyyymmdd', 'today'] or empty.

status_saved_at
string

Datetime 'a-b'; a, b in ['yyyymmdd', 'today'] or empty.

sort
string
Enum: "-activated_at" "-created_at" "-deadline" "-status" "-status_saved_at" "-title" "activated_at" "created_at" "deadline" "status" "status_saved_at" "title"

Sort results by key.

Responses

Response samples

Content type
application/json
{
  • "page_size": 123,
  • "page": 123,
  • "last_page": 123,
  • "count": 123,
  • "results": [
    ]
}

Delete

path Parameters
id
required
integer

A unique integer value identifying this esign.

Responses

Partial update

After the signing process is complete, only the following fields can be updated: available_until

path Parameters
id
required
integer

A unique integer value identifying this esign.

Request Body schema:
attachments
Array of any

List of attachment document IDs

contract
string

ID of the Contract to attach this esign to.

contract_binders
Array of strings

List of binders where signed contract is moved

deadline
string or null <date-time>

If no deadline set, default 14 days from activation will be used.

document
string

ID of the Document to attach this esign to

greetings
string or null
merge_documents
boolean
need_auth_to_view_documents
boolean

Does e-sign party need to authenticate before viewing documents

needs_to_be_viewed
boolean

Does attachments need to be viewed before signing

Array of objects (EsignParty)
sender_name
string or null
sign_order
string (SignOrderEnum)
Enum: "parallel" "consecutive" "flexible"
title
string <= 2014 characters

Name of signed document set

Responses

Request samples

Content type
{
  • "attachments": [
    ],
  • "contract": "string",
  • "contract_binders": [
    ],
  • "deadline": "2019-08-24T14:15:22Z",
  • "document": "string",
  • "greetings": "string",
  • "merge_documents": true,
  • "need_auth_to_view_documents": true,
  • "needs_to_be_viewed": true,
  • "parties": [
    ],
  • "sender_name": "string",
  • "sign_order": "parallel",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "activated": true,
  • "activated_at": "2019-08-24T14:15:22Z",
  • "available_until": "2019-08-24T14:15:22Z",
  • "contract": "string",
  • "contract_binders": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "deadline": "2019-08-24T14:15:22Z",
  • "documents": [
    ],
  • "form_submission": "string",
  • "greetings": "string",
  • "id": "string",
  • "merge_documents": true,
  • "need_auth_to_view_documents": true,
  • "owner": {
    },
  • "parties": [
    ],
  • "sender_name": "string",
  • "sign_order": "parallel",
  • "signed": true,
  • "status": "draft",
  • "status_saved_at": "2019-08-24T14:15:22Z",
  • "title": "string"
}

Read

path Parameters
id
required
integer

A unique integer value identifying this esign.

Responses

Response samples

Content type
application/json
{
  • "activated": true,
  • "activated_at": "2019-08-24T14:15:22Z",
  • "available_until": "2019-08-24T14:15:22Z",
  • "contract": "string",
  • "contract_binders": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "deadline": "2019-08-24T14:15:22Z",
  • "documents": [
    ],
  • "form_submission": "string",
  • "greetings": "string",
  • "id": "string",
  • "merge_documents": true,
  • "need_auth_to_view_documents": true,
  • "owner": {
    },
  • "parties": [
    ],
  • "sender_name": "string",
  • "sign_order": "parallel",
  • "signed": true,
  • "status": "draft",
  • "status_saved_at": "2019-08-24T14:15:22Z",
  • "title": "string"
}

Activate

Activate e-sign for signing and send signing requests

path Parameters
id
required
integer

A unique integer value identifying this esign.

Responses

Response samples

Content type
application/json
{
  • "activated": true,
  • "activated_at": "2019-08-24T14:15:22Z",
  • "available_until": "2019-08-24T14:15:22Z",
  • "contract": "string",
  • "contract_binders": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "deadline": "2019-08-24T14:15:22Z",
  • "documents": [
    ],
  • "form_submission": "string",
  • "greetings": "string",
  • "id": "string",
  • "merge_documents": true,
  • "need_auth_to_view_documents": true,
  • "owner": {
    },
  • "parties": [
    ],
  • "sender_name": "string",
  • "sign_order": "parallel",
  • "signed": true,
  • "status": "draft",
  • "status_saved_at": "2019-08-24T14:15:22Z",
  • "title": "string"
}

Cancel

Cancel e-sign signing process and send cancellation notifications to e-sign parties

path Parameters
id
required
integer

A unique integer value identifying this esign.

Responses

Response samples

Content type
application/json
{
  • "activated": true,
  • "activated_at": "2019-08-24T14:15:22Z",
  • "available_until": "2019-08-24T14:15:22Z",
  • "contract": "string",
  • "contract_binders": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "deadline": "2019-08-24T14:15:22Z",
  • "documents": [
    ],
  • "form_submission": "string",
  • "greetings": "string",
  • "id": "string",
  • "merge_documents": true,
  • "need_auth_to_view_documents": true,
  • "owner": {
    },
  • "parties": [
    ],
  • "sender_name": "string",
  • "sign_order": "parallel",
  • "signed": true,
  • "status": "draft",
  • "status_saved_at": "2019-08-24T14:15:22Z",
  • "title": "string"
}

Reactivate

Re-activate cancelled or expired e-sign process for signing and send new signing requests

path Parameters
id
required
integer

A unique integer value identifying this esign.

Responses

Response samples

Content type
application/json
{
  • "activated": true,
  • "activated_at": "2019-08-24T14:15:22Z",
  • "available_until": "2019-08-24T14:15:22Z",
  • "contract": "string",
  • "contract_binders": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "deadline": "2019-08-24T14:15:22Z",
  • "documents": [
    ],
  • "form_submission": "string",
  • "greetings": "string",
  • "id": "string",
  • "merge_documents": true,
  • "need_auth_to_view_documents": true,
  • "owner": {
    },
  • "parties": [
    ],
  • "sender_name": "string",
  • "sign_order": "parallel",
  • "signed": true,
  • "status": "draft",
  • "status_saved_at": "2019-08-24T14:15:22Z",
  • "title": "string"
}

Resend completed

Resend e-sign completed e-mails to all parties

path Parameters
id
required
integer

A unique integer value identifying this esign.

Responses

Response samples

Content type
application/json
{
  • "activated": true,
  • "activated_at": "2019-08-24T14:15:22Z",
  • "available_until": "2019-08-24T14:15:22Z",
  • "contract": "string",
  • "contract_binders": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "deadline": "2019-08-24T14:15:22Z",
  • "documents": [
    ],
  • "form_submission": "string",
  • "greetings": "string",
  • "id": "string",
  • "merge_documents": true,
  • "need_auth_to_view_documents": true,
  • "owner": {
    },
  • "parties": [
    ],
  • "sender_name": "string",
  • "sign_order": "parallel",
  • "signed": true,
  • "status": "draft",
  • "status_saved_at": "2019-08-24T14:15:22Z",
  • "title": "string"
}

Parties > Create

path Parameters
esign_id
required
integer
Request Body schema:
additional_info
string or null <= 100 characters
authentication_type
string
email
string <email> <= 128 characters
language
string <= 32 characters
name
string <= 100 characters
need_auth_to_view_documents
boolean or null

Does viewing documents need authentication

ordinal
integer >= 1

Ordinal of party, cannot be set if sign order is parallel

personal_id
string or null <= 30 characters
phone_number
string or null <= 128 characters
role
string (EsignPartyRoleEnum)
Enum: "signer" "approver" "cc"
user
string

Responses

Request samples

Content type
{
  • "additional_info": "string",
  • "authentication_type": "string",
  • "email": "user@example.com",
  • "language": "string",
  • "name": "string",
  • "need_auth_to_view_documents": true,
  • "ordinal": 1,
  • "personal_id": "string",
  • "phone_number": "string",
  • "role": "signer",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "additional_info": "string",
  • "authentication_type": "string",
  • "email": "user@example.com",
  • "id": "string",
  • "invitation_sent_at": "string",
  • "language": "string",
  • "message": "string",
  • "name": "string",
  • "need_auth_to_view_documents": true,
  • "ordinal": 1,
  • "personal_id": "string",
  • "phone_number": "string",
  • "role": "signer",
  • "sms_delivery_status": "string",
  • "status": "string",
  • "status_saved_at": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "user": "string"
}

Parties > List

path Parameters
esign_id
required
integer
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "page_size": 123,
  • "page": 123,
  • "last_page": 123,
  • "count": 123,
  • "results": [
    ]
}

Parties > Delete

path Parameters
esign_id
required
integer
id
required
integer

A unique integer value identifying this esign party.

Responses

Parties > Partial update

path Parameters
esign_id
required
integer
id
required
integer

A unique integer value identifying this esign party.

Request Body schema:
additional_info
string or null <= 100 characters
authentication_type
string
email
string <email> <= 128 characters
language
string <= 32 characters
name
string <= 100 characters
need_auth_to_view_documents
boolean or null

Does viewing documents need authentication

ordinal
integer >= 1

Ordinal of party, cannot be set if sign order is parallel

personal_id
string or null <= 30 characters
phone_number
string or null <= 128 characters
role
string (EsignPartyRoleEnum)
Enum: "signer" "approver" "cc"
user
string

Responses

Request samples

Content type
{
  • "additional_info": "string",
  • "authentication_type": "string",
  • "email": "user@example.com",
  • "language": "string",
  • "name": "string",
  • "need_auth_to_view_documents": true,
  • "ordinal": 1,
  • "personal_id": "string",
  • "phone_number": "string",
  • "role": "signer",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "additional_info": "string",
  • "authentication_type": "string",
  • "email": "user@example.com",
  • "id": "string",
  • "invitation_sent_at": "string",
  • "language": "string",
  • "message": "string",
  • "name": "string",
  • "need_auth_to_view_documents": true,
  • "ordinal": 1,
  • "personal_id": "string",
  • "phone_number": "string",
  • "role": "signer",
  • "sms_delivery_status": "string",
  • "status": "string",
  • "status_saved_at": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "user": "string"
}

Parties > Read

path Parameters
esign_id
required
integer
id
required
integer

A unique integer value identifying this esign party.

Responses

Response samples

Content type
application/json
{
  • "additional_info": "string",
  • "authentication_type": "string",
  • "email": "user@example.com",
  • "id": "string",
  • "invitation_sent_at": "string",
  • "language": "string",
  • "message": "string",
  • "name": "string",
  • "need_auth_to_view_documents": true,
  • "ordinal": 1,
  • "personal_id": "string",
  • "phone_number": "string",
  • "role": "signer",
  • "sms_delivery_status": "string",
  • "status": "string",
  • "status_saved_at": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "user": "string"
}

Parties > Resend completed

Resend e-sign completed e-mail to e-sign party

path Parameters
esign_id
required
integer
id
required
integer

A unique integer value identifying this esign party.

Responses

Response samples

Content type
application/json
{
  • "additional_info": "string",
  • "authentication_type": "string",
  • "email": "user@example.com",
  • "id": "string",
  • "invitation_sent_at": "string",
  • "language": "string",
  • "message": "string",
  • "name": "string",
  • "need_auth_to_view_documents": true,
  • "ordinal": 1,
  • "personal_id": "string",
  • "phone_number": "string",
  • "role": "signer",
  • "sms_delivery_status": "string",
  • "status": "string",
  • "status_saved_at": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "user": "string"
}

Parties > Resend invitation

Resend signing or approval invitation to e-sign party

path Parameters
esign_id
required
integer
id
required
integer

A unique integer value identifying this esign party.

Responses

Response samples

Content type
application/json
{
  • "additional_info": "string",
  • "authentication_type": "string",
  • "email": "user@example.com",
  • "id": "string",
  • "invitation_sent_at": "string",
  • "language": "string",
  • "message": "string",
  • "name": "string",
  • "need_auth_to_view_documents": true,
  • "ordinal": 1,
  • "personal_id": "string",
  • "phone_number": "string",
  • "role": "signer",
  • "sms_delivery_status": "string",
  • "status": "string",
  • "status_saved_at": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "user": "string"
}

Documents > Download

Download given e-sign document

path Parameters
esign_id
required
integer
id
required
integer

A unique integer value identifying this esign document.

query Parameters
type
string
Enum: "current" "presigned" "signed"

Responses

Binders

Statistics > List

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

parent
string

The parent binder.

Responses

Create

Request Body schema:
required
name
required
string <= 512 characters
parent
string or null
is_esign_target
boolean
Default: false

Responses

Request samples

Content type
{
  • "name": "string",
  • "parent": "string",
  • "is_esign_target": false
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "permission": "string",
  • "granted_permission": "string",
  • "path": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "inherit_permissions": true,
  • "num_children": 0,
  • "num_contracts": 0,
  • "num_groups": 0,
  • "num_groups_inherited": 0,
  • "num_users": 0,
  • "num_users_inherited": 0,
  • "num_users_total": "string",
  • "num_groups_total": "string",
  • "added_by": "string",
  • "is_esign_target": true
}

List

List accessible binders.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

id
string

Search query string to search in binder ids.

q
string

Search query string to search in binder names.

parent
string

The parent binder.

user
string

Binders accessible by a specific user.

sort
string
Enum: "-name" "-num_contracts" "name" "num_contracts"

Sort results by key.

permission
string
Enum: "edit" "full" "view"

Minimum effective permission level.

permission_type
string
Enum: "effective" "esign_targets" "granted"

Type of permissions used. Choices: effective, granted, esign_targets

Responses

Response samples

Content type
application/json
{
  • "page_size": 123,
  • "page": 123,
  • "last_page": 123,
  • "count": 123,
  • "results": [
    ]
}

Access report > Read

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": {
    },
  • "backend_status": "done",
  • "backend_status_info": "string",
  • "frontend_status": "done",
  • "de