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.

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": [{"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"
}
]
}

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

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 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

200

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"
}

Read

path Parameters

id

required

integer

A unique integer value identifying this esign.

Responses

Response samples

200

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"
}

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

200

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"
}

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

200

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"
}

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

200

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"
}

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

200

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"
}

Parties > Create

path Parameters

esign_id

required

integer

Request Body schema:
application/json

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" `signer` - Signer `approver` - Approver `cc` - cc
user	string

Responses

Request samples

Payload

Content type

application/json

{"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

201

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

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

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" `signer` - Signer `approver` - Approver `cc` - cc
user	string

Responses

Request samples

Payload

Content type

application/json

{"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

200

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

200

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

200

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

200

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

name required	string <= 512 characters
parent	string or null
inherit_permissions	boolean
is_esign_target	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"parent": "string",
"inherit_permissions": true,
"is_esign_target": false
}

Response samples

201

Content type

application/json

{"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
}

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
failed_task	string Only list binders 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",
"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
}
]
}

Access report > Read

Responses

Response samples

200

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 rename

Request Body schema:
application/json
required

name required	string <= 512 characters
parent	string or null
inherit_permissions	boolean
is_esign_target	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"parent": "string",
"inherit_permissions": true,
"is_esign_target": false
}

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
}
]
}

Check access > Read

path Parameters

binder_id required	string^.+$
id required	string^.+$

Responses

Response samples

200

Content type

application/json

{"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
}

Read

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"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,
"members": "string",
"deleted": true
}

Delete

path Parameters

id

required

string

Responses

Partial update

path Parameters

id

required

string

Request Body schema:
application/json

name	string <= 512 characters
parent	string or null
inherit_permissions	boolean
is_esign_target	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"parent": "string",
"inherit_permissions": true,
"is_esign_target": false
}

Response samples

200

Content type

application/json

{"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
}

Update

path Parameters

id

required

string

Request Body schema:
application/json
required

name required	string <= 512 characters
parent	string or null
inherit_permissions	boolean
is_esign_target	boolean Default: false

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"parent": "string",
"inherit_permissions": true,
"is_esign_target": false
}

Response samples

200

Content type

application/json

{"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
}

Download

path Parameters

id

required

string

Request Body schema:
application/json

include_ids	boolean Default: false Should the folders inside the ZIP file include entity ids
create_contract_folders	boolean Default: true Should documents related to the same contract be places in a separate folder
include_subfolders	boolean Default: true Should document folders be included in the ZIP file

Responses

Request samples

Payload

Content type

application/json

{"include_ids": false,
"create_contract_folders": true,
"include_subfolders": true
}

Response samples

200

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
}
]
}

Merge

path Parameters

id

required

string

Request Body schema:
application/json
required

merged

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"merged": ["string"
]
}

Response samples

200

Content type

application/json

{"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
}

Contents > List

path Parameters

binder_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": {"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
}
},
"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": {"ask_feedback": true,
"can_create_contracts": true,
"can_create_esigns": true,
"can_create_tags": true,
"can_edit": true,
"can_manage_account_settings": true,
"can_manage_all_content": true,
"can_manage_binders": true,
"can_manage_custom_metadata": true,
"can_manage_forms": true,
"can_manage_parties": true,
"can_manage_tags": true,
"can_manage_users_and_groups": true,
"can_perform_bulk_operations": true,
"can_use_ai_chat": true,
"contract_view": "cards",
"default_binder": {"id": "string",
"name": "string",
"path": "string"
},
"default_search": {"account_default": true,
"contracts_view": "cards",
"id": "string",
"internal": true,
"name": "string",
"owner": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"params": "string",
"public": true,
"table_columns": ["string"
]
},
"display_name": "string",
"email": "user@example.com",
"eventlogs_enabled": true,
"first_name": "string",
"id": "string",
"is_floating": true,
"language": "da",
"last_login": "2019-08-24T14:15:22Z",
"name": "string",
"party_table_columns": [null
],
"phone_number": "string",
"profile_type": "administrator",
"saml": true,
"short_name": "string",
"status": "active",
"table_columns": ["string"
],
"timezone": "string"
}
}
]
}

Contracts > Add

Adds contracts to binder.

path Parameters

binder_id

required

string

Responses

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
}
]
}

Contracts > List

path Parameters

binder_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": [{"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
}
}
]
}

Contracts > Bulk Remove

Removes contracts from binder.

path Parameters

binder_id

required

string

Responses

Response samples

200

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
}
]
}

Contracts > Delete

Removes a contract from a binder

path Parameters

binder_id required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"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
}

Account

Attributes > Create

Request Body schema:
application/json

	object
attribute_type	string (AttributeTypeEnum) Enum: "text-singleline" "text-multiline" "number" "date" "parties" "owner" "taggings" "boolean" "choice" "sequence" "multichoice" "list" "language" "related_contracts" "relative_time_interval" `text-singleline` - A line of text `text-multiline` - A multiline text area `number` - A number `date` - A date `parties` - The parties attribute `owner` - The owner of the contract `taggings` - The taggings attribute `boolean` - A boolean `choice` - A list of choices `sequence` - An increasing sequence `multichoice` - A multi-selection list `list` - A list of objects `language` - Contract main language `related_contracts` - Related contracts `relative_time_interval` - Relative time interval
	object
	object
	Array of objects (ChoiceValueCustomField)
automatic_reminders	boolean
mandatory	boolean
subfield	string or null <= 50 characters
	(ListTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
list_max_items	integer or null [ 0 .. 32767 ]
list_auto_add_to_activity	boolean
ai_question	string or null Question used to populate meta attribute values
auto_extract	boolean Auto populate contracts with question to AI

Responses

Request samples

Payload

Content type

application/json

{"label_translations": {"property1": "string",
"property2": "string"
},
"attribute_type": "text-singleline",
"placeholder_translations": {"property1": "string",
"property2": "string"
},
"ui_extra_info_translations": {"property1": null,
"property2": null
},
"custom_fields": [{"label_translations": {"property1": "string",
"property2": "string"
},
"visible": true
}
],
"automatic_reminders": true,
"mandatory": true,
"subfield": "string",
"list_type": "user_list",
"list_max_items": 32767,
"list_auto_add_to_activity": true,
"ai_question": "string",
"auto_extract": true
}

Response samples

201

Content type

application/json

{"id": "string",
"name": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"attribute_type": "text-singleline",
"defaults": [{"id": "string",
"attribute_id": "string",
"name": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}
],
"placeholder": "string",
"placeholder_translations": {"property1": "string",
"property2": "string"
},
"ui_extra_info": "string",
"ui_extra_info_translations": {"property1": null,
"property2": null
},
"custom_fields": [{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}
],
"automatic_reminders": true,
"mandatory": true,
"deletable": true,
"parent": "string",
"subfield": "string",
"static_fields": ["string"
],
"list_type": "user_list",
"list_max_items": 32767,
"list_auto_add_to_activity": true,
"is_custom": true,
"ai_question": "string",
"auto_extract": true,
"has_choices": true
}

Attributes > List

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"name": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"attribute_type": "text-singleline",
"defaults": [{"id": "string",
"attribute_id": "string",
"name": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}
],
"placeholder": "string",
"placeholder_translations": {"property1": "string",
"property2": "string"
},
"ui_extra_info": "string",
"ui_extra_info_translations": {"property1": null,
"property2": null
},
"custom_fields": [{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}
],
"automatic_reminders": true,
"mandatory": true,
"deletable": true,
"parent": "string",
"subfield": "string",
"static_fields": ["string"
],
"list_type": "user_list",
"list_max_items": 32767,
"list_auto_add_to_activity": true,
"is_custom": true,
"ai_question": "string",
"auto_extract": true,
"has_choices": true
}
]

Attributes > Read

path Parameters

cryptid

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"attribute_type": "text-singleline",
"defaults": [{"id": "string",
"attribute_id": "string",
"name": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}
],
"placeholder": "string",
"placeholder_translations": {"property1": "string",
"property2": "string"
},
"ui_extra_info": "string",
"ui_extra_info_translations": {"property1": null,
"property2": null
},
"custom_fields": [{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}
],
"automatic_reminders": true,
"mandatory": true,
"deletable": true,
"parent": "string",
"subfield": "string",
"static_fields": ["string"
],
"list_type": "user_list",
"list_max_items": 32767,
"list_auto_add_to_activity": true,
"is_custom": true,
"ai_question": "string",
"auto_extract": true,
"has_choices": true
}

Attributes > Delete

path Parameters

cryptid

required

string

Responses

Attributes > Partial update

path Parameters

cryptid

required

string

Request Body schema:
application/json

	object
attribute_type	string (AttributeTypeEnum) Enum: "text-singleline" "text-multiline" "number" "date" "parties" "owner" "taggings" "boolean" "choice" "sequence" "multichoice" "list" "language" "related_contracts" "relative_time_interval" `text-singleline` - A line of text `text-multiline` - A multiline text area `number` - A number `date` - A date `parties` - The parties attribute `owner` - The owner of the contract `taggings` - The taggings attribute `boolean` - A boolean `choice` - A list of choices `sequence` - An increasing sequence `multichoice` - A multi-selection list `list` - A list of objects `language` - Contract main language `related_contracts` - Related contracts `relative_time_interval` - Relative time interval
	object
	object
	Array of objects (ChoiceValueCustomField)
automatic_reminders	boolean
mandatory	boolean
subfield	string or null <= 50 characters
	(ListTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
list_max_items	integer or null [ 0 .. 32767 ]
list_auto_add_to_activity	boolean
ai_question	string or null Question used to populate meta attribute values
auto_extract	boolean Auto populate contracts with question to AI

Responses

Request samples

Payload

Content type

application/json

{"label_translations": {"property1": "string",
"property2": "string"
},
"attribute_type": "text-singleline",
"placeholder_translations": {"property1": "string",
"property2": "string"
},
"ui_extra_info_translations": {"property1": null,
"property2": null
},
"custom_fields": [{"label_translations": {"property1": "string",
"property2": "string"
},
"visible": true
}
],
"automatic_reminders": true,
"mandatory": true,
"subfield": "string",
"list_type": "user_list",
"list_max_items": 32767,
"list_auto_add_to_activity": true,
"ai_question": "string",
"auto_extract": true
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"attribute_type": "text-singleline",
"defaults": [{"id": "string",
"attribute_id": "string",
"name": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}
],
"placeholder": "string",
"placeholder_translations": {"property1": "string",
"property2": "string"
},
"ui_extra_info": "string",
"ui_extra_info_translations": {"property1": null,
"property2": null
},
"custom_fields": [{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}
],
"automatic_reminders": true,
"mandatory": true,
"deletable": true,
"parent": "string",
"subfield": "string",
"static_fields": ["string"
],
"list_type": "user_list",
"list_max_items": 32767,
"list_auto_add_to_activity": true,
"is_custom": true,
"ai_question": "string",
"auto_extract": true,
"has_choices": true
}

Attributes > Update

path Parameters

cryptid

required

string

Request Body schema:
application/json

	object
attribute_type	string (AttributeTypeEnum) Enum: "text-singleline" "text-multiline" "number" "date" "parties" "owner" "taggings" "boolean" "choice" "sequence" "multichoice" "list" "language" "related_contracts" "relative_time_interval" `text-singleline` - A line of text `text-multiline` - A multiline text area `number` - A number `date` - A date `parties` - The parties attribute `owner` - The owner of the contract `taggings` - The taggings attribute `boolean` - A boolean `choice` - A list of choices `sequence` - An increasing sequence `multichoice` - A multi-selection list `list` - A list of objects `language` - Contract main language `related_contracts` - Related contracts `relative_time_interval` - Relative time interval
	object
	object
	Array of objects (ChoiceValueCustomField)
automatic_reminders	boolean
mandatory	boolean
subfield	string or null <= 50 characters
	(ListTypeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
list_max_items	integer or null [ 0 .. 32767 ]
list_auto_add_to_activity	boolean
ai_question	string or null Question used to populate meta attribute values
auto_extract	boolean Auto populate contracts with question to AI

Responses

Request samples

Payload

Content type

application/json

{"label_translations": {"property1": "string",
"property2": "string"
},
"attribute_type": "text-singleline",
"placeholder_translations": {"property1": "string",
"property2": "string"
},
"ui_extra_info_translations": {"property1": null,
"property2": null
},
"custom_fields": [{"label_translations": {"property1": "string",
"property2": "string"
},
"visible": true
}
],
"automatic_reminders": true,
"mandatory": true,
"subfield": "string",
"list_type": "user_list",
"list_max_items": 32767,
"list_auto_add_to_activity": true,
"ai_question": "string",
"auto_extract": true
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"attribute_type": "text-singleline",
"defaults": [{"id": "string",
"attribute_id": "string",
"name": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}
],
"placeholder": "string",
"placeholder_translations": {"property1": "string",
"property2": "string"
},
"ui_extra_info": "string",
"ui_extra_info_translations": {"property1": null,
"property2": null
},
"custom_fields": [{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}
],
"automatic_reminders": true,
"mandatory": true,
"deletable": true,
"parent": "string",
"subfield": "string",
"static_fields": ["string"
],
"list_type": "user_list",
"list_max_items": 32767,
"list_auto_add_to_activity": true,
"is_custom": true,
"ai_question": "string",
"auto_extract": true,
"has_choices": true
}

Attributes > Choices > Create

ViewSet mixin class for doing create or update on PUT calls to base urls

Take a ViewSet that is registered in a router as /api/fruits then this mixin adds PUT /api/fruits?id=1, which supports both creating and updating fruit objects. This is not functionality that DRF supports out of the box as PUT requests are only supported on an object level, such as PUT /api/fruits/1. The additional query parameter at the end dictates which filter values that should be used when searching for existing objects.

It uses Django Filters for filtering down the queryset to match an existing object.

Supports only single object updates, no bulk actions supported!

Example usage

class FruitCreateOrUpdateFilter(django_filters.FilterSet):
    id = CryptIdFilter()
    extra_id = django_filters.CharFilter(lookup_expr="exact")

    class Meta:
        model = Fruit
        fields = ["id", "extra_id"]


class FruitViewSet(CreateOrUpdateMixin, GenericViewSet):
    queryset = Fruit.objects.all()
    create_or_update_filter_class = FruitCreateOrUpdateFilter

    def create(self, *args, **kwargs):
        ... # Create logic goes here, alternatively use CreateModelMixin

    def partial_update(self, id, *args, **kwargs):
        ... # Update logic goes here, alternatively use UpdateModelMixin

This would now support calls such as: PUT /api/fruits?extra_id=42 with JSON {"name": "Orange"}

This will try to search for a fruit with extra_id value 42, and if that is not found, it will create a fruit with name set to Orange. Note that the extra_id query parameter will not be used as an attribute for the created fruit.

Prerequisites:

This mixin does not implement create nor update logic, but instead will use the existing create() and partial_update() methods of the ViewSet. For this reason, it requires these two methods to exist in the ViewSet

One attribute needs to be added to ViewSet: create_or_update_filter_class. This should point to the Django Filter FilterSet class.

This mixin also uses get_queryset() to get the initial queryset to filter down on using Django Filter. This method should, however, always be usable as long as the mixin is used with a ViewSet.

Caveats

This mixin overriders the put() method of the ViewSet. Which means that the normal update() will not be the entrypoint for PUT request, but instead this mixins put() method will. This mixin will however call into update() if it notices that a PUT call to a specific instance is made. So while nothing should break, it is good to know that the call stack will slightly change when using this mixin.

path Parameters

attribute_cryptid

required

string

Request Body schema:
application/json
required

required	object
position	integer >= 0 Default: 0
is_default	boolean
	object

Responses

Request samples

Payload

Content type

application/json

{"value_translations": {"property1": "string",
"property2": "string"
},
"position": 0,
"is_default": true,
"custom_values": {"property1": null,
"property2": null
}
}

Response samples

201

Content type

application/json

{"id": "string",
"value": "string",
"value_translations": {"property1": "string",
"property2": "string"
},
"position": 0,
"is_default": true
}

Attributes > Choices > List

ViewSet mixin class for doing create or update on PUT calls to base urls

Take a ViewSet that is registered in a router as /api/fruits then this mixin adds PUT /api/fruits?id=1, which supports both creating and updating fruit objects. This is not functionality that DRF supports out of the box as PUT requests are only supported on an object level, such as PUT /api/fruits/1. The additional query parameter at the end dictates which filter values that should be used when searching for existing objects.

It uses Django Filters for filtering down the queryset to match an existing object.

Supports only single object updates, no bulk actions supported!

Example usage

class FruitCreateOrUpdateFilter(django_filters.FilterSet):
    id = CryptIdFilter()
    extra_id = django_filters.CharFilter(lookup_expr="exact")

    class Meta:
        model = Fruit
        fields = ["id", "extra_id"]


class FruitViewSet(CreateOrUpdateMixin, GenericViewSet):
    queryset = Fruit.objects.all()
    create_or_update_filter_class = FruitCreateOrUpdateFilter

    def create(self, *args, **kwargs):
        ... # Create logic goes here, alternatively use CreateModelMixin

    def partial_update(self, id, *args, **kwargs):
        ... # Update logic goes here, alternatively use UpdateModelMixin

This would now support calls such as: PUT /api/fruits?extra_id=42 with JSON {"name": "Orange"}

This will try to search for a fruit with extra_id value 42, and if that is not found, it will create a fruit with name set to Orange. Note that the extra_id query parameter will not be used as an attribute for the created fruit.

Prerequisites:

This mixin does not implement create nor update logic, but instead will use the existing create() and partial_update() methods of the ViewSet. For this reason, it requires these two methods to exist in the ViewSet

One attribute needs to be added to ViewSet: create_or_update_filter_class. This should point to the Django Filter FilterSet class.

This mixin also uses get_queryset() to get the initial queryset to filter down on using Django Filter. This method should, however, always be usable as long as the mixin is used with a ViewSet.

Caveats

This mixin overriders the put() method of the ViewSet. Which means that the normal update() will not be the entrypoint for PUT request, but instead this mixins put() method will. This mixin will however call into update() if it notices that a PUT call to a specific instance is made. So while nothing should break, it is good to know that the call stack will slightly change when using this mixin.

path Parameters

attribute_cryptid

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",
"value": "string",
"value_translations": {"property1": "string",
"property2": "string"
},
"position": 0,
"is_default": true
}
]
}

Attributes > Choices > Order > Create

ViewSet mixin class for doing create or update on PUT calls to base urls

Take a ViewSet that is registered in a router as /api/fruits then this mixin adds PUT /api/fruits?id=1, which supports both creating and updating fruit objects. This is not functionality that DRF supports out of the box as PUT requests are only supported on an object level, such as PUT /api/fruits/1. The additional query parameter at the end dictates which filter values that should be used when searching for existing objects.

It uses Django Filters for filtering down the queryset to match an existing object.

Supports only single object updates, no bulk actions supported!

Example usage

class FruitCreateOrUpdateFilter(django_filters.FilterSet):
    id = CryptIdFilter()
    extra_id = django_filters.CharFilter(lookup_expr="exact")

    class Meta:
        model = Fruit
        fields = ["id", "extra_id"]


class FruitViewSet(CreateOrUpdateMixin, GenericViewSet):
    queryset = Fruit.objects.all()
    create_or_update_filter_class = FruitCreateOrUpdateFilter

    def create(self, *args, **kwargs):
        ... # Create logic goes here, alternatively use CreateModelMixin

    def partial_update(self, id, *args, **kwargs):
        ... # Update logic goes here, alternatively use UpdateModelMixin

This would now support calls such as: PUT /api/fruits?extra_id=42 with JSON {"name": "Orange"}

This will try to search for a fruit with extra_id value 42, and if that is not found, it will create a fruit with name set to Orange. Note that the extra_id query parameter will not be used as an attribute for the created fruit.

Prerequisites:

This mixin does not implement create nor update logic, but instead will use the existing create() and partial_update() methods of the ViewSet. For this reason, it requires these two methods to exist in the ViewSet

One attribute needs to be added to ViewSet: create_or_update_filter_class. This should point to the Django Filter FilterSet class.

This mixin also uses get_queryset() to get the initial queryset to filter down on using Django Filter. This method should, however, always be usable as long as the mixin is used with a ViewSet.

Caveats

This mixin overriders the put() method of the ViewSet. Which means that the normal update() will not be the entrypoint for PUT request, but instead this mixins put() method will. This mixin will however call into update() if it notices that a PUT call to a specific instance is made. So while nothing should break, it is good to know that the call stack will slightly change when using this mixin.

path Parameters

attribute_cryptid

required

string

Request Body schema:
application/json
required

order

required

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"order": ["string"
]
}

Response samples

200

Content type

application/json

{"id": "string",
"value": "string",
"value_translations": {"property1": "string",
"property2": "string"
},
"position": 0,
"is_default": true
}

Attributes > Choices > Read

ViewSet mixin class for doing create or update on PUT calls to base urls

Take a ViewSet that is registered in a router as /api/fruits then this mixin adds PUT /api/fruits?id=1, which supports both creating and updating fruit objects. This is not functionality that DRF supports out of the box as PUT requests are only supported on an object level, such as PUT /api/fruits/1. The additional query parameter at the end dictates which filter values that should be used when searching for existing objects.

It uses Django Filters for filtering down the queryset to match an existing object.

Supports only single object updates, no bulk actions supported!

Example usage

class FruitCreateOrUpdateFilter(django_filters.FilterSet):
    id = CryptIdFilter()
    extra_id = django_filters.CharFilter(lookup_expr="exact")

    class Meta:
        model = Fruit
        fields = ["id", "extra_id"]


class FruitViewSet(CreateOrUpdateMixin, GenericViewSet):
    queryset = Fruit.objects.all()
    create_or_update_filter_class = FruitCreateOrUpdateFilter

    def create(self, *args, **kwargs):
        ... # Create logic goes here, alternatively use CreateModelMixin

    def partial_update(self, id, *args, **kwargs):
        ... # Update logic goes here, alternatively use UpdateModelMixin

This would now support calls such as: PUT /api/fruits?extra_id=42 with JSON {"name": "Orange"}

This will try to search for a fruit with extra_id value 42, and if that is not found, it will create a fruit with name set to Orange. Note that the extra_id query parameter will not be used as an attribute for the created fruit.

Prerequisites:

This mixin does not implement create nor update logic, but instead will use the existing create() and partial_update() methods of the ViewSet. For this reason, it requires these two methods to exist in the ViewSet

One attribute needs to be added to ViewSet: create_or_update_filter_class. This should point to the Django Filter FilterSet class.

This mixin also uses get_queryset() to get the initial queryset to filter down on using Django Filter. This method should, however, always be usable as long as the mixin is used with a ViewSet.

Caveats

This mixin overriders the put() method of the ViewSet. Which means that the normal update() will not be the entrypoint for PUT request, but instead this mixins put() method will. This mixin will however call into update() if it notices that a PUT call to a specific instance is made. So while nothing should break, it is good to know that the call stack will slightly change when using this mixin.

path Parameters

attribute_cryptid required	string
cryptid required	string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"value": "string",
"value_translations": {"property1": "string",
"property2": "string"
},
"position": 0,
"is_default": true
}

Attributes > Choices > Delete

ViewSet mixin class for doing create or update on PUT calls to base urls

Take a ViewSet that is registered in a router as /api/fruits then this mixin adds PUT /api/fruits?id=1, which supports both creating and updating fruit objects. This is not functionality that DRF supports out of the box as PUT requests are only supported on an object level, such as PUT /api/fruits/1. The additional query parameter at the end dictates which filter values that should be used when searching for existing objects.

It uses Django Filters for filtering down the queryset to match an existing object.

Supports only single object updates, no bulk actions supported!

Example usage

class FruitCreateOrUpdateFilter(django_filters.FilterSet):
    id = CryptIdFilter()
    extra_id = django_filters.CharFilter(lookup_expr="exact")

    class Meta:
        model = Fruit
        fields = ["id", "extra_id"]


class FruitViewSet(CreateOrUpdateMixin, GenericViewSet):
    queryset = Fruit.objects.all()
    create_or_update_filter_class = FruitCreateOrUpdateFilter

    def create(self, *args, **kwargs):
        ... # Create logic goes here, alternatively use CreateModelMixin

    def partial_update(self, id, *args, **kwargs):
        ... # Update logic goes here, alternatively use UpdateModelMixin

This would now support calls such as: PUT /api/fruits?extra_id=42 with JSON {"name": "Orange"}

This will try to search for a fruit with extra_id value 42, and if that is not found, it will create a fruit with name set to Orange. Note that the extra_id query parameter will not be used as an attribute for the created fruit.

Prerequisites:

This mixin does not implement create nor update logic, but instead will use the existing create() and partial_update() methods of the ViewSet. For this reason, it requires these two methods to exist in the ViewSet

One attribute needs to be added to ViewSet: create_or_update_filter_class. This should point to the Django Filter FilterSet class.

This mixin also uses get_queryset() to get the initial queryset to filter down on using Django Filter. This method should, however, always be usable as long as the mixin is used with a ViewSet.

Caveats

This mixin overriders the put() method of the ViewSet. Which means that the normal update() will not be the entrypoint for PUT request, but instead this mixins put() method will. This mixin will however call into update() if it notices that a PUT call to a specific instance is made. So while nothing should break, it is good to know that the call stack will slightly change when using this mixin.

path Parameters

attribute_cryptid required	string
cryptid required	string

Responses

Attributes > Choices > Partial update

ViewSet mixin class for doing create or update on PUT calls to base urls

Take a ViewSet that is registered in a router as /api/fruits then this mixin adds PUT /api/fruits?id=1, which supports both creating and updating fruit objects. This is not functionality that DRF supports out of the box as PUT requests are only supported on an object level, such as PUT /api/fruits/1. The additional query parameter at the end dictates which filter values that should be used when searching for existing objects.

It uses Django Filters for filtering down the queryset to match an existing object.

Supports only single object updates, no bulk actions supported!

Example usage

class FruitCreateOrUpdateFilter(django_filters.FilterSet):
    id = CryptIdFilter()
    extra_id = django_filters.CharFilter(lookup_expr="exact")

    class Meta:
        model = Fruit
        fields = ["id", "extra_id"]


class FruitViewSet(CreateOrUpdateMixin, GenericViewSet):
    queryset = Fruit.objects.all()
    create_or_update_filter_class = FruitCreateOrUpdateFilter

    def create(self, *args, **kwargs):
        ... # Create logic goes here, alternatively use CreateModelMixin

    def partial_update(self, id, *args, **kwargs):
        ... # Update logic goes here, alternatively use UpdateModelMixin

This would now support calls such as: PUT /api/fruits?extra_id=42 with JSON {"name": "Orange"}

This will try to search for a fruit with extra_id value 42, and if that is not found, it will create a fruit with name set to Orange. Note that the extra_id query parameter will not be used as an attribute for the created fruit.

Prerequisites:

This mixin does not implement create nor update logic, but instead will use the existing create() and partial_update() methods of the ViewSet. For this reason, it requires these two methods to exist in the ViewSet

One attribute needs to be added to ViewSet: create_or_update_filter_class. This should point to the Django Filter FilterSet class.

This mixin also uses get_queryset() to get the initial queryset to filter down on using Django Filter. This method should, however, always be usable as long as the mixin is used with a ViewSet.

Caveats

This mixin overriders the put() method of the ViewSet. Which means that the normal update() will not be the entrypoint for PUT request, but instead this mixins put() method will. This mixin will however call into update() if it notices that a PUT call to a specific instance is made. So while nothing should break, it is good to know that the call stack will slightly change when using this mixin.

path Parameters

attribute_cryptid required	string
cryptid required	string

Request Body schema:
application/json

	object
position	integer >= 0 Default: 0
is_default	boolean
	object

Responses

Request samples

Payload

Content type

application/json

{"value_translations": {"property1": "string",
"property2": "string"
},
"position": 0,
"is_default": true,
"custom_values": {"property1": null,
"property2": null
}
}

Response samples

200

Content type

application/json

{"id": "string",
"value": "string",
"value_translations": {"property1": "string",
"property2": "string"
},
"position": 0,
"is_default": true
}

Attributes > Choices > Update

ViewSet mixin class for doing create or update on PUT calls to base urls

Take a ViewSet that is registered in a router as /api/fruits then this mixin adds PUT /api/fruits?id=1, which supports both creating and updating fruit objects. This is not functionality that DRF supports out of the box as PUT requests are only supported on an object level, such as PUT /api/fruits/1. The additional query parameter at the end dictates which filter values that should be used when searching for existing objects.

It uses Django Filters for filtering down the queryset to match an existing object.

Supports only single object updates, no bulk actions supported!

Example usage

class FruitCreateOrUpdateFilter(django_filters.FilterSet):
    id = CryptIdFilter()
    extra_id = django_filters.CharFilter(lookup_expr="exact")

    class Meta:
        model = Fruit
        fields = ["id", "extra_id"]


class FruitViewSet(CreateOrUpdateMixin, GenericViewSet):
    queryset = Fruit.objects.all()
    create_or_update_filter_class = FruitCreateOrUpdateFilter

    def create(self, *args, **kwargs):
        ... # Create logic goes here, alternatively use CreateModelMixin

    def partial_update(self, id, *args, **kwargs):
        ... # Update logic goes here, alternatively use UpdateModelMixin

This would now support calls such as: PUT /api/fruits?extra_id=42 with JSON {"name": "Orange"}

This will try to search for a fruit with extra_id value 42, and if that is not found, it will create a fruit with name set to Orange. Note that the extra_id query parameter will not be used as an attribute for the created fruit.

Prerequisites:

This mixin does not implement create nor update logic, but instead will use the existing create() and partial_update() methods of the ViewSet. For this reason, it requires these two methods to exist in the ViewSet

One attribute needs to be added to ViewSet: create_or_update_filter_class. This should point to the Django Filter FilterSet class.

This mixin also uses get_queryset() to get the initial queryset to filter down on using Django Filter. This method should, however, always be usable as long as the mixin is used with a ViewSet.

Caveats

This mixin overriders the put() method of the ViewSet. Which means that the normal update() will not be the entrypoint for PUT request, but instead this mixins put() method will. This mixin will however call into update() if it notices that a PUT call to a specific instance is made. So while nothing should break, it is good to know that the call stack will slightly change when using this mixin.

path Parameters

attribute_cryptid required	string
cryptid required	string

Request Body schema:
application/json
required

required	object
position	integer >= 0 Default: 0
is_default	boolean
	object

Responses

Request samples

Payload

Content type

application/json

{"value_translations": {"property1": "string",
"property2": "string"
},
"position": 0,
"is_default": true,
"custom_values": {"property1": null,
"property2": null
}
}

Response samples

200

Content type

application/json

{"id": "string",
"value": "string",
"value_translations": {"property1": "string",
"property2": "string"
},
"position": 0,
"is_default": true
}

Attributes > Custom fields > Create

path Parameters

attribute_cryptid

required

string

Request Body schema:
application/json
required

required	object
visible	boolean Custom field's value is also shown next to the actual ChoivceValue's value when inspecting a single contract in UI.

Responses

Request samples

Payload

Content type

application/json

{"label_translations": {"property1": "string",
"property2": "string"
},
"visible": true
}

Response samples

201

Content type

application/json

{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}

Attributes > Custom fields > List

path Parameters

attribute_cryptid

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",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}
]
}

Attributes > Custom fields > Read

path Parameters

attribute_cryptid required	string
cryptid required	string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}

Attributes > Custom fields > Delete

path Parameters

attribute_cryptid required	string
cryptid required	string

Responses

Attributes > Custom fields > Partial update

path Parameters

attribute_cryptid required	string
cryptid required	string

Request Body schema:
application/json

	object
visible	boolean Custom field's value is also shown next to the actual ChoivceValue's value when inspecting a single contract in UI.

Responses

Request samples

Payload

Content type

application/json

{"label_translations": {"property1": "string",
"property2": "string"
},
"visible": true
}

Response samples

200

Content type

application/json

{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}

Attributes > Custom fields > Update

path Parameters

attribute_cryptid required	string
cryptid required	string

Request Body schema:
application/json
required

required	object
visible	boolean Custom field's value is also shown next to the actual ChoivceValue's value when inspecting a single contract in UI.

Responses

Request samples

Payload

Content type

application/json

{"label_translations": {"property1": "string",
"property2": "string"
},
"visible": true
}

Response samples

200

Content type

application/json

{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}

Read

Returns account settings. In case the current API-key does not have permission to manage account settings or manage users and groups, the response excludes following fields: organizations, floating_viewers, max_viewers, viewers_remaining, max_administrators, max_signers, webhooks_enabled, allowed_email_senders, session_max_age, can_create_esigns_default, static_meta_attribute_fields_by_type, require_admin_license_for_empty_trash, max_editors, eventlog_access, status, key_dates_enabled, can_manage_binders_default, signers_remaining, floating_editors, administrators_remaining, quickedit_enabled, automatically_empty_trash, api_enabled, editors_remaining, custom_logo_enabled, related_contracts_enabled, docai_suggest_new_parties, can_create_tags_default, can_manage_forms_default, can_manage_parties_default, session_window, party_manager_enabled, can_create_contracts_default, all_parties_public, ai_chat_licences, trial_ends, floating_administrators, allowed_ips, ai_chat_licences_remaining

Responses

Response samples

200

Content type

application/json

{"ai_chat_enabled": true,
"ai_chat_hidden": true,
"allow_access_requests": true,
"allowed_esign_authentication_methods": ["string"
],
"available_insights": ["string"
],
"beta": true,
"binder_suggestions_enabled": true,
"can_manage_esigns": true,
"can_send_sms": true,
"card_slot_1": "string",
"card_slot_2": "string",
"card_slot_3": "string",
"contract_emails_by_default": true,
"contract_meta_attributes": {"property1": {"id": "string",
"name": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"attribute_type": "text-singleline",
"defaults": [{"id": "string",
"attribute_id": "string",
"name": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}
],
"placeholder": "string",
"placeholder_translations": {"property1": "string",
"property2": "string"
},
"ui_extra_info": "string",
"ui_extra_info_translations": {"property1": null,
"property2": null
},
"custom_fields": [{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}
],
"automatic_reminders": true,
"mandatory": true,
"deletable": true,
"parent": "string",
"subfield": "string",
"static_fields": ["string"
],
"list_type": "user_list",
"list_max_items": 32767,
"list_auto_add_to_activity": true,
"is_custom": true,
"ai_question": "string",
"auto_extract": true,
"has_choices": true
},
"property2": {"id": "string",
"name": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"attribute_type": "text-singleline",
"defaults": [{"id": "string",
"attribute_id": "string",
"name": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}
],
"placeholder": "string",
"placeholder_translations": {"property1": "string",
"property2": "string"
},
"ui_extra_info": "string",
"ui_extra_info_translations": {"property1": null,
"property2": null
},
"custom_fields": [{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}
],
"automatic_reminders": true,
"mandatory": true,
"deletable": true,
"parent": "string",
"subfield": "string",
"static_fields": ["string"
],
"list_type": "user_list",
"list_max_items": 32767,
"list_auto_add_to_activity": true,
"is_custom": true,
"ai_question": "string",
"auto_extract": true,
"has_choices": true
}
},
"contract_metadata_layout": {"property1": null,
"property2": null
},
"contract_type_setting": "string",
"custom_logo": true,
"custom_metadata_enabled": true,
"dashboard_enabled": true,
"default_contracts_view": "cards",
"default_esign_authentication_method": "string",
"default_esign_sender": "string",
"default_party_table_columns": [null
],
"default_search": {"account_default": true,
"contracts_view": "cards",
"id": "string",
"internal": true,
"name": "string",
"owner": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"params": "string",
"public": true,
"table_columns": ["string"
]
},
"default_table_columns": ["string"
],
"docusign_personal_integration_enabled": true,
"enabled_languages": ["da"
],
"esign_select_option_to_merge_documents_by_default": true,
"esign_production_enabled": true,
"can_perform_bulk_operations_default": true,
"eventlogs_enabled": true,
"extra_party_fields": ["contact"
],
"extract_metadata_enabled": true,
"forms_enabled": true,
"inboxes_enabled": true,
"incoming_email_enabled": true,
"insights_enabled": true,
"mandatory_contract_fields": true,
"mandatory_settings": {"property1": null,
"property2": null
},
"max_contracts": 2147483647,
"ml_training_exclude": "string",
"name": "string",
"need_auth_to_view_documents_default": true,
"num_contracts": 0,
"party_extra_text_field_1_title": "string",
"party_extra_text_field_2_title": "string",
"reminder_settings": [null
],
"similar_contracts_enabled": true,
"sso_domains": ["string"
],
"administrators_remaining": 0,
"ai_chat_licences": 0,
"ai_chat_licences_remaining": 0,
"all_parties_public": true,
"allowed_email_senders": ["string"
],
"allowed_ips": ["string"
],
"api_enabled": true,
"automatically_empty_trash": true,
"can_create_contracts_default": true,
"can_create_esigns_default": true,
"can_create_tags_default": true,
"can_manage_binders_default": true,
"can_manage_forms_default": true,
"can_manage_parties_default": true,
"custom_logo_enabled": true,
"docai_suggest_new_parties": true,
"editors_remaining": 0,
"eventlog_access": "administrator",
"floating_administrators": 0,
"floating_editors": 0,
"floating_viewers": 0,
"key_dates_enabled": true,
"max_administrators": 32767,
"max_editors": 32767,
"max_signers": 0,
"max_viewers": 32767,
"organizations": null,
"party_manager_enabled": true,
"quickedit_enabled": true,
"related_contracts_enabled": true,
"require_admin_license_for_empty_trash": true,
"session_max_age": 2147483647,
"session_window": 2147483647,
"signers_remaining": 0,
"static_meta_attribute_fields_by_type": {"property1": [null
],
"property2": [null
]
},
"status": "trial",
"trial_ends": "2019-08-24T14:15:22Z",
"viewers_remaining": 0,
"webhooks_enabled": true
}

Partial update

Modifies account settings. Requires the can_manage_account_settings permission.

Request Body schema:
application/json

ai_chat_hidden	boolean
all_parties_public	boolean If true, all Parties on the account are visible to all users.
allow_access_requests	boolean Can users request editing permissions.
allowed_email_senders	Array of strings or null List of patterns of senders where incoming email is allowed. If unset (null), any sender is allowed.
allowed_esign_authentication_methods	Array of strings or null
allowed_ips	Array of strings or null List of allowed IPv4 or IPv6 networks where users may connect to this account. A network is given as a string in CIDR notation (an IP address and a mask separated by slash) such as "192.0.2.0/24" for IPv4, or "2001:db8::/32" for IPv6. Set to null to remove IP address restrictions.
automatically_empty_trash	boolean
binder_suggestions_enabled	boolean
can_create_contracts_default	boolean
can_create_esigns_default	boolean
can_create_tags_default	boolean
can_manage_binders_default	boolean
can_manage_esigns	boolean
can_manage_forms_default	boolean
can_manage_parties_default	boolean
can_perform_bulk_operations_default	boolean
can_send_sms	boolean
card_slot_1	string <= 256 characters
card_slot_2	string <= 256 characters
card_slot_3	string <= 256 characters
contract_emails_by_default	boolean
contract_metadata_layout	any
contract_type_setting	string or null
default_contracts_view	string (DefaultContractsViewEnum) Enum: "cards" "list" "calendar" `cards` - Cards view `list` - Table view `calendar` - Calendar view
esign_select_option_to_merge_documents_by_default	boolean
default_esign_authentication_method	string or null
default_esign_sender	string or null
default_party_table_columns	Array of any
default_search	string or null
default_table_columns	Array of strings (Table columns) [ items <= 120 characters ]
docai_suggest_new_parties	boolean Accept suggestions for new parties from docai
enabled_languages	Array of strings (EnabledLanguagesEnum) Items Enum: "da" "en-us" "es" "et" "fi" "lt" "lv" "nb" "sv"
esign_production_enabled	boolean
eventlog_access	string (EventlogAccessEnum) Enum: "administrator" "editor" "viewer" `administrator` - Administrator `editor` - Editor `viewer` - Viewer
extra_party_fields	Array of strings or null (ExtraPartyFieldsEnum) Enum: "contact" "country" "CUSTOM_lei_id" "CUSTOM_otava_customer" "CUSTOM_otava_link" "CUSTOM_otava_tietosuoja" "CUSTOM_soparo_code" "CUSTOM_soparo_type" "CUSTOM_street_address" "CUSTOM_vat_id" "external_id" "extra_text_field_1" "extra_text_field_2" "group" "previous_names" "t24_id" If set, names of extra fields enabled for Party objects.
incoming_email_enabled	boolean
	object
need_auth_to_view_documents_default	boolean
organizations	any
party_extra_text_field_1_title	string <= 25 characters
party_extra_text_field_2_title	string <= 25 characters
quickedit_enabled	boolean
	Array of objects or null
require_admin_license_for_empty_trash	boolean
session_max_age	integer or null >= 1 `Maximum API session lifetime in hours. If null, a default value is used (currently 720h).`
session_window	integer or null >= 1 `Number of hours until an idle API session expires. If null, a default value is used (currently 96h).`

Responses

Request samples

Payload

Content type

application/json

{"ai_chat_hidden": true,
"all_parties_public": true,
"allow_access_requests": true,
"allowed_email_senders": ["string"
],
"allowed_esign_authentication_methods": ["string"
],
"allowed_ips": ["string"
],
"automatically_empty_trash": true,
"binder_suggestions_enabled": true,
"can_create_contracts_default": true,
"can_create_esigns_default": true,
"can_create_tags_default": true,
"can_manage_binders_default": true,
"can_manage_esigns": true,
"can_manage_forms_default": true,
"can_manage_parties_default": true,
"can_perform_bulk_operations_default": true,
"can_send_sms": true,
"card_slot_1": "string",
"card_slot_2": "string",
"card_slot_3": "string",
"contract_emails_by_default": true,
"contract_metadata_layout": null,
"contract_type_setting": "string",
"default_contracts_view": "cards",
"esign_select_option_to_merge_documents_by_default": true,
"default_esign_authentication_method": "string",
"default_esign_sender": "string",
"default_party_table_columns": [null
],
"default_search": "string",
"default_table_columns": ["string"
],
"docai_suggest_new_parties": true,
"enabled_languages": ["da"
],
"esign_production_enabled": true,
"eventlog_access": "administrator",
"extra_party_fields": ["contact"
],
"incoming_email_enabled": true,
"mandatory_settings": {"property1": null,
"property2": null
},
"need_auth_to_view_documents_default": true,
"organizations": null,
"party_extra_text_field_1_title": "string",
"party_extra_text_field_2_title": "string",
"quickedit_enabled": true,
"reminder_settings": [{"property1": null,
"property2": null
}
],
"require_admin_license_for_empty_trash": true,
"session_max_age": 1,
"session_window": 1
}

Response samples

200

Content type

application/json

{"ai_chat_enabled": true,
"ai_chat_hidden": true,
"allow_access_requests": true,
"allowed_esign_authentication_methods": ["string"
],
"available_insights": ["string"
],
"beta": true,
"binder_suggestions_enabled": true,
"can_manage_esigns": true,
"can_send_sms": true,
"card_slot_1": "string",
"card_slot_2": "string",
"card_slot_3": "string",
"contract_emails_by_default": true,
"contract_meta_attributes": {"property1": {"id": "string",
"name": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"attribute_type": "text-singleline",
"defaults": [{"id": "string",
"attribute_id": "string",
"name": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}
],
"placeholder": "string",
"placeholder_translations": {"property1": "string",
"property2": "string"
},
"ui_extra_info": "string",
"ui_extra_info_translations": {"property1": null,
"property2": null
},
"custom_fields": [{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}
],
"automatic_reminders": true,
"mandatory": true,
"deletable": true,
"parent": "string",
"subfield": "string",
"static_fields": ["string"
],
"list_type": "user_list",
"list_max_items": 32767,
"list_auto_add_to_activity": true,
"is_custom": true,
"ai_question": "string",
"auto_extract": true,
"has_choices": true
},
"property2": {"id": "string",
"name": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"attribute_type": "text-singleline",
"defaults": [{"id": "string",
"attribute_id": "string",
"name": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}
],
"placeholder": "string",
"placeholder_translations": {"property1": "string",
"property2": "string"
},
"ui_extra_info": "string",
"ui_extra_info_translations": {"property1": null,
"property2": null
},
"custom_fields": [{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}
],
"automatic_reminders": true,
"mandatory": true,
"deletable": true,
"parent": "string",
"subfield": "string",
"static_fields": ["string"
],
"list_type": "user_list",
"list_max_items": 32767,
"list_auto_add_to_activity": true,
"is_custom": true,
"ai_question": "string",
"auto_extract": true,
"has_choices": true
}
},
"contract_metadata_layout": {"property1": null,
"property2": null
},
"contract_type_setting": "string",
"custom_logo": true,
"custom_metadata_enabled": true,
"dashboard_enabled": true,
"default_contracts_view": "cards",
"default_esign_authentication_method": "string",
"default_esign_sender": "string",
"default_party_table_columns": [null
],
"default_search": {"account_default": true,
"contracts_view": "cards",
"id": "string",
"internal": true,
"name": "string",
"owner": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"params": "string",
"public": true,
"table_columns": ["string"
]
},
"default_table_columns": ["string"
],
"docusign_personal_integration_enabled": true,
"enabled_languages": ["da"
],
"esign_select_option_to_merge_documents_by_default": true,
"esign_production_enabled": true,
"can_perform_bulk_operations_default": true,
"eventlogs_enabled": true,
"extra_party_fields": ["contact"
],
"extract_metadata_enabled": true,
"forms_enabled": true,
"inboxes_enabled": true,
"incoming_email_enabled": true,
"insights_enabled": true,
"mandatory_contract_fields": true,
"mandatory_settings": {"property1": null,
"property2": null
},
"max_contracts": 2147483647,
"ml_training_exclude": "string",
"name": "string",
"need_auth_to_view_documents_default": true,
"num_contracts": 0,
"party_extra_text_field_1_title": "string",
"party_extra_text_field_2_title": "string",
"reminder_settings": [null
],
"similar_contracts_enabled": true,
"sso_domains": ["string"
],
"administrators_remaining": 0,
"ai_chat_licences": 0,
"ai_chat_licences_remaining": 0,
"all_parties_public": true,
"allowed_email_senders": ["string"
],
"allowed_ips": ["string"
],
"api_enabled": true,
"automatically_empty_trash": true,
"can_create_contracts_default": true,
"can_create_esigns_default": true,
"can_create_tags_default": true,
"can_manage_binders_default": true,
"can_manage_forms_default": true,
"can_manage_parties_default": true,
"custom_logo_enabled": true,
"docai_suggest_new_parties": true,
"editors_remaining": 0,
"eventlog_access": "administrator",
"floating_administrators": 0,
"floating_editors": 0,
"floating_viewers": 0,
"key_dates_enabled": true,
"max_administrators": 32767,
"max_editors": 32767,
"max_signers": 0,
"max_viewers": 32767,
"organizations": null,
"party_manager_enabled": true,
"quickedit_enabled": true,
"related_contracts_enabled": true,
"require_admin_license_for_empty_trash": true,
"session_max_age": 2147483647,
"session_window": 2147483647,
"signers_remaining": 0,
"static_meta_attribute_fields_by_type": {"property1": [null
],
"property2": [null
]
},
"status": "trial",
"trial_ends": "2019-08-24T14:15:22Z",
"viewers_remaining": 0,
"webhooks_enabled": true
}

Attributes > Defaults > Read

path Parameters

attribute_id required	string
id required	string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"attribute_id": "string",
"name": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}

Attributes > Defaults > Partial update

path Parameters

attribute_id required	string
id required	string

Request Body schema:
application/json

	object
automatic	boolean
value	string

Responses

Request samples

Payload

Content type

application/json

{"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"attribute_id": "string",
"name": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}

Attributes > Defaults > Delete

path Parameters

attribute_id required	string
id required	string

Responses

Attributes > Defaults > Read

path Parameters

attribute_id

required

string

Responses

Response samples

200

Content type

application/json

{"attribute_id": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}

Attributes > Defaults > Create

path Parameters

attribute_id

required

string

Request Body schema:
application/json
required

	object
automatic	boolean
value required	string

Responses

Request samples

Payload

Content type

application/json

{"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}

Response samples

200

Content type

application/json

{"attribute_id": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}

Activities

Create

Request Body schema:
application/json
required

title required	string <= 512 characters Activity title
description	string
contract required	string
date	string or null <date>
hour_of_day	integer or null
recurrence	string (RecurrenceEnum) Enum: "once" "weekly" "monthly" "quarterly" "semiannually" "annually" `once` - Once `weekly` - Recurring weekly `monthly` - Recurring monthly `quarterly` - Recurring quarterly `semiannually` - Recurring semi-annually `annually` - Recurring annually
complete_by_email	boolean
owner_is_recipient	boolean Contract owner always a reminder recipient.
related_meta_attribute	string

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"contract": "string",
"date": "2019-08-24",
"hour_of_day": 0,
"recurrence": "once",
"complete_by_email": true,
"owner_is_recipient": true,
"related_meta_attribute": "string"
}

Response samples

201

Content type

application/json

{"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"
}

List

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"
}
]
}

Delete

path Parameters

id

required

string

Responses

Partial update

path Parameters

id

required

string

Request Body schema:
application/json

title	string <= 512 characters Activity title
description	string
completed	boolean
complete_reason	string Reason or note about completion
date	string or null <date>
hour_of_day	integer or null
recurrence	string (RecurrenceEnum) Enum: "once" "weekly" "monthly" "quarterly" "semiannually" "annually" `once` - Once `weekly` - Recurring weekly `monthly` - Recurring monthly `quarterly` - Recurring quarterly `semiannually` - Recurring semi-annually `annually` - Recurring annually
has_recurred	boolean
complete_by_email	boolean
owner_is_recipient	boolean Contract owner always a reminder recipient.
related_meta_attribute	string

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"description": "string",
"completed": true,
"complete_reason": "string",
"date": "2019-08-24",
"hour_of_day": 0,
"recurrence": "once",
"has_recurred": true,
"complete_by_email": true,
"owner_is_recipient": true,
"related_meta_attribute": "string"
}

Response samples

200

Content type

application/json

{"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"
}

Read

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"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"
}

Groups > Create

path Parameters

activity_id

required

string

Request Body schema:
application/json
required

group

required

string

Responses

Request samples

Payload

Content type

application/json

{"group": "string"
}

Response samples

201

Content type

application/json

{"name": "string",
"id": "string",
"count": 0,
"idp_groups": "string",
"default_binder": {"id": "string",
"name": "string",
"path": "string"
}
}

Groups > List

path Parameters

activity_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": [{"name": "string",
"id": "string",
"count": 0,
"idp_groups": "string",
"default_binder": {"id": "string",
"name": "string",
"path": "string"
}
}
]
}

Groups > Delete

path Parameters

activity_id required	string
id required	string

Responses

Reminders > Create

path Parameters

activity_id

required

string

Request Body schema:
application/json

timedelta_type	string (TimedeltaTypeEnum) Enum: "days" "weeks" "months" `days` - Days `weeks` - Weeks `months` - Months
timedelta_count	integer [ 0 .. 2147483647 ]

Responses

Request samples

Payload

Content type

application/json

{"timedelta_type": "days",
"timedelta_count": 2147483647
}

Response samples

201

Content type

application/json

{"id": "string",
"activity_id": "string",
"timedelta_type": "days",
"timedelta_count": 2147483647
}

Reminders > List

path Parameters

activity_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",
"activity_id": "string",
"timedelta_type": "days",
"timedelta_count": 2147483647
}
]
}

Reminders > Delete

path Parameters

activity_id required	string
id required	string

Responses

Reminders > Partial update

path Parameters

activity_id required	string
id required	string

Request Body schema:
application/json

timedelta_type	string (TimedeltaTypeEnum) Enum: "days" "weeks" "months" `days` - Days `weeks` - Weeks `months` - Months
timedelta_count	integer [ 0 .. 2147483647 ]

Responses

Request samples

Payload

Content type

application/json

{"timedelta_type": "days",
"timedelta_count": 2147483647
}

Response samples

200

Content type

application/json

{"id": "string",
"activity_id": "string",
"timedelta_type": "days",
"timedelta_count": 2147483647
}

Users > Create

path Parameters

activity_id

required

string

Request Body schema:
application/json
required

user

required

string

Responses

Request samples

Payload

Content type

application/json

{"user": "string"
}

Response samples

201

Content type

application/json

{"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"
}

Users > List

path Parameters

activity_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",
"email": "string",
"name": "string",
"status": "active"
}
]
}

Users > Delete

path Parameters

activity_id required	string
id required	string

Responses

Lists > Create

path Parameters

activity_id

required

string

Request Body schema:
application/json
required

list_attribute

required

string

Responses

Request samples

Payload

Content type

application/json

{"list_attribute": "string"
}

Response samples

201

Content type

application/json

{"id": "string",
"name": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"attribute_type": "text-singleline",
"defaults": [{"id": "string",
"attribute_id": "string",
"name": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}
],
"placeholder": "string",
"placeholder_translations": {"property1": "string",
"property2": "string"
},
"ui_extra_info": "string",
"ui_extra_info_translations": {"property1": null,
"property2": null
},
"custom_fields": [{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}
],
"automatic_reminders": true,
"mandatory": true,
"deletable": true,
"parent": "string",
"subfield": "string",
"static_fields": ["string"
],
"list_type": "user_list",
"list_max_items": 32767,
"list_auto_add_to_activity": true,
"is_custom": true,
"ai_question": "string",
"auto_extract": true,
"has_choices": true
}

Lists > List

path Parameters

activity_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",
"name": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"attribute_type": "text-singleline",
"defaults": [{"id": "string",
"attribute_id": "string",
"name": "string",
"name_translations": {"property1": "string",
"property2": "string"
},
"automatic": true,
"value": "string"
}
],
"placeholder": "string",
"placeholder_translations": {"property1": "string",
"property2": "string"
},
"ui_extra_info": "string",
"ui_extra_info_translations": {"property1": null,
"property2": null
},
"custom_fields": [{"id": "string",
"label": "string",
"label_translations": {"property1": "string",
"property2": "string"
},
"name": "string",
"visible": true
}
],
"automatic_reminders": true,
"mandatory": true,
"deletable": true,
"parent": "string",
"subfield": "string",
"static_fields": ["string"
],
"list_type": "user_list",
"list_max_items": 32767,
"list_auto_add_to_activity": true,
"is_custom": true,
"ai_question": "string",
"auto_extract": true,
"has_choices": true
}
]
}

Lists > Delete

path Parameters

activity_id required	string
id required	string

Responses

Chat

Create

Request Body schema:
application/json
required

source_document	string
user_input required	string
source_token_start	integer

Responses

Request samples

Payload

Content type

application/json

{"source_document": "string",
"user_input": "string",
"source_token_start": 0
}

Response samples

201

Content type

application/json

{"id": "string",
"profile": "string",
"source_document": "string",
"system_input": "string",
"user_input": "string",
"created_at": "2019-08-24T14:15:22Z",
"responses": "string",
"usage": "string",
"source_token_total": 0,
"meta_attribute_chat": {"contract": "string",
"meta_attribute": "string",
"question": "string",
"result": "string",
"success": true
}
}

List

List chats

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
document	string Document which is searched
profile	string User who have made request
sort	string Enum: "-created_at" "created_at" Sort results by key.

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",
"profile": "string",
"source_document": "string",
"system_input": "string",
"user_input": "string",
"created_at": "2019-08-24T14:15:22Z",
"responses": "string",
"usage": "string",
"source_token_total": 0,
"meta_attribute_chat": {"contract": "string",
"meta_attribute": "string",
"question": "string",
"result": "string",
"success": true
}
}
]
}

Delete

path Parameters

cryptid

required

string

Responses

Read

path Parameters

cryptid

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"profile": "string",
"source_document": "string",
"system_input": "string",
"user_input": "string",
"created_at": "2019-08-24T14:15:22Z",
"responses": "string",
"usage": "string",
"source_token_total": 0,
"meta_attribute_chat": {"contract": "string",
"meta_attribute": "string",
"question": "string",
"result": "string",
"success": true
}
}

Documents

Create

Uploads a new attachment to a contract.

Request Body schema:
multipart/form-data
required

blob required	string <uri> The file data for the new attachment. This can be any file format.
contract required	string ID of the Contract to attach this file to.

Responses

Response samples

201

Content type

application/json

{"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
}

Read

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"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
}

Delete

Deletes a document

path Parameters

id

required

string

Responses

Partial update

path Parameters

id

required

string

Request Body schema:
multipart/form-data

filename	string
role	string
status	string (Status278Enum) Enum: "queued" "quarantined" "complete" "archived" "hidden" "deleted" "error" `queued` - The file is queued for processing. `quarantined` - The file is quarantined by antivirus. `complete` - Automatic processing is complete. `archived` - The file has been removed (put in archive). `hidden` - The file is hidden `deleted` - The document is deleted `error` - All attempts to process the document failed
folder	string or null

Responses

Request samples

Payload

Content type

multipart/form-data

No sample

Response samples

200

Content type

application/json

{"id": "string",
"filename": "string",
"role": "string",
"status": "queued",
"folder": "string",
"position": 2147483647
}

Update

path Parameters

id

required

string

Request Body schema:
multipart/form-data
required

filename	string
role	string
status	string (Status278Enum) Enum: "queued" "quarantined" "complete" "archived" "hidden" "deleted" "error" `queued` - The file is queued for processing. `quarantined` - The file is quarantined by antivirus. `complete` - Automatic processing is complete. `archived` - The file has been removed (put in archive). `hidden` - The file is hidden `deleted` - The document is deleted `error` - All attempts to process the document failed
folder required	string or null

Responses

Request samples

Payload

Content type

multipart/form-data

No sample

Response samples

200

Content type

application/json

{"id": "string",
"filename": "string",
"role": "string",
"status": "queued",
"folder": "string",
"position": 2147483647
}

Detach

Detaches document from contract and creates a new contract with this document

path Parameters

id

required

string

Request Body schema:
multipart/form-data

receive_time	string <date-time> When was this document added to this system?
role	string (DocumentRoleEnum) Enum: "unknown" "contract" "attachment" "other" `unknown` - The role has not been determined yet `contract` - The main contract document `attachment` - An attachment `other` - An other type of file
status	string (Status278Enum) Enum: "queued" "quarantined" "complete" "archived" "hidden" "deleted" "error" `queued` - The file is queued for processing. `quarantined` - The file is quarantined by antivirus. `complete` - Automatic processing is complete. `archived` - The file has been removed (put in archive). `hidden` - The file is hidden `deleted` - The document is deleted `error` - All attempts to process the document failed

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"
}

Download

A download/embed link for the original document file.

path Parameters

id

required

string

Responses

Esignsenders

Create

Request Body schema:
application/json
required

name

required

string <= 256 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

201

Content type

application/json

{"id": "string",
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

List

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",
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Read

path Parameters

cryptid

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete

path Parameters

cryptid

required

string

Responses

Partial update

path Parameters

cryptid

required

string

Request Body schema:
application/json

name	string <= 256 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update

path Parameters

cryptid

required

string

Request Body schema:
application/json
required

name

required

string <= 256 characters

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Groups

Create

Request Body schema:
application/json
required

name required	string The name of the group
default_binder	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"default_binder": "string"
}

Response samples

201

Content type

application/json

{"name": "string",
"id": "string",
"count": 0,
"idp_groups": "string",
"default_binder": {"id": "string",
"name": "string",
"path": "string"
}
}

List

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 group names.
sort	string Enum: "-name" "-user-count" "name" "user-count" Sort results by key.
provisioned_by	string Value: "scim"

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": [{"name": "string",
"id": "string",
"count": 0,
"idp_groups": "string",
"default_binder": {"id": "string",
"name": "string",
"path": "string"
}
}
]
}

Delete

path Parameters

id

required

string

Responses

Partial update

path Parameters

id

required

string

Request Body schema:
application/json

name	string The name of the group
idp_groups	string A semicolon separated list of linked groups on the IdP side.
default_binder	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"idp_groups": "string",
"default_binder": "string"
}

Response samples

200

Content type

application/json

{"name": "string",
"id": "string",
"count": 0,
"idp_groups": "string",
"default_binder": {"id": "string",
"name": "string",
"path": "string"
}
}

Read

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"name": "string",
"id": "string",
"count": 0,
"idp_groups": "string",
"default_binder": {"id": "string",
"name": "string",
"path": "string"
}
}

Users > Create

Adds a user to the group.

path Parameters

group_id

required

string

Request Body schema:
application/json
required

user

required

string

Responses

Request samples

Payload

Content type

application/json

{"user": "string"
}

Response samples

201

Content type

application/json

{"user": "string"
}

Users > List

path Parameters

group_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",
"name": "string",
"email": "user@example.com",
"language": "da",
"is_sso": true
}
]
}

Users > Delete

Deletes a user from the group.

path Parameters

group_id required	string
user_id required	string

Responses

Inboxes

Create

Request Body schema:
application/json

binder	string or null
is_personal	boolean Default: true
contract_owner	string
restricted	boolean Default: true

Responses

Request samples

Payload

Content type

application/json

{"binder": "string",
"is_personal": true,
"contract_owner": "string",
"restricted": true
}

Response samples

201

Content type

application/json

{"id": "string",
"address": "string",
"binder": "string",
"binder_name": "string",
"binder_path": "string",
"contract_owner": "string",
"profile": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"restricted": true,
"type": "string"
}

List

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
binder	string Search for inboxes for this binder.

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",
"address": "string",
"binder": "string",
"binder_name": "string",
"binder_path": "string",
"contract_owner": "string",
"profile": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"restricted": true,
"type": "string"
}
]
}

Delete

path Parameters

id

required

string

Responses

Partial update

path Parameters

id

required

string

Request Body schema:
application/json

reset_address	boolean Default: true
restricted	boolean
contract_owner	string

Responses

Request samples

Payload

Content type

application/json

{"reset_address": true,
"restricted": true,
"contract_owner": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"address": "string",
"binder": "string",
"binder_name": "string",
"binder_path": "string",
"contract_owner": "string",
"profile": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"restricted": true,
"type": "string"
}

Keys

Create

Creates a new API key. The response contains a unique secret key in the key field. It will not be present in other responses.

Request Body schema:
application/json
required

name required	string <= 256 characters A name for the key
user required	string ID of the user whose permissions the key will grant.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"user": "string"
}

Response samples

201

Content type

application/json

{"id": "string",
"name": "string",
"user": "string",
"key": "string"
}

List

Lists all API keys.

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",
"name": "string",
"user": "string"
}
]
}

Delete

path Parameters

id

required

string

Responses

Read

Retrieves an API key. Note that the actual secret key is only present in the create response.

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"user": "string"
}

Members

Create

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
binder required	string

Responses

Request samples

Payload

Content type

application/json

{"permission": "view",
"user": "string",
"group": "string",
"binder": "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"
},
"binder": "string"
}

Delete

path Parameters

cryptid

required

string

Responses

Partial update

path Parameters

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
binder	string

Responses

Request samples

Payload

Content type

application/json

{"permission": "view",
"binder": "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"
},
"binder": "string"
}

Update

path Parameters

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
binder required	string

Responses

Request samples

Payload

Content type

application/json

{"permission": "view",
"user": "string",
"group": "string",
"binder": "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"
},
"binder": "string"
}

Parties

Create

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

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"
}

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",
"num_contracts": "string",
"managed": true,
"public": true,
"country": "st",
"contact": "string",
"group": "string",
"is_merging": true,
"previous_names": "string"
}

List

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 string for all party fields.
q_name	string Exact string for searching party names.
q_org_id	string Exact string for searching party organizations.
match_q	string Enum: "AND" "OR" Operator for matching q fields.
external_id	string Exact string for searching party external ids.
sort	string Enum: "-contact" "-country" "-external_id" "-extra_text_field_1" "-extra_text_field_2" "-group" "-is_merging" "-managed" "-name" "-num_contracts" "-org_id" "-previous_names" "-public" "contact" "country" "external_id" "extra_text_field_1" "extra_text_field_2" "group" "is_merging" "managed" "name" "num_contracts" "org_id" "previous_names" "public" Sort results by key.

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",
"name": "string",
"org_id": "string",
"external_id": "string",
"extra_text_field_1": "string",
"extra_text_field_2": "string",
"num_contracts": "string",
"managed": true,
"public": true,
"country": "st",
"contact": "string",
"group": "string",
"is_merging": true,
"previous_names": "string"
}
]
}

Update or Create

This endpoint combines both the create and update functionality often found in POST and PATCH requests. It uses query parameters to determine which object should be updated and if no object is found, it creates it instead.

This endpoint should mainly be used when the caller does not know the ID of an object or does not know if the object exists or not. If you know you want to create, use POST and if you know the ID and want to update, use PATCH instead. Both of them are more efficient endpoints, this is mainly useful for special cases where neither of them suffice.

Example:

Verb: PUT
Endpoint: /api/parties/?external_id=norse_gods
JSON Data: {"name": "Aesir"}

What this will do is first look for an object with external_id set to norse_gods and if that object is found, it would update the attribute name to the value Aesir. If an object is not found, however, then it will create a new instance with the values set in the JSON data. Note that the values in the query parameters will not be used when creating a new object. You will need to pass the same parameters again in the JSON data as in the query parameters in order to also store that value.

In short, query parameters are used for querying for an object, JSON data is the values to be stored.

Note that the same restrictions for creating and updating objects apply as those found in the POST and PATCH endpoints. Meaning that if a field must be included to create a new object with POST, it will also be required when a new object is created using this endpoint. This means that if you are unsure whether an object is going to be created or updated, you should follow the more strict requirements regarding input data from POST or PATCH.

Note that this is not a bulk action endpoint, it does not update nor create multiple objects. This means that if more than one object would be found with the given query parameters, the action will fail and a 400 error will be returned.

query Parameters

id	string
org_id	string
external_id	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

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"
}

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",
"num_contracts": "string",
"managed": true,
"public": true,
"country": "st",
"contact": "string",
"group": "string",
"is_merging": true,
"previous_names": "string"
}

Merge

Merges two or more parties to a new combined party.

Request Body schema:
application/json
required

name	string The name of the new party (can a name of a merged party)
org_id	string The org_id of the new party (can be an org_id of a merged party)
managed	boolean Default: true Explicitly managed party (exists even without contracts)
merged required	Array of strings List of parties to be merged.
country	string The country of the merged party.
group	string The group value of the new party.
contact	string The contactvalue of the new party.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"org_id": "string",
"managed": true,
"merged": ["string"
],
"country": "string",
"group": "string",
"contact": "string"
}

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",
"num_contracts": "string",
"managed": true,
"public": true,
"country": "st",
"contact": "string",
"group": "string",
"is_merging": true,
"previous_names": "string"
}

Delete

path Parameters

id

required

string

Responses

Partial update

path Parameters

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

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"
}

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",
"num_contracts": "string",
"managed": true,
"public": true,
"country": "st",
"contact": "string",
"group": "string",
"is_merging": true,
"previous_names": "string"
}

Read

path Parameters

id

required

string

Responses

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",
"num_contracts": "string",
"managed": true,
"public": true,
"country": "st",
"contact": "string",
"group": "string",
"is_merging": true,
"previous_names": "string"
}

Roles

Create

Request Body schema:
application/json
required

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

201

Content type

application/json

{"id": "string",
"name": "string",
"is_editable": true,
"created_by": "string",
"created_at": "2019-08-24T14:15:22Z"
}

List

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",
"name": "string",
"is_editable": true,
"created_by": "string",
"created_at": "2019-08-24T14:15:22Z"
}
]
}

Delete

path Parameters

id

required

string

Responses

Partial update

path Parameters

id

required

string

Request Body schema:
application/json

name

string

Responses

Request samples

Payload

Content type

application/json

{"name": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"is_editable": true,
"created_by": "string",
"created_at": "2019-08-24T14:15:22Z"
}

Read

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "string",
"is_editable": true,
"created_by": "string",
"created_at": "2019-08-24T14:15:22Z"
}

Searches

Actions > Create

Request Body schema:
application/json
required

name	string Default: "New search action"
search	string
	object
action required	string (ActionEnum) Value: "notify" `notify` - Notify
occurrence required	string (OccurrenceEnum) Enum: "immediate" "scheduled" `immediate` - Immediate `scheduled` - Scheduled
days	Array of strings or null (DaysEnum) Enum: "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" "sunday"
time	string or null <time>
receivers required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "New search action",
"search": "string",
"search_obj": {"account_default": true,
"contracts_view": "cards",
"name": "string",
"params": "string",
"public": true,
"table_columns": ["string"
]
},
"action": "notify",
"occurrence": "immediate",
"days": ["monday"
],
"time": "14:15:22Z",
"receivers": ["string"
]
}

Response samples

201

Content type

application/json

{"id": "string",
"name": "New search action",
"search": "string",
"action": "notify",
"occurrence": "immediate",
"days": ["monday"
],
"time": "14:15:22Z",
"receivers": ["string"
],
"latest_check": "2019-08-24T14:15:22Z",
"created_by": "string"
}

Actions > List

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",
"name": "New search action",
"search": "string",
"action": "notify",
"occurrence": "immediate",
"days": ["monday"
],
"time": "14:15:22Z",
"receivers": ["string"
],
"latest_check": "2019-08-24T14:15:22Z",
"created_by": "string"
}
]
}

Actions > Read

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"name": "New search action",
"search": "string",
"action": "notify",
"occurrence": "immediate",
"days": ["monday"
],
"time": "14:15:22Z",
"receivers": ["string"
],
"latest_check": "2019-08-24T14:15:22Z",
"created_by": "string"
}

Actions > Delete

path Parameters

id

required

string

Responses

Actions > Partial update

path Parameters

id

required

string

Request Body schema:
application/json

name	string Default: "New search action"
search	string
	object
action	string (ActionEnum) Value: "notify" `notify` - Notify
occurrence	string (OccurrenceEnum) Enum: "immediate" "scheduled" `immediate` - Immediate `scheduled` - Scheduled
days	Array of strings or null (DaysEnum) Enum: "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" "sunday"
time	string or null <time>
receivers	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "New search action",
"search": "string",
"search_obj": {"account_default": true,
"contracts_view": "cards",
"name": "string",
"params": "string",
"public": true,
"table_columns": ["string"
]
},
"action": "notify",
"occurrence": "immediate",
"days": ["monday"
],
"time": "14:15:22Z",
"receivers": ["string"
]
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "New search action",
"search": "string",
"action": "notify",
"occurrence": "immediate",
"days": ["monday"
],
"time": "14:15:22Z",
"receivers": ["string"
],
"latest_check": "2019-08-24T14:15:22Z",
"created_by": "string"
}

Actions > Update

path Parameters

id

required

string

Request Body schema:
application/json
required

name	string Default: "New search action"
search	string
	object
action required	string (ActionEnum) Value: "notify" `notify` - Notify
occurrence required	string (OccurrenceEnum) Enum: "immediate" "scheduled" `immediate` - Immediate `scheduled` - Scheduled
days	Array of strings or null (DaysEnum) Enum: "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" "sunday"
time	string or null <time>
receivers required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"name": "New search action",
"search": "string",
"search_obj": {"account_default": true,
"contracts_view": "cards",
"name": "string",
"params": "string",
"public": true,
"table_columns": ["string"
]
},
"action": "notify",
"occurrence": "immediate",
"days": ["monday"
],
"time": "14:15:22Z",
"receivers": ["string"
]
}

Response samples

200

Content type

application/json

{"id": "string",
"name": "New search action",
"search": "string",
"action": "notify",
"occurrence": "immediate",
"days": ["monday"
],
"time": "14:15:22Z",
"receivers": ["string"
],
"latest_check": "2019-08-24T14:15:22Z",
"created_by": "string"
}

Create

Request Body schema:
application/json
required

tag_name required	string <= 50 characters
active	boolean

Responses

Request samples

Payload

Content type

application/json

{"tag_name": "string",
"active": true
}

Response samples

201

Content type

application/json

{"id": "string",
"tag_name": "string",
"active": true,
"num_contracts": 0
}

List

query Parameters

page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
q	string Only include tags with matching names.

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",
"tag_name": "string",
"active": true,
"num_contracts": 0
}
]
}

Merge

Request Body schema:
application/json
required

tag_name required	string <= 50 characters
merged required	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"tag_name": "string",
"merged": ["string"
]
}

Response samples

200

Content type

application/json

{"id": "string",
"tag_name": "string",
"active": true,
"num_contracts": 0
}

Delete

path Parameters

id

required

string

Responses

Partial update

path Parameters

id

required

string

Request Body schema:
application/json

tag_name	string <= 50 characters
active	boolean

Responses

Request samples

Payload

Content type

application/json

{"tag_name": "string",
"active": true
}

Response samples

200

Content type

application/json

{"id": "string",
"tag_name": "string",
"active": true,
"num_contracts": 0
}

Read

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"tag_name": "string",
"active": true,
"num_contracts": 0
}

Contracts > Add

path Parameters

tag_id

required

string

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
}
]
}

Contracts > Delete

path Parameters

tag_id required	string
id required	string

Responses

Documents > Delete

path Parameters

tag_id required	string
id required	string

Responses

Tasks

List

Responses

Response samples

200

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
}
]
}
]

Partial update

path Parameters

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

200

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
}
]
}

Read

path Parameters

id

required

string

Responses

Response samples

200

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
}
]
}

Download

path Parameters

id

required

string

Responses

Response samples

200

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
}
]
}

Users

Create

Creates a new user account.

If an email address is specified, an invitation email is sent to the email address, and the user account is set in the pending state. The user must follow a link in the email to activate their account.

If no email address is specified, the user account will be created directly in the active state. The account can be be used with API keys (see the keys API endpoint), or an email address can be added later.

Request Body schema:
application/json
required

name required	string Full name.
language	string <= 32 characters Default: "en-us"
email	string <email> <= 254 characters An email address (must be unique).
phone_number	string or null
profile_type	string Default: "editor" Enum: "administrator" "editor" "viewer" "signer" A profile type for the user. `administrator` - administrator `editor` - editor `viewer` - viewer `signer` - signer
is_floating	boolean Default: false Use a floating license?
send_email	boolean Default: true Send invitation email?
days_valid	integer Default: 30 Number of days the invitation is valid until it expires.
can_create_contracts	boolean
can_create_esigns	boolean
can_create_tags	boolean
can_manage_account_settings	boolean
can_manage_all_content	boolean
can_manage_binders	boolean
can_manage_custom_metadata	boolean
can_manage_forms	boolean
can_manage_parties	boolean
can_manage_users_and_groups	boolean
can_perform_bulk_operations	boolean
can_use_ai_chat	boolean Default: false
default_binder	string or null
default_search	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"language": "en-us",
"email": "user@example.com",
"phone_number": "string",
"profile_type": "editor",
"is_floating": false,
"send_email": true,
"days_valid": 30,
"can_create_contracts": true,
"can_create_esigns": true,
"can_create_tags": true,
"can_manage_account_settings": true,
"can_manage_all_content": true,
"can_manage_binders": true,
"can_manage_custom_metadata": true,
"can_manage_forms": true,
"can_manage_parties": true,
"can_manage_users_and_groups": true,
"can_perform_bulk_operations": true,
"can_use_ai_chat": false,
"default_binder": "string",
"default_search": "string"
}

Response samples

201

Content type

application/json

{"ask_feedback": true,
"can_create_contracts": true,
"can_create_esigns": true,
"can_create_tags": true,
"can_edit": true,
"can_manage_account_settings": true,
"can_manage_all_content": true,
"can_manage_binders": true,
"can_manage_custom_metadata": true,
"can_manage_forms": true,
"can_manage_parties": true,
"can_manage_tags": true,
"can_manage_users_and_groups": true,
"can_perform_bulk_operations": true,
"can_use_ai_chat": true,
"contract_view": "cards",
"default_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
},
"default_search": {"account_default": true,
"contracts_view": "cards",
"id": "string",
"internal": true,
"name": "string",
"owner": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"params": "string",
"public": true,
"table_columns": ["string"
]
},
"display_name": "string",
"email": "user@example.com",
"eventlogs_enabled": true,
"first_name": "string",
"id": "string",
"is_floating": true,
"language": "da",
"last_login": "2019-08-24T14:15:22Z",
"name": "string",
"party_table_columns": [null
],
"phone_number": "string",
"profile_type": "administrator",
"saml": true,
"short_name": "string",
"status": "active",
"table_columns": ["string"
],
"timezone": "string",
"pending_email": {"property1": null,
"property2": null
},
"token_valid": 0,
"pending_phone_number": {"property1": null,
"property2": null
},
"all_default_binders": [{"id": "string",
"name": "string",
"permission": "string",
"granted_permission": "string"
}
]
}

List

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 group names.
sort	string Enum: "-email" "-last_login" "-name" "-role" "-status" "email" "last_login" "name" "role" "status" Sort results by key.

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": [{"ask_feedback": true,
"can_create_contracts": true,
"can_create_esigns": true,
"can_create_tags": true,
"can_edit": true,
"can_manage_account_settings": true,
"can_manage_all_content": true,
"can_manage_binders": true,
"can_manage_custom_metadata": true,
"can_manage_forms": true,
"can_manage_parties": true,
"can_manage_tags": true,
"can_manage_users_and_groups": true,
"can_perform_bulk_operations": true,
"can_use_ai_chat": true,
"contract_view": "cards",
"default_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
},
"default_search": {"account_default": true,
"contracts_view": "cards",
"id": "string",
"internal": true,
"name": "string",
"owner": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"params": "string",
"public": true,
"table_columns": ["string"
]
},
"display_name": "string",
"email": "user@example.com",
"eventlogs_enabled": true,
"first_name": "string",
"id": "string",
"is_floating": true,
"language": "da",
"last_login": "2019-08-24T14:15:22Z",
"name": "string",
"party_table_columns": [null
],
"phone_number": "string",
"profile_type": "administrator",
"saml": true,
"short_name": "string",
"status": "active",
"table_columns": ["string"
],
"timezone": "string",
"pending_email": {"property1": null,
"property2": null
},
"token_valid": 0,
"pending_phone_number": {"property1": null,
"property2": null
},
"all_default_binders": [{"id": "string",
"name": "string",
"permission": "string",
"granted_permission": "string"
}
]
}
]
}

Update or Create

This endpoint combines both the create and update functionality often found in POST and PATCH requests. It uses query parameters to determine which object should be updated and if no object is found, it creates it instead.

This endpoint should mainly be used when the caller does not know the ID of an object or does not know if the object exists or not. If you know you want to create, use POST and if you know the ID and want to update, use PATCH instead. Both of them are more efficient endpoints, this is mainly useful for special cases where neither of them suffice.

Example:

Verb: PUT
Endpoint: /api/contracts/?email=thor@asgard.com
JSON Data: {"name": "Thor Odinsson"}

What this will do is first look for an object with email set to thor@asgard.com and if that object is found, it would update the attribute name to the value Thor Odinsson. If an object is not found, however, then it will create a new instance with the values set in the JSON data. Note that the values in the query parameters will not be used when creating a new object. You will need to pass the same parameters again in the JSON data as in the query parameters in order to also store that value.

In short, query parameters are used for querying for an object, JSON data is the values to be stored.

Note that the same restrictions for creating and updating objects apply as those found in the POST and PATCH endpoints. Meaning that if a field must be included to create a new object with POST, it will also be required when a new object is created using this endpoint. This means that if you are unsure whether an object is going to be created or updated, you should follow the more strict requirements regarding input data from POST or PATCH.

Note that this is not a bulk action endpoint, it does not update nor create multiple objects. This means that if more than one object would be found with the given query parameters, the action will fail and a 400 error will be returned.

query Parameters

id	string
email	string <email>

Request Body schema:
application/json

ask_feedback	boolean
can_create_contracts	boolean
can_create_esigns	boolean
can_create_tags	boolean
can_manage_account_settings	boolean
can_manage_all_content	boolean
can_manage_binders	boolean
can_manage_custom_metadata	boolean
can_manage_forms	boolean
can_manage_parties	boolean
can_manage_users_and_groups	boolean
can_perform_bulk_operations	boolean
can_use_ai_chat	boolean
contract_view	string (ContractViewEnum) Enum: "cards" "list" "calendar" `cards` - Cards `list` - List `calendar` - Calendar
default_binder	string or null
default_search	string or null
email	string <email> <= 254 characters An email address (must be unique).
is_floating	boolean
language	string <= 32 characters
last_read_notification	string (LastReadNotificationEnum) Enum: "now" "reset" `now` - now `reset` - reset
name	string
party_table_columns	Array of any
phone_number	string or null
profile_type	string Enum: "administrator" "editor" "viewer" "signer" A profile type for the user. `administrator` - Administrator `editor` - Editor `viewer` - Viewer `signer` - Signer
send_review_emails	boolean
skip_review_state	boolean
status	string (Status228Enum) Enum: "active" "pending" "bounced" "inactive" "pending_deletion" "deleted" `active` - Active `pending` - Activation pending `bounced` - Activation email bounced `inactive` - Inactive `pending_deletion` - Pending deletion `deleted` - Deleted
table_columns	Array of strings[ items <= 120 characters ]
timezone	string

Responses

Request samples

Payload

Content type

application/json

{"ask_feedback": true,
"can_create_contracts": true,
"can_create_esigns": true,
"can_create_tags": true,
"can_manage_account_settings": true,
"can_manage_all_content": true,
"can_manage_binders": true,
"can_manage_custom_metadata": true,
"can_manage_forms": true,
"can_manage_parties": true,
"can_manage_users_and_groups": true,
"can_perform_bulk_operations": true,
"can_use_ai_chat": true,
"contract_view": "cards",
"default_binder": "string",
"default_search": "string",
"email": "user@example.com",
"is_floating": true,
"language": "string",
"last_read_notification": "now",
"name": "string",
"party_table_columns": [null
],
"phone_number": "string",
"profile_type": "administrator",
"send_review_emails": true,
"skip_review_state": true,
"status": "active",
"table_columns": ["string"
],
"timezone": "string"
}

Bulkop change owner

Changes the owner of all contracts and binders currently owned by old to new and public inboxes where user is contract_owner and active e-signs. Requires the can_manage_users_and_groups permission.

Request Body schema:
application/json
required

old required	string User ID of current owner.
new required	string User ID of new owner.

Responses

Request samples

Payload

Content type

application/json

{"old": "string",
"new": "string"
}

Response samples

200

Content type

application/json

{"old": "string",
"new": "string"
}

Delete

Deletes the user.

path Parameters

id

required

integer

A unique integer value identifying this profile.

query Parameters

new_owner

string or null non-empty

Responses

Partial update

path Parameters

id

required

integer

A unique integer value identifying this profile.

Request Body schema:
application/json

ask_feedback	boolean
can_create_contracts	boolean
can_create_esigns	boolean
can_create_tags	boolean
can_manage_account_settings	boolean
can_manage_all_content	boolean
can_manage_binders	boolean
can_manage_custom_metadata	boolean
can_manage_forms	boolean
can_manage_parties	boolean
can_manage_users_and_groups	boolean
can_perform_bulk_operations	boolean
can_use_ai_chat	boolean
contract_view	string (ContractViewEnum) Enum: "cards" "list" "calendar" `cards` - Cards `list` - List `calendar` - Calendar
default_binder	string or null
default_search	string or null
email	string <email> <= 254 characters An email address (must be unique).
is_floating	boolean
language	string <= 32 characters
last_read_notification	string (LastReadNotificationEnum) Enum: "now" "reset" `now` - now `reset` - reset
name	string
party_table_columns	Array of any
phone_number	string or null
profile_type	string Enum: "administrator" "editor" "viewer" "signer" A profile type for the user. `administrator` - Administrator `editor` - Editor `viewer` - Viewer `signer` - Signer
send_review_emails	boolean
skip_review_state	boolean
status	string (Status228Enum) Enum: "active" "pending" "bounced" "inactive" "pending_deletion" "deleted" `active` - Active `pending` - Activation pending `bounced` - Activation email bounced `inactive` - Inactive `pending_deletion` - Pending deletion `deleted` - Deleted
table_columns	Array of strings[ items <= 120 characters ]
timezone	string

Responses

Request samples

Payload

Content type

application/json

{"ask_feedback": true,
"can_create_contracts": true,
"can_create_esigns": true,
"can_create_tags": true,
"can_manage_account_settings": true,
"can_manage_all_content": true,
"can_manage_binders": true,
"can_manage_custom_metadata": true,
"can_manage_forms": true,
"can_manage_parties": true,
"can_manage_users_and_groups": true,
"can_perform_bulk_operations": true,
"can_use_ai_chat": true,
"contract_view": "cards",
"default_binder": "string",
"default_search": "string",
"email": "user@example.com",
"is_floating": true,
"language": "string",
"last_read_notification": "now",
"name": "string",
"party_table_columns": [null
],
"phone_number": "string",
"profile_type": "administrator",
"send_review_emails": true,
"skip_review_state": true,
"status": "active",
"table_columns": ["string"
],
"timezone": "string"
}

Response samples

200

Content type

application/json

{"ask_feedback": true,
"can_create_contracts": true,
"can_create_esigns": true,
"can_create_tags": true,
"can_edit": true,
"can_manage_account_settings": true,
"can_manage_all_content": true,
"can_manage_binders": true,
"can_manage_custom_metadata": true,
"can_manage_forms": true,
"can_manage_parties": true,
"can_manage_tags": true,
"can_manage_users_and_groups": true,
"can_perform_bulk_operations": true,
"can_use_ai_chat": true,
"contract_view": "cards",
"default_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
},
"default_search": {"account_default": true,
"contracts_view": "cards",
"id": "string",
"internal": true,
"name": "string",
"owner": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"params": "string",
"public": true,
"table_columns": ["string"
]
},
"display_name": "string",
"email": "user@example.com",
"eventlogs_enabled": true,
"first_name": "string",
"id": "string",
"is_floating": true,
"language": "da",
"last_login": "2019-08-24T14:15:22Z",
"name": "string",
"party_table_columns": [null
],
"phone_number": "string",
"profile_type": "administrator",
"saml": true,
"short_name": "string",
"status": "active",
"table_columns": ["string"
],
"timezone": "string",
"pending_email": {"property1": null,
"property2": null
},
"token_valid": 0,
"pending_phone_number": {"property1": null,
"property2": null
},
"all_default_binders": [{"id": "string",
"name": "string",
"permission": "string",
"granted_permission": "string"
}
],
"has_password": true,
"has_pending_verification_token": true,
"has_unverified_webauthn": true,
"last_read_notification": "string",
"send_review_emails": true,
"skip_review_state": true,
"use_webauthn": true,
"docusign_personal_activated": true
}

Read

Returns the User object. In case the current API-key does not have permission to manage account settings or manage users and groups, the response excludes following fields: token_valid, pending_email, pending_phone_number, all_default_binders

path Parameters

id

required

integer

A unique integer value identifying this profile.

Responses

Response samples

200

Content type

application/json

{"ask_feedback": true,
"can_create_contracts": true,
"can_create_esigns": true,
"can_create_tags": true,
"can_edit": true,
"can_manage_account_settings": true,
"can_manage_all_content": true,
"can_manage_binders": true,
"can_manage_custom_metadata": true,
"can_manage_forms": true,
"can_manage_parties": true,
"can_manage_tags": true,
"can_manage_users_and_groups": true,
"can_perform_bulk_operations": true,
"can_use_ai_chat": true,
"contract_view": "cards",
"default_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
},
"default_search": {"account_default": true,
"contracts_view": "cards",
"id": "string",
"internal": true,
"name": "string",
"owner": {"id": "string",
"email": "string",
"name": "string",
"status": "active"
},
"params": "string",
"public": true,
"table_columns": ["string"
]
},
"display_name": "string",
"email": "user@example.com",
"eventlogs_enabled": true,
"first_name": "string",
"id": "string",
"is_floating": true,
"language": "da",
"last_login": "2019-08-24T14:15:22Z",
"name": "string",
"party_table_columns": [null
],
"phone_number": "string",
"profile_type": "administrator",
"saml": true,
"short_name": "string",
"status": "active",
"table_columns": ["string"
],
"timezone": "string",
"pending_email": {"property1": null,
"property2": null
},
"token_valid": 0,
"pending_phone_number": {"property1": null,
"property2": null
},
"all_default_binders": [{"id": "string",
"name": "string",
"permission": "string",
"granted_permission": "string"
}
]
}

Integrations

Docusign personal > Delete

Delete DocuSignProfile of current Profile object.

path Parameters

id

required

string

Responses

Oidc > Events > List

path Parameters

integration_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": [{"actor": "string",
"verb": "requested_auth",
"state": "string",
"error_code": "error_group",
"has_error": true,
"error_message": "string",
"userinfo": null,
"created_at": "2019-08-24T14:15:22Z"
}
]
}

Update or Create

This endpoint combines both the create and update functionality often found in POST and PATCH requests. It uses query parameters to determine which object should be updated and if no object is found, it creates it instead.

This endpoint should mainly be used when the caller does not know the ID of an object or does not know if the object exists or not. If you know you want to create, use POST and if you know the ID and want to update, use PATCH instead. Both of them are more efficient endpoints, this is mainly useful for special cases where neither of them suffice.

Example:

Verb: PUT
Endpoint: /api/account/attributes/<attribute_id>/choices/?id=attr_1KrYzcNlpAuyPnJlIi
JSON Data: {"value": "Thor Odinsson"}

What this will do is first look for an object with id set to attr_1KrYzcNlpAuyPnJlIi and if that object is found, it would update the attribute value to the value Thor Odinsson. If an object is not found, however, then it will create a new instance with the values set in the JSON data. Note that the values in the query parameters will not be used when creating a new object. You will need to pass the same parameters again in the JSON data as in the query parameters in order to also store that value.

In short, query parameters are used for querying for an object, JSON data is the values to be stored.

Note that the same restrictions for creating and updating objects apply as those found in the POST and PATCH endpoints. Meaning that if a field must be included to create a new object with POST, it will also be required when a new object is created using this endpoint. This means that if you are unsure whether an object is going to be created or updated, you should follow the more strict requirements regarding input data from POST or PATCH.

Note that this is not a bulk action endpoint, it does not update nor create multiple objects. This means that if more than one object would be found with the given query parameters, the action will fail and a 400 error will be returned.

path Parameters

attribute_cryptid

required

string

query Parameters

id

string

Request Body schema:
application/json

	object
position	integer >= 0 Default: 0
is_default	boolean
	object

Responses

Request samples

Payload

Content type

application/json

{"value_translations": {"property1": "string",
"property2": "string"
},
"position": 0,
"is_default": true,
"custom_values": {"property1": null,
"property2": null
}
}

Response samples

200

Content type

application/json

{"id": "string",
"value": "string",
"value_translations": {"property1": "string",
"property2": "string"
},
"position": 0,
"is_default": true
}

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