Document
A document is a file within an envelope. It can be either a signable item, such as a contract, or for informational purposes only, like a cover letter. It can be either in PDF or docx format.
Using templates, documents can be generated programmatically by combining a static template with dynamic data.
A document belongs to an envelope.
Places
Places are specific areas within a document that contain certain types of information:
- Recipient input (for example, the recipient’s signature)
- Details about the recipient (for example, the date when the recipient signed)
- Details about the envelope (for example, the date when the envelope was completed)
These places can be set in the document either by using a placeholder or by placing them in a fixed position.
Attributes
The unique identifier of the document.
The unique identifier of the envelope.
The title of the document. It may be shown to recipients.
The number of pages in the document.
The URL where the document or template is located must be publicly accessible and from a valid source.
The format of the document or template.
Available options are pdf and docx.
The data to fill the template with.
Object keys must be alphanumeric.
Fixed positions within a document where a place can be inserted.
Learn more about fixed positions and placeholders.
Defined areas within a document where a recipient either provides input, such as a signature, or where a constant or calculated value is added, like a completion date.
Learn more about places.
Was this page helpful?