v1
documents

Get Document Status

Envelope status: document, signing session, per-recipient progress, and — once completed — the completed_document_id to pass to GET /api/v1/documents/{completed_document_id}/download.

?override_send_invite=true evaluates each recipient's can_remind with the manual-remind override applied, matching what the Remind Recipient action would allow on an invite-suppressed envelope.

get/api/v1/documents/{document_id}

Request

  • Base URL: https://zsign.io (the document declares no server; this is the origin it was published from)
  • URL: https://zsign.io/api/v1/documents/{document_id}
  • Auth: HTTP bearer

Path parameters

document_idstring required

Query parameters

override_send_inviteboolean

Response

Successful Response

document_idstring uuid required
namestring nullable
filenamestring required
statusstring required
created_atstring date-time nullable
completed_document_idstring uuid nullable
metadataobject nullable
parsed_fieldsobject[] nullable
recipientsobject[] nullable
sentboolean nullable

Changes

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