The Document object
A document represents the content of an envelope in the form of a PDF. It includes metadata such as the file name and number of pages.
Documents can only be created when creating an envelope, and each envelope must contain at least one document.
Original and master copies
Each document, like the envelope it belongs to, has two versions:
- The original copy represents the document exactly as it was uploaded — before any fields (such as signatures or dates) were applied.
- The master copy (also referred to as the “live copy”) reflects the most up-to-date version of the document, with any applied fields and completed actions.
The master copy is available only if the envelope has progressed beyond the created status. If the envelope is voided, download access to the document is disabled.
Attributes
A user-defined identifier for the document.
If not supplied, Annature will generate one automatically. Supplying your own ID is recommended, as it allows you to reference this document in future API requests without needing to store the generated ID from the response.
The file name of the document. This value is used as the download file name when retrieving the document from Annature.
The number of pages in the document.
A temporary URL that can be used to download the original version of the document (before any fields were applied).
Download links are valid for 60 minutes. After expiry, the endpoint will return a 403 Forbidden response.
A temporary URL that can be used to download the master version of the document.
This value will be null if the associated envelope has a created status.
Download links are valid for 60 minutes. After expiry, the endpoint will return a 403 Forbidden response.
The ISO 8601 timestamp for when the document was created.