Get Document Status

It is useful to request document status to ensure a document is in the expected state before calling additional API methods.

Required Document Statuses

Here are some common methods and the document.status required to proceed:

API Method	Required Document State
Send A Document	`document.draft`
Get Document Details	`document.draft`
Embed A Document	`document.sent`
Download A Document	`document.completed`

Available Document Statuses

The following is a complete list of all possible document statuses returned:

Document Status	Status Description
`document.uploaded`	The document has just been created or uploaded. It is in processing and will be in `document.draft` state momentarily.
`document.draft`	The document is in a draft state. All aspects of the document can be edited in this state.
`document.sent`	The document has been "sealed" and optionally sent. No further document edits can occur except for document recipient(s) filling out or signing the document.
`document.viewed`	Document recipient(s) have viewed the sent document.
`document.waiting_approval`	The document has an automatic approval workflow and has not yet been approved.
`document.rejected`	The document has an automatic approval workflow and was rejected.
`document.approved`	The document has an automatic approval workflow and was approved.
`document.completed`	The document has been completed by all recipients.
`document.voided`	The document expired and is no longer available for completion or signature.
`document.declined`	The document was manually marked as "Declined"
`document.external_review`	The document is reviewed by it's recipient using Suggest Edit feature

Responses

🟢200OK

application/json

Body

Examples

Document processing after createDocument in draft

{
    "id": "fANp5wW5EwY7AkiTkTGekZ",
    "name": "Document from file",
    "status": "document.uploaded",
    "date_created": "2024-07-02T16:21:57.510203Z",
    "date_modified": "2024-07-02T16:21:57.708251Z",
    "expiration_date": null,
    "version": null,
    "uuid": "fANp5wW5EwY7AkiTkTGekZ"
}

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠429429

Required Document Statuses

Available Document Statuses

Request

Request Code Samples

Responses

Get Document Status

Required Document Statuses#

Available Document Statuses#

Request

Request Code Samples

Responses

Required Document Statuses

Available Document Statuses