openapi: 3.0.1 info: title: DocuSign Admin AccountBrands EnvelopeDocumentTabs API description: An API for an organization administrator to manage organizations, accounts and users termsOfService: https://www.docusign.com/company/terms-and-conditions/developers contact: name: DocuSign Developer Center url: https://developers.docusign.com email: devcenter@docusign.com version: v2.1 servers: - url: https://api.docusign.net/Management tags: - name: EnvelopeDocumentTabs description: The EnvelopeDocumentTabs resource provides methods that allow you to manage various tabs in envelopes. For a complete list of options see the following Properties section. paths: /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/pages/{pageNumber}/tabs: get: tags: - EnvelopeDocumentTabs summary: Docusign Returns tabs on the specified page. operationId: Tabs_GetPageTabs parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: documentId in: path description: The ID of the document being accessed. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: pageNumber in: path description: The page number being accessed. required: true schema: type: string responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/EnvelopeDocumentTabs' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: getPageTabs x-ds-method: getByPage x-ds-service: Envelopes x-ds-in-sdk: true /v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs: get: tags: - EnvelopeDocumentTabs summary: Docusign Returns tabs on the document. operationId: Tabs_GetDocumentTabs parameters: - name: accountId in: path description: The external account number (int) or account id GUID. required: true schema: type: string - name: documentId in: path description: The ID of the document being accessed. required: true schema: type: string - name: envelopeId in: path description: 'The envelope''s GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec ' required: true schema: type: string - name: page_numbers in: query schema: type: string responses: '200': description: Successful response. content: '*/*': schema: $ref: '#/components/schemas/EnvelopeDocumentTabs' '400': description: Error encountered. content: '*/*': schema: $ref: '#/components/schemas/errorDetails' deprecated: false x-ds-methodname: getDocumentTabs x-ds-method: get x-ds-service: Envelopes x-ds-in-sdk: true components: schemas: checkbox: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. required: type: string description: This property does not apply to `checkbox` tabs. Check boxes are always optional. requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. selected: type: string description: When set to **true**, the checkbox is selected. shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: '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: type: string description: '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) ' description: 'A tab that allows the recipient to select a yes/no (on/off) option. ' x-ds-definition-name: checkbox x-ms-summary: 'A tab that allows the recipient to select a yes/no (on/off) option. ' signHere: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. optional: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. scaleValue: type: number description: '' format: float stampType: type: string description: '' stampTypeMetadata: $ref: '#/components/schemas/propertyMetadata' status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: '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: type: string description: '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) ' description: 'A tab that allows the recipient to sign a document. May be optional. ' x-ds-definition-name: signHere x-ms-summary: 'A tab that allows the recipient to sign a document. May be optional. ' paymentLineItem: type: object properties: amountReference: type: string description: 'This is a the `tabLabel` that specifies the amount paid for the line items. ' description: type: string description: 'A sender-defined description of the line item. ' itemCode: type: string description: 'This is the sender-defined SKU, inventory number, or other item code for the line item. ' name: type: string description: 'This is a sender-defined product name, service name, or other designation for the line item. ' description: 'A line item describes details about an individual line item in a payment request. ' x-ds-definition-name: paymentLineItem x-ms-summary: 'A line item describes details about an individual line item in a payment request. ' text: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: '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: type: integer description: Height of the tab in pixels. format: int32 isPaymentAmount: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: '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: type: string description: '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) ' description: 'A tab that allows the recipient to enter any type of text. ' x-ds-definition-name: text x-ms-summary: 'A tab that allows the recipient to enter any type of text. ' company: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. required: type: string description: When set to **true**, the signer is required to fill out this tab status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: '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: type: string description: '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) ' description: 'A tab that displays the recipient''s company name. ' x-ds-definition-name: company x-ms-summary: 'A tab that displays the recipient''s company name. ' paymentDetails: type: object properties: allowedPaymentMethods: type: array description: '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. ' items: type: string chargeId: type: string description: 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: type: string description: '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: type: string description: '' customMetadata: type: string description: '' customMetadataRequired: type: boolean description: '' gatewayAccountId: type: string description: '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: type: string description: 'Display name of the gateway connected to sender''s Docusign account. Possible values are: Stripe, Braintree, Authorize.Net.' gatewayName: type: string description: 'Name of the gateway connected to sender''s DocuSign account. Possible values are: * `Stripe` * `Braintree` * `AuthorizeDotNet`' lineItems: type: array description: '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. ' items: $ref: '#/components/schemas/paymentLineItem' paymentOption: type: string description: '' paymentSourceId: type: string description: '' signerValues: $ref: '#/components/schemas/paymentSignerValues' status: type: string description: "This read-only property describes the status of a payment.\n\n* `new`
\n This is a new payment request.\n The envelope has been created,\n but no payment authorizations have been made.\n\n* `auth_complete`
\n A recipient has entered their credit card information,\n but the envelope has not been completed.\n The card has not been charged.\n\n* `payment_complete`
\n The recipient's card has been charged.\n\n* `payment_capture_failed`
\n Final charge failed.\n This can happen when too much time\n passes between authorizing the payment\n and completing the document.\n" total: $ref: '#/components/schemas/money' description: '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 ' x-ds-definition-name: paymentDetails x-ms-summary: '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 ' EnvelopeDocumentTabs: type: object properties: approveTabs: type: array description: "A list of\n[Approve tabs][approve].\n\n\nThis tab allows\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\n\n[approve]:\t\t https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/approve\n" items: $ref: '#/components/schemas/approve' checkboxTabs: type: array description: '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 ' items: $ref: '#/components/schemas/checkbox' companyTabs: type: array description: "A list of \n[Company tabs][company].\n\n\nThis tab displays the recipient's company name.\n\n\n\n[company]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/company \n" items: $ref: '#/components/schemas/company' dateSignedTabs: type: array description: "A list of \n[Date Signed tabs][dateSigned]\n\n\nThis tab displays the date that the recipient signed the\ndocument.\n\n[dateSigned]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/dateSigned \n" items: $ref: '#/components/schemas/dateSigned' dateTabs: type: array description: "A list of \n[Date tabs][date].\n\n\nThis tab allows the recipient to enter a date. Date tabs\nare one-line fields that allow date information to be\nentered in any format. The tooltip for this tab recommends\nentering the date as MM/DD/YYYY, but this is not enforced.\nThe format entered by the signer is retained. If you need a\nparticular date format enforced, DocuSign recommends using a\nText tab with a validation pattern and a validation message\nto enforce the format.\n\n\n[date]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/date \n" items: $ref: '#/components/schemas/date' declineTabs: type: array description: "A list of \n[Decline tabs][decline].\n\nThis tab allows the recipient the option of declining an\nenvelope. If the recipient clicks the tab during the signing\nprocess, the envelope is voided.\n\n\n[decline]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/decline \n" items: $ref: '#/components/schemas/decline' emailAddressTabs: type: array description: "A list of \n[Email Address tabs][emailAddress].\n\nThis tab \ndisplays the recipient's email as entered in the\nrecipient information.\n\n\n[emailAddress]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/emailAddress \n" items: $ref: '#/components/schemas/emailAddress' emailTabs: type: array description: "A list of \n[Email tabs][email].\n\nThis tab \nallows the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/email \n" items: $ref: '#/components/schemas/email' envelopeIdTabs: type: array description: "A list of \n[Envelope ID tabs][envelopeId].\n\nThis tab \ndisplays the envelope ID. Recipients cannot enter\nor change the information in this tab.\n\n\n[envelopeId]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/envelopeId \n" items: $ref: '#/components/schemas/envelopeId' firstNameTabs: type: array description: "A list of \n[First Name tabs][firstName].\n\nThis tab \ndisplays the recipient's first name. It\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the first section as the first name.\n\n\n[firstName]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/firstName \n" items: $ref: '#/components/schemas/firstName' formulaTabs: type: array description: "A list of [Formula tabs][formulaTab].\n\nThe value of a formula tab is calculated\nfrom the values of other\nnumber or date tabs in the document.\nWhen the recipient completes the underlying fields,\nthe formula tab calculates and displays the result.\n\nThe `formula` property of the tab\ncontains the references\nto the underlying tabs.\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nIf a formula tab contains\na `paymentDetails` property,\nthe tab is considered a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields\n[paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures\n[formulaTab]:\t \thttps://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/formulaTab\n" items: $ref: '#/components/schemas/formulaTab' fullNameTabs: type: array description: "A list of \n[Full Name tabs][fullName].\n\nThis tab \ndisplays the recipient's full name.\n\n\n[fullName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/fullName \n" items: $ref: '#/components/schemas/fullName' initialHereTabs: type: array description: "A list of \n[Initial Here tabs][initialHere].\n\nThis tab allows the recipient to initial the document. May\nbe optional.\n\n[initialHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/initialHere \n" items: $ref: '#/components/schemas/initialHere' lastNameTabs: type: array description: "A list of \n[Last Name tabs][lastName].\n\nThis tab \ndisplays the recipient's last name. It\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the last section as the last name.\n\n\n[lastName]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/lastName \n" items: $ref: '#/components/schemas/lastName' listTabs: type: array description: "A list of \n[list tabs][list].\n\nThis tab offers a list of options to choose from. The\n`listItems` property is used to specify the selectable\noptions.\n\n\n\n[list]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/list \n" items: $ref: '#/components/schemas/list' notarizeTabs: type: array description: "A list of \n[Notarize tabs][notarize].\n\nA notarize tab is a tab that alerts notary recipients that\nthey must take action on the page.\nOnly one notarize tab can appear on a page.\n\n[notarize]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/notarize \n" items: $ref: '#/components/schemas/notarize' noteTabs: type: array description: "A list of \n[Note tabs][note].\n\nThis tab displays additional information, in the form of a\nnote, for the recipient.\n\n[note]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/note \n" items: $ref: '#/components/schemas/note' numberTabs: type: array description: "A list of \n[Number tabs][number].\n\nThis tab allows the recipient to enter numbers and decimal\n(.) points.\n\n\n\n[number]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/number \n" items: $ref: '#/components/schemas/number' radioGroupTabs: type: array description: "A list of \n[Radio Group tabs][radioGroup].\n\nThis tab \nThis group tab is used to place radio buttons on a document.\nThe `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can\nbe selected in a group.\n\n\n[radioGroup]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/radioGroup \n" items: $ref: '#/components/schemas/radioGroup' signerAttachmentTabs: type: array description: "A list of \n[Signer Attachment tabs][signerAttachment].\n\nThis tab \nallows the recipient to attach supporting\ndocuments to an envelope.\n\n\n[signerAttachment]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signerAttachment \n" items: $ref: '#/components/schemas/signerAttachment' signHereTabs: type: array description: "A list of \n[Sign Here tabs][signHere].\n\nThis tab allows the recipient to sign a document. May be\noptional.\n\n[signHere]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/signHere \n" items: $ref: '#/components/schemas/signHere' smartSectionTabs: type: array description: '' items: $ref: '#/components/schemas/smartSection' ssnTabs: type: array description: "A list of \n[SSN tabs][ssn].\n\nThis tab \nis a one-line field that allows the recipient to enter a Social\nSecurity Number. The SSN can be typed with or without\ndashes. It uses the same parameters as a Text tab, with the\nvalidation message and pattern set for SSN information.\n\n\n[ssn]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/ssn \n" items: $ref: '#/components/schemas/ssn' textTabs: type: array description: "A list of \n[Text tabs][text].\n\nThis tab \nA tab that allows the recipient to enter any type of text.\n\n[text]: https://developers.docusign.com/esign-rest-api/reference/EnvelopeRecipientTabs/create/#/definitions/text \n" items: $ref: '#/components/schemas/text' titleTabs: type: array description: "A list of \n[Title tabs][title].\n\nThis tab displays the recipient's title.\n\n\n[title]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/title \n" items: $ref: '#/components/schemas/title' viewTabs: type: array description: "A list of \n[View tabs][view].\n\nThis tab \nThis tab is used with the Approve tab to handle\nsupplemental documents.\n\n[view]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/view \n" items: $ref: '#/components/schemas/view' zipTabs: type: array description: "A list of \n[Zip tabs][zip].\n\nThis tab \nallows the recipient to enter a ZIP code. The ZIP\ncode can be five digits or nine digits in the ZIP+4 format.\nThe zip code can be typed with or without dashes. It uses\nthe same parameters as a Text tab, with the validation\nmessage and pattern set for ZIP code information.\n\n\n[zip]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/create/#/definitions/zip\n" items: $ref: '#/components/schemas/zip' description: 'Envelope Document Tabs resource ' x-ds-definition-name: tabs x-ds-category: Envelopes x-ds-order: '50' x-ms-summary: 'Envelope Document Tabs resource ' radioGroup: type: object properties: conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. groupName: type: string description: The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. radios: type: array description: Specifies the locations and status for radio buttons that are grouped together. items: $ref: '#/components/schemas/radio' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. shared: type: string description: When set to **true**, this custom tab is shared. templateLocked: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' description: '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. ' x-ds-definition-name: radioGroup x-ms-summary: '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. ' emailAddress: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: '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: type: string description: '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) ' description: 'A tab that displays the recipient''s email as entered in the recipient information. ' x-ds-definition-name: emailAddress x-ms-summary: 'A tab that displays the recipient''s email as entered in the recipient information. ' email: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: '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: type: string description: '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) ' description: '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. ' x-ds-definition-name: email x-ms-summary: '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. ' dateSigned: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: '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: type: string description: '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) ' description: 'A tab that displays the date that the recipient signed the document. ' x-ds-definition-name: dateSigned x-ms-summary: 'A tab that displays the date that the recipient signed the document. ' radio: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' errorDetails: $ref: '#/components/schemas/errorDetails' locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' required: type: string description: When set to **true**, the signer is required to fill out this tab selected: type: string description: When set to **true**, the radio button is selected. tabId: type: string description: The unique identifier for the tab. tabOrder: type: string description: '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: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: '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. ' x-ds-definition-name: radio x-ms-summary: '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. ' signerAttachment: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' optional: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. scaleValue: type: number description: '' format: float status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: '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: type: string description: '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) ' description: 'A tab that allows the recipient to attach supporting documents to an envelope. ' x-ds-definition-name: signerAttachment x-ms-summary: 'A tab that allows the recipient to attach supporting documents to an envelope. ' smartSection: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' caseSensitive: type: boolean description: '' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: '' displaySettings: $ref: '#/components/schemas/smartSectionDisplaySettings' documentId: type: string description: The ID of the document being accessed. endAnchor: type: string description: '' endPosition: $ref: '#/components/schemas/smartSectionAnchorPosition' errorDetails: $ref: '#/components/schemas/errorDetails' mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: The page number being accessed. recipientId: type: string description: 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: type: boolean description: '' removeStartAnchor: type: boolean description: '' startAnchor: type: string description: '' startPosition: $ref: '#/components/schemas/smartSectionAnchorPosition' status: type: string description: Item status. tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabOrder: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: '' x-ds-definition-name: smartSection x-ms-summary: '' envelopeId: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: 'A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab. ' x-ds-definition-name: envelopeId x-ms-summary: 'A tab that displays the envelope ID. Recipients cannot enter or change the information in this tab. ' smartSectionCollapsibleDisplaySettings: type: object properties: arrowClosed: type: string description: '' arrowColor: type: string description: '' arrowLocation: type: string description: '' arrowOpen: type: string description: '' arrowSize: type: string description: '' arrowStyle: type: string description: '' containerStyle: type: string description: '' labelStyle: type: string description: '' onlyArrowIsClickable: type: boolean description: '' outerLabelAndArrowStyle: type: string description: '' description: '' x-ds-definition-name: smartSectionCollapsibleDisplaySettings x-ms-summary: '' errorDetails: type: object properties: errorCode: type: string description: An error code associated with the error. message: type: string description: A short error message. description: This object describes errors that occur. It is only valid for responses, and ignored in requests. x-ds-definition-name: errorDetails x-ms-summary: This object describes errors that occur. It is only valid for responses, and ignored in requests. list: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. listItems: type: array description: "The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four]\n\nMaximum Length of listItems: 2048 characters.\nMaximum Length of items in the list: 100 characters. \n" items: $ref: '#/components/schemas/listItem' locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: The value to use when the item is selected. width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: '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: type: string description: '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) ' description: '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. ' x-ds-definition-name: list x-ms-summary: '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. ' propertyMetadata: type: object properties: options: type: array description: '' items: type: string rights: type: string description: '' description: '' x-ds-definition-name: propertyMetadata x-ms-summary: '' smartSectionDisplaySettings: type: object properties: cellStyle: type: string description: '' collapsibleSettings: $ref: '#/components/schemas/smartSectionCollapsibleDisplaySettings' display: type: string description: "This string sets the display and behavior properties of\nthe document during signing. The possible values are:\n\n* `modal`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a modal window.\n This is the recommended value for supplemental documents. \n\n* `download`
\n The document is shown as a supplement action strip\n and can be viewed, downloaded, or printed in a new browser window. \n\n* `inline`
\n The document is shown in the normal signing window.\n This value is not used with supplemental documents,\n but is the default value for all other documents.\n" displayLabel: type: string description: '' displayOrder: type: integer description: '' format: int32 displayPageNumber: type: integer description: '' format: int32 hideLabelWhenOpened: type: boolean description: '' inlineOuterStyle: type: string description: '' labelWhenOpened: type: string description: '' preLabel: type: string description: '' scrollToTopWhenOpened: type: boolean description: '' tableStyle: type: string description: '' description: '' x-ds-definition-name: smartSectionDisplaySettings x-ms-summary: '' formulaTab: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: '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: type: string description: '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: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' paymentDetails: $ref: '#/components/schemas/paymentDetails' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. roundDecimalPlaces: type: string description: '' senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: '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: type: string description: '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) ' description: '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 ' x-ds-definition-name: formulaTab x-ms-summary: '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 ' title: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. required: type: string description: When set to **true**, the signer is required to fill out this tab status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: '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: type: string description: '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) ' description: 'A tab that displays the recipient''s title. ' x-ds-definition-name: title x-ms-summary: 'A tab that displays the recipient''s title. ' initialHere: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. optional: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. scaleValue: type: number description: ' 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.' format: float status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: '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: type: string description: '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) ' description: 'A tab that allows the recipient to initial the document. May be optional. ' x-ds-definition-name: initialHere x-ms-summary: 'A tab that allows the recipient to initial the document. May be optional. ' approve: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. buttonText: type: string description: ' Specifies the approval text displayed in the tab. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: integer description: Height of the tab in pixels. format: int32 italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: '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: type: string description: '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) ' description: 'A tab that allows the recipient to approve documents without placing a signature or initials on the document. ' x-ds-definition-name: approve x-ms-summary: 'A tab that allows the recipient to approve documents without placing a signature or initials on the document. ' ssn: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: '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: type: string description: '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) ' description: '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. ' x-ds-definition-name: ssn x-ms-summary: '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. ' number: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: '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: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: '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: type: string description: '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) ' description: 'A tab that allows the recipient to enter numbers and decimal (.) points. ' x-ds-definition-name: number x-ms-summary: 'A tab that allows the recipient to enter numbers and decimal (.) points. ' view: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. buttonText: type: string description: '' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: integer description: Height of the tab in pixels. format: int32 italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. required: type: string description: When set to **true**, the signer is required to fill out this tab requiredRead: type: string description: '' status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: 'This tab is used with the Approve tab to handle supplemental documents.' x-ds-definition-name: view x-ms-summary: 'This tab is used with the Approve tab to handle supplemental documents.' fullName: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: '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: type: string description: '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) ' description: 'A tab that displays the recipient''s full name. ' x-ds-definition-name: fullName x-ms-summary: 'A tab that displays the recipient''s full name. ' mergeField: type: object properties: allowSenderToEdit: type: string description: When set to **true**, the sender can modify the value of the custom tab during the sending process. configurationType: type: string description: If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. path: type: string description: Sets the object associated with the custom tab. Currently this is the Salesforce Object. row: type: string description: Specifies the row number in a Salesforce table that the merge field value corresponds to. writeBack: type: string description: When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed. description: Contains information for transfering values between Salesforce data fields and DocuSign Tabs. x-ds-definition-name: mergeField x-ms-summary: Contains information for transfering values between Salesforce data fields and DocuSign Tabs. note: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: integer description: Height of the tab in pixels. format: int32 italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: Specifies the tool tip text for the tab. pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: '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: type: string description: '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) ' description: 'A tab that displays additional information, in the form of a note, for the recipient. ' x-ds-definition-name: note x-ms-summary: 'A tab that displays additional information, in the form of a note, for the recipient. ' money: type: object properties: amountInBaseUnit: type: string description: 'The total payment amount in the currency''s base unit. For example, for USD the base currency is one cent. ' currency: type: string description: '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: type: string description: '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. ' description: 'Describes information about the `total` of a payment. ' x-ds-definition-name: money x-ms-summary: 'Describes information about the `total` of a payment. ' notarize: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: '' documentId: type: string description: The ID of the document being accessed. errorDetails: $ref: '#/components/schemas/errorDetails' locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: The page number being accessed. recipientId: type: string description: 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: type: string description: When set to **true**, the signer is required to fill out this tab status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabOrder: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' xPosition: type: string description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' yPosition: type: string description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' description: 'A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.' x-ds-definition-name: notarize x-ms-summary: 'A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page.' paymentSignerValues: type: object properties: paymentOption: type: string description: '' description: '' x-ds-definition-name: paymentSignerValues x-ms-summary: '' zip: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents.' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. useDash4: type: string description: '' validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: '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: type: string description: '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) ' description: '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. ' x-ds-definition-name: zip x-ms-summary: '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. ' firstName: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: '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: type: string description: '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) ' description: '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. ' x-ds-definition-name: firstName x-ms-summary: '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. ' decline: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. buttonText: type: string description: ' Specifies the decline text displayed in the tab.' conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: The reason the recipient declined the document. documentId: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: integer description: Height of the tab in pixels. format: int32 italic: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: '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: type: string description: '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) ' description: '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. ' x-ds-definition-name: decline x-ms-summary: '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. ' smartSectionAnchorPosition: type: object properties: pageNumber: type: integer description: The page number being accessed. format: int32 xPosition: type: number description: 'This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' format: double yPosition: type: number description: 'This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero. ' format: double description: '' x-ds-definition-name: smartSectionAnchorPosition x-ms-summary: '' date: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. concealValueOnDocument: type: string description: '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: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. locked: type: string description: When set to **true**, the signer cannot change the data of the custom tab. maxLength: type: integer description: An optional value that describes the maximum length of the property when the property is a string. format: int32 mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' originalValue: type: string description: 'The initial value of the tab when it was sent to the recipient. ' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. requireAll: type: string description: 'When set to **true** and shared is true, information must be entered in this field to complete the envelope. ' required: type: string description: When set to **true**, the signer is required to fill out this tab requireInitialOnSharedChange: type: string description: Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. senderRequired: type: string description: "When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope." shared: type: string description: When set to **true**, this custom tab is shared. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. validationMessage: type: string description: The message displayed if the custom tab fails input validation (either custom of embedded). validationPattern: type: string description: A regular expressionn used to validate input for the tab. value: type: string description: 'Specifies the value of the tab. ' width: type: integer description: Width of the tab in pixels. format: int32 xPosition: type: string description: '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: type: string description: '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) ' description: '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. ' x-ds-definition-name: date x-ms-summary: '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. ' listItem: type: object properties: selected: type: string description: "When set to **true**, indicates that this item is the default selection shown to a signer. \n\nOnly one selection can be set as the default." text: type: string description: 'Specifies the text that is shown in the dropdown list. ' value: type: string description: Specifies the value that is used when the list item is selected. description: '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.' x-ds-definition-name: listItem x-ms-summary: '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.' lastName: type: object properties: anchorCaseSensitive: type: string description: 'Reserved for DocuSign. ' anchorHorizontalAlignment: type: string description: 'Reserved for DocuSign. ' anchorIgnoreIfNotPresent: type: string description: When set to **true**, this tab is ignored if anchorString is not found in the document. anchorMatchWholeWord: type: string description: 'Reserved for DocuSign. ' anchorString: type: string description: Specifies the anchor string. anchorUnits: type: string description: 'Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` - `inches` - `mms` - `cms` ' anchorXOffset: type: string description: 'Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. ' anchorYOffset: type: string description: 'Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. ' bold: type: string description: When set to **true**, the information in the tab is bold. conditionalParentLabel: type: string description: For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. conditionalParentValue: type: string description: '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: type: string description: 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: type: string description: Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. errorDetails: $ref: '#/components/schemas/errorDetails' font: type: string description: '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: type: string description: "The font color used for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n" fontSize: type: string description: '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: type: string description: When set to **true**, the information in the tab is italic. mergeField: $ref: '#/components/schemas/mergeField' name: type: string description: '' pageNumber: type: string description: 'Specifies the page number on which the tab is located. Must be 1 for supplemental documents. ' recipientId: type: string description: Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. status: type: string description: 'Tab status ' tabGroupLabels: type: array description: '' items: type: string tabId: type: string description: The unique identifier for the tab. tabLabel: type: string description: '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: type: string description: '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: type: string description: 'When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. ' templateRequired: type: string description: When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. tooltip: type: string description: '' underline: type: string description: When set to **true**, the information in the tab is underlined. value: type: string description: 'Specifies the value of the tab. ' xPosition: type: string description: '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: type: string description: '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) ' description: '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. ' x-ds-definition-name: lastName x-ms-summary: '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. ' securitySchemes: accessCode: type: oauth2 description: OAuth2 Access code Grant flows: authorizationCode: authorizationUrl: https://account.docusign.com/oauth/auth tokenUrl: https://account.docusign.com/oauth/auth scopes: organization_read: '' permission_read: '' group_read: '' user_read: '' account_read: '' account_write: '' user_write: '' identity_provider_read: '' domain_read: '' x-ds-categories: - name: UserManagement summary: Methods to manage users in an account. description: Methods to manage users in an account. - name: BulkOperations summary: Methods to import and export users and accounts. description: Methods to import and export users and accounts. - name: IdentityProviders summary: Methods to get a list of identity providers. description: Methods to get a list of identity providers. - name: ReservedDomains summary: Methods to get a list of reserved domains. description: Methods to get a list of reserved domains. - name: Organization summary: Methods for working with organizations. description: Methods for working with organizations. x-original-swagger-version: '2.0'