get https://api.pandadoc.com/public/v1/documents/
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 |
Polling vs Webhooks
If you are using the
GETdocument status endpoint for polling, we also support and recommend using webhooks for event-driven needs: https://developers.pandadoc.com/reference/on-document-status-change
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. Our API does not support edits after the document has been created, but it can still be edited manually on https://app.pandadoc.com |
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.waiting_pay | The document has a Stripe payment option and is awaiting payment. |
document.paid | The document has a Stripe payment option and was paid. |
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 |