> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL. > > Documentation indexes by section: > - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt > - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt > - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt > - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt > > Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth > Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks > > OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json > MCP server: https://docusign.docs.buildwithfern.com/_mcp/server # EnvelopeRecipientTabs Resource The EnvelopeRecipientTabs resource provides methods that enable you to add, update, and delete tabs from an envelope. Tabs are associated with a specific recipient in an envelope and are only used by the recipient types In Person Signers and Signers. **On this page** * [Tab Types](#tab-types) * [View Tab](#view-tab) * [Requesting Payments](#requesting-payments) * [Using Custom Tabs in Envelopes and Templates](#using-custom-tabs-in-envelopes-and-templates) * [Anchoring Tabs](#anchoring-tabs) * [Automatically Populating Tabs](#automatically-populating-tabs) ## Tab Types Some tabs enable values to be entered by the signer. Those tabs' values can be preset either through the web browser or via the API. Other tab types use information that is already recognized by the Docusign platform. These tabs cannot have their value updated on a per-tab basis by the API or via the browser. In some cases, the info might be settable using a different technique. For example, the Full name tab uses the signer's name, which is set elsewhere in the request. Here is the list of tabs and whether you can or cannot set their values in the tab definition: | Tab Type | Description | | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Approve (`approve`) | Enables the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history. This value **can't** be set in the API request. | | Checkbox (`checkbox`) | Enables the recipient to select a yes/no (on/off) option. This value can be set. | | Comment Thread (commentThreadTabs) | Represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value **can't** be set. | | Commission County (`commissionCounty`) | Displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api). This value **can't** be set. | | Commission Expiration (`commissionExpiration`) | Displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api). This value **can't** be set. | | Commission Number (`commissionNumber`) | Displays the number of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api). This value **can't** be set. | | Commission State (`commissionState`) | Displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api). This value **can't** be set. | | Company (`company`) | Displays the recipient's company name. This value **can't** be set. | | Date Signed (`dateSigned`) | Displays the date that the recipient signed the document. This value **can't** be set. | | Date (`date`) | Enables 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 YYYY-MM-DD, 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. This value can be set. | | Decline (`decline`) | Enables the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided. This value **can't** be set. | | Draw (`drawTabs`) | Places a rectangular space in the document where the recipient can create a free-form drawing. See [Drawing Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980\&topicId=ilm1598911310881.html) in the Docusign Support Center. | | Email Address (`emailAddress`) | Displays the recipient's email as entered in the recipient information. This value **can't** be set. | | Email (`email`) | Enables 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. This value can be set. | | Envelope ID (`envelopeId`) | Displays the envelope ID. Recipients cannot enter or change the information in this tab. This value **can't** be set. | | First Name (`firstName`) | 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. This value **can't** be set. | | Formula Tab (`formulaTab`) | The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result. This value can be set. The `formula` property of the tab contains the references to the underlying tabs. See [Calculated Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980\&topicId=crs1578456361259.html) 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 One-Time Payments Along with Signatures](https://support.docusign.com/s/document-item?bundleId=juu1573854950452\&topicId=fyw1573854935374.html) in the Docusign Support Center to learn more about payments. | | Full Name (`fullName`) | Displays the recipient's full name. This value **can't** be set. | | Initial Here (`initialHere`) | Enables the recipient to initial the document. May be optional. This value **can't** be set. | | Last Name (`lastName`) | 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. This value **can't** be set. | | List (`list`) | This tab offers a list of options to choose from. The `listItems` property is used to specify the selectable options. This value can be set, | | Notarize (`notarize`) | Alerts Notary recipients that they must take action. Only one Notarize tab can appear on a page. This value can be set. | | Notary Seal (`notarySeal`) | Enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api). This value **can't** be set. | | Note (`note`) | Displays additional information for the recipient in the form of a note. This value can be set. | | Number (`number`) | Enables the recipient to enter numeric values using numerals and decimal (.) points. This value can be set. | | Numerical (`numerical`) | Provides the same functions as Number tabs, but with robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. | | Phone Number (`phoneNumber`) | Enables the recipient to enter a phone number. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api). This value **can't** be set. | | Poly Line Overlay (polyLineOverlayTabs) | Enables the recipient to strike through document text. This value **can't** be set. | | Prefill (`prefillTabs`) | A tab whose value is set by the sender and inserted to a document prior to sending its envelope to its recipients. These tabs are visible to all recipients during signing, but cannot be edited by them. See [Pre-filled tabs](/docs/esign-rest-api/esign101/concepts/tabs/prefilled-tabs). | | Radio Group (`radioGroup`) | This group tab is used to place radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. | | Sign Here (`signHere`) | Enables the recipient to sign a document. May be optional. This value **can't** be set. **Note:** `signHere` tabs can also be used to add a visual representation for an electronic seal in a document. | | Signer Attachment (`signerAttachment`) | Enables the recipient to attach supporting documents to an envelope. This value **can't** be set. | | Smart Section (`smartSectionTabs`) | Used to place smart sections on documents to improve the mobile signing experience. Smart sections may be collapsible sections, rotating tables, or Continue buttons. For more information, see [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive); for information on the corresponding Docusign eSignature UI features, see [Smart Sections Overview](https://support.docusign.com/s/document-item?rsc_301\&bundleId=gbo1643332197980\&topicId=jdm1578456474291.html) in the Docusign Support Center. | | SSN (`ssn`) | A one-line field that allows the recipient to enter a Social Security number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. | | Tab Groups (`tabGroups`) | Creates a DocuSign envelope recipient tab group. To assign a tab to a group, you assign the group's dataLabel to the tab's tabDataLabels array. | | Text (`text`) | Enables the recipient to enter any type of text. This value can be set. Maximum length: 4000 bytes. | | Title (`title`) | Displays the recipient's title. This value **can't** be set. | | View (`view`) | The View tab is used with the Approve tab to handle supplemental documents. This value can be set. | | Zip (`zip`) | 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. This value can be set. | ## View Tab The View tab is used on supplemental documents. To learn more about using the View tab with supplemental documents, see [Using Supplemental Documents](/docs/esign-rest-api/esign101/concepts/documents/supplemental) in the [Sending Documents](/docs/esign-rest-api/reference/envelopes/envelopes/create) section of the [Envelope: create](/docs/esign-rest-api/reference/envelopes/envelopes/create) method. | Name | Required | Type | Description | | ---------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | documentId | Yes | String | The document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. | | pageNumber | Yes | String | Must be set to 1. | | recipientId | Yes | String | The recipient associated with the tab. Must refer to an existing recipient's ID attribute. | | required | No | Boolean | When **true,** the recipient is required to select the supplemental document View button during signing. | | tabLabel | No | String | The label used for the tab. If an empty string is provided for this, an empty sting is used. If no value is provided, the tab type is used as the value. Maximum of 500 characters. | | templateLocked | No | Boolean | Optional. Used only when working with template tabs. When **true,** the attributes of the tab cannot be changed by the sender. | | templateRequired | No | Boolean | Optional. Used only when working with template tabs. When **true,** the tab cannot be removed by the sender. | | xPosition | Yes | String | Required, but can be 0. | | yPosition | Yes | String | Required, but can be 0. | ## Requesting Payments The Payments feature of the Docusign eSignature REST API lets you collect payments along with signatures and other information. To send a request for payment and collect payments, you need a payment gateway account, which is the destination for the payments. Create a payment account with a supported payment gateway, and then connect the payment gateway account to your Docusign account. To learn how to connect a payment gateway account to your Docusign account see [Managing Payment Gateways](https://support.docusign.com/s/document-item?bundleId=juu1573854950452\&topicId=knc1573854895499.html) in the Docusign Support Center. You must connect and manage payment gateway accounts manually through the Docusign Admin console and through your chosen payment gateway. There is no public API for connecting payment gateway accounts to Docusign accounts or for managing payment gateway accounts. Currently [Stripe](https://stripe.com/), [Braintree](https://www.braintreepayments.com/), [Authorize.net](https://www.authorize.net/), [CyberSource](https://www.cybersource.com/), [Zuora](https://www.zuora.com/), and [Elavon](https://www.elavon.com/) are the supported payment gateways. ### How Payments Work To make a request for payment, use a [`formulaTab`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs#tab-types) that has a [`paymentDetails`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create) object. This object includes a list of [`paymentLineItem`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create) objects. Each line item refers to a [`number`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create) tab that contains the value of the each item. The purpose of the line items is to transmit them to the payment gateway as metadata, so that you can use the information in the payment processor. **Note:** If the `fileExtension` parameter is not added in an API call, only base64 converted PDF files will be accepted. Any attempt to send a non-PDF file without using `fileExtension` results in an error. This is an example request for two books. Each book is specified in the `number` tabs labeled "Hamlet" and "Tempest". The books are referenced as line items by their tab labels within the `paymentDetails` object of a `formula` tab. The formula of the `formula` tab add the values of the same two `number` tabs. **Note:** This example uses US dollars, a decimal currency, so the price is multiplied by 100. If you are using a zero-decimal currency, such as Japanese yen, *do not* multiply by 100. ```json { "documents": [ { "documentBase64": "", "documentId": "1", "fileExtension": "pdf", "name": "payment.pdf" } ], "emailSubject": "Order Some Books", "recipients": { "signers": [ { "email": "vreader@example.com", "name": "Voracious Reader", "recipientId": "1", "routingOrder": "1", "tabs": { . . . "numberTabs": [ { "value": "10.00", "width": 78, "required": "true", "locked": "true", "tabLabel": "Hamlet", "documentId": "1", "pageNumber": "1", "xPosition": "323", "yPosition": "134" }, { "value": "10.00", "width": 78, "required": "true", "locked": "true", "tabLabel": "Tempest", "documentId": "1", "pageNumber": "1", "xPosition": "323", "yPosition": "154" } ], "formulaTabs": [ { "required": "true", "formula": "([Hamlet] + [Tempest]) * 100", "roundDecimalPlaces": "2", "paymentDetails": { "currencyCode": "USD", "lineItems": [ { "name": "Hamlet", "description": "The Danish Play", "itemCode": "SHAK1", "amountReference": "Hamlet" }, { "name": "Othello", "description": "The one with Caliban in it", "itemCode": "SHAK2", "amountReference": "Tempest" } ], "gatewayAccountId": "e76668b4-xxxx-xxxx-xxxx-a208d659e490" }, "tabLabel": "Payment1", "documentId": "1", "pageNumber": "1", "xPosition": 300, "yPosition": 200 } ] } } ] }, "status": "sent" } ``` Use the [EnvelopeRecipients: list](/docs/esign-rest-api/reference/envelopes/enveloperecipients/list) method to check the status of a payment. When the payment is successful, the `status` property of the [`paymentDetails`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create) object is `payment_complete`. ```json { "signers": [ { "tabs": { . . . "numberTabs": [ { "value": "10.00", "tabLabel": "Hamlet", "documentId": "1", "recipientId": "1", "pageNumber": "1", "xPosition": "323", "yPosition": "134", }, { "value": "10.00", "tabLabel": "Tempest", "documentId": "1", "recipientId": "1", "pageNumber": "1", } ], "formulaTabs": [ { "formula": "([Hamlet] + [Tempest]) * 100", "roundDecimalPlaces": "2", "paymentDetails": { "status": "payment_complete", "currencyCode": "USD", "lineItems": [ { "name": "Hamlet", "description": "The Danish Play", "itemCode": "SHAK1", "amountReference": "Hamlet" }, { "name": "Tempest", "description": "The one with Caliban in it", "itemCode": "SHAK2", "amountReference": "Tempest" } ], "gatewayAccountId": "e76668b4-xxxx-xxxx-xxxx-a208d659e490" }, "value": "20", "required": "true", "locked": "false", "tabLabel": "Payment1", "documentId": "1", "recipientId": "1", "pageNumber": "1", } ] }, "creationReason": "sender", "email": "vreader@example.com", "name": "Voracious Reader", "recipientId": "1", "requireIdLookup": "false", "status": "completed", } ], . . . } ``` #### How to make a request for future payments Use the following steps to make a request to collect a signer's payment method for future use: 1. Add a text tab with a descriptive `tabLabel` such as `FuturePayment`. 2. In the formula tab's `paymentDetails` object, add a `lineItem` object that references the `tabLabel` from step 1. **Note:** Do not include this new `lineItem` in formula calculations. The following example builds on the previous code block to also collect a payment method for future use: ```json { "documents": [ { "documentBase64": "", "documentId": "1", "fileExtension": "pdf", "name": "payment.pdf" } ], "emailSubject": "Order Some Books", "recipients": { "signers": [ { "email": "vreader@example.com", "name": "Voracious Reader", "recipientId": "1", "routingOrder": "1", "tabs": { "numberTabs": [ { "value": "10.00", "width": 78, "required": "true", "locked": "true", "tabLabel": "Hamlet", "documentId": "1", "pageNumber": "1", "xPosition": "323", "yPosition": "134" }, { "value": "10.00", "width": 78, "required": "true", "locked": "true", "tabLabel": "Tempest", "documentId": "1", "pageNumber": "1", "xPosition": "323", "yPosition": "154" } ], "textTabs": [ { "value": "", "width": 78, "required": "true", "locked": "true", "tabLabel": "FuturePayment", "documentId": "1", "pageNumber": "1", "xPosition": "323", "yPosition": "174" } ], "formulaTabs": [ { "required": "true", "formula": "([Hamlet] + [Tempest]) * 100", "roundDecimalPlaces": "2", "paymentDetails": { "currencyCode": "USD", "paymentOption": "save_and_authorize", "lineItems": [ { "name": "Hamlet", "description": "The Danish Play", "itemCode": "SHAK1", "amountReference": "Hamlet" }, { "name": "Othello", "description": "The one with Caliban in it", "itemCode": "SHAK2", "amountReference": "Tempest" }, { "name": "Request books", "description": "collect Payment method", "itemCode": "", "amountReference": "FuturePayment" } ], "gatewayAccountId": "e76668b4-xxxx-xxxx-xxxx-a208d659e490" }, "tabLabel": "Payment1", "documentId": "1", "pageNumber": "1", "xPosition": 300, "yPosition": 200 } ] } } ] }, "status": "sent" } ``` ### Some Things to Keep in Mind About Payments * An envelope is not completed until all payments are completed. * If you are using a a decimal currency, such as USD, remember to multiply amounts by 100. If you are using zero-decimal currency, such as JPY, *do not* multiply by 100. * If a Docusign account Administrator deletes a payment gateway account connection Docusign cancels all in-process envelopes that reference the deleted payment gateway account. * If the sender voids an envelope, all payment authorizations are canceled. * If a required recipient refuses to sign, all authorized payments are canceled. * If a required recipient's payment fails authorization, Docusign attempts to recover by sending the recipient notification about the failed payment authorization. The recipient has the opportunity to correct the payment method information. * Each recipient's payment is authorized separately. Accounts are charged and payment made after all required tabs are completed, and all payments in an envelope for all recipients are authorized. * Refunds are not supported. Conduct refunds or payment changes with the payment gateway separately from Docusign. * At this time, Docusign does not charge a per-transaction fee. ## Anchoring Tabs The tab anchoring option allows you to send documents for signature that do not have a fixed layout or format. In these documents you might not know the absolute location of the tabs when you design your API client application because the tabs must move with text. As an alternative to sending X and Y coordinates for tabs, the Docusign Service can derive an anchor location for the tab by correlating anchor information to data within the document. When the Docusign Service receives a request that contains tabs with anchor information, it searches the document for instances of the `anchorString` property. When found, it places a tab of the specified type for the designated recipient. Tab positions are established by setting offsets for the tab. When you apply tabs to the document, Docusign does not remove or replace the text in the `anchorString` property. You can hide codified anchors by using the same font color as the background of the document. So the anchor can be used by Docusign processes and it will not be visible on the document. To use an anchoring option: 1. Identify the location in the document by text string. You can use a pre-existing text string or add a new one. For best performance Docusign recommends using single word anchor strings when possible, especially when there are a large number of pages in the envelope. For example, you might want to add a Sign Here tab to the "Borrower's Signature" lines in a document, but that phrase might occur in places in the document where you don't want to tab to appear. In this case, you could add the text "BorrowerSignHere" in white font color (so that isn't visible in the document) to all the places you want Sign Here tabs to appear and use "BorrowerSignHere" as the anchor string. 2. Reference the anchor through the `anchorString` property of the tab. 3. Determine the offset from the anchor string location to where the tab should be placed. Setting a positive value in the `anchorXOffset` property moves the tab right on the page and positive values in the `anchorYoffset` prove moves the tab down the page. The `anchorUnits` property specifies the units used for the offsets. For Sign Here and Initial Here tabs the bottom-left of the anchor string is equivalent to position (0,0), and the bottom-left of the tab graphic is placed relative to that. For all other tabs the bottom-left of the anchor string is equivalent to position (0,0), and the top-left of the tab graphic is placed relative to that. Docusign does not currently provide tools to derive the offset values. Determination of the proper offset will likely require some trial-and-error. ### Rules for working with anchor tags When anchor tabs are used, all documents in the envelope are searched for the `anchorString` property. * You set the text of the anchor string in the `anchorString` property. Docusign tabs are created for each instance of the `anchorString` property within the document, so special care must be taken to establish unique anchor strings that do not result in unintentional tabs. * You cannot use the same anchored tab for different recipients for the same document. * The Docusign system cannot search for text that is embedded in an image when checking for anchor strings. * X or Y offsets supplied for a tab apply to all instances of the tab in the document. To use different offsets at different locations in the document for the same recipient, create multiple, unique anchor tabs. * If the Y offset value of an anchor string would force a tab outside of the page boundaries, the tag is placed at the page boundary. If the X offset value places a tab outside of the page boundaries, the error message `Invalid_User_Offset` is sent. The error message includes the X offset that resulted in the error. * The system does not support an anchor string embedded in the form of a PDF X-object in the document. * The system does not re-flow the text that surrounds the anchor tabs. It is the responsibility of the document author to provide sufficient white space to contain the potential width of the ultimate tab value. ### Tips and Tricks The following are tips for effective use of anchor tags: * In order to avoid unintentional conflicts between text contained in an `anchorString` property and the text that naturally exists in documents, establish a codified syntax for the anchor string text that is unlikely to appear elsewhere in a document. * Develop an extensible and consistent syntax that can be used across multiple document types. * Especially for documents that have variable numbers of tabs or signers, author the source document to include hidden anchor tabs for all potential signers/permutations. Then, control the tabs that are actually placed by including/excluding the anchor tabs in the request. This approach allows a single document to be used for all use cases instead of maintaining separate documents for each scenario. ## Automatically Populating Tabs If you want similar tab types to automatically populate with the same data, you must follow these guidelines: * Each `tabLabel` entry must have the characters `\\*` in front of the label. If you omit the `\\*` prefix, only the first occurrence of the tab is populated. When automatically populating tabs, the `tabLabel` must not contain any spaces. In the JSON example below, the Text tabs properties `StudentLastName` and `StudentFirstName` will be auto-populated as specified ("Doe" and "John") each place they appear throughout the envelope. ```text "tabs": { "textTabs": [ { "tabLabel": "\\*StudentLastName", "value": "Doe" }, { "tabLabel": "\\*StudentFirstName", "value": "John" }] } ``` * Note that `\\*` matches *anything*. If you were to add another tab with the `tabLabel` set to `\\*Name` to the example above, it would end up matching the other two labels as well. This pattern is not a regex expression, and Docusign uses it as a wildcard to populate identical values in tabs. * Each occurrence of the tab must have identical properties. For example, suppose there are two Text tabs in a document, each with `tabLabel` set to `Name`. If one tab has the `bold` property set to **true,** and the other has the `bold` property set to **false,** only the first one will be populated. In order to automatically populate both occurrences of the `Name` Text tabs, the `bold` property must be set to the same value for both tabs. ## Methods supported | Method | Description | | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | [create](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create) | POST `/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs` Adds tabs for a recipient. | | [delete](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/delete) | DEL `/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs` Deletes the tabs associated with a recipient. **Note:** It is an error to delete a tab that has the `templateLocked` property set to true. This property corresponds to the **Restrict changes** option in the web app. | | [list](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/list) | GET `/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs` Gets the tabs information for a signer or sign-in-person recipient in an envelope. | | [update](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/update) | PUT `/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs` Updates the tabs for a recipient. | ## EnvelopeRecipientTabs properties | Property | Type | Description | | -------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `approveTabs` | array | A list of [Approve tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). An Approve tab enables the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history. The value is read-only. | | `checkboxTabs` | array | A list of [Checkbox tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value is read/write. | | `commentThreadTabs` | array | An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value is read-only. | | `commissionCountyTabs` | array | A list of [Commission County tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api). The tab's value can be edited by the recipient. | | `commissionExpirationTabs` | array | A list of [Commission Expiration tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api). The tab's value can be edited by the recipient. | | `commissionNumberTabs` | array | A list of [Commission Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api). The tab's value can be edited by the recipient. | | `commissionStateTabs` | array | A list of [Commission State tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api). The tab's value can be edited by the recipient. | | `companyTabs` | array | A list of [Company tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create#parameters_company). A Company tab displays a field for the name of the recipient's company. This value is read-only. | | `dateSignedTabs` | array | A list of [Date Signed tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Date Signed tab displays the date that the recipient signed the document. This value is read-only. | | `dateTabs` | array | A list of Date tabs. A Date tab enables the recipient to enter a date either by typing or using a date-picker. If you provide a `value` for this tab, it becomes read-only. The tooltip shown to the signer will always show MM/DD/YYYY, but you can specify three different [regular expression](https://en.wikipedia.org/wiki/Regular_expression) (regex) validation patterns for the date by setting the `validationPattern` property. Your three choices are:- DD/MM/YYYY: `^(\|by DocuSign)((\|0)[1-9]\|[1-2][0-9]\|3[0-1])/((\|0)[1-9]\|1[0-2])/[0-9]{4}$` - MM/DD/YYYY: `^(\|by DocuSign)((\|0)[1-9]\|1[0-2])/((\|0)[1-9]\|[1-2][0-9]\|3[0-1])/[0-9]{4}$` - YYYY/DD/MM: `^(\|by DocuSign)[0-9]{4}/((\|0)[1-9]\|1[0-2])/((\|0)[1-9]\|[1-2][0-9]\|3[0-1])$`**Must use these exact strings and not standard regex expressions for this to work** | | `declineTabs` | array | A list of [Decline tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab is read-only. | | `drawTabs` | array | A list of Draw Tabs. A Draw Tab allows the recipient to add a free-form drawing to the document. | | `emailAddressTabs` | array | A list of [Email Address tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). An Email Address tab displays the recipient's email as entered in the recipient information. This value is read-only. | | `emailTabs` | array | A list of [Email tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). An Email tab enables 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. This value can be set. 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. | | `envelopeIdTabs` | array | A list of [Envelope ID tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create#response201_envelopeid). An Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value is read-only. | | `firstNameTabs` | array | A list of [First Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create#parameters_firstname). A First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value is read-only. | | `formulaTabs` | array | A list of [Formula tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). 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. This value is read/write. The `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980\&topicId=crs1578456361259.html). If a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures](https://support.docusign.com/s/document-item?bundleId=juu1573854950452\&topicId=fyw1573854935374.html). | | `fullNameTabs` | array | A list of [Full Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Full Name tab displays the recipient's full name. This value is read-only. | | `initialHereTabs` | array | A list of [Initial Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). This type of tab enables the recipient to initial the document. May be optional. This value is read-only. | | `lastNameTabs` | array | A list of [Last Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value is read-only. | | `listTabs` | array | An array of List tabs. A List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). | | `notarizeTabs` | array | A list of [Notarize tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Notarize tab alerts notary recipients that they must take action on the page. This value can be set. **Note:** Only one notarize tab can appear on a page. | | `notarySealTabs` | array | A list of Notary Seal tabs. A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api). | | `noteTabs` | array | A list of [Note tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Note tab displays additional information to the recipient in the form of a note. This value is read/write. | | `numberTabs` | array | A list of Number tabs. Number tabs validate that the entered value is a number. They do not support advanced validation or display options. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields) in the Concepts guide. For specific information about number tabs see [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields#features-of-numbertabs). | | `numericalTabs` | array | A list of numerical tabs. Numerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields) in the Concepts guide. For specific information about numerical tabs see [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields#features-of-numericaltabs). | | `phoneNumberTabs` | array | A list of [Phone Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Phone Number tab enables a recipient to enter a phone number. **Note:** This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api). | | `polyLineOverlayTabs` | array | This type of tab enables the recipient to strike through document text. This value is read-only. | | `prefillTabs` | prefillTabs | Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980\&topicId=nwo1611173513994.html) describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields](https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields) shows how to use prefill tabs in your application using the eSignature SDKs. | | `radioGroupTabs` | array | A list of [Radio Group tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value is read/write. | | `signerAttachmentTabs` | array | A list of [Signer Attachment tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). This type of tab enables the recipient to attach supporting documents to an envelope. This value is read-only. | | `signHereTabs` | array | A list of [Sign Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). This type of tab enables the recipient to sign a document. May be optional. This value is read-only. | | `smartSectionTabs` | array | A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs. Smart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality. **Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account. | | `ssnTabs` | array | A list of [SSN tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). An SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value is read/write. | | `tabGroups` | array | An array of `tabGroup` items. To associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array. | | `textTabs` | array | A list of Text tabs. A text tab enables the recipient to enter free text. This value is read/write. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). | | `titleTabs` | array | A list of [Title tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Title tab displays the recipient's title. This value is read-only. | | `viewTabs` | array | A list of [View tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A View tab is used with an Approve tab to handle supplemental documents. This value is read/write. | | `zipTabs` | array | A list of [Zip tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs). A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value is read/write. | ## API Docs - EnvelopeRecipientTabs [Add tabs for recipient](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create.md) - EnvelopeRecipientTabs [Delete tabs associated with recipient](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/delete.md) - EnvelopeRecipientTabs [List envelope recipient tabs](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/list.md) - EnvelopeRecipientTabs [Update tabs for recipient](https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/update.md) ## OpenAPI Specification The raw OpenAPI 3.1 specification for this API is available at: - [OpenAPI JSON](https://developers.docusign.com/openapi.json) - [OpenAPI YAML](https://developers.docusign.com/openapi.yaml)