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

200

Content type

application/json

{"page_size": 123,
"page": 123,
"last_page": 123,
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": "string"
}
]
}

Trash > Empty > Create

Permanently delete all contracts from the trash.

Request Body schema:
application/json

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

202

Content type

application/json

{"id": "string",
"name": "string",
"details": null,
"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": [{"property1": null,
"property2": null
}
],
"failed_binders": [{"property1": null,
"property2": null
}
]
}

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:
application/json

Responses

Request samples

Payload

Content type

application/json

{ }

Create

Upload a new contract.

Request Body schema:
application/json

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" "end_of_current_term" "main_language" "notice_period" "parties" "renewal_period" "signed_date" "taggings" "title"
binders	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"blob": "http://example.com",
"title": "string",
"docai_skip": ["effective_date"
],
"binders": ["string"
]
}

Response samples

201

Content type

application/json

{"attributes": {"title": "string",
"end_date": "2019-08-24"
},
"cover_document": {"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
},
"unverified_docai_attributes": "string",
"id": "string",
"incomplete": true,
"num_emails": 0,
"num_files": 0,
"num_users": 2147483647,
"matches": null,
"owner": {"property1": null,
"property2": null
},
"parties": [{"id": "string",
"name": "string",
"org_id": "string",
"external_id": "string",
"extra_text_field_1": "string",
"extra_text_field_2": "string",
"role_id": "string",
"role_name": "string",
"role": "string",
"editable": true,
"country": "string",
"contact": "string",
"group": "string",
"previous_names": "string",
"source": "ai",
"docai_value_verified": true,
"name_in_document": "string",
"name_coordinates": {"property1": null,
"property2": null
},
"org_id_coordinates": {"property1": null,
"property2": null
}
}
],
"permission": "string",
"receive_time": "2019-08-24T14:15:22Z",
"related_contracts": [null
],
"status": "queued",
"is_duplicate": true,
"favorite_of": [null
],
"last_modified": "2019-08-24T14:15:22Z",
"first_docai_result_time": "2019-08-24T14:15:22Z",
"trashed": true,
"esigns": [{"id": "string",
"owner": "string",
"status": "draft"
}
],
"num_signed_documents": 0,
"docai_skip": ["effective_date"
],
"attribute_coordinates": {"property1": null,
"property2": null
},
"activities": [{"id": "string",
"title": "string",
"description": "string",
"completed": true,
"completed_by": "string",
"completion_date": "2019-08-24",
"complete_reason": "string",
"date": "2019-08-24",
"hour_of_day": 23,
"num_reminders": 0,
"recipients": {"property1": null,
"property2": null
},
"recurrence": "once",
"has_recurred": true,
"complete_by_email": true,
"contract": "string",
"owner_is_recipient": true,
"related_meta_attribute": "string"
}
],
"allow_emails": true,
"documents": [{"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
}
],
"duplicates": [null
],
"emails": [{"file_extension": "string",
"id": "string",
"subject": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
],
"notes": [{"id": "string",
"contract_id": "string",
"timestamp": "2019-08-24T14:15:22Z",
"set_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"content": "string",
"document": "string",
"highlight": null
}
],
"num_binders": 0,
"rated": true,
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"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

200

Content type

application/json

{"page_size": 123,
"page": 123,
"last_page": 123,
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"attributes": {"title": "string",
"end_date": "2019-08-24"
},
"cover_document": {"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
},
"unverified_docai_attributes": "string",
"id": "string",
"incomplete": true,
"num_emails": 0,
"num_files": 0,
"num_users": 2147483647,
"matches": null,
"owner": {"property1": null,
"property2": null
},
"parties": [{"id": "string",
"name": "string",
"org_id": "string",
"external_id": "string",
"extra_text_field_1": "string",
"extra_text_field_2": "string",
"role_id": "string",
"role_name": "string",
"role": "string",
"editable": true,
"country": "string",
"contact": "string",
"group": "string",
"previous_names": "string",
"source": "ai",
"docai_value_verified": true,
"name_in_document": "string",
"name_coordinates": {"property1": null,
"property2": null
},
"org_id_coordinates": {"property1": null,
"property2": null
}
}
],
"permission": "string",
"receive_time": "2019-08-24T14:15:22Z",
"related_contracts": [null
],
"status": "queued",
"is_duplicate": true,
"favorite_of": [null
],
"last_modified": "2019-08-24T14:15:22Z",
"first_docai_result_time": "2019-08-24T14:15:22Z",
"trashed": true,
"esigns": [{"id": "string",
"owner": "string",
"status": "draft"
}
],
"num_signed_documents": 0,
"docai_skip": ["effective_date"
],
"attribute_coordinates": {"property1": null,
"property2": null
},
"activities": [{"id": "string",
"title": "string",
"description": "string",
"completed": true,
"completed_by": "string",
"completion_date": "2019-08-24",
"complete_reason": "string",
"date": "2019-08-24",
"hour_of_day": 23,
"num_reminders": 0,
"recipients": {"property1": null,
"property2": null
},
"recurrence": "once",
"has_recurred": true,
"complete_by_email": true,
"contract": "string",
"owner_is_recipient": true,
"related_meta_attribute": "string"
}
],
"allow_emails": true,
"documents": [{"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
}
],
"duplicates": [null
],
"emails": [{"file_extension": "string",
"id": "string",
"subject": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
],
"notes": [{"id": "string",
"contract_id": "string",
"timestamp": "2019-08-24T14:15:22Z",
"set_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"content": "string",
"document": "string",
"highlight": null
}
],
"num_binders": 0,
"rated": true,
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"form": "string"
}
]
}

Bulk contract party delete

Request Body schema:
application/json
required

required	object (ContractAttributes)
required	object (Document)
incomplete	boolean The contract is missing some mandatory attributes.
num_users	integer [ 0 .. 2147483647 ]
status	string (StatusE11Enum) Enum: "queued" "processing" "review" "done" "archived" "error" "limited" `queued` - Queued for AI processing. `processing` - Being processed. `review` - Pending owner review. `done` - All processing and reviews done. `archived` - Moved to archive. `error` - Failed to process the contract `limited` - Limited due to exceeding account.max_contracts
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" "end_of_current_term" "main_language" "notice_period" "parties" "renewal_period" "signed_date" "taggings" "title"
allow_emails required	boolean

Responses

Request samples

Payload

Content type

application/json

{"attributes": {"title": "string",
"end_date": "2019-08-24"
},
"cover_document": {"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"status": "queued"
},
"incomplete": true,
"num_users": 2147483647,
"status": "queued",
"is_duplicate": true,
"first_docai_result_time": "2019-08-24T14:15:22Z",
"trashed": true,
"docai_skip": ["effective_date"
],
"allow_emails": true
}

Response samples

202

Content type

application/json

{"id": "string",
"name": "string",
"details": null,
"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": [{"property1": null,
"property2": null
}
],
"failed_binders": [{"property1": null,
"property2": null
}
]
}

Bulk contract party update

Request Body schema:
application/json
required

required	object (ContractAttributes)
required	object (Document)
incomplete	boolean The contract is missing some mandatory attributes.
num_users	integer [ 0 .. 2147483647 ]
status	string (StatusE11Enum) Enum: "queued" "processing" "review" "done" "archived" "error" "limited" `queued` - Queued for AI processing. `processing` - Being processed. `review` - Pending owner review. `done` - All processing and reviews done. `archived` - Moved to archive. `error` - Failed to process the contract `limited` - Limited due to exceeding account.max_contracts
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" "end_of_current_term" "main_language" "notice_period" "parties" "renewal_period" "signed_date" "taggings" "title"
allow_emails required	boolean

Responses

Request samples

Payload

Content type

application/json

{"attributes": {"title": "string",
"end_date": "2019-08-24"
},
"cover_document": {"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"status": "queued"
},
"incomplete": true,
"num_users": 2147483647,
"status": "queued",
"is_duplicate": true,
"first_docai_result_time": "2019-08-24T14:15:22Z",
"trashed": true,
"docai_skip": ["effective_date"
],
"allow_emails": true
}

Response samples

202

Content type

application/json

{"id": "string",
"name": "string",
"details": null,
"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": [{"property1": null,
"property2": null
}
],
"failed_binders": [{"property1": null,
"property2": null
}
]
}

Bulk delete

Responses

Response samples

202

Content type

application/json

{"id": "string",
"name": "string",
"details": null,
"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": [{"property1": null,
"property2": null
}
],
"failed_binders": [{"property1": null,
"property2": null
}
]
}

Bulk docai process

Run docai processing for selected contracts.

Responses

Response samples

202

Content type

application/json

{"id": "string",
"name": "string",
"details": null,
"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": [{"property1": null,
"property2": null
}
],
"failed_binders": [{"property1": null,
"property2": null
}
]
}

Bulk extract metadata

Extract given meta attribute to selected contracts with ChatGPT

Responses

Response samples

202

Content type

application/json

{"id": "string",
"name": "string",
"details": null,
"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": [{"property1": null,
"property2": null
}
],
"failed_binders": [{"property1": null,
"property2": null
}
]
}

Bulk update

Updates a large number of contracts.

Responses

Response samples

202

Content type

application/json

{"id": "string",
"name": "string",
"details": null,
"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": [{"property1": null,
"property2": null
}
],
"failed_binders": [{"property1": null,
"property2": null
}
]
}

Delete

path Parameters

id

required

string

Responses

Partial update

path Parameters

id

required

string

Request Body schema:
application/json

	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" "end_of_current_term" "main_language" "notice_period" "parties" "renewal_period" "signed_date" "taggings" "title"
	object
allow_emails	boolean
	object
favorite	boolean Set this contract as a favorite of the requesting user.

Responses

Request samples

Payload

Content type

application/json

{"attributes": {"title": "string",
"end_date": "2019-08-24"
},
"cover_document": {"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"status": "queued"
},
"incomplete": true,
"num_users": 2147483647,
"owner": "string",
"parties": [{"property1": null,
"property2": null
}
],
"status": "string",
"is_duplicate": true,
"first_docai_result_time": "2019-08-24T14:15:22Z",
"trashed": true,
"docai_skip": ["effective_date"
],
"attribute_coordinates": {"property1": {"document": "string",
"positions": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
}
},
"property2": {"document": "string",
"positions": {"property1": {"property1": null,
"property2": null
},
"property2": {"property1": null,
"property2": null
}
}
}
},
"allow_emails": true,
"set_defaults_for": {"property1": null,
"property2": null
},
"favorite": true
}

Response samples

200

Content type

application/json

{"attributes": {"title": "string",
"end_date": "2019-08-24"
},
"cover_document": {"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
},
"unverified_docai_attributes": "string",
"id": "string",
"incomplete": true,
"num_emails": 0,
"num_files": 0,
"num_users": 2147483647,
"matches": null,
"owner": {"property1": null,
"property2": null
},
"parties": [{"id": "string",
"name": "string",
"org_id": "string",
"external_id": "string",
"extra_text_field_1": "string",
"extra_text_field_2": "string",
"role_id": "string",
"role_name": "string",
"role": "string",
"editable": true,
"country": "string",
"contact": "string",
"group": "string",
"previous_names": "string",
"source": "ai",
"docai_value_verified": true,
"name_in_document": "string",
"name_coordinates": {"property1": null,
"property2": null
},
"org_id_coordinates": {"property1": null,
"property2": null
}
}
],
"permission": "string",
"receive_time": "2019-08-24T14:15:22Z",
"related_contracts": [null
],
"status": "queued",
"is_duplicate": true,
"favorite_of": [null
],
"last_modified": "2019-08-24T14:15:22Z",
"first_docai_result_time": "2019-08-24T14:15:22Z",
"trashed": true,
"esigns": [{"id": "string",
"owner": "string",
"status": "draft"
}
],
"num_signed_documents": 0,
"docai_skip": ["effective_date"
],
"attribute_coordinates": {"property1": null,
"property2": null
},
"activities": [{"id": "string",
"title": "string",
"description": "string",
"completed": true,
"completed_by": "string",
"completion_date": "2019-08-24",
"complete_reason": "string",
"date": "2019-08-24",
"hour_of_day": 23,
"num_reminders": 0,
"recipients": {"property1": null,
"property2": null
},
"recurrence": "once",
"has_recurred": true,
"complete_by_email": true,
"contract": "string",
"owner_is_recipient": true,
"related_meta_attribute": "string"
}
],
"allow_emails": true,
"documents": [{"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
}
],
"duplicates": [null
],
"emails": [{"file_extension": "string",
"id": "string",
"subject": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
],
"notes": [{"id": "string",
"contract_id": "string",
"timestamp": "2019-08-24T14:15:22Z",
"set_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"content": "string",
"document": "string",
"highlight": null
}
],
"num_binders": 0,
"rated": true,
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"form": "string"
}

Read

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"attributes": {"title": "string",
"end_date": "2019-08-24"
},
"cover_document": {"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
},
"unverified_docai_attributes": "string",
"id": "string",
"incomplete": true,
"num_emails": 0,
"num_files": 0,
"num_users": 2147483647,
"matches": null,
"owner": {"property1": null,
"property2": null
},
"parties": [{"id": "string",
"name": "string",
"org_id": "string",
"external_id": "string",
"extra_text_field_1": "string",
"extra_text_field_2": "string",
"role_id": "string",
"role_name": "string",
"role": "string",
"editable": true,
"country": "string",
"contact": "string",
"group": "string",
"previous_names": "string",
"source": "ai",
"docai_value_verified": true,
"name_in_document": "string",
"name_coordinates": {"property1": null,
"property2": null
},
"org_id_coordinates": {"property1": null,
"property2": null
}
}
],
"permission": "string",
"receive_time": "2019-08-24T14:15:22Z",
"related_contracts": [null
],
"status": "queued",
"is_duplicate": true,
"favorite_of": [null
],
"last_modified": "2019-08-24T14:15:22Z",
"first_docai_result_time": "2019-08-24T14:15:22Z",
"trashed": true,
"esigns": [{"id": "string",
"owner": "string",
"status": "draft"
}
],
"num_signed_documents": 0,
"docai_skip": ["effective_date"
],
"attribute_coordinates": {"property1": null,
"property2": null
},
"activities": [{"id": "string",
"title": "string",
"description": "string",
"completed": true,
"completed_by": "string",
"completion_date": "2019-08-24",
"complete_reason": "string",
"date": "2019-08-24",
"hour_of_day": 23,
"num_reminders": 0,
"recipients": {"property1": null,
"property2": null
},
"recurrence": "once",
"has_recurred": true,
"complete_by_email": true,
"contract": "string",
"owner_is_recipient": true,
"related_meta_attribute": "string"
}
],
"allow_emails": true,
"documents": [{"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
}
],
"duplicates": [null
],
"emails": [{"file_extension": "string",
"id": "string",
"subject": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
],
"notes": [{"id": "string",
"contract_id": "string",
"timestamp": "2019-08-24T14:15:22Z",
"set_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"content": "string",
"document": "string",
"highlight": null
}
],
"num_binders": 0,
"rated": true,
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"form": "string"
}

Access > Read

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"profiles": [{"entry": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"permissions": [{"permission": "string",
"admin": "string",
"binder": {"id": "string",
"name": "string",
"path": "string"
},
"group": {"id": "string",
"name": "string"
},
"owner": "string",
"derived_access_path": "string"
}
]
}
],
"groups": [{"entry": {"id": "string",
"name": "string"
},
"permissions": [{"permission": "string",
"admin": "string",
"binder": {"id": "string",
"name": "string",
"path": "string"
},
"group": {"id": "string",
"name": "string"
},
"owner": "string",
"derived_access_path": "string"
}
]
}
]
}

Add file

Uploads a new attachment of any type to a contract.

path Parameters

id

required

string

Request Body schema:
application/json
required

blob required	string <uri> New file to contract
folder	string or null

Responses

Request samples

Payload

Content type

application/json

{"blob": "http://example.com",
"folder": "string"
}

Response samples

200

Content type

application/json

{"attributes": {"title": "string",
"end_date": "2019-08-24"
},
"cover_document": {"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
},
"unverified_docai_attributes": "string",
"id": "string",
"incomplete": true,
"num_emails": 0,
"num_files": 0,
"num_users": 2147483647,
"matches": null,
"owner": {"property1": null,
"property2": null
},
"parties": [{"id": "string",
"name": "string",
"org_id": "string",
"external_id": "string",
"extra_text_field_1": "string",
"extra_text_field_2": "string",
"role_id": "string",
"role_name": "string",
"role": "string",
"editable": true,
"country": "string",
"contact": "string",
"group": "string",
"previous_names": "string",
"source": "ai",
"docai_value_verified": true,
"name_in_document": "string",
"name_coordinates": {"property1": null,
"property2": null
},
"org_id_coordinates": {"property1": null,
"property2": null
}
}
],
"permission": "string",
"receive_time": "2019-08-24T14:15:22Z",
"related_contracts": [null
],
"status": "queued",
"is_duplicate": true,
"favorite_of": [null
],
"last_modified": "2019-08-24T14:15:22Z",
"first_docai_result_time": "2019-08-24T14:15:22Z",
"trashed": true,
"esigns": [{"id": "string",
"owner": "string",
"status": "draft"
}
],
"num_signed_documents": 0,
"docai_skip": ["effective_date"
],
"attribute_coordinates": {"property1": null,
"property2": null
},
"activities": [{"id": "string",
"title": "string",
"description": "string",
"completed": true,
"completed_by": "string",
"completion_date": "2019-08-24",
"complete_reason": "string",
"date": "2019-08-24",
"hour_of_day": 23,
"num_reminders": 0,
"recipients": {"property1": null,
"property2": null
},
"recurrence": "once",
"has_recurred": true,
"complete_by_email": true,
"contract": "string",
"owner_is_recipient": true,
"related_meta_attribute": "string"
}
],
"allow_emails": true,
"documents": [{"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
}
],
"duplicates": [null
],
"emails": [{"file_extension": "string",
"id": "string",
"subject": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
],
"notes": [{"id": "string",
"contract_id": "string",
"timestamp": "2019-08-24T14:15:22Z",
"set_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"content": "string",
"document": "string",
"highlight": null
}
],
"num_binders": 0,
"rated": true,
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"form": "string"
}

Renew > Create

path Parameters

id

required

string

Request Body schema:
application/json

renewal_date

string <date>

Responses

Request samples

Payload

Content type

application/json

{"renewal_date": "2019-08-24"
}

Response samples

200

Content type

application/json

{"attributes": {"title": "string",
"end_date": "2019-08-24"
},
"cover_document": {"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
},
"unverified_docai_attributes": "string",
"id": "string",
"incomplete": true,
"num_emails": 0,
"num_files": 0,
"num_users": 2147483647,
"matches": null,
"owner": {"property1": null,
"property2": null
},
"parties": [{"id": "string",
"name": "string",
"org_id": "string",
"external_id": "string",
"extra_text_field_1": "string",
"extra_text_field_2": "string",
"role_id": "string",
"role_name": "string",
"role": "string",
"editable": true,
"country": "string",
"contact": "string",
"group": "string",
"previous_names": "string",
"source": "ai",
"docai_value_verified": true,
"name_in_document": "string",
"name_coordinates": {"property1": null,
"property2": null
},
"org_id_coordinates": {"property1": null,
"property2": null
}
}
],
"permission": "string",
"receive_time": "2019-08-24T14:15:22Z",
"related_contracts": [null
],
"status": "queued",
"is_duplicate": true,
"favorite_of": [null
],
"last_modified": "2019-08-24T14:15:22Z",
"first_docai_result_time": "2019-08-24T14:15:22Z",
"trashed": true,
"esigns": [{"id": "string",
"owner": "string",
"status": "draft"
}
],
"num_signed_documents": 0,
"docai_skip": ["effective_date"
],
"attribute_coordinates": {"property1": null,
"property2": null
},
"activities": [{"id": "string",
"title": "string",
"description": "string",
"completed": true,
"completed_by": "string",
"completion_date": "2019-08-24",
"complete_reason": "string",
"date": "2019-08-24",
"hour_of_day": 23,
"num_reminders": 0,
"recipients": {"property1": null,
"property2": null
},
"recurrence": "once",
"has_recurred": true,
"complete_by_email": true,
"contract": "string",
"owner_is_recipient": true,
"related_meta_attribute": "string"
}
],
"allow_emails": true,
"documents": [{"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
}
],
"duplicates": [null
],
"emails": [{"file_extension": "string",
"id": "string",
"subject": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
],
"notes": [{"id": "string",
"contract_id": "string",
"timestamp": "2019-08-24T14:15:22Z",
"set_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"content": "string",
"document": "string",
"highlight": null
}
],
"num_binders": 0,
"rated": true,
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"form": "string"
}

Send to docusign > Create

Send contract's active documents to DocuSign as an envelope for signing. When used first time, user needs to authenticate.

path Parameters

id

required

string

Request Body schema:
application/json
required

required	object (ContractAttributes)
required	object (Document)
incomplete	boolean The contract is missing some mandatory attributes.
num_users	integer [ 0 .. 2147483647 ]
status	string (StatusE11Enum) Enum: "queued" "processing" "review" "done" "archived" "error" "limited" `queued` - Queued for AI processing. `processing` - Being processed. `review` - Pending owner review. `done` - All processing and reviews done. `archived` - Moved to archive. `error` - Failed to process the contract `limited` - Limited due to exceeding account.max_contracts
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" "end_of_current_term" "main_language" "notice_period" "parties" "renewal_period" "signed_date" "taggings" "title"
allow_emails required	boolean

Responses

Request samples

Payload

Content type

application/json

{"attributes": {"title": "string",
"end_date": "2019-08-24"
},
"cover_document": {"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"status": "queued"
},
"incomplete": true,
"num_users": 2147483647,
"status": "queued",
"is_duplicate": true,
"first_docai_result_time": "2019-08-24T14:15:22Z",
"trashed": true,
"docai_skip": ["effective_date"
],
"allow_emails": true
}

Response samples

202

Content type

application/json

{"id": "string",
"name": "string",
"details": null,
"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": [{"property1": null,
"property2": null
}
],
"failed_binders": [{"property1": null,
"property2": null
}
]
}

Subsume

Subsume given contracts to the primary contract

path Parameters

id

required

string

Request Body schema:
application/json
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

Payload

Content type

application/json

{"contracts": ["string"
],
"included_properties": ["activities"
]
}

Response samples

200

Content type

application/json

{"attributes": {"title": "string",
"end_date": "2019-08-24"
},
"cover_document": {"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
},
"unverified_docai_attributes": "string",
"id": "string",
"incomplete": true,
"num_emails": 0,
"num_files": 0,
"num_users": 2147483647,
"matches": null,
"owner": {"property1": null,
"property2": null
},
"parties": [{"id": "string",
"name": "string",
"org_id": "string",
"external_id": "string",
"extra_text_field_1": "string",
"extra_text_field_2": "string",
"role_id": "string",
"role_name": "string",
"role": "string",
"editable": true,
"country": "string",
"contact": "string",
"group": "string",
"previous_names": "string",
"source": "ai",
"docai_value_verified": true,
"name_in_document": "string",
"name_coordinates": {"property1": null,
"property2": null
},
"org_id_coordinates": {"property1": null,
"property2": null
}
}
],
"permission": "string",
"receive_time": "2019-08-24T14:15:22Z",
"related_contracts": [null
],
"status": "queued",
"is_duplicate": true,
"favorite_of": [null
],
"last_modified": "2019-08-24T14:15:22Z",
"first_docai_result_time": "2019-08-24T14:15:22Z",
"trashed": true,
"esigns": [{"id": "string",
"owner": "string",
"status": "draft"
}
],
"num_signed_documents": 0,
"docai_skip": ["effective_date"
],
"attribute_coordinates": {"property1": null,
"property2": null
},
"activities": [{"id": "string",
"title": "string",
"description": "string",
"completed": true,
"completed_by": "string",
"completion_date": "2019-08-24",
"complete_reason": "string",
"date": "2019-08-24",
"hour_of_day": 23,
"num_reminders": 0,
"recipients": {"property1": null,
"property2": null
},
"recurrence": "once",
"has_recurred": true,
"complete_by_email": true,
"contract": "string",
"owner_is_recipient": true,
"related_meta_attribute": "string"
}
],
"allow_emails": true,
"documents": [{"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
}
],
"duplicates": [null
],
"emails": [{"file_extension": "string",
"id": "string",
"subject": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
],
"notes": [{"id": "string",
"contract_id": "string",
"timestamp": "2019-08-24T14:15:22Z",
"set_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"content": "string",
"document": "string",
"highlight": null
}
],
"num_binders": 0,
"rated": true,
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"form": "string"
}

Terminate > Create

path Parameters

id

required

string

Request Body schema:
application/json
required

archive	boolean Default: false
termination_date required	string <date>

Responses

Request samples

Payload

Content type

application/json

{"archive": false,
"termination_date": "2019-08-24"
}

Response samples

200

Content type

application/json

{"attributes": {"title": "string",
"end_date": "2019-08-24"
},
"cover_document": {"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
},
"unverified_docai_attributes": "string",
"id": "string",
"incomplete": true,
"num_emails": 0,
"num_files": 0,
"num_users": 2147483647,
"matches": null,
"owner": {"property1": null,
"property2": null
},
"parties": [{"id": "string",
"name": "string",
"org_id": "string",
"external_id": "string",
"extra_text_field_1": "string",
"extra_text_field_2": "string",
"role_id": "string",
"role_name": "string",
"role": "string",
"editable": true,
"country": "string",
"contact": "string",
"group": "string",
"previous_names": "string",
"source": "ai",
"docai_value_verified": true,
"name_in_document": "string",
"name_coordinates": {"property1": null,
"property2": null
},
"org_id_coordinates": {"property1": null,
"property2": null
}
}
],
"permission": "string",
"receive_time": "2019-08-24T14:15:22Z",
"related_contracts": [null
],
"status": "queued",
"is_duplicate": true,
"favorite_of": [null
],
"last_modified": "2019-08-24T14:15:22Z",
"first_docai_result_time": "2019-08-24T14:15:22Z",
"trashed": true,
"esigns": [{"id": "string",
"owner": "string",
"status": "draft"
}
],
"num_signed_documents": 0,
"docai_skip": ["effective_date"
],
"attribute_coordinates": {"property1": null,
"property2": null
},
"activities": [{"id": "string",
"title": "string",
"description": "string",
"completed": true,
"completed_by": "string",
"completion_date": "2019-08-24",
"complete_reason": "string",
"date": "2019-08-24",
"hour_of_day": 23,
"num_reminders": 0,
"recipients": {"property1": null,
"property2": null
},
"recurrence": "once",
"has_recurred": true,
"complete_by_email": true,
"contract": "string",
"owner_is_recipient": true,
"related_meta_attribute": "string"
}
],
"allow_emails": true,
"documents": [{"content_type": "string",
"docai_task_status": "string",
"email": "string",
"filename": "string",
"folder": "string",
"id": "string",
"is_signable": true,
"lowest_signature_status": "string",
"num_pages": 0,
"path": "string",
"position": 2147483647,
"receive_time": "2019-08-24T14:15:22Z",
"role": "unknown",
"signatures": [{"ordinal": 0,
"valid": true,
"validity_error": "timstamp",
"signer_org": "string",
"signer_org_confidence": 100,
"status": "valid"
}
],
"status": "queued",
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"text_available": true,
"valid_signature": true
}
],
"duplicates": [null
],
"emails": [{"file_extension": "string",
"id": "string",
"subject": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
],
"notes": [{"id": "string",
"contract_id": "string",
"timestamp": "2019-08-24T14:15:22Z",
"set_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"content": "string",
"document": "string",
"highlight": null
}
],
"num_binders": 0,
"rated": true,
"taggings": [{"tag_id": "string",
"tag_name": "string",
"is_automatic": true,
"document": {"property1": null,
"property2": null
}
}
],
"form": "string"
}

Users > Read

path Parameters

id

required

string

Responses

Response samples

200

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.
related_meta_attribute	string Activities related to given meta attribute

Responses

Response samples

200

Content type

application/json

{"page_size": 123,
"page": 123,
"last_page": 123,
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": "string",
"title": "string",
"description": "string",
"completed": true,
"completed_by": "string",
"completion_date": "2019-08-24",
"complete_reason": "string",
"date": "2019-08-24",
"hour_of_day": 23,
"num_reminders": 0,
"recipients": {"property1": null,
"property2": null
},
"recurrence": "once",
"has_recurred": true,
"complete_by_email": true,
"contract": "string",
"owner_is_recipient": true,
"related_meta_attribute": "string"
}
]
}

Binders > Create

Adds this contract to a binder.

path Parameters

contract_id

required

string

Request Body schema:
application/json
required

binder

required

string

Responses

Request samples

Payload

Content type

application/json

{"binder": "string"
}

Response samples

201

Content type

application/json

{"binder": {"id": "string",
"name": "string",
"permission": "string",
"granted_permission": "string",
"parent": "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": false
},
"date_added": "2019-08-24T14:15:22Z",
"added_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
}
}

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

200

Content type

application/json

{"page_size": 123,
"page": 123,
"last_page": 123,
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"binder": {"id": "string",
"name": "string",
"permission": "string",
"granted_permission": "string",
"parent": "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": false
},
"date_added": "2019-08-24T14:15:22Z",
"added_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
}
}
]
}

Download

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

path Parameters

contract_id

required

string

Request Body schema:
application/json

frontend_status

string (FrontendStatusEnum)

Enum: "done" "failed" "pending" "processing"

done - Done
failed - Failed
pending - Pending
processing - Processing

Responses

Request samples

Payload

Content type

application/json

{"frontend_status": "done"
}

Response samples

201

Content type

application/json

{"id": "string",
"name": "string",
"details": null,
"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": [{"property1": null,
"property2": null
}
],
"failed_binders": [{"property1": null,
"property2": null
}
]
}

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

Folders > Create

path Parameters

contract_id

required

string

Request Body schema:
application/json
required

name required	string
parent	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"parent": "string"
}

Response samples

201

Content type

application/json

{"id": "string",
"contract": "string",
"documents": ["string"
],
"name": "string",
"parent": "string",
"total_documents": "string"
}

Folders > 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.
parent	string Examples: parent=fol_1Kub2g1AXkOY6npBUA - Folder ID parent=null - Root folders with null

Responses

Response samples

200

Content type

application/json

{"page_size": 123,
"page": 123,
"last_page": 123,
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": "string",
"contract": "string",
"documents": ["string"
],
"name": "string",
"parent": "string",
"total_documents": "string"
}
]
}

Folders > Order > Create

path Parameters

contract_id

required

string

Request Body schema:
application/json
required

parent required	string or null
document_order required	Array of strings
archived_included	boolean Default: true
hidden_included	boolean Default: true

Responses

Request samples

Payload

Content type

application/json

{"parent": "string",
"document_order": ["string"
],
"archived_included": true,
"hidden_included": true
}

Response samples

200

Content type

application/json

{"id": "string",
"contract": "string",
"documents": ["string"
],
"name": "string",
"parent": "string",
"total_documents": "string"
}

Folders > Read

path Parameters

contract_id required	string
cryptid required	string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"contract": "string",
"documents": ["string"
],
"name": "string",
"parent": "string",
"total_documents": "string"
}

Folders > Delete

path Parameters

contract_id required	string
cryptid required	string

Responses

Folders > Partial update

path Parameters

contract_id required	string
cryptid required	string

Request Body schema:
application/json

name	string
parent	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"parent": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"contract": "string",
"documents": ["string"
],
"name": "string",
"parent": "string",
"total_documents": "string"
}

Folders > Update

path Parameters

contract_id required	string
cryptid required	string

Request Body schema:
application/json
required

name required	string
parent	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"parent": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"contract": "string",
"documents": ["string"
],
"name": "string",
"parent": "string",
"total_documents": "string"
}

Memberships > Create

path Parameters

contract_id

required

string

Request Body schema:
application/json
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 `view` - View-only access `edit` - Can view and edit contents `full` - Full permissions
user	string
group	string
contract required	string

Responses

Request samples

Payload

Content type

application/json

{"permission": "view",
"user": "string",
"group": "string",
"contract": "string"
}

Response samples

201

Content type

application/json

{"id": "string",
"permission": "view",
"user": "string",
"group": "string",
"date_added": "2019-08-24T14:15:22Z",
"added_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"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

200

Content type

application/json

{"page_size": 123,
"page": 123,
"last_page": 123,
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": "string",
"permission": "view",
"user": "string",
"group": "string",
"date_added": "2019-08-24T14:15:22Z",
"added_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"contract": "string"
}
]
}

Memberships > Read

path Parameters

contract_id required	string
cryptid required	string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"permission": "view",
"user": "string",
"group": "string",
"date_added": "2019-08-24T14:15:22Z",
"added_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"contract": "string"
}

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:
application/json

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 `view` - View-only access `edit` - Can view and edit contents `full` - Full permissions
contract	string

Responses

Request samples

Payload

Content type

application/json

{"permission": "view",
"contract": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"permission": "view",
"user": "string",
"group": "string",
"date_added": "2019-08-24T14:15:22Z",
"added_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"contract": "string"
}

Memberships > Update

path Parameters

contract_id required	string
cryptid required	string

Request Body schema:
application/json
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 `view` - View-only access `edit` - Can view and edit contents `full` - Full permissions
user	string
group	string
contract required	string

Responses

Request samples

Payload

Content type

application/json

{"permission": "view",
"user": "string",
"group": "string",
"contract": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"permission": "view",
"user": "string",
"group": "string",
"date_added": "2019-08-24T14:15:22Z",
"added_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"contract": "string"
}

Notes > Create

path Parameters

contract_id

required

string

Request Body schema:
application/json

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

Payload

Content type

application/json

{"content": "string",
"document": "string",
"highlight": {"page": 1,
"position": {"x": 100,
"y": 100,
"width": 100,
"height": 100
}
}
}

Response samples

201

Content type

application/json

{"id": "string",
"contract_id": "string",
"timestamp": "2019-08-24T14:15:22Z",
"set_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"content": "string",
"document": "string",
"highlight": null
}

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:
application/json

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

Payload

Content type

application/json

{"content": "string",
"document": "string",
"highlight": {"page": 1,
"position": {"x": 100,
"y": 100,
"width": 100,
"height": 100
}
}
}

Response samples

200

Content type

application/json

{"id": "string",
"contract_id": "string",
"timestamp": "2019-08-24T14:15:22Z",
"set_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"content": "string",
"document": "string",
"highlight": null
}

Notes > Read

path Parameters

contract_id required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"contract_id": "string",
"timestamp": "2019-08-24T14:15:22Z",
"set_by": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"content": "string",
"document": "string",
"highlight": null
}

Parties > Create

path Parameters

contract_id

required

string

Request Body schema:
application/json

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
name_in_document	string
	object or null
	object or null

Responses

Request samples

Payload

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,
"name_in_document": "string",
"name_coordinates": {"property1": null,
"property2": null
},
"org_id_coordinates": {"property1": null,
"property2": null
}
}

Response samples

201

Content type

application/json

{"id": "string",
"name": "string",
"org_id": "string",
"external_id": "string",
"extra_text_field_1": "string",
"extra_text_field_2": "string",
"role_id": "string",
"role_name": "string",
"role": "string",
"editable": true,
"country": "string",
"contact": "string",
"group": "string",
"previous_names": "string",
"source": "ai",
"docai_value_verified": true,
"name_in_document": "string",
"name_coordinates": {"property1": null,
"property2": null
},
"org_id_coordinates": {"property1": null,
"property2": null
}
}

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:
application/json

docai_value_verified	boolean or null
role	string
name_in_document	string <= 1024 characters
	object or null
	object or null

Responses

Request samples

Payload

Content type

application/json

{"docai_value_verified": true,
"role": "string",
"name_in_document": "string",
"name_coordinates": {"property1": null,
"property2": null
},
"org_id_coordinates": {"property1": null,
"property2": null
}
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"org_id": "string",
"external_id": "string",
"extra_text_field_1": "string",
"extra_text_field_2": "string",
"role_id": "string",
"role_name": "string",
"role": "string",
"editable": true,
"country": "string",
"contact": "string",
"group": "string",
"previous_names": "string",
"source": "ai",
"docai_value_verified": true,
"name_in_document": "string",
"name_coordinates": {"property1": null,
"property2": null
},
"org_id_coordinates": {"property1": null,
"property2": null
}
}

Relationships > Create

path Parameters

contract_id

required

string

Request Body schema:
application/json
required

to_contract required	string
	TypeEnum (string) or BlankEnum (any) Default: "related"

Responses

Request samples

Payload

Content type

application/json

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

Response samples

201

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

200

Content type

application/json

{"page_size": 123,
"page": 123,
"last_page": 123,
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"from_contract": "string",
"id": "string",
"to_contract": "string",
"type": "related"
}
]
}

Relationships > Read

path Parameters

contract_id required	string
cryptid required	string

Responses

Response samples

200

Content type

application/json

{"from_contract": "string",
"id": "string",
"to_contract": "string",
"type": "related"
}

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:
application/json

to_contract	string
	TypeEnum (string) or BlankEnum (any) Default: "related"

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200

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:
application/json
required

to_contract required	string
	TypeEnum (string) or BlankEnum (any) Default: "related"

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200

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

200

Content type

application/json

{"page_size": 123,
"page": 123,
"last_page": 123,
"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"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"
}
]
}

Signatures > Read

path Parameters

contract_id required	string
cryptid required	string

Responses

Response samples

200

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:
application/json
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

Payload

Content type

application/json

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

Response samples

200

Content type

application/json

{"is_correct_file": true,
"parties": [{"authentication_method": {"name": "email",
"is_strong_auth": true
},
"email": "user@example.com",
"name": "string",
"status": "string",
"status_saved_at": "2019-08-24T14:15:22Z"
}
],
"status_text": "string"
}

Soft validate > Create

Authorizations:

None

Request Body schema:
application/json
required

validation_id

required

string <uuid>

Validation id of the esign.

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200

Content type

application/json

{"status_text": "string"
}

Create

Request Body schema:
application/json
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 Merge attachments and signed documents
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" `parallel` - Signatures are made consecutively. `consecutive` - Signatures are made in parallel. `flexible` - Signatures can have flexible ordering.
title	string <= 2014 characters Name of signed document set

Responses

Request samples

Payload

Content type

application/json

{"attachments": [null
],
"contract": "string",
"contract_binders": ["string"
],
"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": [{"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"
}
],
"sender_name": "string",
"sign_order": "parallel",
"title": "string"
}

Response samples

201

Content type

application/json

{"activated": true,
"activated_at": "2019-08-24T14:15:22Z",
"available_until": "2019-08-24T14:15:22Z",
"contract": "string",
"contract_binders": [{"id": "string",
"name": "string",
"path": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"deadline": "2019-08-24T14:15:22Z",
"documents": [{"content_type": "string",
"filename": "string",
"id": "string",
"needs_to_be_viewed": true,
"signable": true
}
],
"form_submission": "string",
"greetings": "string",
"id": "string",
"merge_documents": true,
"need_auth_to_view_documents": true,
"owner": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"parties": [{"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"
}
],
"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.

Zefort API Reference (1.0.0)

Contracts

Trash > List

query Parameters

Responses

Response samples

Trash > Empty > Create

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Trash > Delete

path Parameters

Responses

Trash > Partial update

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Create

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

List

query Parameters

Responses

Response samples

Bulk contract party delete

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Responses

Request samples

Response samples

Bulk contract party update

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Responses

Request samples

Response samples

Bulk delete

Responses

Response samples

Bulk docai process

Responses

Response samples

Bulk extract metadata

Responses

Response samples

Bulk update

Responses

Response samples

Delete

path Parameters

Responses

Partial update

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Read

path Parameters

Responses

Response samples

Access > Read

path Parameters

Responses

Response samples

Add file

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/jsonrequired

Responses

Request samples

Response samples

Renew > Create

path Parameters

Request Body schema: application/jsonapplication/x-www-form-urlencodedmultipart/form-dataapplication/json

Responses

Request samples

Response samples

Send to docusign > Create

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required