Unique identifier for the document.
Identifier of the package this document belongs to.
Unique identifier for the file associated with the document.
Auto-template identifier (if created from an auto-template).
Auto-template document identifier (if applicable).
External identifier for the document. (optional)
Order/index of the document within the package.
Original filename uploaded.
File extension or type identifier.
Size of the file in bytes.
Number of pages in the document.
Upload time (ISO 8601 date-time).
Last modified time (ISO 8601 date-time).
Number of signed revisions for this document.
Total number of revisions for this document.
Description of the document. (optional)
Set to true if a CAC (Compliance Audit Certificate) has been appended to the document.
Number of CAC pages if cac is true.
Current state of the document.
Most document states are used internally. All documents included in a returned package will always be in the open state.
| Values | Description |
|---|
| open | The document is open and can be interacted with. |
| failed | The document failed to process and cannot be signed. |
Revision history for the document. Typically includes one revision per signer.
ID of the document this revision belongs to.
Unique identifier for the revision.
Revision number (incrementing integer).
Identifier of the previous revision this revision replaced. (optional)
Last opened time for the revision (ISO 8601).
Signer who is associated with this revision.
Set to true if this revision has been signed.
Time the revision was signed (ISO 8601).
Address metadata captured on sign. (optional)
Latitude coordinate captured on sign. (optional)
Longitude coordinate captured on sign. (optional)
State of the revision (for example: signed, pending).
Signers associated with this document.
Identifier for the signer associated with the document.
Internal signer key used to map fields/tags.
Full name for the signer on this document.
Email for the signer on this document.
Mobile number for the signer on this document. (optional)
Set to true if the signer has signed this document.
Set to true if this signer is next in the signing order for this document.
Template role name if the signer was created from a template role. (optional)
