---
title: "Deletes documents from a draft envelope."
method: DELETE
path: "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents"
tags: ["EnvelopeDocuments"]
---

# Deletes documents from a draft envelope.

`DELETE /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents`

Deletes one or more documents from an existing envelope that has not yet been completed.

To delete a document, use only the relevant parts of the [`envelopeDefinition`](#envelopeDefinition).
For example, this request body specifies that you want to delete the document whose `documentId` is "1".


```text
{
  "documents": [
    {
      "documentId": "1"
    }
  ]
}
```

The envelope status must be one of:

- `created`
- `sent`
- `delivered`

## Path parameters

- `accountId` string, required
- `envelopeId` string, required

## Request body

- EnvelopeDefinition — Envelope object definition.
  - `accessControlListBase64` string — Reserved for Docusign.
  - `accessibility` string — Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account. **Note:** This information is currently generated from the Docusign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here.
  - `allowComments` string — When **true,** comments are allowed on the envelope.
  - `allowMarkup` string — When **true,** the Document Markup feature is enabled. **Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.
  - `allowReassign` string — When **true,** the recipient can redirect an envelope to a more appropriate recipient.
  - `allowRecipientRecursion` string — When **true,** this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.
  - `allowViewHistory` string — When **true,** users can view the history of the envelope.
  - `anySigner` string — Deprecated. This feature has been replaced by signing groups.
  - `asynchronous` string — When **true,** the envelope is queued for processing and the value of the `status` property is set to `Processing`. Additionally, GET status calls return `Processing` until completed. **Note:** A `transactionId` is required for this call to work correctly. When the envelope is created, the status is `Processing` and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query by using the [transactionId](/docs/esign-rest-api/reference/envelopes/envelopes/create/) or by checking the Connect notification.
  - `attachments` Attachment[] — An array of attachment objects containing details about any envelope attachments.
    - `accessControl` string — Valid values are `sender` and `senderAndAllRecipients`.
    - `attachmentId` string — The unique identifier for the attachment.
    - `attachmentType` string — Specifies the type of the attachment for the recipient.
    - `data` string — A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size.
    - `label` string — A label for the attachment. Potential values include: - `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms. - `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property.
    - `name` string — The name of the attachment.
    - `remoteUrl` string — The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads.
  - `attachmentsUri` string — The URI for retrieving the envelope attachments.
  - `authoritativeCopy` string — When **true,** marks all of the documents in the envelope as authoritative copies. **Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**
  - `authoritativeCopyDefault` string — The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. If this property is not set, each document defaults to the envelope's `authoritativeCopy`.
  - `autoNavigation` string — When **true,** autonavigation is set for the recipient.
  - `brandId` string — The ID of the brand, or text and formatting, to use for the envelope. To use brands, account branding must be enabled for the account. **Note:** When creating an envelope using a branded template, include this value to ensure that the brand is applied.
  - `brandLock` string — When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope.
  - `burnDefaultTabData` string
  - `certificateUri` string — The URI for retrieving certificate information.
  - `completedDateTime` string — The date and time that the envelope was completed.
  - `compositeTemplates` CompositeTemplate[] — A complex type that can be added to create envelopes from a combination of Docusign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope.
    - `compositeTemplateId` string — The ID of this composite template. This ID is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document.
    - `document` Document — A document object.
      - `applyAnchorTabs` string — Reserved for Docusign.
      - `assignTabsToRecipientId` string
      - `authoritativeCopy` boolean — When **true,** this document is considered an authoritative copy. If this property is not set, it gets its value from the envelope's `authoritativeCopyDefault` property if it's set, or the envelope's `authoritativeCopy` property. When **false,** this document is not an authoritative copy regardless of the envelope's `authoritativeCopyDefault` or `authoritativeCopy` property.
      - `display` string — This string sets the display and behavior properties of the document during signing. Valid values: * `modal`<br> The document is shown as a supplement action strip and can be viewed, downloaded, or printed in a modal window. This is the recommended value for supplemental documents. * `inline`<br> The document is shown in the normal signing window. This value is not used with supplemental documents, but is the default value for all other documents.
      - `docGenDocumentStatus` string
      - `docGenFormFields` DocGenFormField[]
        - `connectedObjectDetails` ConnectedObjectDetails
          - `recordId` string
        - `defaultValue` string
        - `description` string — A description of the field. Displayed with the label.
        - `filter` string — An object used to present a filtered view of the items in a folder.
        - `format` DocGenFormat
          - `expression` string
          - `locale` string — The user's locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` - `es`
        - `fullyQualifiedPath` string
        - `hidden` string
        - `label` string — A label displayed near the field.
        - `name` string — The name of the sender field. Required for PUT requests.
        - `options` DocGenFormFieldOption[] — When `type` is `Select`, this array describes the available options.
          - `description` string — Description of the selectable option.
          - `label` string — The label for the selectable option.
          - `selected` string — When **true,** the option is selected.
          - `value` string — Specifies the value of the option. This is the value of the form field when this option is selected.
        - `order` string — The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order.
        - `predefinedValidation` string — Reserved for Docusign.
        - `readOnly` string
        - `required` string — When **true,** the field is required.
        - `rowValues` DocGenFormFieldRowValue[] — For fields of type `TableRow`, this property represents the sender fields in the row. For GET requests, this array contains a single `docGenFormFieldRowValue` object. That object contains a list of sender fields that will appear in each row. For PUT requests, you must supply a `docGenFormFieldRowValue` object for each row in the table. This populates the data in the table.
          - `docGenFormFieldList` DocGenFormField[] — The sender fields in each row of the table. For GET requests, the `label`, `type`, `required`, and `name` properties will be returned. For POST requests, supply the `name` and `value` for each child object. These correspond to the values in each column.
        - `type` string — The kind of data the sender field holds. Valid values: - `TextBox` - `Date` - `Number` - `Select` - `TableRow`
        - `validation` DocGenFormFieldValidation — Describes how values are validated.
          - `errorMessage` string — The error message when validation fails.
          - `expression` string — The expression used to validate values.
        - `value` string — The value of the sender field. For PUT requests, you must supply either this property (for all fields except `TableRow` types) or `rowValues` (for `TableRow` fields).
      - `documentBase64` string — The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.
      - `documentFields` NameValue[] — The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by Docusign. The array contains the elements: * `name`: A string that can be a maximum of 50 characters. * `value`: A string that can be a maximum of 200 characters. If you are using XML, the name/value pair is contained in a `nameValue` element.
        - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests.
          - `errorCode` string — The code associated with the error condition.
          - `message` string — A brief message describing the error condition.
        - `name` string — The name of the item.
        - `originalValue` string — The initial value of the item.
        - `value` string — The current value of the item.
      - `documentId` string — Specifies the document ID of this document. This value is used by tabs to determine which document they appear in.
      - `documentTemplateId` string
      - `encryptedWithKeyManager` string — When **true,** the document has been encrypted by the sender for use with the Docusign Key Manager Security Appliance.
      - `fileExtension` string — The file extension type of the document. Non-PDF documents are converted to PDF. If the document is not a PDF, `fileExtension` is required. If you try to upload a non-PDF document without a `fileExtension`, you will receive an "unable to load document" error message.
      - `fileFormatHint` string
      - `htmlDefinition` DocumentHtmlDefinition — Holds the properties that define how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/).
        - `displayAnchorPrefix` string — Contains text that all display anchors must start with. Using at least four characters will improve anchor processing performance.
        - `displayAnchors` DocumentHtmlDisplayAnchor[] — An object that defines how to handle a section of the HTML in signing. This property enables an incoming request to make a section of the HTML collapsible and expandable or hidden from view. A start anchor, end anchor, or both are required. If the anchors are not found, the display anchor will be ignored. For a list of the available types, see the [`display` property](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings_display) of the [`displaySettings` object.](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings)
          - `caseSensitive` boolean — When **true,** the start or end anchor strings must match the strings specified by the start and end anchor settings in case as well as in content.
          - `displaySettings` DocumentHtmlDisplaySettings — This object defines how to display the HTML between the `startAnchor` and `endAnchor`.
            - `cellStyle` string — Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types.
            - `collapsibleSettings` DocumentHtmlCollapsibleDisplaySettings — Display settings for collapsible section.
              - …
            - `display` string — Sets the display and behavior properties. Possible values are: - `inline`: Leaves the HTML where it is in the document. This property lets you add a label or present on a separate page. - `collapsible`: The HTML in this section may be expanded or collapsed. Initially this section is expanded. - `collapsed`: The HTML in this section may be expanded or collapsed. Initially this section is collapsed. - `continue_button`: Creates a stop point in the document to draw the reader's attention before proceeding to the next section. - `responsive_table`: Turns this section into a responsive table. Note that this is only used on HTML tables that fall within the anchor start and end positions. - `responsive_table_single_column`: Turns this section into a responsive single-column table. Note this is only used on HTML tables that fall within the anchor start and end positions. The table will be converted to one single column where each current column will become a row, then stacked. - `print_only`: Do not show this portion of the HTML in the responsive signing view.
            - `displayLabel` string — The label to add to this display section in the signing page.
            - `displayOrder` integer — The position on the page where the display section appears.
            - `displayPageNumber` integer — The number of the page on which the display section appears.
            - `hideLabelWhenOpened` boolean — When **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`.
            - `inlineOuterStyle` string — Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`.
            - `labelWhenOpened` string — The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`.
            - `preLabel` string — Enables you to add descriptive text that appears before a collapsed section or continue button.
            - `scrollToTopWhenOpened` boolean — When **true** and the section is expanded, the position of the section-close control scrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`.
            - `tableStyle` string — Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`.
          - `endAnchor` string — Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default. **Note:** A start anchor, an end anchor, or both are required.
          - `removeEndAnchor` boolean — When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying.
          - `removeStartAnchor` boolean — When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying.
          - `startAnchor` string — Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default. **Note:** A start anchor, an end anchor, or both are required.
        - `displayOrder` string — The position on the page where the display section appears.
        - `displayPageNumber` string — The number of the page on which the display section appears.
        - `documentGuid` string — The GUID of the document.
        - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
        - `headerLabel` string — Header text or an HTML tag to place above the responsive HTML block.
        - `maxScreenWidth` string — If set, the responsive HTML version of the signing document will only display on screens with the specified pixel width or less. If the screen is larger than the value that you specify, the default PDF version of the content displays instead. This setting can also be configured at the account level.
        - `removeEmptyTags` string — Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes).
        - `showMobileOptimizedToggle` string — When **true** (the default), the **Mobile-Friendly** toggle displays at the top of the screen on the user's mobile device. When **false,** the toggle will not be displayed. the **Mobile-Friendly** toggle lets the user switch between the mobile-friendly and the PDF versions of a document. For example, the recipient can use this toggle to review the document using the PDF view before they finish signing.
        - `source` string — Specifies the type of responsive signing that will be used with the document. If the value of this property is valid HTML, and the [smart sections feature][] is enabled, the HTML code is used to display the signing page: ``` source: "<html> ... <body><p>hello world</p></body></html>" ``` If the value of this property is the string `document`, the HTML signing page is generated from the provided document. ``` source: "document" ``` **Related topics** - [How to create a signable HTML document](/docs/esign-rest-api/how-to/creating-signable-html/) - [How to convert a PDF file into a signable HTML document](/docs/esign-rest-api/how-to/converting-pdf/) - [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) [smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html
      - `includeInDownload` string — When **true,** the document is included in the combined document download (`documentsCombinedUri`). This is only applied to [supplemental documents](/docs/esign-rest-api/esign101/concepts/documents/supplemental/). The default value is **true.**
      - `isDocGenDocument` string
      - `matchBoxes` MatchBox[] — Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template.
        - `height` string — The height of the tab in pixels. Must be an integer.
        - `pageNumber` string — Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
        - `width` string — The width of the tab in pixels. Must be an integer.
        - `xPosition` string — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero.
        - `yPosition` string — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero.
      - `name` string — The name of the document.
      - `order` string — The order in which to sort the results. Valid values are: * `asc`: Ascending order. * `desc`: Descending order.
      - `pages` string — The number of pages in the document. This property is read-only.
      - `password` string — The user's password. This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo). This property is not returned by `GET` requests and cannot be updated via `PUT` requests.
      - `pdfFormFieldOption` string
      - `remoteUrl` string — The file ID from the cloud storage service where the document is located. This information is returned using [CloudStorage: listFolders](/docs/esign-rest-api/reference/cloudstorage/cloudstorage/listfolders/) or [CloudStorage: list](/docs/esign-rest-api/reference/cloudstorage/cloudstorage/list/).
      - `signerMustAcknowledge` string — Sets how the signer interacts with the supplemental document. Valid values: * `no_interaction`<br> No recipient action is required. * `view`<br> The recipient is required to view the document. * `accept`<br> The recipient is required to accept the document by selecting accept during signing, but is not required to view the document. * `view_accept`<br> The recipient is required to view and accept the document.
      - `signerMustAcknowledgeUseAccountDefault` boolean — When **true,** the account default setting for the required recipient option is used. If this property is set, `signerMustAcknowledge` cannot be set (and vice versa).
      - `tabs` EnvelopeRecipientTabs — All of the tabs associated with a recipient. Each property is a list of a type of tab.
        - `approveTabs` Approve[] — A list of [Approve tabs][approve]. 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 of an approve tab can't be set. [approve]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/
          - `agreementAttribute` string
          - `agreementAttributeLocked` string
          - `anchorAllowWhiteSpaceInCharacters` string — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will match. The default value is **true.**
          - `anchorAllowWhiteSpaceInCharactersMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorCaseSensitive` string — This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorCaseSensitiveMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorHorizontalAlignment` string — This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorHorizontalAlignmentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorIgnoreIfNotPresent` string — When **true,** this tab is ignored if the `anchorString` is not found in the document.
          - `anchorIgnoreIfNotPresentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorMatchWholeWord` string — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorMatchWholeWordMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorString` string — Specifies the string to find in the document and use as the basis for tab placement.
          - `anchorStringMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorTabProcessorVersion` string — Reserved for Docusign.
          - `anchorTabProcessorVersionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorTabScope` string
          - `anchorUnits` string — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms`
          - `anchorUnitsMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorXOffset` string — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
          - `anchorXOffsetMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorYOffset` string — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
          - `anchorYOffsetMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `bold` string — When **true,** the information in the tab is bold.
          - `boldMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `buttonText` string — Specifies the approval text that displays in the tab.
          - `buttonTextMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `caption` string
          - `captionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `conditionalParentLabel` string — For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.
          - `conditionalParentLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `conditionalParentValue` string — 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.
          - `conditionalParentValueMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `connectedObjectDetails` ConnectedObjectDetails
            - `recordId` string
          - `customTabId` string — The Docusign-generated custom tab ID for the custom tab to be applied. You can only use this when adding new tabs for a recipient. When used, the new tab inherits all of the properties of the custom tab.
          - `customTabIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
          - `documentIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests.
            - `errorCode` string — The code associated with the error condition.
            - `message` string — A brief message describing the error condition.
          - `extensionData` ExtensionData
            - `actionContract` string
            - `actionInputKey` string
            - `actionName` string
            - `applicationId` string
            - `applicationName` string
            - `connectedFieldsData` ConnectedData
              - …
            - `connectionInstances` ConnectionInstance[]
              - …
            - `extensionContract` string
            - `extensionGroupId` string
            - `extensionName` string
            - `extensionPolicy` string
            - `publisherName` string
            - `requiredForExtension` string
          - `font` string — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
          - `fontColor` string — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
          - `fontColorMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `fontMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `fontSize` string — 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
          - `fontSizeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formOrder` string — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.
          - `formOrderMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formPageLabel` string — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
          - `formPageLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formPageNumber` string — An integer specifying the order in which to present the guided form pages.
          - `formPageNumberMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `height` string — The height of the tab in pixels. Must be an integer.
          - `heightMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `italic` string — When **true,** the information in the tab is italic.
          - `italicMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `localePolicy` LocalePolicyTab — Allows you to customize locale settings.
            - `addressFormat` string — Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`
            - `calendarType` string — Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`
            - `cultureName` string — The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
            - `currencyCode` string — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. Supported formats: - `AED` - `AFN` - `ALL` - `AMD` - `ANG` - `AOA` - `ARS` - `AUD` - `AWG` - `AZN` - `BAM` - `BBD` - `BDT` - `BGN` - `BHD` - `BIF` - `BMD` - `BND` - `BOB` - `BOV` - `BRL` - `BSD` - `BTN` - `BWP` - `BYN` - `BYR` - `BZD` - `CAD` - `CDF` - `CHE` - `CHF` - `CHW` - `CLF` - `CLP` - `CNY` - `COP` - `COU` - `CRC` - `CUC` - `CUP` - `CVE` - `CZK` - `DJF` - `DKK` - `DOP` - `DZD` - `EGP` - `ERN` - `ETB` - `EUR` - `FJD` - `FKP` - `GBP` - `GEL` - `GHS` - `GIP` - `GMD` - `GNF` - `GTQ` - `GYD` - `HKD` - `HNL` - `HRK` - `HTG` - `HUF` - `IDR` - `ILS` - `INR` - `IQD` - `IRR` - `ISK` - `JMD` - `JOD` - `JPY` - `KES` - `KGS` - `KHR` - `KMF` - `KPW` - `KRW` - `KWD` - `KYD` - `KZT` - `LAK` - `LBP` - `LKR` - `LRD` - `LSL` - `LYD` - `MAD` - `MDL` - `MGA` - `MKD` - `MMK` - `MNT` - `MOP` - `MRO` - `MUR` - `MVR` - `MWK` - `MXN` - `MXV` - `MYR` - `MZN` - `NAD` - `NGN` - `NIO` - `NOK` - `NPR` - `NZD` - `OMR` - `PAB` - `PEN` - `PGK` - `PHP` - `PKR` - `PLN` - `PYG` - `QAR` - `RON` - `RSD` - `RUB` - `RWF` - `SAR` - `SBD` - `SCR` - `SDG` - `SEK` - `SGD` - `SHP` - `SLL` - `SOS` - `SRD` - `SSP` - `STD` - `SVC` - `SYP` - `SZL` - `THB` - `TJS` - `TMT` - `TND` - `TOP` - `TRY` - `TTD` - `TWD` - `TZS` - `UAH` - `UGX` - `USD` - `USN` - `UYI` - `UYU` - `UZS` - `VEF` - `VND` - `VUV` - `WST` - `XAF` - `XAG` - `XAU` - `XBA` - `XBB` - `XBC` - `XBD` - `XCD` - `XDR` - `XOF` - `XPD` - `XPF` - `XPT` - `XSU` - `XTS` - `XUA` - `XXX` - `YER` - `ZAR` - `ZMW` - `ZWL`
            - `currencyNegativeFormat` string — Determines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1'234'567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1'234'567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1'234'567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1'234'567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123'456'789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00`
            - `currencyPositiveFormat` string — Determines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1'234'567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123'456'789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR)
            - `customDateFormat` string
            - `customTimeFormat` string
            - `dateFormat` string — Specifies the date format. Valid values: - `default` <br> used the UI's - `longformat` <br> use the UI's long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d
            - `initialFormat` string — When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for "William Henry Gates". - `first1last1`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->
            - `nameFormat` string — Describes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->
            - `timeFormat` string — Specifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->
            - `timeZone` string — Specifies the time zone. Valid values: - `TZ_01_AfghanistanStandardTime` - `TZ_02_AlaskanStandardTime` - `TZ_03_ArabStandardTime` - `TZ_04_ArabianStandardTime` - `TZ_05_ArabicStandardTime` - `TZ_06_ArgentinaStandardTime` - `TZ_07_AtlanticStandardTime` - `TZ_08_AUS_CentralStandardTime` - `TZ_09_AUS_EasternStandardTime` - `TZ_10_AzerbaijanStandardTime` - `TZ_11_AzoresStandardTime` - `TZ_12_BangladeshStandardTime` - `TZ_13_CanadaCentralStandardTime` - `TZ_14_CapeVerdeStandardTime` - `TZ_15_CaucasusStandardTime` - `TZ_16_CentralAustraliaStandardTime` - `TZ_17_CentralAmericaStandardTime` - `TZ_18_CentralAsiaStandardTime` - `TZ_19_CentralBrazilianStandardTime` - `TZ_20_CentralEuropeStandardTime` - `TZ_21_CentralEuropeanStandardTime` - `TZ_22_CentralPacificStandardTime` - `TZ_23_CentralStandardTime` - `TZ_24_CentralStandardTimeMexico` - `TZ_25_ChinaStandardTime` - `TZ_26_DatelineStandardTime` - `TZ_27_E_AfricaStandardTime` - `TZ_28_E_AustraliaStandardTime` - `TZ_29_E_EuropeStandardTime` - `TZ_30_E_SouthAmericaStandardTime` - `TZ_31_EasternStandardTime` - `TZ_32_EgyptStandardTime` - `TZ_33_EkaterinburgStandardTime` - `TZ_34_FijiStandardTime` - `TZ_35_FLE_StandardTime` - `TZ_36_GeorgianStandardTime` - `TZ_37_GMT_StandardTime` - `TZ_38_GreenlandStandardTime` - `TZ_39_GreenwichStandardTime` - `TZ_40_GTB_StandardTime` - `TZ_41_HawaiianStandardTime` - `TZ_42_IndiaStandardTime` - `TZ_43_IranStandardTime` - `TZ_44_IsraelStandardTime` - `TZ_45_JordanStandardTime` - `TZ_46_KaliningradStandardTime` - `TZ_47_KamchatkaStandardTime` - `TZ_48_KoreaStandardTime` - `TZ_49_MagadanStandardTime` - `TZ_50_MauritiusStandardTime` - `TZ_51_MidAtlanticStandardTime` - `TZ_52_MiddleEastStandardTime` - `TZ_53_MontevideoStandardTime` - `TZ_54_MoroccoStandardTime` - `TZ_55_MountainStandardTime` - `TZ_56_MountainStandardTimeMMexico` - `TZ_57_MyanmarStandardTime` - `TZ_58_N_CentralAsiaStandardTime` - `TZ_59_NamibiaStandardTime` - `TZ_60_NepalStandardTime` - `TZ_61_NewZealandStandardTime` - `TZ_62_NewfoundlandStandardTime` - `TZ_63_NorthAsiaEastStandardTime` - `TZ_64_NorthAsiaStandardTime` - `TZ_65_PacificSAStandardTime` - `TZ_66_PacificStandardTime` - `TZ_67_PacificStandardTimeMexico` - `TZ_68_PakistanStandardTime` - `TZ_69_ParaguayStandardTime` - `TZ_70_RomanceStandardTime` - `TZ_71_RussianStandardTime` - `TZ_72_SAEasternStandardTime` - `TZ_73_SAPacificStandardTime` - `TZ_74_SAWesternStandardTime` - `TZ_75_SamoaStandardTime` - `TZ_76_SE_AsiaStandardTime` - `TZ_77_SingaporeStandardTime` - `TZ_78_SouthAfricaStandardTime` - `TZ_79_SriLankaStandardTime` - `TZ_80_SyriaStandardTime` - `TZ_81_TaipeiStandardTime` - `TZ_82_TasmaniaStandardTime` - `TZ_83_TokyoStandardTime` - `TZ_84_TongaStandardTime` - `TZ_85_TurkeyStandardTime` - `TZ_86_UlaanbaatarStandardTime` - `TZ_87_US_EasternStandardTime` - `TZ_88_USMountainStandardTime` - `TZ_89_VenezuelaStandardTime` - `TZ_90_VladivostokStandardTime` - `TZ_91_W_AustraliaStandardTime` - `TZ_92_W_CentralAfricaStandardTime` - `TZ_93_W_EuropeStandardTime` - `TZ_94_WestAsiaStandardTime` - `TZ_95_WestPacificStandardTime` - `TZ_96_YakutskStandardTime`
            - `useLongCurrencyFormat` string — When **true,** use the long currency format for the locale.
          - `mergeField` MergeField — Contains information for transferring values between Salesforce data fields and Docusign tabs.
            - `allowSenderToEdit` string — When **true,** the sender can modify the value of the `mergeField` tab during the sending process.
            - `allowSenderToEditMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `configurationType` string — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
            - `configurationTypeMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `path` string — Sets the object associated with the custom tab. Currently this is the Salesforce Object.
            - `pathExtended` PathExtendedElement[] — Reserved for Docusign.
              - …
            - `pathExtendedMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `pathMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `row` string — Specifies the row number in a Salesforce table that the merge field value corresponds to.
            - `rowMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `writeBack` string — When **true,** data entered into the merge field during Signing will update the mapped Salesforce field.
            - `writeBackMetadata` PropertyMetadata — Metadata about a property.
              - …
          - `mergeFieldXml` string — Reserved for Docusign.
          - `pageNumber` string — Specifies the page number on which the tab is located. For supplemental documents, this value must be `1`.
          - `pageNumberMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `recipientId` string — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
          - `recipientIdGuid` string — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
          - `recipientIdGuidMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `recipientIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `smartContractInformation` SmartContractInformation
            - `code` string — Reserved for Docusign.
            - `uri` string — Reserved for Docusign.
          - `source` string — Reserved for Docusign.
          - `status` string — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).
          - `statusMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabFullyQualifiedPath` string
          - `tabGroupLabels` string[] — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array.
          - `tabGroupLabelsMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabId` string — The unique identifier for the tab.
          - `tabIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabLabel` string — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters.
          - `tabLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabOrder` string — 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.
          - `tabOrderMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabType` string — Indicates the type of tab (for example, `signHere` or `initialHere`).
          - `tabTypeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
          - `templateLockedMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients.
          - `templateRequiredMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tooltip` string — **Note:** Approve tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient.
          - `toolTipMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `underline` string — When **true,** the information in the tab is underlined.
          - `underlineMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `warningDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests.
            - `errorCode` string — The code associated with the error condition.
            - `message` string — A brief message describing the error condition.
          - `width` string — The width of the tab in pixels. Must be an integer.
          - `widthMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `xPosition` string — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2)
          - `xPositionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `yPosition` string — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2)
          - `yPositionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
        - `checkboxTabs` Checkbox[] — A list of [Checkbox tabs][checkbox]. A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. [checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/
          - `agreementAttribute` string
          - `agreementAttributeLocked` string
          - `anchorAllowWhiteSpaceInCharacters` string — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will match. The default value is **true.**
          - `anchorAllowWhiteSpaceInCharactersMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorCaseSensitive` string — This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorCaseSensitiveMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorHorizontalAlignment` string — This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorHorizontalAlignmentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorIgnoreIfNotPresent` string — When **true,** this tab is ignored if the `anchorString` is not found in the document.
          - `anchorIgnoreIfNotPresentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorMatchWholeWord` string — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorMatchWholeWordMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorString` string — Specifies the string to find in the document and use as the basis for tab placement.
          - `anchorStringMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorTabProcessorVersion` string — Reserved for Docusign.
          - `anchorTabProcessorVersionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorTabScope` string
          - `anchorUnits` string — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms`
          - `anchorUnitsMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorXOffset` string — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
          - `anchorXOffsetMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorYOffset` string — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
          - `anchorYOffsetMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `bold` string — When **true,** the information in the tab is bold.
          - `boldMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `caption` string
          - `captionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `conditionalParentLabel` string — For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.
          - `conditionalParentLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `conditionalParentValue` string — 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.
          - `conditionalParentValueMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `connectedObjectDetails` ConnectedObjectDetails
            - `recordId` string
          - `customTabId` string — The Docusign-generated custom tab ID for the custom tab to apply. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all custom tab properties.
          - `customTabIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
          - `documentIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests.
            - `errorCode` string — The code associated with the error condition.
            - `message` string — A brief message describing the error condition.
          - `extensionData` ExtensionData
            - `actionContract` string
            - `actionInputKey` string
            - `actionName` string
            - `applicationId` string
            - `applicationName` string
            - `connectedFieldsData` ConnectedData
              - …
            - `connectionInstances` ConnectionInstance[]
              - …
            - `extensionContract` string
            - `extensionGroupId` string
            - `extensionName` string
            - `extensionPolicy` string
            - `publisherName` string
            - `requiredForExtension` string
          - `font` string — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
          - `fontColor` string — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
          - `fontColorMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `fontMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `fontSize` string — 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
          - `fontSizeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formOrder` string — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.
          - `formOrderMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formPageLabel` string — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
          - `formPageLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formPageNumber` string — An integer specifying the order in which to present the guided form pages.
          - `formPageNumberMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `height` string — The height of the tab in pixels. Must be an integer.
          - `heightMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `italic` string — When **true,** the information in the tab is italic.
          - `italicMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `locked` string — When **true,** the signer cannot change the data of the custom tab.
          - `lockedMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `mergeField` MergeField — Contains information for transferring values between Salesforce data fields and Docusign tabs.
            - `allowSenderToEdit` string — When **true,** the sender can modify the value of the `mergeField` tab during the sending process.
            - `allowSenderToEditMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `configurationType` string — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
            - `configurationTypeMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `path` string — Sets the object associated with the custom tab. Currently this is the Salesforce Object.
            - `pathExtended` PathExtendedElement[] — Reserved for Docusign.
              - …
            - `pathExtendedMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `pathMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `row` string — Specifies the row number in a Salesforce table that the merge field value corresponds to.
            - `rowMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `writeBack` string — When **true,** data entered into the merge field during Signing will update the mapped Salesforce field.
            - `writeBackMetadata` PropertyMetadata — Metadata about a property.
              - …
          - `mergeFieldXml` string — Reserved for Docusign.
          - `name` string — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text.
          - `nameMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `pageNumber` string — The page number on which the tab is located. For supplemental documents, this value must be `1`.
          - `pageNumberMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `recipientId` string — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
          - `recipientIdGuid` string — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
          - `recipientIdGuidMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `recipientIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `required` string — This property does not apply to `checkbox` tabs. To require users to check at least one, or at most some number of checkboxes, associate the checkbox tabs with a [`tabGroup`][tabGroup]. Then set the following `tabGroup` properties: - [`maximumAllowed`][maximumAllowed] - [`minimumRequired`][minimumRequired] - [`groupRule`][groupRule] specifies how the other two properties are interpreted. You can find an example at [Stack Overflow][so]. [so]: https://stackoverflow.com/questions/58209376/checkbox-validation-using-docusign-rest-api/58210277#58210277 [tabGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups [groupRule]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_grouprule [maximumAllowed]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_maximumallowed [minimumRequired]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_minimumrequired
          - `requiredMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `requireInitialOnSharedChange` string — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field.
          - `requireInitialOnSharedChangeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `selected` string — When **true,** the checkbox is selected.
          - `selectedMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `selectedOriginal` string
          - `selectedOriginalMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `shared` string — When **true,** this tab is shared.
          - `sharedMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `shareToRecipients` string — Reserved for Docusign.
          - `shareToRecipientsMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `smartContractInformation` SmartContractInformation
            - `code` string — Reserved for Docusign.
            - `uri` string — Reserved for Docusign.
          - `source` string — Reserved for Docusign.
          - `status` string — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).
          - `statusMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabFullyQualifiedPath` string
          - `tabGroupLabels` string[] — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array.
          - `tabGroupLabelsMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabId` string — The unique identifier for the tab.
          - `tabIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabLabel` string — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters.
          - `tabLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabOrder` string — 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.
          - `tabOrderMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabType` string — Indicates the type of tab (for example, `signHere` or `initialHere`).
          - `tabTypeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
          - `templateLockedMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients.
          - `templateRequiredMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tooltip` string — The text of a tooltip that appears when a user hovers over a form field or tab.
          - `toolTipMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `underline` string — When **true,** the information in the tab is underlined.
          - `underlineMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `warningDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests.
            - `errorCode` string — The code associated with the error condition.
            - `message` string — A brief message describing the error condition.
          - `width` string — The width of the tab in pixels. Must be an integer.
          - `widthMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `xPosition` string — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6)
          - `xPositionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `yPosition` string — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6)
          - `yPositionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
        - `commentThreadTabs` CommentThread[] — 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 can't be set.
          - `agreementAttribute` string
          - `agreementAttributeLocked` string
          - `anchorAllowWhiteSpaceInCharacters` string — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will match. The default value is **true.**
          - `anchorAllowWhiteSpaceInCharactersMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorCaseSensitive` string — This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorCaseSensitiveMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorHorizontalAlignment` string — This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorHorizontalAlignmentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorIgnoreIfNotPresent` string — When **true,** this tab is ignored if the `anchorString` is not found in the document.
          - `anchorIgnoreIfNotPresentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorMatchWholeWord` string — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorMatchWholeWordMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorString` string — Specifies the string to find in the document and use as the basis for tab placement.
          - `anchorStringMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorTabProcessorVersion` string — Reserved for Docusign.
          - `anchorTabProcessorVersionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorTabScope` string
          - `anchorUnits` string — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms`
          - `anchorUnitsMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorXOffset` string — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
          - `anchorXOffsetMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorYOffset` string — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
          - `anchorYOffsetMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `bold` string — When **true,** the information in the tab is bold.
          - `boldMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `caption` string
          - `captionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `comments` Comment[] — An array of comment tabs that contain information about users' comments on documents.
            - `envelopeId` string — The Guid of the envelope the comment thread belongs to.
            - `hmac` string — Reserved for Docusign.
            - `id` string — The unique identifier for the comment.
            - `mentions` string[] — An array of userIds that are mentioned directly in the body of a comment.
            - `read` boolean — When **true,** indicates that the comment was read.
            - `sentByEmail` string — The email address of the user who created the comment.
            - `sentByFullName` string — The full name of the user who created the comment.
            - `sentByImageId` string — Reserved for Docusign.
            - `sentByInitials` string — The initials of the user who created the comment.
            - `sentByRecipientId` string — The recipient ID of the user who created the comment.
            - `sentByUserId` string — The user ID of the user who created the comment.
            - `signingGroupId` string — The ID of the signing group that can view the comment or that created the comment.
            - `signingGroupName` string — Optional. The name of the signing group. Maximum Length: 100 characters.
            - `subject` string — The subject of the envelope.
            - `tabId` string — The unique identifier for the tab that represents the comment thread.
            - `text` string — The content of the comment, as UTF-8 text. Maximum Length: 500 characters. **Note:** The maximum size allowed for the entire message body is 32 KB.
            - `threadId` string — The unique identifier for the comment thread.
            - `threadOriginatorId` string — The userId of the user who created the thread.
            - `timestamp` string — The time the comment was created.
            - `timeStampFormatted` string — The time the comment was created, formatted according to the format of the user who created the comment.
            - `visibleTo` string[] — The user IDs of the users that the comment is visible to.
          - `conditionalParentLabel` string — For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.
          - `conditionalParentLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `conditionalParentValue` string — 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.
          - `conditionalParentValueMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `connectedObjectDetails` ConnectedObjectDetails
            - `recordId` string
          - `customTabId` string — 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.
          - `customTabIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
          - `documentIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests.
            - `errorCode` string — The code associated with the error condition.
            - `message` string — A brief message describing the error condition.
          - `extensionData` ExtensionData
            - `actionContract` string
            - `actionInputKey` string
            - `actionName` string
            - `applicationId` string
            - `applicationName` string
            - `connectedFieldsData` ConnectedData
              - …
            - `connectionInstances` ConnectionInstance[]
              - …
            - `extensionContract` string
            - `extensionGroupId` string
            - `extensionName` string
            - `extensionPolicy` string
            - `publisherName` string
            - `requiredForExtension` string
          - `font` string — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
          - `fontColor` string — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
          - `fontColorMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `fontMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `fontSize` string — 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
          - `fontSizeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formOrder` string — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.
          - `formOrderMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formPageLabel` string — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
          - `formPageLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formPageNumber` string — An integer specifying the order in which to present the guided form pages.
          - `formPageNumberMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `height` string — The height of the tab in pixels. Must be an integer.
          - `heightMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `italic` string — When **true,** the information in the tab is italic.
          - `italicMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `localePolicy` LocalePolicyTab — Allows you to customize locale settings.
            - `addressFormat` string — Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`
            - `calendarType` string — Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`
            - `cultureName` string — The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
            - `currencyCode` string — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. Supported formats: - `AED` - `AFN` - `ALL` - `AMD` - `ANG` - `AOA` - `ARS` - `AUD` - `AWG` - `AZN` - `BAM` - `BBD` - `BDT` - `BGN` - `BHD` - `BIF` - `BMD` - `BND` - `BOB` - `BOV` - `BRL` - `BSD` - `BTN` - `BWP` - `BYN` - `BYR` - `BZD` - `CAD` - `CDF` - `CHE` - `CHF` - `CHW` - `CLF` - `CLP` - `CNY` - `COP` - `COU` - `CRC` - `CUC` - `CUP` - `CVE` - `CZK` - `DJF` - `DKK` - `DOP` - `DZD` - `EGP` - `ERN` - `ETB` - `EUR` - `FJD` - `FKP` - `GBP` - `GEL` - `GHS` - `GIP` - `GMD` - `GNF` - `GTQ` - `GYD` - `HKD` - `HNL` - `HRK` - `HTG` - `HUF` - `IDR` - `ILS` - `INR` - `IQD` - `IRR` - `ISK` - `JMD` - `JOD` - `JPY` - `KES` - `KGS` - `KHR` - `KMF` - `KPW` - `KRW` - `KWD` - `KYD` - `KZT` - `LAK` - `LBP` - `LKR` - `LRD` - `LSL` - `LYD` - `MAD` - `MDL` - `MGA` - `MKD` - `MMK` - `MNT` - `MOP` - `MRO` - `MUR` - `MVR` - `MWK` - `MXN` - `MXV` - `MYR` - `MZN` - `NAD` - `NGN` - `NIO` - `NOK` - `NPR` - `NZD` - `OMR` - `PAB` - `PEN` - `PGK` - `PHP` - `PKR` - `PLN` - `PYG` - `QAR` - `RON` - `RSD` - `RUB` - `RWF` - `SAR` - `SBD` - `SCR` - `SDG` - `SEK` - `SGD` - `SHP` - `SLL` - `SOS` - `SRD` - `SSP` - `STD` - `SVC` - `SYP` - `SZL` - `THB` - `TJS` - `TMT` - `TND` - `TOP` - `TRY` - `TTD` - `TWD` - `TZS` - `UAH` - `UGX` - `USD` - `USN` - `UYI` - `UYU` - `UZS` - `VEF` - `VND` - `VUV` - `WST` - `XAF` - `XAG` - `XAU` - `XBA` - `XBB` - `XBC` - `XBD` - `XCD` - `XDR` - `XOF` - `XPD` - `XPF` - `XPT` - `XSU` - `XTS` - `XUA` - `XXX` - `YER` - `ZAR` - `ZMW` - `ZWL`
            - `currencyNegativeFormat` string — Determines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1'234'567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1'234'567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1'234'567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1'234'567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123'456'789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00`
            - `currencyPositiveFormat` string — Determines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1'234'567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123'456'789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR)
            - `customDateFormat` string
            - `customTimeFormat` string
            - `dateFormat` string — Specifies the date format. Valid values: - `default` <br> used the UI's - `longformat` <br> use the UI's long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d
            - `initialFormat` string — When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for "William Henry Gates". - `first1last1`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->
            - `nameFormat` string — Describes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->
            - `timeFormat` string — Specifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->
            - `timeZone` string — Specifies the time zone. Valid values: - `TZ_01_AfghanistanStandardTime` - `TZ_02_AlaskanStandardTime` - `TZ_03_ArabStandardTime` - `TZ_04_ArabianStandardTime` - `TZ_05_ArabicStandardTime` - `TZ_06_ArgentinaStandardTime` - `TZ_07_AtlanticStandardTime` - `TZ_08_AUS_CentralStandardTime` - `TZ_09_AUS_EasternStandardTime` - `TZ_10_AzerbaijanStandardTime` - `TZ_11_AzoresStandardTime` - `TZ_12_BangladeshStandardTime` - `TZ_13_CanadaCentralStandardTime` - `TZ_14_CapeVerdeStandardTime` - `TZ_15_CaucasusStandardTime` - `TZ_16_CentralAustraliaStandardTime` - `TZ_17_CentralAmericaStandardTime` - `TZ_18_CentralAsiaStandardTime` - `TZ_19_CentralBrazilianStandardTime` - `TZ_20_CentralEuropeStandardTime` - `TZ_21_CentralEuropeanStandardTime` - `TZ_22_CentralPacificStandardTime` - `TZ_23_CentralStandardTime` - `TZ_24_CentralStandardTimeMexico` - `TZ_25_ChinaStandardTime` - `TZ_26_DatelineStandardTime` - `TZ_27_E_AfricaStandardTime` - `TZ_28_E_AustraliaStandardTime` - `TZ_29_E_EuropeStandardTime` - `TZ_30_E_SouthAmericaStandardTime` - `TZ_31_EasternStandardTime` - `TZ_32_EgyptStandardTime` - `TZ_33_EkaterinburgStandardTime` - `TZ_34_FijiStandardTime` - `TZ_35_FLE_StandardTime` - `TZ_36_GeorgianStandardTime` - `TZ_37_GMT_StandardTime` - `TZ_38_GreenlandStandardTime` - `TZ_39_GreenwichStandardTime` - `TZ_40_GTB_StandardTime` - `TZ_41_HawaiianStandardTime` - `TZ_42_IndiaStandardTime` - `TZ_43_IranStandardTime` - `TZ_44_IsraelStandardTime` - `TZ_45_JordanStandardTime` - `TZ_46_KaliningradStandardTime` - `TZ_47_KamchatkaStandardTime` - `TZ_48_KoreaStandardTime` - `TZ_49_MagadanStandardTime` - `TZ_50_MauritiusStandardTime` - `TZ_51_MidAtlanticStandardTime` - `TZ_52_MiddleEastStandardTime` - `TZ_53_MontevideoStandardTime` - `TZ_54_MoroccoStandardTime` - `TZ_55_MountainStandardTime` - `TZ_56_MountainStandardTimeMMexico` - `TZ_57_MyanmarStandardTime` - `TZ_58_N_CentralAsiaStandardTime` - `TZ_59_NamibiaStandardTime` - `TZ_60_NepalStandardTime` - `TZ_61_NewZealandStandardTime` - `TZ_62_NewfoundlandStandardTime` - `TZ_63_NorthAsiaEastStandardTime` - `TZ_64_NorthAsiaStandardTime` - `TZ_65_PacificSAStandardTime` - `TZ_66_PacificStandardTime` - `TZ_67_PacificStandardTimeMexico` - `TZ_68_PakistanStandardTime` - `TZ_69_ParaguayStandardTime` - `TZ_70_RomanceStandardTime` - `TZ_71_RussianStandardTime` - `TZ_72_SAEasternStandardTime` - `TZ_73_SAPacificStandardTime` - `TZ_74_SAWesternStandardTime` - `TZ_75_SamoaStandardTime` - `TZ_76_SE_AsiaStandardTime` - `TZ_77_SingaporeStandardTime` - `TZ_78_SouthAfricaStandardTime` - `TZ_79_SriLankaStandardTime` - `TZ_80_SyriaStandardTime` - `TZ_81_TaipeiStandardTime` - `TZ_82_TasmaniaStandardTime` - `TZ_83_TokyoStandardTime` - `TZ_84_TongaStandardTime` - `TZ_85_TurkeyStandardTime` - `TZ_86_UlaanbaatarStandardTime` - `TZ_87_US_EasternStandardTime` - `TZ_88_USMountainStandardTime` - `TZ_89_VenezuelaStandardTime` - `TZ_90_VladivostokStandardTime` - `TZ_91_W_AustraliaStandardTime` - `TZ_92_W_CentralAfricaStandardTime` - `TZ_93_W_EuropeStandardTime` - `TZ_94_WestAsiaStandardTime` - `TZ_95_WestPacificStandardTime` - `TZ_96_YakutskStandardTime`
            - `useLongCurrencyFormat` string — When **true,** use the long currency format for the locale.
          - `mergeField` MergeField — Contains information for transferring values between Salesforce data fields and Docusign tabs.
            - `allowSenderToEdit` string — When **true,** the sender can modify the value of the `mergeField` tab during the sending process.
            - `allowSenderToEditMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `configurationType` string — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
            - `configurationTypeMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `path` string — Sets the object associated with the custom tab. Currently this is the Salesforce Object.
            - `pathExtended` PathExtendedElement[] — Reserved for Docusign.
              - …
            - `pathExtendedMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `pathMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `row` string — Specifies the row number in a Salesforce table that the merge field value corresponds to.
            - `rowMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `writeBack` string — When **true,** data entered into the merge field during Signing will update the mapped Salesforce field.
            - `writeBackMetadata` PropertyMetadata — Metadata about a property.
              - …
          - `mergeFieldXml` string — Reserved for Docusign.
          - `pageNumber` string — Specifies the page number on which the tab is located.
          - `pageNumberMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `recipientId` string — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
          - `recipientIdGuid` string — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
          - `recipientIdGuidMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `recipientIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `smartContractInformation` SmartContractInformation
            - `code` string — Reserved for Docusign.
            - `uri` string — Reserved for Docusign.
          - `source` string — Reserved for Docusign.
          - `status` string — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).
          - `statusMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabFullyQualifiedPath` string
          - `tabGroupLabels` string[] — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array.
          - `tabGroupLabelsMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabId` string — The unique identifier for the tab.
          - `tabIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabLabel` string — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters.
          - `tabLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabOrder` string — 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.
          - `tabOrderMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabType` string — Indicates the type of tab (for example, `signHere` or `initialHere`).
          - `tabTypeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
          - `templateLockedMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients.
          - `templateRequiredMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `threadId` string — The unique identifier for the comment thread.
          - `tooltip` string — The text of a tooltip that appears when a user hovers over a form field or tab.
          - `toolTipMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `underline` string — When **true,** the information in the tab is underlined.
          - `underlineMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `warningDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests.
            - `errorCode` string — The code associated with the error condition.
            - `message` string — A brief message describing the error condition.
          - `width` string — The width of the tab in pixels. Must be an integer.
          - `widthMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `xPosition` string — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero.
          - `xPositionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `yPosition` string — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero.
          - `yPositionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
        - `commissionCountyTabs` CommissionCounty[] — A list of [Commission County tabs][cc]. 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][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/
          - `agreementAttribute` string
          - `agreementAttributeLocked` string
          - `anchorAllowWhiteSpaceInCharacters` string — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will match. The default value is **true.**
          - `anchorAllowWhiteSpaceInCharactersMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorCaseSensitive` string — This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorCaseSensitiveMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorHorizontalAlignment` string — This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorHorizontalAlignmentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorIgnoreIfNotPresent` string — When **true,** this tab is ignored if the `anchorString` is not found in the document.
          - `anchorIgnoreIfNotPresentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorMatchWholeWord` string — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorMatchWholeWordMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorString` string — Specifies the string to find in the document and use as the basis for tab placement.
          - `anchorStringMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorTabProcessorVersion` string — Reserved for Docusign.
          - `anchorTabProcessorVersionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorTabScope` string
          - `anchorUnits` string — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms`
          - `anchorUnitsMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorXOffset` string — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
          - `anchorXOffsetMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorYOffset` string — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
          - `anchorYOffsetMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `bold` string — When **true,** the information in the tab is bold.
          - `boldMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `caption` string
          - `captionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `concealValueOnDocument` string — When **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 only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
          - `concealValueOnDocumentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `conditionalParentLabel` string — For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.
          - `conditionalParentLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `conditionalParentValue` string — 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.
          - `conditionalParentValueMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `connectedObjectDetails` ConnectedObjectDetails
            - `recordId` string
          - `customTabId` string — 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.
          - `customTabIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `disableAutoSize` string — When **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.
          - `disableAutoSizeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
          - `documentIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests.
            - `errorCode` string — The code associated with the error condition.
            - `message` string — A brief message describing the error condition.
          - `extensionData` ExtensionData
            - `actionContract` string
            - `actionInputKey` string
            - `actionName` string
            - `applicationId` string
            - `applicationName` string
            - `connectedFieldsData` ConnectedData
              - …
            - `connectionInstances` ConnectionInstance[]
              - …
            - `extensionContract` string
            - `extensionGroupId` string
            - `extensionName` string
            - `extensionPolicy` string
            - `publisherName` string
            - `requiredForExtension` string
          - `font` string — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
          - `fontColor` string — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
          - `fontColorMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `fontMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `fontSize` string — 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
          - `fontSizeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formOrder` string — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.
          - `formOrderMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formPageLabel` string — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
          - `formPageLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formPageNumber` string — An integer specifying the order in which to present the guided form pages.
          - `formPageNumberMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `height` string — The height of the tab in pixels. Must be an integer.
          - `heightMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `italic` string — When **true,** the information in the tab is italic.
          - `italicMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `localePolicy` LocalePolicyTab — Allows you to customize locale settings.
            - `addressFormat` string — Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`
            - `calendarType` string — Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`
            - `cultureName` string — The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
            - `currencyCode` string — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. Supported formats: - `AED` - `AFN` - `ALL` - `AMD` - `ANG` - `AOA` - `ARS` - `AUD` - `AWG` - `AZN` - `BAM` - `BBD` - `BDT` - `BGN` - `BHD` - `BIF` - `BMD` - `BND` - `BOB` - `BOV` - `BRL` - `BSD` - `BTN` - `BWP` - `BYN` - `BYR` - `BZD` - `CAD` - `CDF` - `CHE` - `CHF` - `CHW` - `CLF` - `CLP` - `CNY` - `COP` - `COU` - `CRC` - `CUC` - `CUP` - `CVE` - `CZK` - `DJF` - `DKK` - `DOP` - `DZD` - `EGP` - `ERN` - `ETB` - `EUR` - `FJD` - `FKP` - `GBP` - `GEL` - `GHS` - `GIP` - `GMD` - `GNF` - `GTQ` - `GYD` - `HKD` - `HNL` - `HRK` - `HTG` - `HUF` - `IDR` - `ILS` - `INR` - `IQD` - `IRR` - `ISK` - `JMD` - `JOD` - `JPY` - `KES` - `KGS` - `KHR` - `KMF` - `KPW` - `KRW` - `KWD` - `KYD` - `KZT` - `LAK` - `LBP` - `LKR` - `LRD` - `LSL` - `LYD` - `MAD` - `MDL` - `MGA` - `MKD` - `MMK` - `MNT` - `MOP` - `MRO` - `MUR` - `MVR` - `MWK` - `MXN` - `MXV` - `MYR` - `MZN` - `NAD` - `NGN` - `NIO` - `NOK` - `NPR` - `NZD` - `OMR` - `PAB` - `PEN` - `PGK` - `PHP` - `PKR` - `PLN` - `PYG` - `QAR` - `RON` - `RSD` - `RUB` - `RWF` - `SAR` - `SBD` - `SCR` - `SDG` - `SEK` - `SGD` - `SHP` - `SLL` - `SOS` - `SRD` - `SSP` - `STD` - `SVC` - `SYP` - `SZL` - `THB` - `TJS` - `TMT` - `TND` - `TOP` - `TRY` - `TTD` - `TWD` - `TZS` - `UAH` - `UGX` - `USD` - `USN` - `UYI` - `UYU` - `UZS` - `VEF` - `VND` - `VUV` - `WST` - `XAF` - `XAG` - `XAU` - `XBA` - `XBB` - `XBC` - `XBD` - `XCD` - `XDR` - `XOF` - `XPD` - `XPF` - `XPT` - `XSU` - `XTS` - `XUA` - `XXX` - `YER` - `ZAR` - `ZMW` - `ZWL`
            - `currencyNegativeFormat` string — Determines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1'234'567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1'234'567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1'234'567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1'234'567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123'456'789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00`
            - `currencyPositiveFormat` string — Determines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1'234'567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123'456'789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR)
            - `customDateFormat` string
            - `customTimeFormat` string
            - `dateFormat` string — Specifies the date format. Valid values: - `default` <br> used the UI's - `longformat` <br> use the UI's long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d
            - `initialFormat` string — When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for "William Henry Gates". - `first1last1`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->
            - `nameFormat` string — Describes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->
            - `timeFormat` string — Specifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->
            - `timeZone` string — Specifies the time zone. Valid values: - `TZ_01_AfghanistanStandardTime` - `TZ_02_AlaskanStandardTime` - `TZ_03_ArabStandardTime` - `TZ_04_ArabianStandardTime` - `TZ_05_ArabicStandardTime` - `TZ_06_ArgentinaStandardTime` - `TZ_07_AtlanticStandardTime` - `TZ_08_AUS_CentralStandardTime` - `TZ_09_AUS_EasternStandardTime` - `TZ_10_AzerbaijanStandardTime` - `TZ_11_AzoresStandardTime` - `TZ_12_BangladeshStandardTime` - `TZ_13_CanadaCentralStandardTime` - `TZ_14_CapeVerdeStandardTime` - `TZ_15_CaucasusStandardTime` - `TZ_16_CentralAustraliaStandardTime` - `TZ_17_CentralAmericaStandardTime` - `TZ_18_CentralAsiaStandardTime` - `TZ_19_CentralBrazilianStandardTime` - `TZ_20_CentralEuropeStandardTime` - `TZ_21_CentralEuropeanStandardTime` - `TZ_22_CentralPacificStandardTime` - `TZ_23_CentralStandardTime` - `TZ_24_CentralStandardTimeMexico` - `TZ_25_ChinaStandardTime` - `TZ_26_DatelineStandardTime` - `TZ_27_E_AfricaStandardTime` - `TZ_28_E_AustraliaStandardTime` - `TZ_29_E_EuropeStandardTime` - `TZ_30_E_SouthAmericaStandardTime` - `TZ_31_EasternStandardTime` - `TZ_32_EgyptStandardTime` - `TZ_33_EkaterinburgStandardTime` - `TZ_34_FijiStandardTime` - `TZ_35_FLE_StandardTime` - `TZ_36_GeorgianStandardTime` - `TZ_37_GMT_StandardTime` - `TZ_38_GreenlandStandardTime` - `TZ_39_GreenwichStandardTime` - `TZ_40_GTB_StandardTime` - `TZ_41_HawaiianStandardTime` - `TZ_42_IndiaStandardTime` - `TZ_43_IranStandardTime` - `TZ_44_IsraelStandardTime` - `TZ_45_JordanStandardTime` - `TZ_46_KaliningradStandardTime` - `TZ_47_KamchatkaStandardTime` - `TZ_48_KoreaStandardTime` - `TZ_49_MagadanStandardTime` - `TZ_50_MauritiusStandardTime` - `TZ_51_MidAtlanticStandardTime` - `TZ_52_MiddleEastStandardTime` - `TZ_53_MontevideoStandardTime` - `TZ_54_MoroccoStandardTime` - `TZ_55_MountainStandardTime` - `TZ_56_MountainStandardTimeMMexico` - `TZ_57_MyanmarStandardTime` - `TZ_58_N_CentralAsiaStandardTime` - `TZ_59_NamibiaStandardTime` - `TZ_60_NepalStandardTime` - `TZ_61_NewZealandStandardTime` - `TZ_62_NewfoundlandStandardTime` - `TZ_63_NorthAsiaEastStandardTime` - `TZ_64_NorthAsiaStandardTime` - `TZ_65_PacificSAStandardTime` - `TZ_66_PacificStandardTime` - `TZ_67_PacificStandardTimeMexico` - `TZ_68_PakistanStandardTime` - `TZ_69_ParaguayStandardTime` - `TZ_70_RomanceStandardTime` - `TZ_71_RussianStandardTime` - `TZ_72_SAEasternStandardTime` - `TZ_73_SAPacificStandardTime` - `TZ_74_SAWesternStandardTime` - `TZ_75_SamoaStandardTime` - `TZ_76_SE_AsiaStandardTime` - `TZ_77_SingaporeStandardTime` - `TZ_78_SouthAfricaStandardTime` - `TZ_79_SriLankaStandardTime` - `TZ_80_SyriaStandardTime` - `TZ_81_TaipeiStandardTime` - `TZ_82_TasmaniaStandardTime` - `TZ_83_TokyoStandardTime` - `TZ_84_TongaStandardTime` - `TZ_85_TurkeyStandardTime` - `TZ_86_UlaanbaatarStandardTime` - `TZ_87_US_EasternStandardTime` - `TZ_88_USMountainStandardTime` - `TZ_89_VenezuelaStandardTime` - `TZ_90_VladivostokStandardTime` - `TZ_91_W_AustraliaStandardTime` - `TZ_92_W_CentralAfricaStandardTime` - `TZ_93_W_EuropeStandardTime` - `TZ_94_WestAsiaStandardTime` - `TZ_95_WestPacificStandardTime` - `TZ_96_YakutskStandardTime`
            - `useLongCurrencyFormat` string — When **true,** use the long currency format for the locale.
          - `locked` string — When **true,** the signer cannot change the data of the custom tab.
          - `lockedMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `maxLength` string — An optional value that describes the maximum length of the property when the property is a string.
          - `maxLengthMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `mergeField` MergeField — Contains information for transferring values between Salesforce data fields and Docusign tabs.
            - `allowSenderToEdit` string — When **true,** the sender can modify the value of the `mergeField` tab during the sending process.
            - `allowSenderToEditMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `configurationType` string — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
            - `configurationTypeMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `path` string — Sets the object associated with the custom tab. Currently this is the Salesforce Object.
            - `pathExtended` PathExtendedElement[] — Reserved for Docusign.
              - …
            - `pathExtendedMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `pathMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `row` string — Specifies the row number in a Salesforce table that the merge field value corresponds to.
            - `rowMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `writeBack` string — When **true,** data entered into the merge field during Signing will update the mapped Salesforce field.
            - `writeBackMetadata` PropertyMetadata — Metadata about a property.
              - …
          - `mergeFieldXml` string — Reserved for Docusign.
          - `name` string
          - `nameMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `originalValue` string — The initial value of the tab.
          - `originalValueMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `pageNumber` string — Specifies the page number on which the tab is located.
          - `pageNumberMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `recipientId` string — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
          - `recipientIdGuid` string — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
          - `recipientIdGuidMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `recipientIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `required` string — When **true,** the signer is required to fill out this tab.
          - `requiredMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `smartContractInformation` SmartContractInformation
            - `code` string — Reserved for Docusign.
            - `uri` string — Reserved for Docusign.
          - `source` string — Reserved for Docusign.
          - `status` string — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
          - `statusMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabFullyQualifiedPath` string
          - `tabGroupLabels` string[] — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array.
          - `tabGroupLabelsMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabId` string — The unique identifier for the tab.
          - `tabIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabLabel` string — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters.
          - `tabLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabOrder` string — 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.
          - `tabOrderMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabType` string — Indicates the type of tab (for example, `signHere` or `initialHere`).
          - `tabTypeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
          - `templateLockedMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients.
          - `templateRequiredMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tooltip` string — The text of a tooltip that appears when a user hovers over a form field or tab.
          - `toolTipMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `underline` string — When **true,** the information in the tab is underlined.
          - `underlineMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `value` string — Specifies the value of the tab.
          - `valueMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `warningDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests.
            - `errorCode` string — The code associated with the error condition.
            - `message` string — A brief message describing the error condition.
          - `width` string — The width of the tab in pixels. Must be an integer.
          - `widthMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `xPosition` string — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero.
          - `xPositionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `yPosition` string — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero.
          - `yPositionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
        - `commissionExpirationTabs` CommissionExpiration[] — A list of [Commission Expiration tabs][tabref]. 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][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/
          - `agreementAttribute` string
          - `agreementAttributeLocked` string
          - `anchorAllowWhiteSpaceInCharacters` string — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will match. The default value is **true.**
          - `anchorAllowWhiteSpaceInCharactersMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorCaseSensitive` string — This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorCaseSensitiveMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorHorizontalAlignment` string — This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorHorizontalAlignmentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorIgnoreIfNotPresent` string — When **true,** this tab is ignored if the `anchorString` is not found in the document.
          - `anchorIgnoreIfNotPresentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorMatchWholeWord` string — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorMatchWholeWordMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorString` string — Specifies the string to find in the document and use as the basis for tab placement.
          - `anchorStringMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorTabProcessorVersion` string — Reserved for Docusign.
          - `anchorTabProcessorVersionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorTabScope` string
          - `anchorUnits` string — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms`
          - `anchorUnitsMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorXOffset` string — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
          - `anchorXOffsetMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorYOffset` string — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
          - `anchorYOffsetMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `bold` string — When **true,** the information in the tab is bold.
          - `boldMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `caption` string
          - `captionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `concealValueOnDocument` string — When **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 only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
          - `concealValueOnDocumentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `conditionalParentLabel` string — For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.
          - `conditionalParentLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `conditionalParentValue` string — 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.
          - `conditionalParentValueMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `connectedObjectDetails` ConnectedObjectDetails
            - `recordId` string
          - `customTabId` string — 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.
          - `customTabIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `disableAutoSize` string — When **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.
          - `disableAutoSizeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
          - `documentIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests.
            - `errorCode` string — The code associated with the error condition.
            - `message` string — A brief message describing the error condition.
          - `extensionData` ExtensionData
            - `actionContract` string
            - `actionInputKey` string
            - `actionName` string
            - `applicationId` string
            - `applicationName` string
            - `connectedFieldsData` ConnectedData
              - …
            - `connectionInstances` ConnectionInstance[]
              - …
            - `extensionContract` string
            - `extensionGroupId` string
            - `extensionName` string
            - `extensionPolicy` string
            - `publisherName` string
            - `requiredForExtension` string
          - `font` string — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
          - `fontColor` string — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
          - `fontColorMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `fontMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `fontSize` string — 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
          - `fontSizeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formOrder` string — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.
          - `formOrderMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formPageLabel` string — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
          - `formPageLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formPageNumber` string — An integer specifying the order in which to present the guided form pages.
          - `formPageNumberMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `height` string — The height of the tab in pixels. Must be an integer.
          - `heightMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `italic` string — When **true,** the information in the tab is italic.
          - `italicMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `localePolicy` LocalePolicyTab — Allows you to customize locale settings.
            - `addressFormat` string — Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`
            - `calendarType` string — Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`
            - `cultureName` string — The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
            - `currencyCode` string — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. Supported formats: - `AED` - `AFN` - `ALL` - `AMD` - `ANG` - `AOA` - `ARS` - `AUD` - `AWG` - `AZN` - `BAM` - `BBD` - `BDT` - `BGN` - `BHD` - `BIF` - `BMD` - `BND` - `BOB` - `BOV` - `BRL` - `BSD` - `BTN` - `BWP` - `BYN` - `BYR` - `BZD` - `CAD` - `CDF` - `CHE` - `CHF` - `CHW` - `CLF` - `CLP` - `CNY` - `COP` - `COU` - `CRC` - `CUC` - `CUP` - `CVE` - `CZK` - `DJF` - `DKK` - `DOP` - `DZD` - `EGP` - `ERN` - `ETB` - `EUR` - `FJD` - `FKP` - `GBP` - `GEL` - `GHS` - `GIP` - `GMD` - `GNF` - `GTQ` - `GYD` - `HKD` - `HNL` - `HRK` - `HTG` - `HUF` - `IDR` - `ILS` - `INR` - `IQD` - `IRR` - `ISK` - `JMD` - `JOD` - `JPY` - `KES` - `KGS` - `KHR` - `KMF` - `KPW` - `KRW` - `KWD` - `KYD` - `KZT` - `LAK` - `LBP` - `LKR` - `LRD` - `LSL` - `LYD` - `MAD` - `MDL` - `MGA` - `MKD` - `MMK` - `MNT` - `MOP` - `MRO` - `MUR` - `MVR` - `MWK` - `MXN` - `MXV` - `MYR` - `MZN` - `NAD` - `NGN` - `NIO` - `NOK` - `NPR` - `NZD` - `OMR` - `PAB` - `PEN` - `PGK` - `PHP` - `PKR` - `PLN` - `PYG` - `QAR` - `RON` - `RSD` - `RUB` - `RWF` - `SAR` - `SBD` - `SCR` - `SDG` - `SEK` - `SGD` - `SHP` - `SLL` - `SOS` - `SRD` - `SSP` - `STD` - `SVC` - `SYP` - `SZL` - `THB` - `TJS` - `TMT` - `TND` - `TOP` - `TRY` - `TTD` - `TWD` - `TZS` - `UAH` - `UGX` - `USD` - `USN` - `UYI` - `UYU` - `UZS` - `VEF` - `VND` - `VUV` - `WST` - `XAF` - `XAG` - `XAU` - `XBA` - `XBB` - `XBC` - `XBD` - `XCD` - `XDR` - `XOF` - `XPD` - `XPF` - `XPT` - `XSU` - `XTS` - `XUA` - `XXX` - `YER` - `ZAR` - `ZMW` - `ZWL`
            - `currencyNegativeFormat` string — Determines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1'234'567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1'234'567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1'234'567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1'234'567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123'456'789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00`
            - `currencyPositiveFormat` string — Determines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1'234'567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123'456'789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR)
            - `customDateFormat` string
            - `customTimeFormat` string
            - `dateFormat` string — Specifies the date format. Valid values: - `default` <br> used the UI's - `longformat` <br> use the UI's long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d
            - `initialFormat` string — When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for "William Henry Gates". - `first1last1`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->
            - `nameFormat` string — Describes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->
            - `timeFormat` string — Specifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->
            - `timeZone` string — Specifies the time zone. Valid values: - `TZ_01_AfghanistanStandardTime` - `TZ_02_AlaskanStandardTime` - `TZ_03_ArabStandardTime` - `TZ_04_ArabianStandardTime` - `TZ_05_ArabicStandardTime` - `TZ_06_ArgentinaStandardTime` - `TZ_07_AtlanticStandardTime` - `TZ_08_AUS_CentralStandardTime` - `TZ_09_AUS_EasternStandardTime` - `TZ_10_AzerbaijanStandardTime` - `TZ_11_AzoresStandardTime` - `TZ_12_BangladeshStandardTime` - `TZ_13_CanadaCentralStandardTime` - `TZ_14_CapeVerdeStandardTime` - `TZ_15_CaucasusStandardTime` - `TZ_16_CentralAustraliaStandardTime` - `TZ_17_CentralAmericaStandardTime` - `TZ_18_CentralAsiaStandardTime` - `TZ_19_CentralBrazilianStandardTime` - `TZ_20_CentralEuropeStandardTime` - `TZ_21_CentralEuropeanStandardTime` - `TZ_22_CentralPacificStandardTime` - `TZ_23_CentralStandardTime` - `TZ_24_CentralStandardTimeMexico` - `TZ_25_ChinaStandardTime` - `TZ_26_DatelineStandardTime` - `TZ_27_E_AfricaStandardTime` - `TZ_28_E_AustraliaStandardTime` - `TZ_29_E_EuropeStandardTime` - `TZ_30_E_SouthAmericaStandardTime` - `TZ_31_EasternStandardTime` - `TZ_32_EgyptStandardTime` - `TZ_33_EkaterinburgStandardTime` - `TZ_34_FijiStandardTime` - `TZ_35_FLE_StandardTime` - `TZ_36_GeorgianStandardTime` - `TZ_37_GMT_StandardTime` - `TZ_38_GreenlandStandardTime` - `TZ_39_GreenwichStandardTime` - `TZ_40_GTB_StandardTime` - `TZ_41_HawaiianStandardTime` - `TZ_42_IndiaStandardTime` - `TZ_43_IranStandardTime` - `TZ_44_IsraelStandardTime` - `TZ_45_JordanStandardTime` - `TZ_46_KaliningradStandardTime` - `TZ_47_KamchatkaStandardTime` - `TZ_48_KoreaStandardTime` - `TZ_49_MagadanStandardTime` - `TZ_50_MauritiusStandardTime` - `TZ_51_MidAtlanticStandardTime` - `TZ_52_MiddleEastStandardTime` - `TZ_53_MontevideoStandardTime` - `TZ_54_MoroccoStandardTime` - `TZ_55_MountainStandardTime` - `TZ_56_MountainStandardTimeMMexico` - `TZ_57_MyanmarStandardTime` - `TZ_58_N_CentralAsiaStandardTime` - `TZ_59_NamibiaStandardTime` - `TZ_60_NepalStandardTime` - `TZ_61_NewZealandStandardTime` - `TZ_62_NewfoundlandStandardTime` - `TZ_63_NorthAsiaEastStandardTime` - `TZ_64_NorthAsiaStandardTime` - `TZ_65_PacificSAStandardTime` - `TZ_66_PacificStandardTime` - `TZ_67_PacificStandardTimeMexico` - `TZ_68_PakistanStandardTime` - `TZ_69_ParaguayStandardTime` - `TZ_70_RomanceStandardTime` - `TZ_71_RussianStandardTime` - `TZ_72_SAEasternStandardTime` - `TZ_73_SAPacificStandardTime` - `TZ_74_SAWesternStandardTime` - `TZ_75_SamoaStandardTime` - `TZ_76_SE_AsiaStandardTime` - `TZ_77_SingaporeStandardTime` - `TZ_78_SouthAfricaStandardTime` - `TZ_79_SriLankaStandardTime` - `TZ_80_SyriaStandardTime` - `TZ_81_TaipeiStandardTime` - `TZ_82_TasmaniaStandardTime` - `TZ_83_TokyoStandardTime` - `TZ_84_TongaStandardTime` - `TZ_85_TurkeyStandardTime` - `TZ_86_UlaanbaatarStandardTime` - `TZ_87_US_EasternStandardTime` - `TZ_88_USMountainStandardTime` - `TZ_89_VenezuelaStandardTime` - `TZ_90_VladivostokStandardTime` - `TZ_91_W_AustraliaStandardTime` - `TZ_92_W_CentralAfricaStandardTime` - `TZ_93_W_EuropeStandardTime` - `TZ_94_WestAsiaStandardTime` - `TZ_95_WestPacificStandardTime` - `TZ_96_YakutskStandardTime`
            - `useLongCurrencyFormat` string — When **true,** use the long currency format for the locale.
          - `locked` string — When **true,** the signer cannot change the data of the custom tab.
          - `lockedMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `maxLength` string — An optional value that describes the maximum length of the property when the property is a string.
          - `maxLengthMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `mergeField` MergeField — Contains information for transferring values between Salesforce data fields and Docusign tabs.
            - `allowSenderToEdit` string — When **true,** the sender can modify the value of the `mergeField` tab during the sending process.
            - `allowSenderToEditMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `configurationType` string — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
            - `configurationTypeMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `path` string — Sets the object associated with the custom tab. Currently this is the Salesforce Object.
            - `pathExtended` PathExtendedElement[] — Reserved for Docusign.
              - …
            - `pathExtendedMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `pathMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `row` string — Specifies the row number in a Salesforce table that the merge field value corresponds to.
            - `rowMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `writeBack` string — When **true,** data entered into the merge field during Signing will update the mapped Salesforce field.
            - `writeBackMetadata` PropertyMetadata — Metadata about a property.
              - …
          - `mergeFieldXml` string — Reserved for Docusign.
          - `name` string
          - `nameMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `originalValue` string — The initial value of the tab.
          - `originalValueMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `pageNumber` string — Specifies the page number on which the tab is located.
          - `pageNumberMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `recipientId` string — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
          - `recipientIdGuid` string — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
          - `recipientIdGuidMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `recipientIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `required` string — When **true,** the signer is required to fill out this tab.
          - `requiredMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `smartContractInformation` SmartContractInformation
            - `code` string — Reserved for Docusign.
            - `uri` string — Reserved for Docusign.
          - `source` string — Reserved for Docusign.
          - `status` string — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
          - `statusMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabFullyQualifiedPath` string
          - `tabGroupLabels` string[] — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array.
          - `tabGroupLabelsMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabId` string — The unique identifier for the tab.
          - `tabIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabLabel` string — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters.
          - `tabLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabOrder` string — 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.
          - `tabOrderMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabType` string — Indicates the type of tab (for example, `signHere` or `initialHere`).
          - `tabTypeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
          - `templateLockedMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients.
          - `templateRequiredMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tooltip` string — The text of a tooltip that appears when a user hovers over a form field or tab.
          - `toolTipMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `underline` string — When **true,** the information in the tab is underlined.
          - `underlineMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `value` string — Specifies the value of the tab.
          - `valueMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `warningDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests.
            - `errorCode` string — The code associated with the error condition.
            - `message` string — A brief message describing the error condition.
          - `width` string — The width of the tab in pixels. Must be an integer.
          - `widthMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `xPosition` string — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero.
          - `xPositionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `yPosition` string — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero.
          - `yPositionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
        - `commissionNumberTabs` CommissionNumber[] — A list of [Commission Number tabs][tabref]. A Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/
          - `agreementAttribute` string
          - `agreementAttributeLocked` string
          - `anchorAllowWhiteSpaceInCharacters` string — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will match. The default value is **true.**
          - `anchorAllowWhiteSpaceInCharactersMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorCaseSensitive` string — This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorCaseSensitiveMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorHorizontalAlignment` string — This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorHorizontalAlignmentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorIgnoreIfNotPresent` string — When **true,** this tab is ignored if the `anchorString` is not found in the document.
          - `anchorIgnoreIfNotPresentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorMatchWholeWord` string — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorMatchWholeWordMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorString` string — Specifies the string to find in the document and use as the basis for tab placement.
          - `anchorStringMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorTabProcessorVersion` string — Reserved for Docusign.
          - `anchorTabProcessorVersionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorTabScope` string
          - `anchorUnits` string — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms`
          - `anchorUnitsMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorXOffset` string — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
          - `anchorXOffsetMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorYOffset` string — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
          - `anchorYOffsetMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `bold` string — When **true,** the information in the tab is bold.
          - `boldMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `caption` string
          - `captionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `concealValueOnDocument` string — When **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 only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
          - `concealValueOnDocumentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `conditionalParentLabel` string — For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility.
          - `conditionalParentLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `conditionalParentValue` string — 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.
          - `conditionalParentValueMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `connectedObjectDetails` ConnectedObjectDetails
            - `recordId` string
          - `customTabId` string — 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.
          - `customTabIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `disableAutoSize` string — When **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.
          - `disableAutoSizeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
          - `documentIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests.
            - `errorCode` string — The code associated with the error condition.
            - `message` string — A brief message describing the error condition.
          - `extensionData` ExtensionData
            - `actionContract` string
            - `actionInputKey` string
            - `actionName` string
            - `applicationId` string
            - `applicationName` string
            - `connectedFieldsData` ConnectedData
              - …
            - `connectionInstances` ConnectionInstance[]
              - …
            - `extensionContract` string
            - `extensionGroupId` string
            - `extensionName` string
            - `extensionPolicy` string
            - `publisherName` string
            - `requiredForExtension` string
          - `font` string — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana
          - `fontColor` string — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White
          - `fontColorMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `fontMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `fontSize` string — 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
          - `fontSizeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formOrder` string — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block.
          - `formOrderMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formPageLabel` string — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
          - `formPageLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `formPageNumber` string — An integer specifying the order in which to present the guided form pages.
          - `formPageNumberMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `height` string — The height of the tab in pixels. Must be an integer.
          - `heightMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `italic` string — When **true,** the information in the tab is italic.
          - `italicMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `localePolicy` LocalePolicyTab — Allows you to customize locale settings.
            - `addressFormat` string — Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw`
            - `calendarType` string — Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist`
            - `cultureName` string — The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code.
            - `currencyCode` string — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. Supported formats: - `AED` - `AFN` - `ALL` - `AMD` - `ANG` - `AOA` - `ARS` - `AUD` - `AWG` - `AZN` - `BAM` - `BBD` - `BDT` - `BGN` - `BHD` - `BIF` - `BMD` - `BND` - `BOB` - `BOV` - `BRL` - `BSD` - `BTN` - `BWP` - `BYN` - `BYR` - `BZD` - `CAD` - `CDF` - `CHE` - `CHF` - `CHW` - `CLF` - `CLP` - `CNY` - `COP` - `COU` - `CRC` - `CUC` - `CUP` - `CVE` - `CZK` - `DJF` - `DKK` - `DOP` - `DZD` - `EGP` - `ERN` - `ETB` - `EUR` - `FJD` - `FKP` - `GBP` - `GEL` - `GHS` - `GIP` - `GMD` - `GNF` - `GTQ` - `GYD` - `HKD` - `HNL` - `HRK` - `HTG` - `HUF` - `IDR` - `ILS` - `INR` - `IQD` - `IRR` - `ISK` - `JMD` - `JOD` - `JPY` - `KES` - `KGS` - `KHR` - `KMF` - `KPW` - `KRW` - `KWD` - `KYD` - `KZT` - `LAK` - `LBP` - `LKR` - `LRD` - `LSL` - `LYD` - `MAD` - `MDL` - `MGA` - `MKD` - `MMK` - `MNT` - `MOP` - `MRO` - `MUR` - `MVR` - `MWK` - `MXN` - `MXV` - `MYR` - `MZN` - `NAD` - `NGN` - `NIO` - `NOK` - `NPR` - `NZD` - `OMR` - `PAB` - `PEN` - `PGK` - `PHP` - `PKR` - `PLN` - `PYG` - `QAR` - `RON` - `RSD` - `RUB` - `RWF` - `SAR` - `SBD` - `SCR` - `SDG` - `SEK` - `SGD` - `SHP` - `SLL` - `SOS` - `SRD` - `SSP` - `STD` - `SVC` - `SYP` - `SZL` - `THB` - `TJS` - `TMT` - `TND` - `TOP` - `TRY` - `TTD` - `TWD` - `TZS` - `UAH` - `UGX` - `USD` - `USN` - `UYI` - `UYU` - `UZS` - `VEF` - `VND` - `VUV` - `WST` - `XAF` - `XAG` - `XAU` - `XBA` - `XBB` - `XBC` - `XBD` - `XCD` - `XDR` - `XOF` - `XPD` - `XPF` - `XPT` - `XSU` - `XTS` - `XUA` - `XXX` - `YER` - `ZAR` - `ZMW` - `ZWL`
            - `currencyNegativeFormat` string — Determines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br> `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br> `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br> `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br> `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br> `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br> `$-1'234'567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89`<br> `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567`<br> `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br> `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br> `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br> `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br> `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br> `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br> `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br> `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym`<br> `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br> `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar`<br> `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar`<br> `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br> `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br> `($ 1'234'567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br> `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br> `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br> `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br> `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br> `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br> `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br> `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br> `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br> `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567`<br> `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `-$ 1'234'567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br> `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567`<br> `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567`<br> `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br> `$ -1'234'567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br> `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym`<br> `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89`<br> `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `-123'456'789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br> `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89`<br> `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br> `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89`<br> `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89`<br> `-$123 456 789,00`
            - `currencyPositiveFormat` string — Determines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default`<br> Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89`<br> `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89`<br> `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br> `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br> `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89`<br> `$ 1'234'567.89` - `CSym_1_Comma_234_Comma_567`<br> `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89`<br> `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89`<br> `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89`<br> `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br> `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89`<br> `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89`<br> `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym`<br> `1 234 567,89$` - `CSym_1_Period_234_Period_567`<br> `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br> `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89`<br> `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89`<br> `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br> `123'456'789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89`<br> `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym`<br> `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89`<br> `$123 456 789,00` (en-ZA, es-CR)
            - `customDateFormat` string
            - `customTimeFormat` string
            - `dateFormat` string — Specifies the date format. Valid values: - `default` <br> used the UI's - `longformat` <br> use the UI's long format - `dd_mm_yy` <br> dd-MM-yy - `dd_mmm_yy` <br> dd-MMM-yy - `dd_mm_yyyy` <br> dd-MM-yyyy - `dd_mmm_yyyy` <br> dd-MMM-yyyy - `ddmmmmyyyy` <br> dd MMMM yyyy - `ddmmyyyy` <br> dd/MM/yyyy - `ddmmyyyy_de` <br> dd.MM.yyyy - `dmyyyy` <br> d/M/yyyy - `d_m_yyyy` <br> d-M-yyyy - `mmmd_yyyy` <br> MMM d, yyyy - `mmm_dd_yyyy` <br> MMM-dd-yyyy - `mmmmd_yyyy` <br> MMMM d, yyyy - `mm_dd_yyyy` <br> MM-dd-yyyy - `mdyyyy` <br> M/d/yyyy - `yyyy_mmm_dd` <br> yyyy-MMM-dd - `yyyy_mm_dd` <br> yyyy-MM-dd - `yyyymmdd` <br> yyyy/MM/dd - `yyyymd` <br> yyyy/M/d - `custom` <br> Customer set own value - `mmddyyyy` <br> MM/dd/yyyy - `mmddyy` <br> MM/dd/yy - `yyyy_mmmm_d` <br> yyyy MMMM d
            - `initialFormat` string — When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for "William Henry Gates". - `first1last1`<br> "WG" - `last2`<br> "GA" - `first2`<br> "WI" - `last2_cjk`<br> first two characters from last name in CJK characters. <!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->
            - `nameFormat` string — Describes how names are displayed. Valid values: - `first_middle_last`<br>William Henry Gates - `full`<br>Mr William Henry Gates III - `last_first`<br>Gates William - `lastfirst`<br>GatesWilliam - `last_first_cjk`<br>Gates William only with CJK characters - `lastfirst_cjk`<br>GatesWilliam only with CJK characters <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->
            - `timeFormat` string — Specifies the time format. Valid values: - `none` <br>None - `hh_mm` <br>hh:mm - `hhmm` <br>HH:mm - `hhmmss` <br>HH:mm:ss - `hhmmsstt` <br>HH:mm:ss tt - `hhmmtt` <br> HH:mm tt - `hmm` <br>h:mm - `hmmss` <br>h:mm:ss - `hmmsstt` <br>h:mm:ss tt - `hmmtt` <br>h:mm tt - `custom` <br>Customer-set format <!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->
            - `timeZone` string — Specifies the time zone. Valid values: - `TZ_01_AfghanistanStandardTime` - `TZ_02_AlaskanStandardTime` - `TZ_03_ArabStandardTime` - `TZ_04_ArabianStandardTime` - `TZ_05_ArabicStandardTime` - `TZ_06_ArgentinaStandardTime` - `TZ_07_AtlanticStandardTime` - `TZ_08_AUS_CentralStandardTime` - `TZ_09_AUS_EasternStandardTime` - `TZ_10_AzerbaijanStandardTime` - `TZ_11_AzoresStandardTime` - `TZ_12_BangladeshStandardTime` - `TZ_13_CanadaCentralStandardTime` - `TZ_14_CapeVerdeStandardTime` - `TZ_15_CaucasusStandardTime` - `TZ_16_CentralAustraliaStandardTime` - `TZ_17_CentralAmericaStandardTime` - `TZ_18_CentralAsiaStandardTime` - `TZ_19_CentralBrazilianStandardTime` - `TZ_20_CentralEuropeStandardTime` - `TZ_21_CentralEuropeanStandardTime` - `TZ_22_CentralPacificStandardTime` - `TZ_23_CentralStandardTime` - `TZ_24_CentralStandardTimeMexico` - `TZ_25_ChinaStandardTime` - `TZ_26_DatelineStandardTime` - `TZ_27_E_AfricaStandardTime` - `TZ_28_E_AustraliaStandardTime` - `TZ_29_E_EuropeStandardTime` - `TZ_30_E_SouthAmericaStandardTime` - `TZ_31_EasternStandardTime` - `TZ_32_EgyptStandardTime` - `TZ_33_EkaterinburgStandardTime` - `TZ_34_FijiStandardTime` - `TZ_35_FLE_StandardTime` - `TZ_36_GeorgianStandardTime` - `TZ_37_GMT_StandardTime` - `TZ_38_GreenlandStandardTime` - `TZ_39_GreenwichStandardTime` - `TZ_40_GTB_StandardTime` - `TZ_41_HawaiianStandardTime` - `TZ_42_IndiaStandardTime` - `TZ_43_IranStandardTime` - `TZ_44_IsraelStandardTime` - `TZ_45_JordanStandardTime` - `TZ_46_KaliningradStandardTime` - `TZ_47_KamchatkaStandardTime` - `TZ_48_KoreaStandardTime` - `TZ_49_MagadanStandardTime` - `TZ_50_MauritiusStandardTime` - `TZ_51_MidAtlanticStandardTime` - `TZ_52_MiddleEastStandardTime` - `TZ_53_MontevideoStandardTime` - `TZ_54_MoroccoStandardTime` - `TZ_55_MountainStandardTime` - `TZ_56_MountainStandardTimeMMexico` - `TZ_57_MyanmarStandardTime` - `TZ_58_N_CentralAsiaStandardTime` - `TZ_59_NamibiaStandardTime` - `TZ_60_NepalStandardTime` - `TZ_61_NewZealandStandardTime` - `TZ_62_NewfoundlandStandardTime` - `TZ_63_NorthAsiaEastStandardTime` - `TZ_64_NorthAsiaStandardTime` - `TZ_65_PacificSAStandardTime` - `TZ_66_PacificStandardTime` - `TZ_67_PacificStandardTimeMexico` - `TZ_68_PakistanStandardTime` - `TZ_69_ParaguayStandardTime` - `TZ_70_RomanceStandardTime` - `TZ_71_RussianStandardTime` - `TZ_72_SAEasternStandardTime` - `TZ_73_SAPacificStandardTime` - `TZ_74_SAWesternStandardTime` - `TZ_75_SamoaStandardTime` - `TZ_76_SE_AsiaStandardTime` - `TZ_77_SingaporeStandardTime` - `TZ_78_SouthAfricaStandardTime` - `TZ_79_SriLankaStandardTime` - `TZ_80_SyriaStandardTime` - `TZ_81_TaipeiStandardTime` - `TZ_82_TasmaniaStandardTime` - `TZ_83_TokyoStandardTime` - `TZ_84_TongaStandardTime` - `TZ_85_TurkeyStandardTime` - `TZ_86_UlaanbaatarStandardTime` - `TZ_87_US_EasternStandardTime` - `TZ_88_USMountainStandardTime` - `TZ_89_VenezuelaStandardTime` - `TZ_90_VladivostokStandardTime` - `TZ_91_W_AustraliaStandardTime` - `TZ_92_W_CentralAfricaStandardTime` - `TZ_93_W_EuropeStandardTime` - `TZ_94_WestAsiaStandardTime` - `TZ_95_WestPacificStandardTime` - `TZ_96_YakutskStandardTime`
            - `useLongCurrencyFormat` string — When **true,** use the long currency format for the locale.
          - `locked` string — When **true,** the signer cannot change the data of the custom tab.
          - `lockedMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `maxLength` string — An optional value that describes the maximum length of the property when the property is a string.
          - `maxLengthMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `mergeField` MergeField — Contains information for transferring values between Salesforce data fields and Docusign tabs.
            - `allowSenderToEdit` string — When **true,** the sender can modify the value of the `mergeField` tab during the sending process.
            - `allowSenderToEditMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `configurationType` string — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`.
            - `configurationTypeMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `path` string — Sets the object associated with the custom tab. Currently this is the Salesforce Object.
            - `pathExtended` PathExtendedElement[] — Reserved for Docusign.
              - …
            - `pathExtendedMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `pathMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `row` string — Specifies the row number in a Salesforce table that the merge field value corresponds to.
            - `rowMetadata` PropertyMetadata — Metadata about a property.
              - …
            - `writeBack` string — When **true,** data entered into the merge field during Signing will update the mapped Salesforce field.
            - `writeBackMetadata` PropertyMetadata — Metadata about a property.
              - …
          - `mergeFieldXml` string — Reserved for Docusign.
          - `name` string
          - `nameMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `originalValue` string — The initial value of the tab.
          - `originalValueMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `pageNumber` string — Specifies the page number on which the tab is located.
          - `pageNumberMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `recipientId` string — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.
          - `recipientIdGuid` string — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only.
          - `recipientIdGuidMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `recipientIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `required` string — When **true,** the signer is required to fill out this tab.
          - `requiredMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `smartContractInformation` SmartContractInformation
            - `code` string — Reserved for Docusign.
            - `uri` string — Reserved for Docusign.
          - `source` string — Reserved for Docusign.
          - `status` string — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
          - `statusMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabFullyQualifiedPath` string
          - `tabGroupLabels` string[] — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array.
          - `tabGroupLabelsMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabId` string — The unique identifier for the tab.
          - `tabIdMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabLabel` string — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters.
          - `tabLabelMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabOrder` string — 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.
          - `tabOrderMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tabType` string — Indicates the type of tab (for example, `signHere` or `initialHere`).
          - `tabTypeMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
          - `templateLockedMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients.
          - `templateRequiredMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `tooltip` string — The text of a tooltip that appears when a user hovers over a form field or tab.
          - `toolTipMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `underline` string — When **true,** the information in the tab is underlined.
          - `underlineMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `value` string — Specifies the value of the tab.
          - `valueMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `warningDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests.
            - `errorCode` string — The code associated with the error condition.
            - `message` string — A brief message describing the error condition.
          - `width` string — The width of the tab in pixels. Must be an integer.
          - `widthMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `xPosition` string — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero.
          - `xPositionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `yPosition` string — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero.
          - `yPositionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
        - `commissionStateTabs` CommissionState[] — A list of [Commission State tabs][cc]. 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][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/
          - `agreementAttribute` string
          - `agreementAttributeLocked` string
          - `anchorAllowWhiteSpaceInCharacters` string — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu&nbsp;&nbsp;&nbsp;Sign</code> will match. The default value is **true.**
          - `anchorAllowWhiteSpaceInCharactersMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorCaseSensitive` string — This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorCaseSensitiveMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorHorizontalAlignment` string — This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorHorizontalAlignmentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorIgnoreIfNotPresent` string — When **true,** this tab is ignored if the `anchorString` is not found in the document.
          - `anchorIgnoreIfNotPresentMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorMatchWholeWord` string — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/
          - `anchorMatchWholeWordMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorString` string — Specifies the string to find in the document and use as the basis for tab placement.
          - `anchorStringMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorTabProcessorVersion` string — Reserved for Docusign.
          - `anchorTabProcessorVersionMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorTabScope` string
          - `anchorUnits` string — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms`
          - `anchorUnitsMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorXOffset` string — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.
          - `anchorXOffsetMetadata` PropertyMetadata — Metadata about a property.
            - `options` string[] — An array of option strings supported by this setting.
            - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only`
          - `anchorYOffset` string — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.
- … truncated; see the full OpenAPI document linked below

## Response `200`

Successful response.

## Other responses

- `400` — Error encountered.

---

[API](https://skmtc.net/docusign/apis/docusign-esignature-rest-api.md) · [All operations](https://skmtc.net/docusign/apis/docusign-esignature-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/docusign/docusign-esignature-rest-api/versions/77f1998c313d/schema)