Zefort logo
API docs by Redocly

Zefort API Reference (2024-08-01)

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.

last_modified
string

Search contracts by the latest date they've been modified.

activities_times
string

A date range string.

pending_activities_times
string

Search contracts by the deadlines of their pending activities.

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

Only list contracts that have a matching status.

include_archived
boolean
is_archived
boolean
cover_document_docai_task_status
string
Enum: "idle" "processing"

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

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

Search contract by esign process with given status.

owner
string

Only list contracts owned by this user.

binder
string

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

recursive
boolean

Search in sub-binders also. True by default.

language
string

Only list contracts with the given main language.

num_files
integer

Number of files

num_main_pages
integer

Number of pages in main document.

num_activities
integer

Number of activities defined.

num_emails
integer

Number of emails attached.

num_signed_documents
integer

Number of documents which have valid signature.

minimal
boolean

Return only minimal data about each hit.

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

Only list contracts where current user has this permission.

similar
string

Show contracts similar to this contract.

similarity_level
string

The level of similarity of shown contracts.

activity_user
string

Contracts with activities related to a user

favorite_of
string

Favorites of this user.

incomplete
boolean

List only incomplete contracts

search
string

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

trashed
boolean

Return only deleted contracts

failed_task
string

Only list contract which processing has failed in given task

Responses

Response samples

Content type
application/json
{}

Trash > Empty > Create

Permanently delete all contracts from the trash.

Request Body schema:

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": 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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Trash > Delete

Permanently delete a single contract from the trash.

path Parameters
id
required
string

Responses

Trash > Partial update

Restore a single contract from the trash.

path Parameters
id
required
string
Request Body schema:

Responses

Request samples

Content type
{ }

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.

last_modified
string

Search contracts by the latest date they've been modified.

activities_times
string

A date range string.

pending_activities_times
string

Search contracts by the deadlines of their pending activities.

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

Only list contracts that have a matching status.

include_archived
boolean
is_archived
boolean
cover_document_docai_task_status
string
Enum: "idle" "processing"

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

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

Search contract by esign process with given status.

owner
string

Only list contracts owned by this user.

binder
string

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

recursive
boolean

Search in sub-binders also. True by default.

language
string

Only list contracts with the given main language.

num_files
integer

Number of files

num_main_pages
integer

Number of pages in main document.

num_activities
integer

Number of activities defined.

num_emails
integer

Number of emails attached.

num_signed_documents
integer

Number of documents which have valid signature.

minimal
boolean

Return only minimal data about each hit.

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

Only list contracts where current user has this permission.

similar
string

Show contracts similar to this contract.

similarity_level
string

The level of similarity of shown contracts.

activity_user
string

Contracts with activities related to a user

favorite_of
string

Favorites of this user.

incomplete
boolean

List only incomplete contracts

search
string

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

trashed
boolean

Return only deleted contracts

failed_task
string

Only list contract which processing has failed in given task

Responses

Response samples

Content type
application/json
{
  • "page_size": 123,
  • "page": 123,
  • "last_page": 123,
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

Create

Upload a new contract.

Request Body schema:
blob
string <uri>

The main contract document file.

title
string

The title of the contract.

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

Responses

Request samples

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

Response samples

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

Bulk contract party delete

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

The contract is missing some mandatory attributes.

num_users
integer [ 0 .. 2147483647 ]
status
string (StatusF43Enum)
Enum: "queued" "processing" "review" "done" "error" "limited"
  • queued - Queued for AI processing.
  • processing - Being processed.
  • review - Pending owner review.
  • done - All processing and reviews done.
  • error - Failed to process the contract
  • limited - Limited due to exceeding account.max_contracts
is_archived
boolean
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

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": 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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Bulk contract party update

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

The contract is missing some mandatory attributes.

num_users
integer [ 0 .. 2147483647 ]
status
string (StatusF43Enum)
Enum: "queued" "processing" "review" "done" "error" "limited"
  • queued - Queued for AI processing.
  • processing - Being processed.
  • review - Pending owner review.
  • done - All processing and reviews done.
  • error - Failed to process the contract
  • limited - Limited due to exceeding account.max_contracts
is_archived
boolean
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

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": 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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Bulk delete

Responses

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Bulk docai process

Run docai processing for selected contracts.

Responses

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Bulk extract metadata

Extract given meta attribute to selected contracts with ChatGPT

Responses

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Bulk update

Updates a large number of contracts.

Responses

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Read

path Parameters
id
required
string

Responses

Response samples

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

Delete

path Parameters
id
required
string

Responses

Partial update

path Parameters
id
required
string
Request Body schema:
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_archived
boolean
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

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

Response samples

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

Access > Read

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "profiles": [
    ],
  • "groups": [
    ]
}

Add file

Uploads a new attachment of any type to a contract.

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

New file to contract

folder
string or null

Responses

Request samples

Content type
{}

Response samples

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

Renew > Create

path Parameters
id
required
string
Request Body schema:
renewal_date
string <date>

Responses

Request samples

Content type
{
  • "renewal_date": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "cover_document": {
    },
  • "unverified_docai_attributes": "string",
  • "id": "string",
  • "incomplete": true,
  • "num_emails": 0,
  • "num_files": 0,
  • "num_users": 2147483647,
  • "matches": null,
  • "owner": {
    },
  • "parties": [
    ],
  • "permission": "string",
  • "receive_time": "2019-08-24T14:15:22Z",
  • "related_contracts": [
    ],
  • "status": "queued",
  • "is_archived": true,
  • "is_duplicate": true,
  • "favorite_of": [
    ],
  • "last_modified": "2019-08-24T14:15:22Z",
  • "first_docai_result_time": "2019-08-24T14:15:22Z",
  • "trashed": true,
  • "esigns": [
    ],
  • "num_signed_documents": 0,
  • "docai_skip": [
    ],
  • "attribute_coordinates": {
    },
  • "activities": [
    ],
  • "allow_emails": true,
  • "documents": [
    ],
  • "duplicates": [
    ],
  • "emails": [
    ],
  • "notes": [
    ],
  • "num_binders": 0,
  • "rated": true,
  • "taggings": [
    ],
  • "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:
required
required
object (Document)
incomplete
boolean

The contract is missing some mandatory attributes.

num_users
integer [ 0 .. 2147483647 ]
status
string (StatusF43Enum)
Enum: "queued" "processing" "review" "done" "error" "limited"
  • queued - Queued for AI processing.
  • processing - Being processed.
  • review - Pending owner review.
  • done - All processing and reviews done.
  • error - Failed to process the contract
  • limited - Limited due to exceeding account.max_contracts
is_archived
boolean
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

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": 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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Subsume

Subsume given contracts to the primary contract

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

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

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

List of properties include in the process.

Responses

Request samples

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

Response samples

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

Terminate > Create

path Parameters
id
required
string
Request Body schema:
required
archive
boolean
Default: false
termination_date
required
string <date>

Responses

Request samples

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

Response samples

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

Users > Read

path Parameters
id
required
string

Responses

Response samples

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

Activities > List

path Parameters
contract_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

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

Binders > List

path Parameters
contract_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "page_size": 123,
  • "page": 123,
  • "last_page": 123,
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

Binders > Create

Adds this contract to a binder.

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

Responses

Request samples

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

Response samples

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

Download

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

path Parameters
contract_id
required
string
Request Body schema:
frontend_status
string (FrontendStatusEnum)
Enum: "done" "failed" "pending" "processing"
  • done - Done
  • failed - Failed
  • pending - Pending
  • processing - Processing

Responses

Request samples

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

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Emails > Read

path Parameters
contract_id
required
string
email_id
required
string

Responses

Emails > Delete

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

Content type
application/json
{}

Folders > Create

path Parameters
contract_id
required
string
Request Body schema:
required
name
required
string
parent
string or null

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "contract": "string",
  • "documents": [
    ],
  • "name": "string",
  • "parent": "string",
  • "total_documents": "string"
}

Folders > Order > Create

path Parameters
contract_id
required
string
Request Body schema:
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

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "contract": "string",
  • "documents": [
    ],
  • "name": "string",
  • "parent": "string",
  • "total_documents": "string"
}

Folders > Read

path Parameters
contract_id
required
string
cryptid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "contract": "string",
  • "documents": [
    ],
  • "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:
name
string
parent
string or null

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "contract": "string",
  • "documents": [
    ],
  • "name": "string",
  • "parent": "string",
  • "total_documents": "string"
}

Folders > Update

path Parameters
contract_id
required
string
cryptid
required
string
Request Body schema:
required
name
required
string
parent
string or null

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "contract": "string",
  • "documents": [
    ],
  • "name": "string",
  • "parent": "string",
  • "total_documents": "string"
}

Memberships > List

path Parameters
contract_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

Memberships > Create

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

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

  • view: View-only access to the Binder and Contracts under this binder.

  • edit: Full access to view and edit Contracts under this binder, as well as adding/removing/editing Members.

  • full: TODO

  • view - View-only access

  • edit - Can view and edit contents

  • full - Full permissions

user
string
group
string
contract
required
string

Responses

Request samples

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

Response samples

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

Memberships > Read

path Parameters
contract_id
required
string
cryptid
required
string

Responses

Response samples

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

Memberships > Delete

path Parameters
contract_id
required
string
cryptid
required
string

Responses

Memberships > Partial update

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

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

  • view: View-only access to the Binder and Contracts under this binder.

  • edit: Full access to view and edit Contracts under this binder, as well as adding/removing/editing Members.

  • full: TODO

  • view - View-only access

  • edit - Can view and edit contents

  • full - Full permissions

contract
string

Responses

Request samples

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

Response samples

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

Memberships > Update

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

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

  • view: View-only access to the Binder and Contracts under this binder.

  • edit: Full access to view and edit Contracts under this binder, as well as adding/removing/editing Members.

  • full: TODO

  • view - View-only access

  • edit - Can view and edit contents

  • full - Full permissions

user
string
group
string
contract
required
string

Responses

Request samples

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

Response samples

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

Notes > Create

path Parameters
contract_id
required
string
Request Body schema:
content
string

The content of the note.

document
string

The id of the document associated with the note.

object

The highlighted section in the document.

Responses

Request samples

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

Response samples

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

Notes > Read

path Parameters
contract_id
required
string
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "contract_id": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "set_by": {
    },
  • "content": "string",
  • "document": "string",
  • "highlight": 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:
content
string

The content of the note.

document
string

The id of the document associated with the note.

object

The highlighted section in the document.

Responses

Request samples

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

Response samples

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

Parties > Create

path Parameters
contract_id
required
string
Request Body schema:
managed
boolean
public
boolean
role
string
party
string or null
docai_value_verified
boolean or null
name_in_document
string <= 1024 characters
object or null
object or null

Responses

Request samples

Content type
{
  • "managed": true,
  • "public": true,
  • "role": "string",
  • "party": "string",
  • "docai_value_verified": true,
  • "name_in_document": "string",
  • "name_coordinates": {
    },
  • "org_id_coordinates": {
    }
}

Response samples

Content type
application/json
{
  • "external_id": "string",
  • "id": "string",
  • "role_id": "string",
  • "role_name": "string",
  • "role": "string",
  • "editable": true,
  • "source": "ai",
  • "docai_value_verified": true,
  • "name_in_document": "string",
  • "name_coordinates": {
    },
  • "org_id_coordinates": {
    }
}

Parties > Delete

path Parameters
contract_id
required
string
id
required
string

Responses

Parties > Partial update

path Parameters
contract_id
required
string
id
required
string
Request Body schema:
docai_value_verified
boolean or null
role
string
name_in_document
string <= 1024 characters
object or null
object or null

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "external_id": "string",
  • "id": "string",
  • "role_id": "string",
  • "role_name": "string",
  • "role": "string",
  • "editable": true,
  • "source": "ai",
  • "docai_value_verified": true,
  • "name_in_document": "string",
  • "name_coordinates": {
    },
  • "org_id_coordinates": {
    }
}

Relationships > List

path Parameters
contract_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{}

Relationships > Create

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

Responses

Request samples

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

Response samples

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

Relationships > Read

path Parameters
contract_id
required
string
cryptid
required
string

Responses

Response samples

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

Relationships > Delete

path Parameters
contract_id
required
string
cryptid
required
string

Responses

Relationships > Partial update

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

Responses

Request samples

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

Response samples

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

Relationships > Update

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

Responses

Request samples

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

Response samples

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

Signatures > List

path Parameters
contract_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "page_size": 123,
  • "page": 123,
  • "last_page": 123,
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

Signatures > Read

path Parameters
contract_id
required
string
cryptid
required
string

Responses

Response samples

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

Esigns

Validate > Create

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

Validation id of the esign.

file_sha256
required
string

SHA-256 hash of the signed document.

Responses

Request samples

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

Response samples

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

Soft validate > Create

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

Validation id of the esign.

Responses

Request samples

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

Response samples

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

List

List e-signs

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

q
string

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

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

Status of the e-sign.

owner
string

E-signs owned by specific user

activated_at
string

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

created_at
string

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

deadline
string

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

status_saved_at
string

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

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

Sort results by key.

Responses

Response samples

Content type
application/json
{
  • "page_size": 123,
  • "page": 123,
  • "last_page": 123,
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

Create

Request Body schema:
required
attachments
Array of any

List of attachment document IDs

contract
required
string

ID of the Contract to attach this esign to.

contract_binders
Array of strings

List of binders where signed contract is moved

deadline
string or null <date-time>

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

document
string

ID of the Document to attach this esign to

greetings
string or null <= 2048 characters
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

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

update_documents
boolean

Will documents be updated. This is effective only if no signers exist.

Responses

Request samples

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

Response samples

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

Read

path Parameters
id
required
integer

A unique integer value identifying this esign.

Responses

Response samples

Content type
application/json
{
  • "activated": true,
  • "activated_at": "2019-08-24T14:15:22Z",
  • "available_until": "2019-08-24T14:15:22Z",
  • "contract": "string",
  • "contract_binders": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "deadline": "2019-08-24T14:15:22Z",
  • "documents": [
    ],
  • "form_submission": "string",
  • "greetings": "string",
  • "id": "string",
  • "merge_documents": true,
  • "need_auth_to_view_documents": true,
  • "owner": {
    },
  • "parties": [
    ],
  • "sender_name": "string",
  • "sign_order": "parallel",
  • "signed": true,
  • "status": "draft",
  • "status_saved_at": "2019-08-24T14:15:22Z",
  • "update_documents": true,
  • "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:
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 <= 2048 characters
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

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

update_documents
boolean

Will documents be updated. This is effective only if no signers exist.

Responses

Request samples

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

Response samples

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

Activate

Activate e-sign for signing and send signing requests

path Parameters
id
required
integer

A unique integer value identifying this esign.

Responses

Response samples

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

Cancel

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

path Parameters
id
required
integer

A unique integer value identifying this esign.

Responses

Response samples

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

Complete

Completes the e-sign process

path Parameters
id
required
integer

A unique integer value identifying this esign.

Request Body schema:
available_until
string or null <date-time>

After signing is completed, links are available until this time

Responses

Request samples

Content type
{
  • "available_until": "2019-08-24T14:15:22Z"
}

Response samples

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

Reactivate

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

path Parameters
id
required
integer

A unique integer value identifying this esign.

Responses

Response samples

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

Resend completed

Resend e-sign completed e-mails to all parties

path Parameters
id
required
integer

A unique integer value identifying this esign.

Responses

Response samples

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

Parties > List

path Parameters
esign_id
required
integer
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "page_size": 123,
  • "page": 123,
  • "last_page": 123,
  • "count": 123,
  • "next": "http://api.example.org/accounts/?page=4",
  • "previous": "http://api.example.org/accounts/?page=2",
  • "results": [
    ]
}

Parties > Create

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

Does viewing documents need authentication

ordinal
integer >= 1

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

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

Responses

Request samples

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

Response samples

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

Parties > Read

path Parameters
esign_id
required
integer
id
required
integer

A unique integer value identifying this esign party.

Responses

Response samples

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

Parties > Delete

path Parameters
esign_id
required
integer
id
required
integer

A unique integer value identifying this esign party.

Responses

Parties > Partial update

path Parameters
esign_id
required
integer
id
required
integer

A unique integer value identifying this esign party.

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

Does viewing documents need authentication

ordinal
integer >= 1

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

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

Responses

Request samples

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

Response samples

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

Parties > Resend completed

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

path Parameters
esign_id
required
integer
id
required
integer

A unique integer value identifying this esign party.

Responses

Response samples

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

Parties > Resend invitation

Resend signing or approval invitation to e-sign party

path Parameters
esign_id
required
integer
id
required
integer

A unique integer value identifying this esign party.

Responses

Response samples

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

Documents > Download

Download given e-sign document

path Parameters
esign_id
required
integer
id
required
integer

A unique integer value identifying this esign document.

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

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

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

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

Create

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

Responses

Request samples

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

Response samples

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",
  • "created_by": "string",
  • "is_esign_target": false
}

Access report > Read

Responses

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Bulk rename

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

Responses

Request samples

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

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Check access > Read

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

Responses

Response samples

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",
  • "created_by": "string",
  • "is_esign_target": false
}

Read

path Parameters
id
required
string

Responses

Response samples

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",
  • "created_by": "string",
  • "is_esign_target": false,
  • "members": "string",
  • "deleted": true
}

Update

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

Responses

Request samples

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

Response samples

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",
  • "created_by": "string",
  • "is_esign_target": false
}

Partial update

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

Responses

Request samples

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

Response samples

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",
  • "created_by": "string",
  • "is_esign_target": false
}

Delete

path Parameters
id
required
string

Responses

Download

path Parameters
id
required
string
Request Body schema:
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

Content type
{
  • "include_ids": false,
  • "create_contract_folders": true,
  • "include_subfolders": true
}

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Merge

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

Responses

Request samples

Content type
{
  • "merged": [
    ]
}

Response samples

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",
  • "created_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

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

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

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

Contracts > Add

Adds contracts to binder.

path Parameters
binder_id
required
string

Responses

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Contracts > Bulk Remove

Removes contracts from binder.

path Parameters
binder_id
required
string

Responses

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Contracts > Delete

Removes a contract from a binder

path Parameters
binder_id
required
string
id
required
string

Responses

Response samples

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",
  • "created_by": "string",
  • "is_esign_target": false
}

Account

Attributes > List

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Attributes > Create

Request Body schema:
required
object
associated_model
required
string (MetaAttributeAssociatedModelEnum)
Enum: "contract" "party"
  • contract - contract
  • party - party
attribute_type
string (AttributeTypeEnum)
Enum: "text-singleline" "text-multiline" "number" "date" "parties" "owner" "taggings" "boolean" "choice" "sequence" "multichoice" "list" "language" "country" "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
  • country - Country selection field
  • 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 <= 6144 characters

Question used to populate meta attribute values

auto_extract
boolean

Auto populate contracts with question to AI

unique
boolean

Value of this field is unique.

Responses

Request samples

Content type
{
  • "label_translations": {
    },
  • "associated_model": "contract",
  • "attribute_type": "text-singleline",
  • "placeholder_translations": {
    },
  • "ui_extra_info_translations": {
    },
  • "custom_fields": [
    ],
  • "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,
  • "unique": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "label": "string",
  • "label_translations": {
    },
  • "associated_model": "contract",
  • "attribute_type": "text-singleline",
  • "defaults": [
    ],
  • "placeholder": "string",
  • "placeholder_translations": {
    },
  • "ui_extra_info": "string",
  • "ui_extra_info_translations": {
    },
  • "custom_fields": [
    ],
  • "automatic_reminders": true,
  • "mandatory": true,
  • "deletable": true,
  • "parent": "string",
  • "subfield": "string",
  • "static_fields": [
    ],
  • "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,
  • "unique": true
}

Attributes > Read

path Parameters
cryptid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "label": "string",
  • "label_translations": {
    },
  • "associated_model": "contract",
  • "attribute_type": "text-singleline",
  • "defaults": [
    ],
  • "placeholder": "string",
  • "placeholder_translations": {
    },
  • "ui_extra_info": "string",
  • "ui_extra_info_translations": {
    },
  • "custom_fields": [
    ],
  • "automatic_reminders": true,
  • "mandatory": true,
  • "deletable": true,
  • "parent": "string",
  • "subfield": "string",
  • "static_fields": [
    ],
  • "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,
  • "unique": true
}

Attributes > Delete

path Parameters
cryptid
required
string

Responses

Attributes > Partial update

path Parameters
cryptid
required
string
Request Body schema:
object
associated_model
string (MetaAttributeAssociatedModelEnum)
Enum: "contract" "party"
  • contract - contract
  • party - party
attribute_type
string (AttributeTypeEnum)
Enum: "text-singleline" "text-multiline" "number" "date" "parties" "owner" "taggings" "boolean" "choice" "sequence" "multichoice" "list" "language" "country" "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
  • country - Country selection field
  • 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 <= 6144 characters

Question used to populate meta attribute values

auto_extract
boolean

Auto populate contracts with question to AI

unique
boolean

Value of this field is unique.

Responses

Request samples

Content type
{
  • "label_translations": {
    },
  • "associated_model": "contract",
  • "attribute_type": "text-singleline",
  • "placeholder_translations": {
    },
  • "ui_extra_info_translations": {
    },
  • "custom_fields": [
    ],
  • "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,
  • "unique": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "label": "string",
  • "label_translations": {
    },
  • "associated_model": "contract",
  • "attribute_type": "text-singleline",
  • "defaults": [
    ],
  • "placeholder": "string",
  • "placeholder_translations": {
    },
  • "ui_extra_info": "string",
  • "ui_extra_info_translations": {
    },
  • "custom_fields": [
    ],
  • "automatic_reminders": true,
  • "mandatory": true,
  • "deletable": true,
  • "parent": "string",
  • "subfield": "string",
  • "static_fields": [
    ],
  • "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,
  • "unique": true
}

Attributes > Update

path Parameters
cryptid
required
string
Request Body schema:
required
object
associated_model
required
string (MetaAttributeAssociatedModelEnum)
Enum: "contract" "party"
  • contract - contract
  • party - party
attribute_type
string (AttributeTypeEnum)
Enum: "text-singleline" "text-multiline" "number" "date" "parties" "owner" "taggings" "boolean" "choice" "sequence" "multichoice" "list" "language" "country" "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
  • country - Country selection field
  • 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 <= 6144 characters

Question used to populate meta attribute values

auto_extract
boolean

Auto populate contracts with question to AI

unique
boolean

Value of this field is unique.

Responses

Request samples

Content type
{
  • "label_translations": {
    },
  • "associated_model": "contract",
  • "attribute_type": "text-singleline",
  • "placeholder_translations": {
    },
  • "ui_extra_info_translations": {
    },
  • "custom_fields": [
    ],
  • "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,
  • "unique": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "label": "string",
  • "label_translations": {
    },
  • "associated_model": "contract",
  • "attribute_type": "text-singleline",
  • "defaults": [
    ],
  • "placeholder": "string",
  • "placeholder_translations": {
    },
  • "ui_extra_info": "string",
  • "ui_extra_info_translations": {
    },
  • "custom_fields": [
    ],
  • "automatic_reminders": true,
  • "mandatory": true,
  • "deletable": true,
  • "parent": "string",
  • "subfield": "string",
  • "static_fields": [
    ],
  • "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,
  • "unique": true
}

Attributelayouts > Party > Default > 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

Content type
application/json
{}

Attributelayouts > Party > Default > Create

Request Body schema:
required
associated_model
string (LayoutAssociatedModelEnum)
Enum: "contract" "party"
  • contract - Contract
  • party - Party
name
required
string <= 100 characters
required
Array of objects (LayoutAttributeSection)

Responses

Request samples

Content type
{
  • "associated_model": "contract",
  • "name": "string",
  • "sections": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "associated_model": "contract",
  • "name": "string",
  • "sections": [
    ]
}

Attributelayouts > Party > Default > Read

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "associated_model": "contract",
  • "name": "string",
  • "sections": [
    ]
}

Attributelayouts > Party > Default > Delete

path Parameters
id
required
string

Responses

Attributelayouts > Party > Default > Partial update

path Parameters
id
required
string
Request Body schema:
associated_model
string (LayoutAssociatedModelEnum)
Enum: "contract" "party"
  • contract - Contract
  • party - Party
name
string <= 100 characters
Array of objects (LayoutAttributeSection)

Responses

Request samples

Content type
{
  • "associated_model": "contract",
  • "name": "string",
  • "sections": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "associated_model": "contract",
  • "name": "string",
  • "sections": [
    ]
}

Attributelayouts > Party > Default > Update

path Parameters
id
required
string
Request Body schema:
required
associated_model
string (LayoutAssociatedModelEnum)
Enum: "contract" "party"
  • contract - Contract
  • party - Party
name
required
string <= 100 characters
required
Array of objects (LayoutAttributeSection)

Responses

Request samples

Content type
{
  • "associated_model": "contract",
  • "name": "string",
  • "sections": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "associated_model": "contract",
  • "name": "string",
  • "sections": [
    ]
}

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

Content type
application/json
{}

Attributes > Choices > Create

path Parameters
attribute_cryptid
required
string
Request Body schema:
required
required
object
position
integer >= 0
Default: 0
is_default
boolean
object

Responses

Request samples

Content type
{
  • "value_translations": {
    },
  • "position": 0,
  • "is_default": true,
  • "custom_values": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "value": "string",
  • "value_translations": {
    },
  • "position": 0,
  • "is_default": true
}

Attributes > Choices > 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_cryptid}/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:
object
position
integer >= 0
Default: 0
is_default
boolean
object

Responses

Request samples

Content type
{
  • "value_translations": {
    },
  • "position": 0,
  • "is_default": true,
  • "custom_values": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "value": "string",
  • "value_translations": {
    },
  • "position": 0,
  • "is_default": true
}

Attributes > Choices > Order > Create

path Parameters
attribute_cryptid
required
string
Request Body schema:
required
order
required
Array of strings

Responses

Request samples

Content type
{
  • "order": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "value": "string",
  • "value_translations": {
    },
  • "position": 0,
  • "is_default": true
}

Attributes > Choices > Read

path Parameters
attribute_cryptid
required
string
cryptid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "value": "string",
  • "value_translations": {
    },
  • "position": 0,
  • "is_default": true
}

Attributes > Choices > Update

path Parameters
attribute_cryptid
required
string
cryptid
required
string
Request Body schema:
required
required
object
position
integer >= 0
Default: 0
is_default
boolean
object

Responses

Request samples

Content type
{
  • "value_translations": {
    },
  • "position": 0,
  • "is_default": true,
  • "custom_values": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "value": "string",
  • "value_translations": {
    },
  • "position": 0,
  • "is_default": true
}

Attributes > Choices > Partial update

path Parameters
attribute_cryptid
required
string
cryptid
required
string
Request Body schema:
object
position
integer >= 0
Default: 0
is_default
boolean
object

Responses

Request samples

Content type
{
  • "value_translations": {
    },
  • "position": 0,
  • "is_default": true,
  • "custom_values": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "value": "string",
  • "value_translations": {
    },
  • "position": 0,
  • "is_default": true
}

Attributes > Choices > Delete

path Parameters
attribute_cryptid
required
string
cryptid
required
string

Responses

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

Content type
application/json
{}

Attributes > Custom fields > Create

path Parameters
attribute_cryptid
required
string
Request Body schema:
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

Content type
{
  • "label_translations": {
    },
  • "visible": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "label": "string",
  • "label_translations": {
    },
  • "name": "string",
  • "visible": true
}

Attributes > Custom fields > Read

path Parameters
attribute_cryptid
required
string
cryptid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "label": "string",
  • "label_translations": {
    },
  • "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:
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

Content type
{
  • "label_translations": {
    },
  • "visible": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "label": "string",
  • "label_translations": {
    },
  • "name": "string",
  • "visible": true
}

Attributes > Custom fields > Update

path Parameters
attribute_cryptid
required
string
cryptid
required
string
Request Body schema:
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

Content type
{
  • "label_translations": {
    },
  • "visible": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "label": "string",
  • "label_translations": {
    },
  • "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: administrators_remaining, related_contracts_enabled, max_viewers, docai_suggest_new_parties, all_parties_public, quickedit_enabled, max_signers, require_admin_license_for_empty_trash, floating_administrators, can_manage_forms_default, allowed_email_senders, viewers_remaining, can_create_esigns_default, trial_ends, floating_editors, status, max_administrators, custom_logo_enabled, webhooks_enabled, organizations, automatically_empty_trash, ai_chat_licences_remaining, signers_remaining, api_enabled, can_manage_parties_default, can_manage_binders_default, floating_viewers, static_meta_attribute_fields_by_type, can_create_tags_default, party_manager_enabled, ai_chat_licences, editors_remaining, session_max_age, can_create_contracts_default, max_editors, eventlog_access, allowed_ips, session_window

Responses

Response samples

Content type
application/json
{
  • "ai_chat_enabled": true,
  • "ai_chat_hidden": true,
  • "allow_access_requests": true,
  • "allowed_esign_authentication_methods": [
    ],
  • "available_insights": [
    ],
  • "beta": true,
  • "binder_suggestions_enabled": true,
  • "can_manage_esigns": true,
  • "signatures_enabled": true,
  • "can_mass_download_contracts_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_meta_attributes": {
    },
  • "contract_metadata_layout": {
    },
  • "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": [
    ],
  • "default_search": {
    },
  • "default_table_columns": [
    ],
  • "docusign_personal_integration_enabled": true,
  • "enabled_languages": [
    ],
  • "esign_select_option_to_merge_documents_by_default": true,
  • "esign_mode": "production",
  • "eventlogs_enabled": true,
  • "extra_party_fields": "string",
  • "extract_metadata_enabled": true,
  • "forms_enabled": true,
  • "inboxes_enabled": true,
  • "incoming_email_enabled": true,
  • "insights_enabled": true,
  • "key_dates_enabled": true,
  • "mandatory_contract_fields": true,
  • "mandatory_settings": {
    },
  • "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": [
    ],
  • "similar_contracts_enabled": true,
  • "sso_domains": [
    ],
  • "uses_local_llm": true,
  • "administrators_remaining": 0,
  • "ai_chat_licences": 0,
  • "ai_chat_licences_remaining": 0,
  • "all_parties_public": true,
  • "allowed_email_senders": [
    ],
  • "allowed_ips": [
    ],
  • "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,
  • "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": {
    },
  • "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:
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
signatures_enabled
boolean
can_manage_forms_default
boolean
can_manage_parties_default
boolean
can_mass_download_contracts_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" "de" "en-us" "es" "et" "fi" "lt" "lv" "nb" "nl" "pl" "sv"
(EsignModeEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
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_european_unique_identifier" "CUSTOM_lei_id" "CUSTOM_otava_customer" "CUSTOM_otava_link" "CUSTOM_otava_tietosuoja" "CUSTOM_soparo_code" "CUSTOM_soparo_type" "CUSTOM_spankki_alfa_rating" "CUSTOM_spankki_counterparty_approval_date" "CUSTOM_spankki_counterparty_approver" "CUSTOM_spankki_counterparty_approver_business_function" "CUSTOM_spankki_counterparty_approver_other" "CUSTOM_spankki_countries" "CUSTOM_spankki_date_of_verification" "CUSTOM_spankki_documentation" "CUSTOM_spankki_financial_entity" "CUSTOM_spankki_financial_entity_currency" "CUSTOM_spankki_financial_situation_review_date" "CUSTOM_spankki_group_country" "CUSTOM_spankki_group_lei" "CUSTOM_spankki_hierarchy_entity_group" "CUSTOM_spankki_ict_provider_annual_expenditure" "CUSTOM_spankki_ict_provider_annual_expenditure_currency" "CUSTOM_spankki_ownership_structure_review_date" "CUSTOM_spankki_parent_company_risk" "CUSTOM_spankki_parent_group_lei" "CUSTOM_spankki_partner_classification" "CUSTOM_spankki_subscriber_liability_status" "CUSTOM_spankki_type_of_entity" "CUSTOM_spankki_type_of_ict_provider" "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).
uses_local_llm
boolean

Responses

Request samples

Content type
{
  • "ai_chat_hidden": true,
  • "all_parties_public": true,
  • "allow_access_requests": true,
  • "allowed_email_senders": [
    ],
  • "allowed_esign_authentication_methods": [
    ],
  • "allowed_ips": [
    ],
  • "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,
  • "signatures_enabled": true,
  • "can_manage_forms_default": true,
  • "can_manage_parties_default": true,
  • "can_mass_download_contracts_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": [
    ],
  • "default_search": "string",
  • "default_table_columns": [
    ],
  • "docai_suggest_new_parties": true,
  • "enabled_languages": [
    ],
  • "esign_mode": "production",
  • "eventlog_access": "administrator",
  • "extra_party_fields": [
    ],
  • "incoming_email_enabled": true,
  • "mandatory_settings": {
    },
  • "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": [
    ],
  • "require_admin_license_for_empty_trash": true,
  • "session_max_age": 1,
  • "session_window": 1,
  • "uses_local_llm": true
}

Response samples

Content type
application/json
{
  • "ai_chat_enabled": true,
  • "ai_chat_hidden": true,
  • "allow_access_requests": true,
  • "allowed_esign_authentication_methods": [
    ],
  • "available_insights": [
    ],
  • "beta": true,
  • "binder_suggestions_enabled": true,
  • "can_manage_esigns": true,
  • "signatures_enabled": true,
  • "can_mass_download_contracts_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_meta_attributes": {
    },
  • "contract_metadata_layout": {
    },
  • "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": [
    ],
  • "default_search": {
    },
  • "default_table_columns": [
    ],
  • "docusign_personal_integration_enabled": true,
  • "enabled_languages": [
    ],
  • "esign_select_option_to_merge_documents_by_default": true,
  • "esign_mode": "production",
  • "eventlogs_enabled": true,
  • "extra_party_fields": "string",
  • "extract_metadata_enabled": true,
  • "forms_enabled": true,
  • "inboxes_enabled": true,
  • "incoming_email_enabled": true,
  • "insights_enabled": true,
  • "key_dates_enabled": true,
  • "mandatory_contract_fields": true,
  • "mandatory_settings": {
    },
  • "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": [
    ],
  • "similar_contracts_enabled": true,
  • "sso_domains": [
    ],
  • "uses_local_llm": true,
  • "administrators_remaining": 0,
  • "ai_chat_licences": 0,
  • "ai_chat_licences_remaining": 0,
  • "all_parties_public": true,
  • "allowed_email_senders": [
    ],
  • "allowed_ips": [
    ],
  • "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,
  • "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": {
    },
  • "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

Content type
application/json
{
  • "id": "string",
  • "attribute_id": "string",
  • "name": "string",
  • "name_translations": {
    },
  • "automatic": true,
  • "value": "string"
}

Attributes > Defaults > Partial update

path Parameters
attribute_id
required
string
id
required
string
Request Body schema:
object
automatic
boolean
value
string

Responses

Request samples

Content type
{
  • "name_translations": {
    },
  • "automatic": true,
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "attribute_id": "string",
  • "name": "string",
  • "name_translations": {
    },
  • "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

Content type
application/json
{
  • "attribute_id": "string",
  • "name_translations": {
    },
  • "automatic": true,
  • "value": "string"
}

Attributes > Defaults > Create

path Parameters
attribute_id
required
string
Request Body schema:
required
object
automatic
boolean
value
required
string

Responses

Request samples

Content type
{
  • "name_translations": {
    },
  • "automatic": true,
  • "value": "string"
}

Response samples

Content type
application/json
{
  • "attribute_id": "string",
  • "name_translations": {
    },
  • "automatic": true,
  • "value": "string"
}

Activities

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

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

Create

Request Body schema:
required
title
required
string <= 512 characters

Activity title

description
string <= 10240 characters
completed
boolean
complete_reason
string <= 2048 characters

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
complete_by_email
boolean
owner_is_recipient
boolean

Contract owner always a reminder recipient.

related_meta_attribute
string

Responses

Request samples

Content type
{
  • "title": "string",
  • "description": "string",
  • "completed": true,
  • "complete_reason": "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

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": 0,
  • "num_reminders": 0,
  • "recipients": {
    },
  • "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

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": 0,
  • "num_reminders": 0,
  • "recipients": {
    },
  • "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:
title
string <= 512 characters

Activity title

description
string <= 10240 characters
completed
boolean
complete_reason
string <= 2048 characters

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
complete_by_email
boolean
owner_is_recipient
boolean

Contract owner always a reminder recipient.

related_meta_attribute
string

Responses

Request samples

Content type
{
  • "title": "string",
  • "description": "string",
  • "completed": true,
  • "complete_reason": "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

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": 0,
  • "num_reminders": 0,
  • "recipients": {
    },
  • "recurrence": "once",
  • "has_recurred": true,
  • "complete_by_email": true,
  • "contract": "string",
  • "owner_is_recipient": true,
  • "related_meta_attribute": "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

Content type
application/json
{}

Groups > Create

path Parameters
activity_id
required
string
Request Body schema:
required
group
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "count": 0,
  • "idp_groups": "string",
  • "default_binder": {
    }
}

Groups > Delete

path Parameters
activity_id
required
string
id
required
string

Responses

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

Content type
application/json
{}

Reminders > Create

path Parameters
activity_id
required
string
Request Body schema:
timedelta_type
string (TimedeltaTypeEnum)
Enum: "days" "weeks" "months"
  • days - Days
  • weeks - Weeks
  • months - Months
timedelta_count
integer [ 0 .. 2147483647 ]

Responses

Request samples

Content type
{
  • "timedelta_type": "days",
  • "timedelta_count": 2147483647
}

Response samples

Content type
application/json
{
  • "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:
timedelta_type
string (TimedeltaTypeEnum)
Enum: "days" "weeks" "months"
  • days - Days
  • weeks - Weeks
  • months - Months
timedelta_count
integer [ 0 .. 2147483647 ]

Responses

Request samples

Content type
{
  • "timedelta_type": "days",
  • "timedelta_count": 2147483647
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "activity_id": "string",
  • "timedelta_type": "days",
  • "timedelta_count": 2147483647
}

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

Content type
application/json
{}

Users > Create

path Parameters
activity_id
required
string
Request Body schema:
required
user
required
string

Responses

Request samples

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

Response samples

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": 0,
  • "num_reminders": 0,
  • "recipients": {
    },
  • "recurrence": "once",
  • "has_recurred": true,
  • "complete_by_email": true,
  • "contract": "string",
  • "owner_is_recipient": true,
  • "related_meta_attribute": "string"
}

Users > Delete

path Parameters
activity_id
required
string
id
required
string

Responses

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

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

Lists > Create

path Parameters
activity_id
required
string
Request Body schema:
required
list_attribute
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "label": "string",
  • "label_translations": {
    },
  • "associated_model": "contract",
  • "attribute_type": "text-singleline",
  • "defaults": [
    ],
  • "placeholder": "string",
  • "placeholder_translations": {
    },
  • "ui_extra_info": "string",
  • "ui_extra_info_translations": {
    },
  • "custom_fields": [
    ],
  • "automatic_reminders": true,
  • "mandatory": true,
  • "deletable": true,
  • "parent": "string",
  • "subfield": "string",
  • "static_fields": [
    ],
  • "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,
  • "unique": true
}

Lists > Delete

path Parameters
activity_id
required
string
id
required
string

Responses

Chat

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

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

Create

Request Body schema:
required
source_document
string
user_input
required
string <= 10240 characters
source_token_start
integer
require_quote
boolean
root_chat_response
string

Responses

Request samples

Content type
{
  • "source_document": "string",
  • "user_input": "string",
  • "source_token_start": 0,
  • "require_quote": true,
  • "root_chat_response": "string"
}

Response samples

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": {
    },
  • "require_quote": true,
  • "root_chat_response": "string"
}

Read

path Parameters
cryptid
required
string

Responses

Response samples

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": {
    },
  • "require_quote": true,
  • "root_chat_response": "string"
}

Delete

path Parameters
cryptid
required
string

Responses

Documents

Create

Uploads a new attachment to a contract.

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

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": [
    ],
  • "status": "queued",
  • "taggings": [
    ],
  • "text_available": true,
  • "valid_signature": true
}

Read

path Parameters
id
required
string

Responses

Response samples

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": [
    ],
  • "status": "queued",
  • "taggings": [
    ],
  • "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:
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

Content type
No sample

Response samples

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

Content type
No sample

Response samples

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

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

Download

A download/embed link for the original document file.

path Parameters
id
required
string

Responses

Esignsenders

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

Content type
application/json
{}

Create

Request Body schema:
required
name
required
string <= 256 characters

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "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

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:
name
string <= 256 characters

Responses

Request samples

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

Response samples

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:
required
name
required
string <= 256 characters

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Groups

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

Content type
application/json
{}

Create

Request Body schema:
required
name
required
string

The name of the group

default_binder
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "default_binder": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "count": 0,
  • "idp_groups": "string",
  • "default_binder": {
    }
}

Read

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "count": 0,
  • "idp_groups": "string",
  • "default_binder": {
    }
}

Delete

path Parameters
id
required
string

Responses

Partial update

path Parameters
id
required
string
Request Body schema:
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

Content type
{
  • "name": "string",
  • "idp_groups": "string",
  • "default_binder": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "count": 0,
  • "idp_groups": "string",
  • "default_binder": {
    }
}

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

Content type
application/json
{}

Users > Create

Adds a user to the group.

path Parameters
group_id
required
string
Request Body schema:
required
user
required
string

Responses

Request samples

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

Response samples

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

Users > Delete

Deletes a user from the group.

path Parameters
group_id
required
string
user_id
required
string

Responses

Inboxes

List

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create

Request Body schema:
binder
string or null
contract_owner
string
is_personal
boolean or null
Default: true

Responses

Request samples

Content type
{
  • "binder": "string",
  • "contract_owner": "string",
  • "is_personal": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "address": "string",
  • "binder": "string",
  • "binder_name": "string",
  • "binder_path": "string",
  • "contract_owner": "string",
  • "profile": {
    },
  • "type": "string"
}

Read

path Parameters
cryptid
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "address": "string",
  • "binder": "string",
  • "binder_name": "string",
  • "binder_path": "string",
  • "contract_owner": "string",
  • "profile": {
    },
  • "type": "string"
}

Delete

path Parameters
cryptid
required
string

Responses

Partial update

path Parameters
cryptid
required
string
Request Body schema:
binder
string or null
contract_owner
string
is_personal
boolean or null
Default: true

Responses

Request samples

Content type
{
  • "binder": "string",
  • "contract_owner": "string",
  • "is_personal": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "address": "string",
  • "binder": "string",
  • "binder_name": "string",
  • "binder_path": "string",
  • "contract_owner": "string",
  • "profile": {
    },
  • "type": "string"
}

Update

path Parameters
cryptid
required
string
Request Body schema:
binder
string or null
contract_owner
string
is_personal
boolean or null
Default: true

Responses

Request samples

Content type
{
  • "binder": "string",
  • "contract_owner": "string",
  • "is_personal": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "address": "string",
  • "binder": "string",
  • "binder_name": "string",
  • "binder_path": "string",
  • "contract_owner": "string",
  • "profile": {
    },
  • "type": "string"
}

Reset address > Create

path Parameters
cryptid
required
string
Request Body schema:
binder
string or null
contract_owner
string
is_personal
boolean or null
Default: true

Responses

Request samples

Content type
{
  • "binder": "string",
  • "contract_owner": "string",
  • "is_personal": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "address": "string",
  • "binder": "string",
  • "binder_name": "string",
  • "binder_path": "string",
  • "contract_owner": "string",
  • "profile": {
    },
  • "type": "string"
}

Keys

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

Content type
application/json
{}

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

Content type
{
  • "name": "string",
  • "user": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "user": "string",
  • "key": "string"
}

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

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "user": "string"
}

Delete

path Parameters
id
required
string

Responses

Members

Create

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

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

  • view: View-only access to the Binder and Contracts under this binder.

  • edit: Full access to view and edit Contracts under this binder, as well as adding/removing/editing Members.

  • full: TODO

  • view - View-only access

  • edit - Can view and edit contents

  • full - Full permissions

user
string
group
string
binder
required
string

Responses

Request samples

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

Response samples

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

Bulk share binder

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

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

  • view: View-only access to the Binder and Contracts under this binder.

  • edit: Full access to view and edit Contracts under this binder, as well as adding/removing/editing Members.

  • full: TODO

  • view - View-only access

  • edit - Can view and edit contents

  • full - Full permissions

user
string
group
string
binder
required
string

Responses

Request samples

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

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Bulk unshare binder

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

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

  • view: View-only access to the Binder and Contracts under this binder.

  • edit: Full access to view and edit Contracts under this binder, as well as adding/removing/editing Members.

  • full: TODO

  • view - View-only access

  • edit - Can view and edit contents

  • full - Full permissions

user
string
group
string
binder
required
string

Responses

Request samples

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

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Update

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

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

  • view: View-only access to the Binder and Contracts under this binder.

  • edit: Full access to view and edit Contracts under this binder, as well as adding/removing/editing Members.

  • full: TODO

  • view - View-only access

  • edit - Can view and edit contents

  • full - Full permissions

user
string
group
string
binder
required
string

Responses

Request samples

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

Response samples

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

Delete

path Parameters
cryptid
required
string

Responses

Partial update

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

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

  • view: View-only access to the Binder and Contracts under this binder.

  • edit: Full access to view and edit Contracts under this binder, as well as adding/removing/editing Members.

  • full: TODO

  • view - View-only access

  • edit - Can view and edit contents

  • full - Full permissions

binder
string

Responses

Request samples

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

Response samples

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

Parties

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: "-attributes" "-created_at" "-external_id" "-is_merging" "-managed" "-num_contracts" "-public" "-updated_at" "attributes" "created_at" "external_id" "is_merging" "managed" "num_contracts" "public" "updated_at"

Sort results by key.

Responses

Response samples

Content type
application/json
{}

Create

Request Body schema:
managed
boolean

Explicitly managed party (exists even without contracts)

public
boolean

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

Responses

Request samples

Content type
{
  • "managed": true,
  • "public": true
}

Response samples

Content type
application/json
{
  • "external_id": "string",
  • "id": "string",
  • "num_contracts": "string",
  • "managed": true,
  • "public": true,
  • "is_merging": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_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/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:
managed
boolean

Explicitly managed party (exists even without contracts)

public
boolean

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

Responses

Request samples

Content type
{
  • "managed": true,
  • "public": true
}

Response samples

Content type
application/json
{
  • "external_id": "string",
  • "id": "string",
  • "num_contracts": "string",
  • "managed": true,
  • "public": true,
  • "is_merging": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Merge

Merges two or more parties to a new combined party.

Request Body schema:
required
managed
boolean
Default: true

Explicitly managed party (exists even without contracts)

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)

merged
required
Array of strings

List of parties to be merged.

Responses

Request samples

Content type
{
  • "managed": true,
  • "name": "string",
  • "org_id": "string",
  • "merged": [
    ]
}

Response samples

Content type
application/json
{
  • "external_id": "string",
  • "id": "string",
  • "num_contracts": "string",
  • "managed": true,
  • "public": true,
  • "is_merging": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Read

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "external_id": "string",
  • "id": "string",
  • "num_contracts": "string",
  • "managed": true,
  • "public": true,
  • "is_merging": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete

path Parameters
id
required
string

Responses

Partial update

path Parameters
id
required
string
Request Body schema:
managed
boolean

Explicitly managed party (exists even without contracts)

public
boolean

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

Responses

Request samples

Content type
{
  • "managed": true,
  • "public": true
}

Response samples

Content type
application/json
{
  • "external_id": "string",
  • "id": "string",
  • "num_contracts": "string",
  • "managed": true,
  • "public": true,
  • "is_merging": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Roles

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

Content type
application/json
{}

Create

Request Body schema:
required
name
required
string

Responses

Request samples

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

Response samples

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

Content type
application/json
{
  • "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:
name
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "is_editable": true,
  • "created_by": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

Searches

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

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

Actions > Create

Request Body schema:
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>
required
Array of objects (SearchActionNotificationReceiver)
enabled
boolean

Responses

Request samples

Content type
{
  • "name": "New search action",
  • "search": "string",
  • "search_obj": {
    },
  • "action": "notify",
  • "occurrence": "immediate",
  • "days": [
    ],
  • "time": "14:15:22Z",
  • "receivers": [
    ],
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "New search action",
  • "search": "string",
  • "action": "notify",
  • "occurrence": "immediate",
  • "days": [
    ],
  • "time": "14:15:22Z",
  • "receivers": [
    ],
  • "latest_check": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "created_by": "string"
}

Actions > Read

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "New search action",
  • "search": "string",
  • "action": "notify",
  • "occurrence": "immediate",
  • "days": [
    ],
  • "time": "14:15:22Z",
  • "receivers": [
    ],
  • "latest_check": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "created_by": "string"
}

Actions > Delete

path Parameters
id
required
string

Responses

Actions > Partial update

path Parameters
id
required
string
Request Body schema:
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
enabled
boolean

Responses

Request samples

Content type
{
  • "name": "New search action",
  • "search": "string",
  • "search_obj": {
    },
  • "action": "notify",
  • "occurrence": "immediate",
  • "days": [
    ],
  • "time": "14:15:22Z",
  • "receivers": [
    ],
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "New search action",
  • "search": "string",
  • "action": "notify",
  • "occurrence": "immediate",
  • "days": [
    ],
  • "time": "14:15:22Z",
  • "receivers": [
    ],
  • "latest_check": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "created_by": "string"
}

Actions > Update

path Parameters
id
required
string
Request Body schema:
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>
required
Array of objects (SearchActionNotificationReceiver)
enabled
boolean

Responses

Request samples

Content type
{
  • "name": "New search action",
  • "search": "string",
  • "search_obj": {
    },
  • "action": "notify",
  • "occurrence": "immediate",
  • "days": [
    ],
  • "time": "14:15:22Z",
  • "receivers": [
    ],
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "New search action",
  • "search": "string",
  • "action": "notify",
  • "occurrence": "immediate",
  • "days": [
    ],
  • "time": "14:15:22Z",
  • "receivers": [
    ],
  • "latest_check": "2019-08-24T14:15:22Z",
  • "enabled": true,
  • "created_by": "string"
}

Tags

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

Content type
application/json
{}

Create

Request Body schema:
required
tag_name
required
string <= 50 characters
active
boolean

Responses

Request samples

Content type
{
  • "tag_name": "string",
  • "active": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "tag_name": "string",
  • "active": true,
  • "num_contracts": 0
}

Merge

Request Body schema:
required
tag_name
required
string <= 50 characters
merged
required
Array of strings

Responses

Request samples

Content type
{
  • "tag_name": "string",
  • "merged": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "tag_name": "string",
  • "active": true,
  • "num_contracts": 0
}

Read

path Parameters
id
required
string

Responses

Response samples

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:
tag_name
string <= 50 characters
active
boolean

Responses

Request samples

Content type
{
  • "tag_name": "string",
  • "active": true
}

Response samples

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

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

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

Content type
application/json
[
  • {
    }
]

Read

path Parameters
cryptid
required
string

Responses

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Partial update

path Parameters
cryptid
required
string
Request Body schema:
frontend_status
string (FrontendStatusEnum)
Enum: "done" "failed" "pending" "processing"
  • done - Done
  • failed - Failed
  • pending - Pending
  • processing - Processing

Responses

Request samples

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

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Download

path Parameters
cryptid
required
string

Responses

Response samples

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": [
    ],
  • "failed_binders": [
    ],
  • "token": "string"
}

Users

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

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

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:
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_mass_download_contracts
boolean
can_perform_bulk_operations
boolean
can_use_ai_chat
boolean
Default: false
default_binder
string or null
default_search
string or null
skip_review_state
boolean

Responses

Request samples

Content type
{
  • "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_mass_download_contracts": true,
  • "can_perform_bulk_operations": true,
  • "can_use_ai_chat": false,
  • "default_binder": "string",
  • "default_search": "string",
  • "skip_review_state": true
}

Response samples

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_mass_download_contracts": true,
  • "can_perform_bulk_operations": true,
  • "can_use_ai_chat": true,
  • "contract_view": "cards",
  • "default_binder": {
    },
  • "default_search": {
    },
  • "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": [
    ],
  • "phone_number": "string",
  • "profile_type": "administrator",
  • "saml": true,
  • "short_name": "string",
  • "oidc": true,
  • "status": "active",
  • "table_columns": [
    ],
  • "timezone": "string",
  • "pending_email": {
    },
  • "token_valid": 0,
  • "pending_phone_number": {
    },
  • "all_default_binders": [
    ]
}

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

Content type
{
  • "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_mass_download_contracts": 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": [
    ],
  • "phone_number": "string",
  • "profile_type": "administrator",
  • "send_review_emails": true,
  • "skip_review_state": true,
  • "status": "active",
  • "table_columns": [
    ],
  • "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:
required
old
required
string

User ID of current owner.

new
required
string

User ID of new owner.

Responses

Request samples

Content type
{
  • "old": "string",
  • "new": "string"
}

Response samples

Content type
application/json
{
  • "old": "string",
  • "new": "string"
}

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: pending_phone_number, all_default_binders, token_valid, pending_email

path Parameters
id
required
integer

A unique integer value identifying this profile.

Responses

Response samples

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_mass_download_contracts": true,
  • "can_perform_bulk_operations": true,
  • "can_use_ai_chat": true,
  • "contract_view": "cards",
  • "default_binder": {
    },
  • "default_search": {
    },
  • "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": [
    ],
  • "phone_number": "string",
  • "profile_type": "administrator",
  • "saml": true,
  • "short_name": "string",
  • "oidc": true,
  • "status": "active",
  • "table_columns": [
    ],
  • "timezone": "string",
  • "pending_email": {
    },
  • "token_valid": 0,
  • "pending_phone_number": {
    },
  • "all_default_binders": [
    ],
  • "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
}

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

Content type
{
  • "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_mass_download_contracts": 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": [
    ],
  • "phone_number": "string",
  • "profile_type": "administrator",
  • "send_review_emails": true,
  • "skip_review_state": true,
  • "status": "active",
  • "table_columns": [
    ],
  • "timezone": "string"
}

Response samples

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_mass_download_contracts": true,
  • "can_perform_bulk_operations": true,
  • "can_use_ai_chat": true,
  • "contract_view": "cards",
  • "default_binder": {
    },
  • "default_search": {
    },
  • "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": [
    ],
  • "phone_number": "string",
  • "profile_type": "administrator",
  • "saml": true,
  • "short_name": "string",
  • "oidc": true,
  • "status": "active",
  • "table_columns": [
    ],
  • "timezone": "string",
  • "pending_email": {
    },
  • "token_valid": 0,
  • "pending_phone_number": {
    },
  • "all_default_binders": [
    ],
  • "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
}