A document is a PDF or DOCX file within an envelope. Each envelope can contain between 1 and 10 documents. Recipients sign, approve, or prepare documents during their ceremony. Documents are defined inside theDocumentation Index
Fetch the complete documentation index at: https://signatureapi-daf4ee54.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
documents array when creating an envelope. They are not created or updated independently.
A document belongs to an envelope.
Document formats
SignatureAPI supports two document formats. You must set theformat property to match the file type.
PDF (format: "pdf") accepts standard PDF files. Place fields using placeholders embedded in the document text or fixed coordinates on a page.
DOCX (format: "docx") accepts Microsoft Word files. In addition to places, DOCX documents support template fields that merge dynamic data into the document before signing begins.
If you upload a DOCX file but omit
format or set it to "pdf", the API returns a cannot-parse-document error. Always set format: "docx" for Word files.DOCX files created with Google Docs or LibreOffice may not be compatible. If you get a cannot-parse-document error, open the file in Microsoft Word and re-save it. This resolves most compatibility issues.
Providing a file
Set theurl property to a publicly accessible URL for the file. SignatureAPI downloads the file when the envelope is created.
You can host files on Amazon S3, Google Cloud Storage, Azure Blob Storage, Cloudflare R2, and other services. You can also upload files directly to SignatureAPI and use the returned URL.
Places
Places are areas in a document where recipients interact or where information is displayed automatically. Input places include signatures, initials, text inputs, checkboxes, and dropdowns. Informational places include static text, completion dates, and recipient details. Define places in theplaces array. Each place has a key and a type.
Place positioning
A place must be positioned in the document. There are two methods. Placeholders: Embed[[place_key]] in the document text. The place appears at that location. This works for both PDF and DOCX documents.
Fixed positions: Specify the page, top, and left values in the fixed_positions array. Coordinates are measured in points (1 point = 1/72 inch) from the top-left corner of the page.
See Place Positioning for details and examples.
Attributes
Show PDF Document
Show PDF Document
The unique identifier of the document. Document IDs start with
doc_.The unique identifier of the envelope, in UUID format.
A user-provided identifier for this document within the envelope. Must be unique within the envelope. Use the key to reference this document in other parts of the API.Only lowercase letters, numbers, and underscores are allowed. Must start with a letter. Maximum 32 characters.If not provided, a key is generated automatically.
An optional display name for the document. When set, the title is shown to recipients during the signing ceremony and in deliverables. Defaults to
null if not provided. Maximum 500 characters.The total number of pages in the document after processing. For DOCX templates, this reflects the page count after template data has been merged.
The URL where the document or template file is located. The file must be publicly accessible.You can host files on Amazon S3, Google Cloud Storage, Azure Blob Storage, Cloudflare R2, and other services. You can also use the URL returned by the Create Upload endpoint.Learn more about your options in Document URL and Upload.
The file format of the document. Determines which features are available.
pdf— Standard PDF file. Supports places via placeholders or fixed positions.docx— Microsoft Word file. Supports template fields for dynamic content in addition to places.
pdf.Show fixed position
Show fixed position
The key of the place to position. Must match one of the
key values in the document’s places array.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The page number where the place is positioned. Page numbering starts at 1.
The vertical distance from the top edge of the page to the bottom-left corner of the place, measured in points (1 point = 1/72 of an inch). For example,
360 places the field 5 inches from the top edge.The horizontal distance from the left edge of the page to the bottom-left corner of the place, measured in points (1 point = 1/72 of an inch). For example,
72 places the field 1 inch from the left edge.Areas within a document where a recipient provides input (such as a signature or text) or where a value is displayed automatically (such as a completion date).Each place has a
type that determines its behavior. A place must be positioned using either a [[place_key]] placeholder in the document text or an entry in the fixed_positions array.Learn more about places.Show signature place
Show signature place
A location where the recipient, identified by
recipient_key, draws or types their signature. A single recipient can have multiple signature places across different pages of a document.Specifies the type of place.For a signature place, the value must be
signature.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.The height of the signature place in . The width is calculated automatically using a 5:2 ratio based on this height.Must be between 20 and 60. Defaults to 60.
Show initials place
Show initials place
A location where the recipient, identified by
recipient_key, enters their initials. A single recipient can have multiple initials places across different pages of a document.Specifies the type of place.For an initials place, the value must be
initials.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.The height of the initials place in . The width equals the height.Must be between 20 and 60. Defaults to 60.
Show text place
Show text place
A read-only text value displayed at a specific location on the document. It is not interactive and does not require a recipient. Use this to pre-fill static information such as company names, reference numbers, or dates before the signing process begins.
Specifies the type of place.For a text place, the value must be
text.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The text content to display on the document. This is a static value set when the envelope is created and cannot be changed by the recipient.Maximum length is 1000 characters.
The font size in points.Must be between 1 and 144. The default is 12.
The font color for this text place. Must be a six-digit hex color code with a leading
#. Defaults to #000000 (black).Show text input place
Show text input place
A location where the recipient, identified by
recipient_key, types free-form text. Supports input validation, placeholder text, and tooltip hints. Use capture_as to store the entered value in the envelope’s captures.Specifies the type of place.For a text input place, the value must be
text_input.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.A key that stores the recipient’s input in the envelope’s
captures object. When set, the value entered or selected by the recipient is saved under this key after the envelope is completed.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters. Set to null to disable capture.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 field in . The field may expand beyond this width during typing.Must be between 30 and 540. Defaults to 30.
The font size in .Must be between 6 and 12. Defaults to 12.
Show boxed text input place
Show boxed text input place
A series of individual character boxes where the recipient, identified by
recipient_key, enters text one character per box. Use this for structured data such as verification codes, ZIP codes, or the last four digits of an SSN. Use capture_as to store the entered value in the envelope’s captures.Specifies the type of place.For a boxed text input place, the value must be
boxed_text_input.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.The number of individual character boxes to display.Must be between 1 and 100. Each box accepts a single character from the recipient.
Specifies whether the recipient must fill all boxes to complete the signing ceremony.Possible values are
required or optional. The default is required.A placeholder message shown inside the first box during the signing ceremony to guide the recipient.Learn more in Hints and Prompts.
A tooltip message displayed over the boxed text input field during the signing ceremony.Learn more in Hints and Prompts.
A key that stores the recipient’s input in the envelope’s
captures object. When set, the value entered or selected by the recipient is saved under this key after the envelope is completed.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters. Set to null to disable capture.The total width of the boxed input field in .Must be between 30 and 540. The default is 30.
The height of each individual box in .
The font size in .Must be between 6 and 12. The default is 12.
Show multiline text input place
Show multiline text input place
A location where the recipient, identified by
recipient_key, enters text that spans multiple lines. Use this for comments, addresses, and longer descriptions. Use capture_as to store the entered value in the envelope’s captures.Specifies the type of place.For a multi-line text input place, the value must be
multiline_text_input.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.Specifies whether the recipient must fill this field to complete the signing ceremony.Possible values are
required or optional. The default is required.A placeholder message shown inside the input text field during the signing ceremony.Learn more in Hints and Prompts.
A tooltip message displayed over the input text field during the signing ceremony.Learn more in Hints and Prompts.
A key that stores the recipient’s input in the envelope’s
captures object. When set, the value entered or selected by the recipient is saved under this key after the envelope is completed.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters. Set to null to disable capture.The width of the multi-line text input place in .Must be between 30 and 540. The default is 30.
The number of lines for the multi-line text input field.Must be between 1 and 100.
The line height in . Must be greater than or equal to
font_size.Must be between 6 and 72. The default is 12.The font size in .Must be between 6 and 12. The default is 12.
Show checkbox place
Show checkbox place
A location where the recipient, identified by
recipient_key, checks or unchecks a box. Use capture_as to store the checkbox value in the envelope’s captures.Specifies the type of place.For a checkbox place, the value must be
checkbox.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.A key that stores the recipient’s input in the envelope’s
captures object. When set, the value entered or selected by the recipient is saved under this key after the envelope is completed.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters. Set to null to disable capture.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 equals the height.Must be between 8 and 40. Defaults to 20.
Show dropdown place
Show dropdown place
A location where the recipient, identified by
recipient_key, selects from a list of options. Options can be a custom list of label-value pairs or a predefined set such as country names or US state codes. Use capture_as to store the selected value in the envelope’s captures.Specifies the type of place.For a dropdown place, the value must be
dropdown.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.The list of options available in the dropdown. Either an array of custom
label/value pairs, or a string specifying a predefined option set such as us_states_names or world_countries_names.The pre-selected option when the dropdown is displayed.
The display behavior of the dropdown. Possible values:
auto, select, or combobox.Whether the recipient must select an option. Possible values:
required or optional.A placeholder message shown inside the dropdown field during the signing ceremony.
A tooltip message displayed when the user hovers over or focuses on the dropdown field.
A key that stores the recipient’s input in the envelope’s
captures object. When set, the value entered or selected by the recipient is saved under this key after the envelope is completed.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters. Set to null to disable capture.The font size in points for the dropdown field.
The width of the dropdown field in points.
Show recipient completed date place
Show recipient completed date place
Displays the date and time when the recipient, identified by
recipient_key, completed their action on the envelope. Use date_format to control how the date is formatted.Specifies the type of place.For this kind of place, the value must be
recipient_completed_date.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.The date and time format using Moment.js syntax. Common formats include
D MMM YYYY (31 Dec 2025), YYYY-MM-DD (2025-12-31), and MM/DD/YYYY (12/31/2025).Defaults to D MMM YYYY.Show envelope completed date place
Show envelope completed date place
Displays the date and time when the envelope was completed. The envelope completes when all recipients have finished their actions. Use
date_format to control how the date is formatted.Specifies the type of place.For this kind of place, the value must be
envelope_completed_date.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The date and time format using Moment.js syntax. Common formats include
D MMM YYYY (31 Dec 2025), YYYY-MM-DD (2025-12-31), and MM/DD/YYYY (12/31/2025).Defaults to D MMM YYYY.Show recipient name place
Show recipient name place
Displays the name of the recipient, identified by
recipient_key, at a specific location on the document. The value is inserted automatically. This place is read-only and does not require any action from the recipient.Specifies the type of place.For this kind of place, the value must be
recipient_name.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.Show recipient email place
Show recipient email place
Displays the email address of the recipient, identified by
recipient_key, at a specific location on the document. The value is inserted automatically. This place is read-only and does not require any action from the recipient.Specifies the type of place.For this kind of place, the value must be
recipient_email.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.Show DOCX Document
Show DOCX Document
The unique identifier of the document. Document IDs start with
doc_.The unique identifier of the envelope, in UUID format.
A user-provided identifier for this document within the envelope. Must be unique within the envelope. Use the key to reference this document in other parts of the API.Only lowercase letters, numbers, and underscores are allowed. Must start with a letter. Maximum 32 characters.If not provided, a key is generated automatically.
An optional display name for the document. When set, the title is shown to recipients during the signing ceremony and in deliverables. Defaults to
null if not provided. Maximum 500 characters.The total number of pages in the document after processing. For DOCX templates, this reflects the page count after template data has been merged.
The URL where the document or template file is located. The file must be publicly accessible.You can host files on Amazon S3, Google Cloud Storage, Azure Blob Storage, Cloudflare R2, and other services. You can also use the URL returned by the Create Upload endpoint.Learn more about your options in Document URL and Upload.
The file format of the document. Determines which features are available.
pdf— Standard PDF file. Supports places via placeholders or fixed positions.docx— Microsoft Word file. Supports template fields for dynamic content in addition to places.
docx.Template data used to fill dynamic fields in a DOCX template. Each key corresponds to a
{{key}} placeholder in the template file.Keys must be alphanumeric and at most 32 characters. Values can be strings, booleans, or nested objects. Nested keys map to dot-notation placeholders (for example, a key person with nested key name fills {{person.name}}). Defaults to {}.Show fixed position
Show fixed position
The key of the place to position. Must match one of the
key values in the document’s places array.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The page number where the place is positioned. Page numbering starts at 1.
The vertical distance from the top edge of the page to the bottom-left corner of the place, measured in points (1 point = 1/72 of an inch). For example,
360 places the field 5 inches from the top edge.The horizontal distance from the left edge of the page to the bottom-left corner of the place, measured in points (1 point = 1/72 of an inch). For example,
72 places the field 1 inch from the left edge.Areas within a document where a recipient provides input (such as a signature or text) or where a value is displayed automatically (such as a completion date).Each place has a
type that determines its behavior. A place must be positioned using either a [[place_key]] placeholder in the document text or an entry in the fixed_positions array.Learn more about places.Show signature place
Show signature place
A location where the recipient, identified by
recipient_key, draws or types their signature. A single recipient can have multiple signature places across different pages of a document.Specifies the type of place.For a signature place, the value must be
signature.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.The height of the signature place in . The width is calculated automatically using a 5:2 ratio based on this height.Must be between 20 and 60. Defaults to 60.
Show initials place
Show initials place
A location where the recipient, identified by
recipient_key, enters their initials. A single recipient can have multiple initials places across different pages of a document.Specifies the type of place.For an initials place, the value must be
initials.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.The height of the initials place in . The width equals the height.Must be between 20 and 60. Defaults to 60.
Show text place
Show text place
A read-only text value displayed at a specific location on the document. It is not interactive and does not require a recipient. Use this to pre-fill static information such as company names, reference numbers, or dates before the signing process begins.
Specifies the type of place.For a text place, the value must be
text.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The text content to display on the document. This is a static value set when the envelope is created and cannot be changed by the recipient.Maximum length is 1000 characters.
The font size in points.Must be between 1 and 144. The default is 12.
The font color for this text place. Must be a six-digit hex color code with a leading
#. Defaults to #000000 (black).Show text input place
Show text input place
A location where the recipient, identified by
recipient_key, types free-form text. Supports input validation, placeholder text, and tooltip hints. Use capture_as to store the entered value in the envelope’s captures.Specifies the type of place.For a text input place, the value must be
text_input.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.A key that stores the recipient’s input in the envelope’s
captures object. When set, the value entered or selected by the recipient is saved under this key after the envelope is completed.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters. Set to null to disable capture.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 field in . The field may expand beyond this width during typing.Must be between 30 and 540. Defaults to 30.
The font size in .Must be between 6 and 12. Defaults to 12.
Show boxed text input place
Show boxed text input place
A series of individual character boxes where the recipient, identified by
recipient_key, enters text one character per box. Use this for structured data such as verification codes, ZIP codes, or the last four digits of an SSN. Use capture_as to store the entered value in the envelope’s captures.Specifies the type of place.For a boxed text input place, the value must be
boxed_text_input.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.The number of individual character boxes to display.Must be between 1 and 100. Each box accepts a single character from the recipient.
Specifies whether the recipient must fill all boxes to complete the signing ceremony.Possible values are
required or optional. The default is required.A placeholder message shown inside the first box during the signing ceremony to guide the recipient.Learn more in Hints and Prompts.
A tooltip message displayed over the boxed text input field during the signing ceremony.Learn more in Hints and Prompts.
A key that stores the recipient’s input in the envelope’s
captures object. When set, the value entered or selected by the recipient is saved under this key after the envelope is completed.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters. Set to null to disable capture.The total width of the boxed input field in .Must be between 30 and 540. The default is 30.
The height of each individual box in .
The font size in .Must be between 6 and 12. The default is 12.
Show multiline text input place
Show multiline text input place
A location where the recipient, identified by
recipient_key, enters text that spans multiple lines. Use this for comments, addresses, and longer descriptions. Use capture_as to store the entered value in the envelope’s captures.Specifies the type of place.For a multi-line text input place, the value must be
multiline_text_input.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.Specifies whether the recipient must fill this field to complete the signing ceremony.Possible values are
required or optional. The default is required.A placeholder message shown inside the input text field during the signing ceremony.Learn more in Hints and Prompts.
A tooltip message displayed over the input text field during the signing ceremony.Learn more in Hints and Prompts.
A key that stores the recipient’s input in the envelope’s
captures object. When set, the value entered or selected by the recipient is saved under this key after the envelope is completed.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters. Set to null to disable capture.The width of the multi-line text input place in .Must be between 30 and 540. The default is 30.
The number of lines for the multi-line text input field.Must be between 1 and 100.
The line height in . Must be greater than or equal to
font_size.Must be between 6 and 72. The default is 12.The font size in .Must be between 6 and 12. The default is 12.
Show checkbox place
Show checkbox place
A location where the recipient, identified by
recipient_key, checks or unchecks a box. Use capture_as to store the checkbox value in the envelope’s captures.Specifies the type of place.For a checkbox place, the value must be
checkbox.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.A key that stores the recipient’s input in the envelope’s
captures object. When set, the value entered or selected by the recipient is saved under this key after the envelope is completed.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters. Set to null to disable capture.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 equals the height.Must be between 8 and 40. Defaults to 20.
Show dropdown place
Show dropdown place
A location where the recipient, identified by
recipient_key, selects from a list of options. Options can be a custom list of label-value pairs or a predefined set such as country names or US state codes. Use capture_as to store the selected value in the envelope’s captures.Specifies the type of place.For a dropdown place, the value must be
dropdown.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.The list of options available in the dropdown. Either an array of custom
label/value pairs, or a string specifying a predefined option set such as us_states_names or world_countries_names.The pre-selected option when the dropdown is displayed.
The display behavior of the dropdown. Possible values:
auto, select, or combobox.Whether the recipient must select an option. Possible values:
required or optional.A placeholder message shown inside the dropdown field during the signing ceremony.
A tooltip message displayed when the user hovers over or focuses on the dropdown field.
A key that stores the recipient’s input in the envelope’s
captures object. When set, the value entered or selected by the recipient is saved under this key after the envelope is completed.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters. Set to null to disable capture.The font size in points for the dropdown field.
The width of the dropdown field in points.
Show recipient completed date place
Show recipient completed date place
Displays the date and time when the recipient, identified by
recipient_key, completed their action on the envelope. Use date_format to control how the date is formatted.Specifies the type of place.For this kind of place, the value must be
recipient_completed_date.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.The date and time format using Moment.js syntax. Common formats include
D MMM YYYY (31 Dec 2025), YYYY-MM-DD (2025-12-31), and MM/DD/YYYY (12/31/2025).Defaults to D MMM YYYY.Show envelope completed date place
Show envelope completed date place
Displays the date and time when the envelope was completed. The envelope completes when all recipients have finished their actions. Use
date_format to control how the date is formatted.Specifies the type of place.For this kind of place, the value must be
envelope_completed_date.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The date and time format using Moment.js syntax. Common formats include
D MMM YYYY (31 Dec 2025), YYYY-MM-DD (2025-12-31), and MM/DD/YYYY (12/31/2025).Defaults to D MMM YYYY.Show recipient name place
Show recipient name place
Displays the name of the recipient, identified by
recipient_key, at a specific location on the document. The value is inserted automatically. This place is read-only and does not require any action from the recipient.Specifies the type of place.For this kind of place, the value must be
recipient_name.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.Show recipient email place
Show recipient email place
Displays the email address of the recipient, identified by
recipient_key, at a specific location on the document. The value is inserted automatically. This place is read-only and does not require any action from the recipient.Specifies the type of place.For this kind of place, the value must be
recipient_email.A unique identifier for this place within the document. Use this key to match the place to its position, either through a
[[place_key]] placeholder in the document or an entry in fixed_positions.Must start with a lowercase letter and contain only lowercase letters, numbers, and underscores. Maximum 32 characters.The key of the recipient assigned to this place. Must match one of the
key values in the envelope’s recipients array.// HTTP Status Code 200
{
"id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
"envelope_id": "5e5ace5e-bd1e-4d5a-bb1f-6a2b2e42cd13",
"key": "agreement",
"title": "Service Agreement",
"page_count": 3,
"url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/agreement.pdf",
"format": "pdf",
"fixed_positions": [
{
"place_key": "provider_signs_here",
"page": 3,
"top": 600,
"left": 72
}
],
"places": [
{
"key": "provider_signs_here",
"type": "signature",
"recipient_key": "service_provider",
"height": 60
},
{
"key": "client_signs_here",
"type": "signature",
"recipient_key": "client",
"height": 60
}
]
}