Sign in

v1

latestSwagger 2.02026-08-063530171.1 KB
documents

Create a Document

post/documents/

Request body

urlstring uri
uuidstring
file_as_pdfstring uri

Temporary URL to original file as PDF, expires in five minutes

namestring nullable

Defaults to filename, including extension

external_idstring nullable

ID used to reference document in external system

frontend_idstring nullable

Shared secret used in conjunction with <a href="#section/Frontend-API/SignRequest-js-client-(beta)">SignRequest-js client</a> to grant user access to a document that's not a member of the document's team

filestring uri nullable

Temporary URL to original file, expires in five minutes

file_from_urlstring uri nullable

Publicly accessible URL of document to be downloaded by SignRequest

events_callback_urlstring uri nullable

URL at which to receive event callbacks for this document

file_from_contentstring nullable

Base64 encoded document content

file_from_content_namestring nullable

Filename, including extension. Required when using file_from_content.

templatestring uri nullable
auto_delete_daysinteger nullable

Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted

auto_expire_daysinteger nullable

Number of days after which a non finished document will be automatically expired

pdfstring uri nullable

Temporary URL to signed document as PDF, expires in five minutes

status'co' | 'ne' | 'se' | 'vi' | 'si' | 'do' | 'sd' | 'ca' | 'de' | 'ec' | 'es' | 'xp'

co: converting, ne: new, se: sent, vi: viewed, si: signed, do: downloaded, sd: signed and downloaded, ca: cancelled, de: declined, ec: error converting, es: error sending, xp: expired

api_usedboolean

Indicates whether document was created using the API

security_hashstring nullable

SHA256 hash of PDF contents

auto_delete_afterstring date-time nullable

Date and time calculated using auto_delete_days after which a finished document (signed/cancelled/declined) will be automatically deleted

sandboxboolean nullable

Indicates whether document was created as part of a sandbox team

auto_expire_afterstring date-time nullable

Date and time calculated using auto_expire_days after which a non finished document will be automatically expired

processingboolean

Indicates whether a change to the document is processing and the PDF may be out of date. It is recommended to wait until processing has finished before downloading the PDF. Webhooks are not sent until processing has been completed.

short_idstring

Response

Created

urlstring uri
uuidstring
file_as_pdfstring uri

Temporary URL to original file as PDF, expires in five minutes

namestring nullable

Defaults to filename, including extension

external_idstring nullable

ID used to reference document in external system

frontend_idstring nullable

Shared secret used in conjunction with <a href="#section/Frontend-API/SignRequest-js-client-(beta)">SignRequest-js client</a> to grant user access to a document that's not a member of the document's team

filestring uri nullable

Temporary URL to original file, expires in five minutes

file_from_urlstring uri nullable

Publicly accessible URL of document to be downloaded by SignRequest

events_callback_urlstring uri nullable

URL at which to receive event callbacks for this document

file_from_contentstring nullable

Base64 encoded document content

file_from_content_namestring nullable

Filename, including extension. Required when using file_from_content.

templatestring uri nullable
auto_delete_daysinteger nullable

Number of days after which a finished document (signed/cancelled/declined) will be automatically deleted

auto_expire_daysinteger nullable

Number of days after which a non finished document will be automatically expired

pdfstring uri nullable

Temporary URL to signed document as PDF, expires in five minutes

status'co' | 'ne' | 'se' | 'vi' | 'si' | 'do' | 'sd' | 'ca' | 'de' | 'ec' | 'es' | 'xp'

co: converting, ne: new, se: sent, vi: viewed, si: signed, do: downloaded, sd: signed and downloaded, ca: cancelled, de: declined, ec: error converting, es: error sending, xp: expired

api_usedboolean

Indicates whether document was created using the API

security_hashstring nullable

SHA256 hash of PDF contents

auto_delete_afterstring date-time nullable

Date and time calculated using auto_delete_days after which a finished document (signed/cancelled/declined) will be automatically deleted

sandboxboolean nullable

Indicates whether document was created as part of a sandbox team

auto_expire_afterstring date-time nullable

Date and time calculated using auto_expire_days after which a non finished document will be automatically expired

processingboolean

Indicates whether a change to the document is processing and the PDF may be out of date. It is recommended to wait until processing has finished before downloading the PDF. Webhooks are not sent until processing has been completed.

short_idstring