Documents

List document statuses

The supported document statuses and whether a document in each status can be deleted.

Status	Deletable	Description
uploading	no	The document upload is in process.
uploaded	no	The document has been uploaded.
metadata_processing	no	The initial processing is under way.
metadata_ready	yes	The initial processing has been completed.
expired	yes	The signature deadline has been reached.
certificating	no	The document has been signed and is being certificated.
certificated	no	The document is certificated.
rejected_by_signer	yes	A signer declined signing the document.
pending_signature	yes	The document is waiting for signatures.
pending_identity_review	yes	Every signer has signed; the document waits for the account to review a signer's identity before it is certificated. Deleting it cancels it and notifies the signers.
rejected_by_user	yes	The signature process was cancelled by a user.
failed	yes	The document processing has failed.

get/v1/documents/statuses

Request

Supported statuses

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

{
  "status": 200,
  "data": [
    {
      "code": "metadata_ready",
      "deletable": true
    }
  ]
}

No recorded changes to this operation across all 14 revisions of this API.