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 in a document where recipients can perform actions, such as signing or entering data. They can also include information generated during the signing process, like signing dates.

You can position places in the document either by using a placeholder or by setting them in a fixed position.

These places are specified in the places array within the Document object. Fixed positions are defined in the fixed_positions array.

​
Attributes

​
id
string

The unique identifier of the document.

​
envelope_id
uuid

The unique identifier of the envelope.

​
title
string

The title of the document. It may be shown to recipients.

​
page_count
integer

The number of pages in the document.

​
url
string

The URL where the document or template is located must be publicly accessible and from a valid source.

​
format
enum

The format of the document or template.

Available options are pdf and docx.

​
data
object

The data to fill the template with.

Object keys must be alphanumeric.

​
fixed_positions
array of fixed positions

Fixed positions within a document where a place can be inserted.

Learn more about fixed positions and placeholders.

​
places
array of places

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?

Resend requestDocument sources