Copy
Ask AI
{
"id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"title": "Dummy Agreement",
"page_count": 2,
"url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/dummy.docx",
"format": "docx",
"data": {
"date": "December 31st, 2025",
"showAlert": true,
"serviceProvider": {
"name": "Jane Smith",
"organization": "ACME Global, Inc."
},
"client": {
"name": "Michael J. Miller",
"organization": "Miller Industries"
}
},
"places" : [
{
"key": "provider_signs_here",
"type": "signature",
"recipient_key": "service_provider",
"height": 60
},
{
"key": "client_signs_here",
"type": "signature",
"recipient_key": "client",
"height": 60
}
]
}
Documents
Document
Copy
Ask AI
{
"id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"title": "Dummy Agreement",
"page_count": 2,
"url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/dummy.docx",
"format": "docx",
"data": {
"date": "December 31st, 2025",
"showAlert": true,
"serviceProvider": {
"name": "Jane Smith",
"organization": "ACME Global, Inc."
},
"client": {
"name": "Michael J. Miller",
"organization": "Miller Industries"
}
},
"places" : [
{
"key": "provider_signs_here",
"type": "signature",
"recipient_key": "service_provider",
"height": 60
},
{
"key": "client_signs_here",
"type": "signature",
"recipient_key": "client",
"height": 60
}
]
}
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 theplaces array within the Document object. Fixed positions are defined in the fixed_positions array.
Attributes
Show PDF Document
Show PDF Document
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 a publicly accessible URL.You can also use the URL returned by the Create Upload endpoint.Learn more about options in Document URL and Upload.
The format of the document or template. Available options are
pdf and docx.For PDF documents the format is pdf.Show fixed position
Show fixed position
A user-provided key that identifies a place within a document.It must match one of the
place.key values defined in the document’s places list.The page number for this position.
The distance, in points (or 1/72th of an inch), from the top border of the page to the position.
The distance, in points (or 1/72th of an inch), from the left border of the page to the position.
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.
Show signature place
Show signature place
A space where the recipient, identified by the
recipient_key, needs to sign.Specifies the type of place.For a signature place, the value must be
signature.A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
A user-provided key that identifies a recipient within an envelope.It must match one of the
recipient.key values in the envelope’s recipient list.The height of the signature place in . The width is calculated based on a 5:2 ratio.Must be between 20 and 60. The default is 60.
Show initials place
Show initials place
A space where the recipient, identified by the
recipient_key, needs to write their initials.Specifies the type of place.For an initials place, the value must be
initials.A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
A user-provided key that identifies a recipient within an envelope.It must match one of the
recipient.key values in the envelope’s recipient list.The height of the initials place in . The width is the same as the height.Must be between 20 and 60. The default is 60.
Show text place
Show text place
An arbitrary text string.
Specifies the type of place.For a text place, the value must be
text.A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
The text content.
The font size in points.Must be between 1 and 144. The default is 12.
The font color in hexadecimal notation. Default is
#000000 (black).Show text input place
Show text input place
A text input field to ask recipients to enter text.
Specifies the type of place.For a text input place, the value must be
text_input.A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
A user-provided key that identifies a recipient within an envelope.It must match one of the
recipient.key values in the envelope’s recipient list.A user-defined identifier used to store the value entered by the recipient. This value will be included in the
captures object of the Envelope.Must start with a lowercase letter and contain only lowercase letters, numbers, or underscores. Maximum length is 32.A tooltip message displayed over the input text field during the signing ceremony.Learn more in Hints and Prompts.
A placeholder message shown inside the input text field during the signing ceremony.Learn more in Hints and Prompts.
Specifies whether the recipient must fill this field to complete the signing ceremony.Possible values are
required or optional. The default is required.Defines the validation format for the user’s input.Accepted values:
emailzipcode-us- a custom regular expression, enclosed in
/, for example:/^[a-z0-9]{1,10}$/
The message displayed when the user’s input does not match the required format.Learn more in Format Validation -> Adding a Custom Message.
The initial width of the text input place in .Must be between 30 and 540. The default is 30.
The font size in .Must be between 6 and 12. The default is 12.
Show checkbox place
Show checkbox place
A checkbox field to ask recipients to check a box.
Specifies the type of place.For a checkbox place, the value must be
checkbox.A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
A user-provided key that identifies a recipient within an envelope.It must match one of the
recipient.key values in the envelope’s recipient list.A user-defined identifier used to store the value entered by the recipient. This value will be included in the
captures object of the Envelope.Must start with a lowercase letter and contain only lowercase letters, numbers, or underscores. Maximum length is 32.The symbol to display in the checkbox when it is checked.Available options are
check and xmark. The default is check.Specifies whether the recipient must check this box to complete the signing ceremony.Possible values are
required or optional. The default is optional.The height of the checkbox in . The width is the same as the height.Must be between 8 and 40. The default is 20.
Show recipient completed date place
Show recipient completed date place
The date when the recipient, identified by the
recipient_key, completed (for example, signed) the envelope.Specifies the type of place.For this kind of place, the value must be
recipient_completed_date.A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
A user-provided key that identifies a recipient within an envelope.It must match one of the
recipient.key values in the envelope’s recipient list.Defines the format of the date, using MomentJS date format definitions.The default format is
D MMM YYYY, which outputs as 31 Dec 2025.Show envelope completed date place
Show envelope completed date place
The date when the envelope was completed.
Specifies the type of place.For this kind of place, the value must be
envelope_completed_date.A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
Defines the format of the date, using MomentJS date format definitions.The default format is
D MMM YYYY, which outputs as 31 Dec 2025.Show DOCX Document
Show DOCX Document
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 a publicly accessible URL.You can also use the URL returned by the Create Upload endpoint.Learn more about options in Document URL and Upload.
The format of the document or template. Available options are
pdf and docx.For DOCX documents the format is docx.The data to fill the template with.Keys must start with a lowercase letter and contain up to 32 alphanumeric characters. Values can be strings or booleans. Nested objects are allowed, but their values must also be strings or booleans.
Show fixed position
Show fixed position
A user-provided key that identifies a place within a document.It must match one of the
place.key values defined in the document’s places list.The page number for this position.
The distance, in points (or 1/72th of an inch), from the top border of the page to the position.
The distance, in points (or 1/72th of an inch), from the left border of the page to the position.
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.
Show signature place
Show signature place
A space where the recipient, identified by the
recipient_key, needs to sign.Specifies the type of place.For a signature place, the value must be
signature.A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
A user-provided key that identifies a recipient within an envelope.It must match one of the
recipient.key values in the envelope’s recipient list.The height of the signature place in . The width is calculated based on a 5:2 ratio.Must be between 20 and 60. The default is 60.
Show initials place
Show initials place
A space where the recipient, identified by the
recipient_key, needs to write their initials.Specifies the type of place.For an initials place, the value must be
initials.A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
A user-provided key that identifies a recipient within an envelope.It must match one of the
recipient.key values in the envelope’s recipient list.The height of the initials place in . The width is the same as the height.Must be between 20 and 60. The default is 60.
Show text place
Show text place
An arbitrary text string.
Specifies the type of place.For a text place, the value must be
text.A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
The text content.
The font size in points.Must be between 1 and 144. The default is 12.
The font color in hexadecimal notation. Default is
#000000 (black).Show text input place
Show text input place
A text input field to ask recipients to enter text.
Specifies the type of place.For a text input place, the value must be
text_input.A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
A user-provided key that identifies a recipient within an envelope.It must match one of the
recipient.key values in the envelope’s recipient list.A user-defined identifier used to store the value entered by the recipient. This value will be included in the
captures object of the Envelope.Must start with a lowercase letter and contain only lowercase letters, numbers, or underscores. Maximum length is 32.A tooltip message displayed over the input text field during the signing ceremony.Learn more in Hints and Prompts.
A placeholder message shown inside the input text field during the signing ceremony.Learn more in Hints and Prompts.
Specifies whether the recipient must fill this field to complete the signing ceremony.Possible values are
required or optional. The default is required.Defines the validation format for the user’s input.Accepted values:
emailzipcode-us- a custom regular expression, enclosed in
/, for example:/^[a-z0-9]{1,10}$/
The message displayed when the user’s input does not match the required format.Learn more in Format Validation -> Adding a Custom Message.
The initial width of the text input place in .Must be between 30 and 540. The default is 30.
The font size in .Must be between 6 and 12. The default is 12.
Show checkbox place
Show checkbox place
A checkbox field to ask recipients to check a box.
Specifies the type of place.For a checkbox place, the value must be
checkbox.A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
A user-provided key that identifies a recipient within an envelope.It must match one of the
recipient.key values in the envelope’s recipient list.A user-defined identifier used to store the value entered by the recipient. This value will be included in the
captures object of the Envelope.Must start with a lowercase letter and contain only lowercase letters, numbers, or underscores. Maximum length is 32.The symbol to display in the checkbox when it is checked.Available options are
check and xmark. The default is check.Specifies whether the recipient must check this box to complete the signing ceremony.Possible values are
required or optional. The default is optional.The height of the checkbox in . The width is the same as the height.Must be between 8 and 40. The default is 20.
Show recipient completed date place
Show recipient completed date place
The date when the recipient, identified by the
recipient_key, completed (for example, signed) the envelope.Specifies the type of place.For this kind of place, the value must be
recipient_completed_date.A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
A user-provided key that identifies a recipient within an envelope.It must match one of the
recipient.key values in the envelope’s recipient list.Defines the format of the date, using MomentJS date format definitions.The default format is
D MMM YYYY, which outputs as 31 Dec 2025.Show envelope completed date place
Show envelope completed date place
The date when the envelope was completed.
Specifies the type of place.For this kind of place, the value must be
envelope_completed_date.A user-provided key that identifies a place within a document.It must be up to 32 characters long, using only lowercase letters, numbers, or underscores, and it must begin with a letter.
Defines the format of the date, using MomentJS date format definitions.The default format is
D MMM YYYY, which outputs as 31 Dec 2025.Copy
Ask AI
{
"id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"title": "Dummy Agreement",
"page_count": 2,
"url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/dummy.docx",
"format": "docx",
"data": {
"date": "December 31st, 2025",
"showAlert": true,
"serviceProvider": {
"name": "Jane Smith",
"organization": "ACME Global, Inc."
},
"client": {
"name": "Michael J. Miller",
"organization": "Miller Industries"
}
},
"places" : [
{
"key": "provider_signs_here",
"type": "signature",
"recipient_key": "service_provider",
"height": 60
},
{
"key": "client_signs_here",
"type": "signature",
"recipient_key": "client",
"height": 60
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.