Documents

List document statuses

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

StatusDeletableDescription
uploadingnoThe document upload is in process.
uploadednoThe document has been uploaded.
metadata_processingnoThe initial processing is under way.
metadata_readyyesThe initial processing has been completed.
expiredyesThe signature deadline has been reached.
certificatingnoThe document has been signed and is being certificated.
certificatednoThe document is certificated.
rejected_by_signeryesA signer declined signing the document.
pending_signatureyesThe document is waiting for signatures.
rejected_by_useryesThe signature process was cancelled by a user.
failedyesThe document processing has failed.

Copy as Markdown Open in ChatGPT Open in Claude

get/v1/documents/statuses

Response

Supported statuses

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.