> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL. > > Documentation indexes by section: > - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt > - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt > - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt > - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt > > Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth > Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks > > OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json > MCP server: https://docusign.docs.buildwithfern.com/_mcp/server # Get tabs on page GET https://demo.docusign.net/restapi/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs Reference: https://developers.docusign.com/docs/esign-rest-api/v2/reference/envelopes/envelopedocumenttabs/getbypage ## Authentication - `Authorization` header (required) — OAuth 2.0 access token (JWT or auth-code grant). Sent as Authorization: Bearer \. ## Servers - `https://demo.docusign.net/restapi` (Demo, default) - `https://www.docusign.net/restapi` (Production) ## Request ### Path parameters - `accountId` (string, required) — The external account number (int) or account id GUID. - `documentId` (string, required) — The ID of the document being accessed. - `envelopeId` (string, required) — The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec - `pageNumber` (string, required) — The page number being accessed. ## Response ### 200 Successful response. - `approveTabs` (list of approve, optional) — A list of [Approve tabs][approve]. This tab allows the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history. [approve]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/approve - `checkboxTabs` (list of checkbox, optional) — A list of [Checkbox tabs][checkbox]. This tab allows the recipient to select a yes/no (on/off) option. [checkbox]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/checkbox - `companyTabs` (list of company, optional) — A list of [Company tabs][company]. This tab displays the recipient's company name. [company]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company - `dateSignedTabs` (list of dateSigned, optional) — A list of [Date Signed tabs][dateSigned] This tab displays the date that the recipient signed the document. [dateSigned]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/dateSigned - `dateTabs` (list of date, optional) — A list of [Date tabs][date]. This tab allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format. [date]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/date - `declineTabs` (list of decline, optional) — A list of [Decline tabs][decline]. This tab allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided. [decline]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/decline - `emailAddressTabs` (list of emailAddress, optional) — A list of [Email Address tabs][emailAddress]. This tab displays the recipient's email as entered in the recipient information. [emailAddress]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/emailAddress - `emailTabs` (list of email, optional) — A list of [Email tabs][email]. This tab allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. [email]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/email - `envelopeIdTabs` (list of envelopeId, optional) — A list of [Envelope ID tabs][envelopeId]. This tab displays the envelope ID. Recipients cannot enter or change the information in this tab. [envelopeId]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId - `firstNameTabs` (list of firstName, optional) — A list of [First Name tabs][firstName]. This tab displays the recipient's first name. It takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. [firstName]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName - `formulaTabs` (list of formulaTab, optional) — A list of [Formula tabs][formulaTab]. The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result. The `formula` property of the tab contains the references to the underlying tabs. See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. If a formula tab contains a `paymentDetails` property, the tab is considered a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures [formulaTab]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab - `fullNameTabs` (list of fullName, optional) — A list of [Full Name tabs][fullName]. This tab displays the recipient's full name. [fullName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/fullName - `initialHereTabs` (list of initialHere, optional) — A list of [Initial Here tabs][initialHere]. This tab allows the recipient to initial the document. May be optional. [initialHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/initialHere - `lastNameTabs` (list of lastName, optional) — A list of [Last Name tabs][lastName]. This tab displays the recipient's last name. It takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. [lastName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/lastName - `listTabs` (list of list, optional) — A list of [list tabs][list]. This tab offers a list of options to choose from. The `listItems` property is used to specify the selectable options. [list]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/list - `notarizeTabs` (list of notarize, optional) — A list of [Notarize tabs][notarize]. A notarize tab is a tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page. [notarize]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/notarize - `noteTabs` (list of note, optional) — A list of [Note tabs][note]. This tab displays additional information, in the form of a note, for the recipient. [note]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/note - `numberTabs` (list of number, optional) — A list of [Number tabs][number]. This tab allows the recipient to enter numbers and decimal (.) points. [number]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number - `radioGroupTabs` (list of radioGroup, optional) — A list of [Radio Group tabs][radioGroup]. This tab This group tab is used to place radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. [radioGroup]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup - `signerAttachmentTabs` (list of signerAttachment, optional) — A list of [Signer Attachment tabs][signerAttachment]. This tab allows the recipient to attach supporting documents to an envelope. [signerAttachment]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signerAttachment - `signHereTabs` (list of signHere, optional) — A list of [Sign Here tabs][signHere]. This tab allows the recipient to sign a document. May be optional. [signHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signHere - `smartSectionTabs` (list of smartSection, optional) - `ssnTabs` (list of ssn, optional) — A list of [SSN tabs][ssn]. This tab is a one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. [ssn]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/ssn - `textTabs` (list of text, optional) — A list of [Text tabs][text]. This tab A tab that allows the recipient to enter any type of text. [text]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/text - `titleTabs` (list of title, optional) — A list of [Title tabs][title]. This tab displays the recipient's title. [title]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/title - `viewTabs` (list of view, optional) — A list of [View tabs][view]. This tab This tab is used with the Approve tab to handle supplemental documents. [view]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/view - `zipTabs` (list of zip, optional) — A list of [Zip tabs][zip]. This tab allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. [zip]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/zip ## Errors ### 400 Bad Request Error Error encountered. - `errorCode` (string, optional) — An error code associated with the error. - `message` (string, optional) — A short error message. ## Types ### approve A tab that allows the recipient to approve documents without placing a signature or initials on the document. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `buttonText` (string, optional) — Specifies the approval text displayed in the tab. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `height` (integer, optional) — Height of the tab in pixels. - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `width` (integer, optional) — Width of the tab in pixels. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### checkbox A tab that allows the recipient to select a yes/no (on/off) option. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) — Specifies the tool tip text for the tab. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `required` (string, optional) — This property does not apply to `checkbox` tabs. Check boxes are always optional. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - `selected` (string, optional) — When set to **true**, the checkbox is selected. - `shared` (string, optional) — When set to **true**, this custom tab is shared. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6) ### company A tab that displays the recipient's company name. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `concealValueOnDocument` (string, optional) — When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `disableAutoSize` (string, optional) — When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab. - `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) — Specifies the tool tip text for the tab. - `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `required` (string, optional) — When set to **true**, the signer is required to fill out this tab - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `value` (string, optional) — Specifies the value of the tab. - `width` (integer, optional) — Width of the tab in pixels. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### dateSigned A tab that displays the date that the recipient signed the document. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `value` (string, optional) — Specifies the value of the tab. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### date A tab that allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `concealValueOnDocument` (string, optional) — When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `disableAutoSize` (string, optional) — When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab. - `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) - `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope. - `required` (string, optional) — When set to **true**, the signer is required to fill out this tab - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `shared` (string, optional) — When set to **true**, this custom tab is shared. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationPattern` (string, optional) — A regular expressionn used to validate input for the tab. - `value` (string, optional) — Specifies the value of the tab. - `width` (integer, optional) — Width of the tab in pixels. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### decline A tab that allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `buttonText` (string, optional) — Specifies the decline text displayed in the tab. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `declineReason` (string, optional) — The reason the recipient declined the document. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `height` (integer, optional) — Height of the tab in pixels. - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `width` (integer, optional) — Width of the tab in pixels. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### emailAddress A tab that displays the recipient's email as entered in the recipient information. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `value` (string, optional) — Specifies the value of the tab. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### email A tab that allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `concealValueOnDocument` (string, optional) — When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `disableAutoSize` (string, optional) — When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab. - `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) - `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope. - `required` (string, optional) — When set to **true**, the signer is required to fill out this tab - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `shared` (string, optional) — When set to **true**, this custom tab is shared. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationPattern` (string, optional) — A regular expressionn used to validate input for the tab. - `value` (string, optional) — Specifies the value of the tab. - `width` (integer, optional) — Width of the tab in pixels. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### envelopeId A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ### firstName A tab that displays the recipient's first name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `value` (string, optional) — Specifies the value of the tab. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### formulaTab The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result. The `formula` property of the tab contains the references to the underlying tabs. See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. If a formula tab contains a `paymentDetails` property, the tab is considered a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `concealValueOnDocument` (string, optional) — When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `disableAutoSize` (string, optional) — When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `formula` (string, optional) — Contains the formula for calculating the value of this tab. Use a tab's `tabLabel`, enclosed in brackets, to refer to it. For example, you want to present the total cost of two items, tax included. The cost of each item is stored in number tabs labeled Item1 and Item2. The tax rate is in a number tab labeled TaxRate. The formula string for this property would be: `([Item1] + [Item2]) * (1 + [TaxRate])` See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. Maximum Length: 2000 characters [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields - `hidden` (string, optional) — If this is a regular formula (no `paymentDetails` property is present): * **true**: The tab is hidden. * **false**: The tab is shown. If the formula is payment item (a `paymentDetails` property is present): * **true**: The tab is displayed as a payment. * **false**: The tab is displayed as a regular formula. - `isPaymentAmount` (string, optional) — When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab. - `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) - `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `paymentDetails` (paymentDetails, optional) — When a formula tab has a `paymentDetails` property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope. - `required` (string, optional) — When set to **true**, the signer is required to fill out this tab - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - `roundDecimalPlaces` (string, optional) - `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `shared` (string, optional) — When set to **true**, this custom tab is shared. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationPattern` (string, optional) — A regular expressionn used to validate input for the tab. - `value` (string, optional) — Specifies the value of the tab. - `width` (integer, optional) — Width of the tab in pixels. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+35, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+35, -2) ### fullName A tab that displays the recipient's full name. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `value` (string, optional) — Specifies the value of the tab. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### initialHere A tab that allows the recipient to initial the document. May be optional. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) — Specifies the tool tip text for the tab. - `optional` (string, optional) - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `scaleValue` (float, optional) — Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -23) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -23) ### lastName A tab that displays the recipient's last name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `value` (string, optional) — Specifies the value of the tab. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### list This tab offers a list of options to choose from. The `listItems` property contains a list of [`listItem`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/listItem) objects to specify the selectable options. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `listItems` (list of listItem, optional) — The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four] Maximum Length of listItems: 2048 characters. Maximum Length of items in the list: 100 characters. - `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope. - `required` (string, optional) — When set to **true**, the signer is required to fill out this tab - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `shared` (string, optional) — When set to **true**, this custom tab is shared. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `value` (string, optional) — The value to use when the item is selected. - `width` (integer, optional) — Width of the tab in pixels. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### notarize A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) - `documentId` (string, optional) — The ID of the document being accessed. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `pageNumber` (string, optional) — The page number being accessed. - `recipientId` (string, optional) — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `required` (string, optional) — When set to **true**, the signer is required to fill out this tab - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ### note A tab that displays additional information, in the form of a note, for the recipient. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `height` (integer, optional) — Height of the tab in pixels. - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) — Specifies the tool tip text for the tab. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `shared` (string, optional) — When set to **true**, this custom tab is shared. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `value` (string, optional) — Specifies the value of the tab. - `width` (integer, optional) — Width of the tab in pixels. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### number A tab that allows the recipient to enter numbers and decimal (.) points. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `concealValueOnDocument` (string, optional) — When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `disableAutoSize` (string, optional) — When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `formula` (string, optional) — Contains the formula for calculating the value of this tab. Use a tab's `tabLabel`, enclosed in brackets, to refer to it. For example, you want to present the total cost of two items, tax included. The cost of each item is stored in number tabs labeled Item1 and Item2. The tax rate is in a number tab labeled TaxRate. The formula string for this property would be: `([Item1] + [Item2]) * (1 + [TaxRate])` See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. Maximum Length: 2000 characters [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields - `isPaymentAmount` (string, optional) — When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab. - `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) — Specifies the tool tip text for the tab. - `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope. - `required` (string, optional) — When set to **true**, the signer is required to fill out this tab - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `shared` (string, optional) — When set to **true**, this custom tab is shared. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationPattern` (string, optional) — A regular expressionn used to validate input for the tab. - `value` (string, optional) — Specifies the value of the tab. - `width` (integer, optional) — Width of the tab in pixels. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### radioGroup This group tab is used to place radio buttons on a document. The `radios` property contains a list of [`radio`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radio) objects associated with the group. Only one radio button can be selected in a group. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `groupName` (string, optional) — The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. - `radios` (list of radio, optional) — Specifies the locations and status for radio buttons that are grouped together. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - `shared` (string, optional) — When set to **true**, this custom tab is shared. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) ### signerAttachment A tab that allows the recipient to attach supporting documents to an envelope. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) - `optional` (string, optional) - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `scaleValue` (float, optional) - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+0, -24) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+0, -24) ### signHere A tab that allows the recipient to sign a document. May be optional. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) — Specifies the tool tip text for the tab. - `optional` (string, optional) - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `scaleValue` (float, optional) - `stampType` (string, optional) - `stampTypeMetadata` (propertyMetadata, optional) - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -27) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -27) ### smartSection - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `caseSensitive` (boolean, optional) - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) - `displaySettings` (smartSectionDisplaySettings, optional) - `documentId` (string, optional) — The ID of the document being accessed. - `endAnchor` (string, optional) - `endPosition` (smartSectionAnchorPosition, optional) - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `pageNumber` (string, optional) — The page number being accessed. - `recipientId` (string, optional) — A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `removeEndAnchor` (boolean, optional) - `removeStartAnchor` (boolean, optional) - `startAnchor` (string, optional) - `startPosition` (smartSectionAnchorPosition, optional) - `status` (string, optional) — Item status. - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ### ssn A one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `concealValueOnDocument` (string, optional) — When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `disableAutoSize` (string, optional) — When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab. - `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) — Specifies the tool tip text for the tab. - `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope. - `required` (string, optional) — When set to **true**, the signer is required to fill out this tab - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `shared` (string, optional) — When set to **true**, this custom tab is shared. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationPattern` (string, optional) — A regular expressionn used to validate input for the tab. - `value` (string, optional) — Specifies the value of the tab. - `width` (integer, optional) — Width of the tab in pixels. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### text A tab that allows the recipient to enter any type of text. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `concealValueOnDocument` (string, optional) — When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `disableAutoSize` (string, optional) — When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `formula` (string, optional) — Contains the formula for calculating the value of this tab. Use a tab's `tabLabel`, enclosed in brackets, to refer to it. For example, you want to present the total cost of two items, tax included. The cost of each item is stored in number tabs labeled Item1 and Item2. The tax rate is in a number tab labeled TaxRate. The formula string for this property would be: `([Item1] + [Item2]) * (1 + [TaxRate])` See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. Maximum Length: 2000 characters [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields - `height` (integer, optional) — Height of the tab in pixels. - `isPaymentAmount` (string, optional) — When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab. - `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) — Specifies the tool tip text for the tab. - `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope. - `required` (string, optional) — When set to **true**, the signer is required to fill out this tab - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `shared` (string, optional) — When set to **true**, this custom tab is shared. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationPattern` (string, optional) — A regular expressionn used to validate input for the tab. - `value` (string, optional) — Specifies the value of the tab. - `width` (integer, optional) — Width of the tab in pixels. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### title A tab that displays the recipient's title. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `concealValueOnDocument` (string, optional) — When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `disableAutoSize` (string, optional) — When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab. - `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) - `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `required` (string, optional) — When set to **true**, the signer is required to fill out this tab - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `value` (string, optional) — Specifies the value of the tab. - `width` (integer, optional) — Width of the tab in pixels. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### view This tab is used with the Approve tab to handle supplemental documents. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `buttonText` (string, optional) - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `height` (integer, optional) — Height of the tab in pixels. - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `required` (string, optional) — When set to **true**, the signer is required to fill out this tab - `requiredRead` (string, optional) - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `width` (integer, optional) — Width of the tab in pixels. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ### zip A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `bold` (string, optional) — When set to **true**, the information in the tab is bold. - `concealValueOnDocument` (string, optional) — When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `disableAutoSize` (string, optional) — When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `font` (string, optional) — The font to be used for the tab value. Supported Fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color used for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `italic` (string, optional) — When set to **true**, the information in the tab is italic. - `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab. - `maxLength` (integer, optional) — An optional value that describes the maximum length of the property when the property is a string. - `mergeField` (mergeField, optional) — Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `name` (string, optional) - `originalValue` (string, optional) — The initial value of the tab when it was sent to the recipient. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `requireAll` (string, optional) — When set to **true** and shared is true, information must be entered in this field to complete the envelope. - `required` (string, optional) — When set to **true**, the signer is required to fill out this tab - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. - `senderRequired` (string, optional) — When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `shared` (string, optional) — When set to **true**, this custom tab is shared. - `status` (string, optional) — Tab status - `tabGroupLabels` (list of string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabLabel` (string, optional) — The label string associated with the tab. The string may be the empty string. If no value is provided, the tab type is used as the value. Maximum of 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `tooltip` (string, optional) - `underline` (string, optional) — When set to **true**, the information in the tab is underlined. - `useDash4` (string, optional) - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationPattern` (string, optional) — A regular expressionn used to validate input for the tab. - `value` (string, optional) — Specifies the value of the tab. - `width` (integer, optional) — Width of the tab in pixels. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. To improve the tab's position on the document, DocuSign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) ### errorDetails This object describes errors that occur. It is only valid for responses, and ignored in requests. - `errorCode` (string, optional) — An error code associated with the error. - `message` (string, optional) — A short error message. ### mergeField Contains information for transfering values between Salesforce data fields and DocuSign Tabs. - `allowSenderToEdit` (string, optional) — When set to **true**, the sender can modify the value of the custom tab during the sending process. - `configurationType` (string, optional) — If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. - `path` (string, optional) — Sets the object associated with the custom tab. Currently this is the Salesforce Object. - `row` (string, optional) — Specifies the row number in a Salesforce table that the merge field value corresponds to. - `writeBack` (string, optional) — When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed. ### paymentDetails When a formula tab has a `paymentDetails` property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures - `allowedPaymentMethods` (list of string, optional) — An array of accepted payment methods: * `CreditCard` * `ApplePay` * `AndroidPay` * `BankAccount` For example, if you only accept credit cards and ACH transfers, you would set this property to: `'["BankAccount", "CreditCard"]'` Do not specify `BankAccount` (ACH) if you are also using in-person signing. - `chargeId` (string, optional) — The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment. - `currencyCode` (string, optional) — Specifies the three-letter [ISO 4217][ISO4217] currency code for the payment. Supported currencies are: * AUD Australian dollar * CAD Canadian dollar * EUR Euro * GBP Great Britain pound * USD United States dollar Specifying any other ISO 4217 code for payments is an error. [ISO4217]: https://en.wikipedia.org/wiki/ISO_4217 - `customerId` (string, optional) - `customMetadata` (string, optional) - `customMetadataRequired` (boolean, optional) - `gatewayAccountId` (string, optional) — A GUID that identifies the payment gateway connected to the sender's DocuSign account. There is no public API for connecting payment gateway accounts You must connect and manage payment gateway accounts through the DocuSign Admin console and through your chosen payment gateway. You can get the gateway account ID in the Payments section of the DocuSign Admin console. [paymentgateways]: https://support.docusign.com/en/guides/managing-payment-gateways - `gatewayDisplayName` (string, optional) — Display name of the gateway connected to sender's Docusign account. Possible values are: Stripe, Braintree, Authorize.Net. - `gatewayName` (string, optional) — Name of the gateway connected to sender's DocuSign account. Possible values are: * `Stripe` * `Braintree` * `AuthorizeDotNet` - `lineItems` (list of paymentLineItem, optional) — A payment formula can have one or more line items that provide detail about individual items in a payment request. The list of line items are returned as metadata to the payment gateway. - `paymentOption` (string, optional) - `paymentSourceId` (string, optional) - `signerValues` (paymentSignerValues, optional) - `status` (string, optional) — This read-only property describes the status of a payment. * `new` This is a new payment request. The envelope has been created, but no payment authorizations have been made. * `auth_complete` A recipient has entered their credit card information, but the envelope has not been completed. The card has not been charged. * `payment_complete` The recipient's card has been charged. * `payment_capture_failed` Final charge failed. This can happen when too much time passes between authorizing the payment and completing the document. - `total` (money, optional) — Describes information about the `total` of a payment. ### listItem One of the selectable items in the `listItems` property of a [`list`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/list) tab. - `selected` (string, optional) — When set to **true**, indicates that this item is the default selection shown to a signer. Only one selection can be set as the default. - `text` (string, optional) — Specifies the text that is shown in the dropdown list. - `value` (string, optional) — Specifies the value that is used when the list item is selected. ### radio One of the selectable radio buttons in the `radios` property of a [`radioGroup`](https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup) tab. - `anchorCaseSensitive` (string, optional) — Reserved for DocuSign. - `anchorHorizontalAlignment` (string, optional) — Reserved for DocuSign. - `anchorIgnoreIfNotPresent` (string, optional) — When set to **true**, this tab is ignored if anchorString is not found in the document. - `anchorMatchWholeWord` (string, optional) — Reserved for DocuSign. - `anchorString` (string, optional) — Specifies the anchor string. - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `locked` (string, optional) — When set to **true**, the signer cannot change the data of the custom tab. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `required` (string, optional) — When set to **true**, the signer is required to fill out this tab - `selected` (string, optional) — When set to **true**, the radio button is selected. - `tabId` (string, optional) — The unique identifier for the tab. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `value` (string, optional) — Specifies the value of the tab. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ### propertyMetadata - `options` (list of string, optional) - `rights` (string, optional) ### smartSectionDisplaySettings - `cellStyle` (string, optional) - `collapsibleSettings` (smartSectionCollapsibleDisplaySettings, optional) - `display` (string, optional) — This string sets the display and behavior properties of the document during signing. The possible values are: * `modal` The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. This is the recommended value for supplemental documents. * `download` The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a new browser window. * `inline` The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents. - `displayLabel` (string, optional) - `displayOrder` (integer, optional) - `displayPageNumber` (integer, optional) - `hideLabelWhenOpened` (boolean, optional) - `inlineOuterStyle` (string, optional) - `labelWhenOpened` (string, optional) - `preLabel` (string, optional) - `scrollToTopWhenOpened` (boolean, optional) - `tableStyle` (string, optional) ### smartSectionAnchorPosition - `pageNumber` (integer, optional) — The page number being accessed. - `xPosition` (double, optional) — This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. - `yPosition` (double, optional) — This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ### paymentLineItem A line item describes details about an individual line item in a payment request. - `amountReference` (string, optional) — This is a the `tabLabel` that specifies the amount paid for the line items. - `description` (string, optional) — A sender-defined description of the line item. - `itemCode` (string, optional) — This is the sender-defined SKU, inventory number, or other item code for the line item. - `name` (string, optional) — This is a sender-defined product name, service name, or other designation for the line item. ### paymentSignerValues - `paymentOption` (string, optional) ### money Describes information about the `total` of a payment. - `amountInBaseUnit` (string, optional) — The total payment amount in the currency's base unit. For example, for USD the base currency is one cent. - `currency` (string, optional) — The three-letter [ISO 4217][ISO4217] currency code for the payment. For example: * AUD Australian dollar * CAD Canadian dollar * EUR Euro * GBP Great Britain pound * USD United States dollar This is a read-only property. [ISO4217]: https://en.wikipedia.org/wiki/ISO_4217 - `displayAmount` (string, optional) — The payment amount as displayed in the `currency`. For example, if the payment amount is USD 12.59, the `amountInBaseUnit` is 1259 (cents), and the displayed amount is `$12.59 USD`. This is a read-only property. ### smartSectionCollapsibleDisplaySettings - `arrowClosed` (string, optional) - `arrowColor` (string, optional) - `arrowLocation` (string, optional) - `arrowOpen` (string, optional) - `arrowSize` (string, optional) - `arrowStyle` (string, optional) - `containerStyle` (string, optional) - `labelStyle` (string, optional) - `onlyArrowIsClickable` (boolean, optional) - `outerLabelAndArrowStyle` (string, optional) ## Examples **Response** ```json { "approveTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "buttonText": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "height": 1, "italic": "string", "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "pageNumber": "string", "recipientId": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "width": 1, "xPosition": "string", "yPosition": "string" } ], "checkboxTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "locked": "string", "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "pageNumber": "string", "recipientId": "string", "required": "string", "requireInitialOnSharedChange": "string", "selected": "string", "shared": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "xPosition": "string", "yPosition": "string" } ], "companyTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "concealValueOnDocument": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "disableAutoSize": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "italic": "string", "locked": "string", "maxLength": 1, "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "originalValue": "string", "pageNumber": "string", "recipientId": "string", "required": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "value": "string", "width": 1, "xPosition": "string", "yPosition": "string" } ], "dateSignedTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "italic": "string", "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "pageNumber": "string", "recipientId": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "value": "string", "xPosition": "string", "yPosition": "string" } ], "dateTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "concealValueOnDocument": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "disableAutoSize": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "italic": "string", "locked": "string", "maxLength": 1, "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "originalValue": "string", "pageNumber": "string", "recipientId": "string", "requireAll": "string", "required": "string", "requireInitialOnSharedChange": "string", "senderRequired": "string", "shared": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "validationMessage": "string", "validationPattern": "string", "value": "string", "width": 1, "xPosition": "string", "yPosition": "string" } ], "declineTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "buttonText": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "declineReason": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "height": 1, "italic": "string", "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "pageNumber": "string", "recipientId": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "width": 1, "xPosition": "string", "yPosition": "string" } ], "emailAddressTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "italic": "string", "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "pageNumber": "string", "recipientId": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "value": "string", "xPosition": "string", "yPosition": "string" } ], "emailTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "concealValueOnDocument": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "disableAutoSize": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "italic": "string", "locked": "string", "maxLength": 1, "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "originalValue": "string", "pageNumber": "string", "recipientId": "string", "requireAll": "string", "required": "string", "requireInitialOnSharedChange": "string", "senderRequired": "string", "shared": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "validationMessage": "string", "validationPattern": "string", "value": "string", "width": 1, "xPosition": "string", "yPosition": "string" } ], "envelopeIdTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "italic": "string", "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "pageNumber": "string", "recipientId": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "xPosition": "string", "yPosition": "string" } ], "firstNameTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "italic": "string", "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "pageNumber": "string", "recipientId": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "value": "string", "xPosition": "string", "yPosition": "string" } ], "formulaTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "concealValueOnDocument": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "disableAutoSize": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "formula": "string", "hidden": "string", "isPaymentAmount": "string", "italic": "string", "locked": "string", "maxLength": 1, "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "originalValue": "string", "pageNumber": "string", "paymentDetails": { "allowedPaymentMethods": [ "string" ], "chargeId": "string", "currencyCode": "string", "customerId": "string", "customMetadata": "string", "customMetadataRequired": true, "gatewayAccountId": "string", "gatewayDisplayName": "string", "gatewayName": "string", "lineItems": [ { "amountReference": "string", "description": "string", "itemCode": "string", "name": "string" } ], "paymentOption": "string", "paymentSourceId": "string", "signerValues": { "paymentOption": "string" }, "status": "string", "total": { "amountInBaseUnit": "string", "currency": "string", "displayAmount": "string" } }, "recipientId": "string", "requireAll": "string", "required": "string", "requireInitialOnSharedChange": "string", "roundDecimalPlaces": "string", "senderRequired": "string", "shared": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "validationMessage": "string", "validationPattern": "string", "value": "string", "width": 1, "xPosition": "string", "yPosition": "string" } ], "fullNameTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "italic": "string", "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "pageNumber": "string", "recipientId": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "value": "string", "xPosition": "string", "yPosition": "string" } ], "initialHereTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "optional": "string", "pageNumber": "string", "recipientId": "string", "scaleValue": 1.1, "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "xPosition": "string", "yPosition": "string" } ], "lastNameTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "italic": "string", "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "pageNumber": "string", "recipientId": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "value": "string", "xPosition": "string", "yPosition": "string" } ], "listTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "italic": "string", "listItems": [ { "selected": "string", "text": "string", "value": "string" } ], "locked": "string", "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "pageNumber": "string", "recipientId": "string", "requireAll": "string", "required": "string", "requireInitialOnSharedChange": "string", "senderRequired": "string", "shared": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "value": "string", "width": 1, "xPosition": "string", "yPosition": "string" } ], "notarizeTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "locked": "string", "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "pageNumber": "string", "recipientId": "string", "required": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "xPosition": "string", "yPosition": "string" } ], "noteTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "height": 1, "italic": "string", "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "pageNumber": "string", "recipientId": "string", "shared": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "value": "string", "width": 1, "xPosition": "string", "yPosition": "string" } ], "numberTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "concealValueOnDocument": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "disableAutoSize": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "formula": "string", "isPaymentAmount": "string", "italic": "string", "locked": "string", "maxLength": 1, "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "originalValue": "string", "pageNumber": "string", "recipientId": "string", "requireAll": "string", "required": "string", "requireInitialOnSharedChange": "string", "senderRequired": "string", "shared": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "validationMessage": "string", "validationPattern": "string", "value": "string", "width": 1, "xPosition": "string", "yPosition": "string" } ], "radioGroupTabs": [ { "conditionalParentLabel": "string", "conditionalParentValue": "string", "documentId": "string", "groupName": "string", "radios": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "locked": "string", "pageNumber": "string", "required": "string", "selected": "string", "tabId": "string", "tabOrder": "string", "value": "string", "xPosition": "string", "yPosition": "string" } ], "recipientId": "string", "requireAll": "string", "requireInitialOnSharedChange": "string", "shared": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string" } ], "signerAttachmentTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "optional": "string", "pageNumber": "string", "recipientId": "string", "scaleValue": 1.1, "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "xPosition": "string", "yPosition": "string" } ], "signHereTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "optional": "string", "pageNumber": "string", "recipientId": "string", "scaleValue": 1.1, "stampType": "string", "stampTypeMetadata": { "options": [ "string" ], "rights": "string" }, "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "xPosition": "string", "yPosition": "string" } ], "smartSectionTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "caseSensitive": true, "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "displaySettings": { "cellStyle": "string", "collapsibleSettings": { "arrowClosed": "string", "arrowColor": "string", "arrowLocation": "string", "arrowOpen": "string", "arrowSize": "string", "arrowStyle": "string", "containerStyle": "string", "labelStyle": "string", "onlyArrowIsClickable": true, "outerLabelAndArrowStyle": "string" }, "display": "string", "displayLabel": "string", "displayOrder": 1, "displayPageNumber": 1, "hideLabelWhenOpened": true, "inlineOuterStyle": "string", "labelWhenOpened": "string", "preLabel": "string", "scrollToTopWhenOpened": true, "tableStyle": "string" }, "documentId": "string", "endAnchor": "string", "endPosition": { "pageNumber": 1, "xPosition": 1.1, "yPosition": 1.1 }, "errorDetails": { "errorCode": "string", "message": "string" }, "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "pageNumber": "string", "recipientId": "string", "removeEndAnchor": true, "removeStartAnchor": true, "startAnchor": "string", "startPosition": { "pageNumber": 1, "xPosition": 1.1, "yPosition": 1.1 }, "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "xPosition": "string", "yPosition": "string" } ], "ssnTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "concealValueOnDocument": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "disableAutoSize": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "italic": "string", "locked": "string", "maxLength": 1, "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "originalValue": "string", "pageNumber": "string", "recipientId": "string", "requireAll": "string", "required": "string", "requireInitialOnSharedChange": "string", "senderRequired": "string", "shared": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "validationMessage": "string", "validationPattern": "string", "value": "string", "width": 1, "xPosition": "string", "yPosition": "string" } ], "textTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "concealValueOnDocument": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "disableAutoSize": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "formula": "string", "height": 1, "isPaymentAmount": "string", "italic": "string", "locked": "string", "maxLength": 1, "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "originalValue": "string", "pageNumber": "string", "recipientId": "string", "requireAll": "string", "required": "string", "requireInitialOnSharedChange": "string", "senderRequired": "string", "shared": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "validationMessage": "string", "validationPattern": "string", "value": "string", "width": 1, "xPosition": "string", "yPosition": "string" } ], "titleTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "concealValueOnDocument": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "disableAutoSize": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "italic": "string", "locked": "string", "maxLength": 1, "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "originalValue": "string", "pageNumber": "string", "recipientId": "string", "required": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "value": "string", "width": 1, "xPosition": "string", "yPosition": "string" } ], "viewTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "buttonText": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "height": 1, "italic": "string", "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "pageNumber": "string", "recipientId": "string", "required": "string", "requiredRead": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "width": 1, "xPosition": "string", "yPosition": "string" } ], "zipTabs": [ { "anchorCaseSensitive": "string", "anchorHorizontalAlignment": "string", "anchorIgnoreIfNotPresent": "string", "anchorMatchWholeWord": "string", "anchorString": "string", "anchorUnits": "string", "anchorXOffset": "string", "anchorYOffset": "string", "bold": "string", "concealValueOnDocument": "string", "conditionalParentLabel": "string", "conditionalParentValue": "string", "customTabId": "string", "disableAutoSize": "string", "documentId": "string", "errorDetails": { "errorCode": "string", "message": "string" }, "font": "string", "fontColor": "string", "fontSize": "string", "italic": "string", "locked": "string", "maxLength": 1, "mergeField": { "allowSenderToEdit": "string", "configurationType": "string", "path": "string", "row": "string", "writeBack": "string" }, "name": "string", "originalValue": "string", "pageNumber": "string", "recipientId": "string", "requireAll": "string", "required": "string", "requireInitialOnSharedChange": "string", "senderRequired": "string", "shared": "string", "status": "string", "tabGroupLabels": [ "string" ], "tabId": "string", "tabLabel": "string", "tabOrder": "string", "templateLocked": "string", "templateRequired": "string", "tooltip": "string", "underline": "string", "useDash4": "string", "validationMessage": "string", "validationPattern": "string", "value": "string", "width": 1, "xPosition": "string", "yPosition": "string" } ] } ```