Zefort API Reference (1.0.0)

Download OpenAPI specification:Download

Contracts

Trash > List

List all contracts in the trash.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

q
string

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

q_main_documents
string

Search query string to search in main document content.

q_attachments
string

Search query string to search in attachments content.

q_parties
string

Search query string to search in contract parties.

q_notes
string

Search query string to search in contract notes.

q_tags
string

Search query string to search in contract tags.

q_emails
string

Search query string to search in contract emails.

receive_time
string

A date range string.

activities_times
string

A date range string.

pending_activities_times
string

Search contracts by the deadlines of their pending activities.

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

Only list contracts that have a matching status.

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

Search contract by esign process with given status.

owner
string

Only list contracts owned by this user.

binder
string

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

recursive
boolean

Search in sub-binders also. True by default.

language
string

Only list contracts with the given main language.

num_files
integer

Number of files

num_main_pages
integer

Number of pages in main document.

num_activities
integer

Number of activities defined.

num_emails
integer

Number of emails attached.

num_signed_documents
integer

Number of documents which have valid signature.

minimal
boolean

Return only minimal data about each hit.

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

Only list contracts where current user has this permission.

similar
string

Show contracts similar to this contract.

similarity_level
string

The level of similarity of shown contracts.

activity_user
string

Contracts with activities related to a user

favorite_of
string

Favorites of this user.

incomplete
boolean

List only incomplete contracts

search
string

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

trashed
boolean

Return only deleted contracts

failed_task
string

Only list contract which processing has failed in given task

Responses

Response samples

Content type
application/json
{}

Trash > Empty > Create

Permanently delete all contracts from the trash.

Request Body schema:

Responses

Request samples

Content type
{ }

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": {
    },
  • "backend_status": "done",
  • "backend_status_info": "string",
  • "frontend_status": "done",
  • "description": "string",
  • "progress": 0,
  • "processing_started_at": "2019-08-24T14:15:22Z",
  • "processing_ended_at": "2019-08-24T14:15:22Z",
  • "failed_contracts": "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
{ }

Create

Upload a new contract.

Request Body schema:
blob
string <uri>

The main contract document file.

title
string

The title of the contract.

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

Responses

Request samples

Content type
{}

Response samples

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

List

Retrieves a list of all contracts for the authenticated user.

A <date> is either:

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

where <offset> is

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

where is a number between 1-9999.

Date ranges must be one of the following formats:

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

Examples:

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

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

q
string

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

q_main_documents
string

Search query string to search in main document content.

q_attachments
string

Search query string to search in attachments content.

q_parties
string

Search query string to search in contract parties.

q_notes
string

Search query string to search in contract notes.

q_tags
string

Search query string to search in contract tags.

q_emails
string

Search query string to search in contract emails.

receive_time
string

A date range string.

activities_times
string

A date range string.

pending_activities_times
string

Search contracts by the deadlines of their pending activities.

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

Only list contracts that have a matching status.

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

Search contract by esign process with given status.

owner
string

Only list contracts owned by this user.

binder
string

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

recursive
boolean

Search in sub-binders also. True by default.

language
string

Only list contracts with the given main language.

num_files
integer

Number of files

num_main_pages
integer

Number of pages in main document.

num_activities
integer

Number of activities defined.

num_emails
integer

Number of emails attached.

num_signed_documents
integer

Number of documents which have valid signature.

minimal
boolean

Return only minimal data about each hit.

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

Only list contracts where current user has this permission.

similar
string

Show contracts similar to this contract.

similarity_level
string

The level of similarity of shown contracts.

activity_user
string

Contracts with activities related to a user

favorite_of
string

Favorites of this user.

incomplete
boolean

List only incomplete contracts

search
string

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

trashed
boolean

Return only deleted contracts

failed_task
string

Only list contract which processing has failed in given task

Responses

Response samples

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

Bulk contract party delete

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

The contract is missing some mandatory attributes.

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

The main document already exists as another main doc.

trashed
boolean

The contract has been moved to the trash can

allow_emails
required
boolean

Responses

Request samples

Content type
{
  • "attributes": {
    },
  • "cover_document": {
    },
  • "incomplete": true,
  • "num_users": 2147483647,
  • "status": "queued",
  • "is_duplicate": true,
  • "trashed": true,
  • "allow_emails": true
}

Response samples

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

Bulk contract party update

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

The contract is missing some mandatory attributes.

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

The main document already exists as another main doc.

trashed
boolean

The contract has been moved to the trash can

allow_emails
required
boolean

Responses

Request samples

Content type
{
  • "attributes": {
    },
  • "cover_document": {
    },
  • "incomplete": true,
  • "num_users": 2147483647,
  • "status": "queued",
  • "is_duplicate": true,
  • "trashed": true,
  • "allow_emails": true
}

Response samples

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

Bulk delete

Request Body schema:
contracts
Array of strings

List of contracts IDs.

object

Params for searching contracts.

Responses

Request samples

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

Response samples

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

Bulk update

Updates a large number of contracts.

Request Body schema:
owner
string

The new owner of the contracts.

status
string
Enum: "archived" "done" "review"

Archive or unarchive the contracts.

object (ContractAttributes)
contracts
Array of strings

List of contracts IDs.

object

Params for searching contracts.

Responses

Request samples

Content type
{
  • "owner": "string",
  • "status": "archived",
  • "attributes": {
    },
  • "contracts": [
    ],
  • "search": {
    }
}

Response samples

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

Delete

path Parameters
id
required
string

Responses

Read

path Parameters
id
required
string

Responses

Response samples

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

Partial update

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

The contract is missing some mandatory attributes.

num_users
integer [ 0 .. 2147483647 ]
owner
string

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

Array of objects
status
string
is_duplicate
boolean
trashed
boolean

The contract has been moved to the trash can

allow_emails
boolean
object
favorite
boolean

Set this contract as a favorite of the requesting user.

Responses

Request samples

Content type
{
  • "attributes": {
    },
  • "cover_document": {
    },
  • "incomplete": true,
  • "num_users": 2147483647,
  • "owner": "string",
  • "parties": [
    ],
  • "status": "string",
  • "is_duplicate": true,
  • "trashed": true,
  • "allow_emails": true,
  • "set_defaults_for": {
    },
  • "favorite": true
}

Response samples

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

Add file

Uploads a new attachment of any type to a contract.

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

New file to contract

Responses

Request samples

Content type
{}

Response samples

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

Subsume

Subsume given contracts to the primary contract

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

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

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

List of properties include in the process.

Responses

Request samples

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

Response samples

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

Activities > List

path Parameters
contract_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

q
string

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

title
string

Search query string to search in activity titles.

description
string

Search query string to search in descriptions.

complete_reason
string

Search query string to search in complete reasons.

time
string

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

completed
boolean

The 'completed' state of the activity.

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

Activities related to contracts owned by the user.

Responses

Response samples

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

Binders > Create

Adds this contract to a binder.

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

Responses

Request samples

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

Response samples

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

Binders > List

path Parameters
contract_id
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

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

Emails > Delete

Removes the email object.

path Parameters
contract_id
required
string
email_id
required
string

Responses

Emails > Read

Retrieves the email object.

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

Notes > Create

path Parameters
contract_id
required
string
Request Body schema:
content
string

The content of the note.

document
string

The id of the document associated with the note.

object

The highlighted section in the document.

Responses

Request samples

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

Response samples

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

Notes > Delete

path Parameters
contract_id
required
string
id
required
string

Responses

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

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

Parties > Create

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

Name of party

org_id
string or null <= 128 characters

ID code

external_id
string or null <= 1000 characters

External ID for integration purposes

managed
boolean

Explicitly managed party (exists even without contracts)

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

Responses

Request samples

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

Response samples

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

Parties > Delete

path Parameters
contract_id
required
string
id
required
string

Responses

Parties > Partial update

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

Name of party

org_id
string or null <= 128 characters

ID code

external_id
string or null <= 1000 characters

External ID for integration purposes

managed
boolean

Explicitly managed party (exists even without contracts)

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

Responses

Request samples

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

Response samples

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

Activities

Create

Request Body schema:
title
required
string <= 512 characters

Activity title

description
string
contract
required
string
date
string or null <date>
hour_of_day
integer or null
recurrence
string (RecurrenceEnum)
Enum: "once" "weekly" "monthly" "quarterly" "semiannually" "annually"
complete_by_email
boolean
owner_is_recipient
boolean

Contract owner always a reminder recipient.

Responses

Request samples

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

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

List

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

q
string

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

title
string

Search query string to search in activity titles.

description
string

Search query string to search in descriptions.

complete_reason
string

Search query string to search in complete reasons.

time
string

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

completed
boolean

The 'completed' state of the activity.

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

Activities related to contracts owned by the user.

Responses

Response samples

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

Delete

path Parameters
id
required
string

Responses

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

Partial update

path Parameters
id
required
string
Request Body schema:
title
string <= 512 characters

Activity title

description
string
completed
boolean
complete_reason
string

Reason or note about completion

date
string or null <date>
hour_of_day
integer or null
recurrence
string (RecurrenceEnum)
Enum: "once" "weekly" "monthly" "quarterly" "semiannually" "annually"
has_recurred
boolean
complete_by_email
boolean
owner_is_recipient
boolean

Contract owner always a reminder recipient.

Responses

Request samples

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

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

Groups > Create

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

path Parameters
activity_id
required
string
id
required
string

Responses

Reminders > Create

path Parameters
activity_id
required
string
Request Body schema:
timedelta_type
string (TimedeltaTypeEnum)
Enum: "days" "weeks" "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 > 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 > 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"
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 > Create

path Parameters
activity_id
required
string
Request Body schema:
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": 23,
  • "num_reminders": 0,
  • "recipients": {
    },
  • "recurrence": "once",
  • "has_recurred": true,
  • "complete_by_email": true,
  • "contract": "string",
  • "owner_is_recipient": true
}

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

path Parameters
activity_id
required
string
id
required
string

Responses

Lists > Create

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

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "label": "string",
  • "attribute_type": "text-singleline",
  • "defaults": [
    ],
  • "placeholder": "string",
  • "ui_extra_info": {
    },
  • "choices": [
    ],
  • "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
}

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

Lists > Delete

path Parameters
activity_id
required
string
id
required
string

Responses

Binders

Create

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

Responses

Request samples

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

Response samples

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

List

List accessible binders.

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

id
string

Search query string to search in binder ids.

q
string

Search query string to search in binder names.

parent
string

The parent binder.

user
string

Binders accessible by a specific user.

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

Sort results by key.

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

Minimum effective permission level.

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

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

Responses

Response samples

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

Delete

Removes the binder.

path Parameters
id
required
string

Responses

Read

path Parameters
id
required
string

Responses

Response samples

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

Partial update

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

Responses

Request samples

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

Response samples

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

Merge

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

Responses

Request samples

Content type
{
  • "merged": [
    ]
}

Response samples

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

Contracts > Add

Adds contracts to binder.

path Parameters
binder_id
required
string
Request Body schema:
remove_from_others
boolean
Default: false
contracts
Array of strings

List of contracts IDs.

object

Params for searching contracts.

Responses

Request samples

Content type
{
  • "remove_from_others": false,
  • "contracts": [
    ],
  • "search": {
    }
}

Response samples

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

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

Contracts > Bulk Remove

Removes contracts from binder.

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

List of contracts IDs.

object

Params for searching contracts.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "details": {
    },
  • "backend_status": "done",
  • "backend_status_info": "string",
  • "frontend_status": "done",
  • "description": "string",
  • "progress": 0,
  • "processing_started_at": "2019-08-24T14:15:22Z",
  • "processing_ended_at": "2019-08-24T14:15:22Z",
  • "failed_contracts": "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",
  • "path": "string",
  • "date_created": "2019-08-24T14:15:22Z",
  • "inherit_permissions": true,
  • "num_children": 0,
  • "num_contracts": 0,
  • "num_groups": 0,
  • "num_groups_inherited": 0,
  • "num_users": 0,
  • "num_users_inherited": 0,
  • "num_users_total": "string",
  • "num_groups_total": "string",
  • "added_by": "string",
  • "permission": "string",
  • "granted_permission": "string",
  • "is_esign_target": true
}

Documents

Create

Uploads a new attachment to a contract.

Request Body schema:
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
{
  • "id": "string",
  • "content_type": "string",
  • "role": "unknown",
  • "status": "queued",
  • "num_pages": 0,
  • "filename": "string",
  • "receive_time": "2019-08-24T14:15:22Z",
  • "taggings": [
    ],
  • "email": "string",
  • "ordinal": 32767,
  • "text_available": true,
  • "valid_signature": true,
  • "is_signable": true,
  • "signatures": [
    ]
}

Delete

Deletes a document

path Parameters
id
required
string

Responses

Read

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "content_type": "string",
  • "role": "unknown",
  • "status": "queued",
  • "num_pages": 0,
  • "filename": "string",
  • "receive_time": "2019-08-24T14:15:22Z",
  • "taggings": [
    ],
  • "email": "string",
  • "ordinal": 32767,
  • "text_available": true,
  • "valid_signature": true,
  • "is_signable": true,
  • "signatures": [
    ]
}

Update

path Parameters
id
required
string
Request Body schema:
filename
string
role
string
status
string (Status031Enum)
Enum: "queued" "quarantined" "complete" "archived" "hidden" "deleted" "error"
ordinal
integer or null [ 0 .. 32767 ]

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "id": "string",
  • "content_type": "string",
  • "role": "unknown",
  • "status": "queued",
  • "num_pages": 0,
  • "filename": "string",
  • "receive_time": "2019-08-24T14:15:22Z",
  • "taggings": [
    ],
  • "email": "string",
  • "ordinal": 32767,
  • "text_available": true,
  • "valid_signature": true,
  • "is_signable": true,
  • "signatures": [
    ]
}

Partial update

path Parameters
id
required
string
Request Body schema:
filename
string
role
string
status
string (Status031Enum)
Enum: "queued" "quarantined" "complete" "archived" "hidden" "deleted" "error"
ordinal
integer or null [ 0 .. 32767 ]

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "id": "string",
  • "content_type": "string",
  • "role": "unknown",
  • "status": "queued",
  • "num_pages": 0,
  • "filename": "string",
  • "receive_time": "2019-08-24T14:15:22Z",
  • "taggings": [
    ],
  • "email": "string",
  • "ordinal": 32767,
  • "text_available": true,
  • "valid_signature": true,
  • "is_signable": true,
  • "signatures": [
    ]
}

Detach

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

path Parameters
id
required
string
Request Body schema:
role
string (DocumentRoleEnum)
Enum: "unknown" "contract" "attachment" "other"
status
string (Status031Enum)
Enum: "queued" "quarantined" "complete" "archived" "hidden" "deleted" "error"
receive_time
string <date-time>

When was this document added to this system?

ordinal
integer or null [ 0 .. 32767 ]

Responses

Response samples

Content type
application/json
{
  • "attributes": {
    },
  • "cover_document": {
    },
  • "unverified_docai_attributes": "string",
  • "id": "string",
  • "incomplete": true,
  • "num_emails": 0,
  • "num_files": 0,
  • "num_users": 2147483647,
  • "matches": {
    },
  • "owner": {
    },
  • "parties": [
    ],
  • "permission": "string",
  • "receive_time": "2019-08-24T14:15:22Z",
  • "related_contracts": [
    ],
  • "status": "queued",
  • "is_duplicate": true,
  • "favorite_of": [
    ],
  • "last_modified": "2019-08-24T14:15:22Z",
  • "trashed": true,
  • "esigns": [
    ],
  • "num_signed_documents": 0,
  • "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

Esigns

Create

Request Body schema:
contract
required
string

ID of the Contract to attach this esign to.

document
string

ID of the Document to attach this esign to

attachments
Array of any

List of attachment document IDs

needs_to_be_viewed
boolean

Does attachments need to be viewed before signing

sign_order
string (SignOrderEnum)
Enum: "parallel" "consecutive" "flexible"
greetings
string or null
deadline
string or null <date-time>

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

need_auth_to_view_documents
boolean

Does e-sign party need to authenticate before viewing documents

title
string <= 2014 characters

Name of signed document set

contract_binders
Array of strings

List of binders where signed contract is moved

Array of objects (EsignParty)

Responses

Request samples

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

Response samples

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

List

List e-signs

query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

q
string

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

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

Status of the e-sign.

owner
string

E-signs owned by specific user

activated_at
string

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

created_at
string

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

deadline
string

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

status_saved_at
string

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

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

Sort results by key.

Responses

Response samples

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

Delete

path Parameters
id
required
integer

A unique integer value identifying this esign.

Responses

Read

path Parameters
id
required
integer

A unique integer value identifying this esign.

Responses

Response samples

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

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

ID of the Contract to attach this esign to.

document
string

ID of the Document to attach this esign to

attachments
Array of any

List of attachment document IDs

needs_to_be_viewed
boolean

Does attachments need to be viewed before signing

sign_order
string (SignOrderEnum)
Enum: "parallel" "consecutive" "flexible"
greetings
string or null
deadline
string or null <date-time>

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

need_auth_to_view_documents
boolean

Does e-sign party need to authenticate before viewing documents

title
string <= 2014 characters

Name of signed document set

contract_binders
Array of strings

List of binders where signed contract is moved

Array of objects (EsignParty)

Responses