{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "A URI containing the user ID."
    },
    "name": {
      "type": "string",
      "description": "The name of the template."
    },
    "applied": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "documentId": {
      "type": "string",
      "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing document's ID attribute."
    },
    "templateId": {
      "type": "string",
      "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. "
    },
    "documentName": {
      "type": "string",
      "description": "The name of the document."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "templateMatch": {
      "$ref": "#/components/schemas/templateMatch"
    }
  },
  "description": "Summary of a template request.",
  "x-ms-summary": "Summary of a template request.",
  "x-ds-definition-name": "templateSummary"
}

{
  "type": "object",
  "properties": {
    "ssnTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ssn"
      },
      "description": "A list of\n[SSN tabs][ssn].\n\nAn SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without\ndashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set.\n\n\n[ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "zipTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/zip"
      },
      "description": "A list of\n[Zip tabs][zip].\n\nA Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information.  This value can be set.\n\n\n[zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "dateTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/date"
      },
      "description": "A list of\n[Date tabs][date].\n\nA Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters.\n\n**Note:** If you need to enforce a specific date format, DocuSign recommends that you use a Text tab with a validation pattern and validation message.\n\n\n[date]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "drawTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/draw"
      },
      "description": "A list of Draw Tabs.\n\nA Draw Tab allows the recipient to add a free-form drawing to the document."
    },
    "listTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/list"
      },
      "description": "An array of List tabs.\n\nA List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "noteTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/note"
      },
      "description": "A list of\n[Note tabs][note].\n\nA Note tab displays additional information to the recipient in the form of a note. This value can be set.\n\n[note]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "textTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/text"
      },
      "description": "A list of\nText tabs.\n\nA text tab enables the recipient to enter free text. This value can be set.\n\nFind descriptions of all tab types in\nthe [EnvelopeRecipientTabs Resource][ert].\n\n[ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "viewTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/view"
      },
      "description": "A list of\n[View tabs][view].\n\nA View tab is used with an Approve tab to handle supplemental documents.  This value can be set.\n\n[view]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "emailTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/email"
      },
      "description": "A list of\n[Email tabs][email].\n\nAn Email tab enables the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation. This value can be set.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n\n[email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "tabGroups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tabGroup"
      },
      "description": "An array of `tabGroup` items.\n\nTo associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array.\n"
    },
    "titleTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/title"
      },
      "description": "A list of\n[Title tabs][title].\n\nA Title tab displays the recipient's title.  This value can't be set.\n\n\n[title]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "numberTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/number"
      },
      "description": "A list of Number tabs.\n\nNumber tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\n\nTo learn more about the different forms of number tabs,\nsee [Number fields](https://raw.githubusercontent.com) in the Concepts guide.\nFor specific information about number tabs\nsee [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs).\n\n[number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "approveTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/approve"
      },
      "description": "A list of\n[Approve tabs][approve].\n\nAn Approve tab enables\nthe recipient to approve documents without\nplacing a signature or initials on the document. If the\nrecipient clicks the tab during the signing process, the\nrecipient is considered to have signed the document. No\ninformation is shown on the document of the approval, but it\nis recorded as a signature in the envelope history.\nThe value of an approve tab can't be set.\n\n[approve]:          /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "companyTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/company"
      },
      "description": "A list of\n[Company tabs][company].\n\nA Company tab displays a field for the name of the recipient's company. This value can't be set.\n\n[company]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company\n"
    },
    "declineTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/decline"
      },
      "description": "A list of\n[Decline tabs][decline].\n\nA Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set.\n\n\n[decline]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "formulaTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/formulaTab"
      },
      "description": "A list of [Formula tabs][formulaTab].\n\nThe value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set.\n\nThe `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields].\n\nIf a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide].\n\n[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html\n[paymentguide]:     https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html\n[formulaTab]:       /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "prefillTabs": {
      "$ref": "#/components/schemas/prefillTabs"
    },
    "checkboxTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/checkbox"
      },
      "description": "A list of\n[Checkbox tabs][checkbox].\n\n\nA Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set.\n\n\n[checkbox]:  /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "fullNameTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/fullName"
      },
      "description": "A list of\n[Full Name tabs][fullName].\n\nA Full Name tab displays the recipient's full name. This value can't be set.\n\n\n[fullName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "lastNameTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/lastName"
      },
      "description": "A list of\n[Last Name tabs][lastName].\n\nA Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[lastName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "notarizeTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/notarize"
      },
      "description": "A list of  [Notarize tabs][notarize].\n\nA Notarize tab alerts notary recipients that they must take action on the page. This value can be set.\n\n**Note:** Only one notarize tab can appear on a page.\n\n[notarize]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "signHereTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signHere"
      },
      "description": "A list of\n[Sign Here tabs][signHere].\n\nThis type of tab enables the recipient to sign a document. May be optional. This value can't be set.\n\n[signHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "firstNameTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/firstName"
      },
      "description": "A list of\n[First Name tabs][firstName].\n\nA First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set.\n\n\n[firstName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname\n"
    },
    "numericalTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/numerical"
      },
      "description": "A list of numerical tabs.\n\nNumerical  tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation.                                                                                                                                                                                                                                                                                                                                                                                                                                                             \n\nTo learn more about the different forms of number tabs,\nsee [Number fields](https://raw.githubusercontent.com) in the Concepts guide.\nFor specific information about numerical tabs\nsee [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs)."
    },
    "dateSignedTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/dateSigned"
      },
      "description": "A list of\n[Date Signed tabs][dateSigned].\n\n\nA Date Signed tab displays the date that the recipient signed the document. This value can't be set.\n\n[dateSigned]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "envelopeIdTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeId"
      },
      "description": "A list of\n[Envelope ID tabs][envelopeId].\n\nAn Envelope ID tab  displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set.\n\n\n[envelopeId]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid\n"
    },
    "notarySealTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/notarySeal"
      },
      "description": "A list of Notary Seal tabs.\n\nA Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/"
    },
    "radioGroupTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/radioGroup"
      },
      "description": "A list of [Radio Group tabs][radioGroup].\n\nA Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio\nbuttons associated with the group. Only one radio button can be selected in a group. This value can be set.\n\n\n[radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "initialHereTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/initialHere"
      },
      "description": "A list of\n[Initial Here tabs][initialHere].\n\nThis type of tab enables the recipient to initial the document. May be optional. This value can't be set.\n\n[initialHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "phoneNumberTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/phoneNumber"
      },
      "description": "A list of\n[Phone Number tabs][cc].\n\n\nA Phone Number tab enables a recipient to enter a phone number.\n\n**Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[cc]:  /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
    },
    "emailAddressTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/emailAddress"
      },
      "description": "A list of\n[Email Address tabs][emailAddress].\n\nAn Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set.\n\n\n[emailAddress]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "smartSectionTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/smartSection"
      },
      "description": "A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs.\n\nSmart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality.\n\n**Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account."
    },
    "commentThreadTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/commentThread"
      },
      "description": "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."
    },
    "commissionStateTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/commissionState"
      },
      "description": "A list of\n[Commission State tabs][cc].\n\n\nA 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.\n\n\n[cc]:  /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
    },
    "polyLineOverlayTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/polyLineOverlay"
      },
      "description": "This type of tab enables the recipient to strike through document text. This value can't be set.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      "
    },
    "commissionCountyTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/commissionCounty"
      },
      "description": "A list of\n[Commission County tabs][cc].\n\n\nA 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.\n\n\n[cc]:  /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
    },
    "commissionNumberTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/commissionNumber"
      },
      "description": "A list of\n[Commission Number tabs][tabref].\n\n\nA 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.\n\n\n[tabref]:  /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
    },
    "signerAttachmentTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signerAttachment"
      },
      "description": "A list of\n[Signer Attachment tabs][signerAttachment].\n\nThis type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set.\n\n\n[signerAttachment]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n"
    },
    "commissionExpirationTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/commissionExpiration"
      },
      "description": "A list of\n[Commission Expiration tabs][tabref].\n\n\nA 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.\n\n\n[tabref]:  /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/\n[notary]: /docs/notary-api/"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "templateTabs"
}

{
  "type": "object",
  "properties": {
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "purgeState": {
      "type": "string",
      "description": "Shows the current purge state for the envelope. Valid values:\n\n- `unpurged`: There has been no successful request to purge documents.\n- `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged.\n- `documents_dequeued`: The envelope documents have been taken out of the purge queue.\n- `documents_purged`: The envelope documents have been successfully purged.\n- `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged.\n- `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged.\n- `documents_and_metadata_and_redact_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged, nor has personal information been redacted.\n- `documents_and_metadata_and_redact_purged`: The envelope documents and metadata have been successfully purged, and personal information has been redacted.\n\n**Related topics**\n\n- [Purging documents (eSingature Concepts)](https://raw.githubusercontent.com)\n- [Purging documents in an envelope (blog post)](https://www.docusign.com/blog/developers/purging-documents-envelope)\n\n"
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "lockInformation": {
      "$ref": "#/components/schemas/EnvelopeLocks"
    },
    "tabUpdateResults": {
      "$ref": "#/components/schemas/EnvelopeRecipientTabs"
    },
    "bulkEnvelopeStatus": {
      "$ref": "#/components/schemas/bulkEnvelopeStatus"
    },
    "recipientUpdateResults": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientUpdateResponse"
      },
      "description": "An array of `recipientUpdateResults` objects that contain details about the recipients."
    },
    "listCustomFieldUpdateResults": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/listCustomField"
      },
      "description": ""
    },
    "textCustomFieldUpdateResults": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/textCustomField"
      },
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "templateUpdateSummary"
}

{
  "type": "object",
  "properties": {
    "bold": {
      "type": "string",
      "description": "When **true,** the information in the tab is bold."
    },
    "font": {
      "type": "string",
      "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
    },
    "name": {
      "type": "string",
      "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n\nIf the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text."
    },
    "tabId": {
      "type": "string",
      "description": "The unique identifier for the tab."
    },
    "value": {
      "type": "string",
      "description": "The value of the text tab.\n\nMaximum length: 4000 bytes."
    },
    "width": {
      "type": "string",
      "description": "The width of the tab in pixels.\nMust be an integer."
    },
    "height": {
      "type": "string",
      "description": "The height of the tab in pixels.\nMust be an integer."
    },
    "italic": {
      "type": "string",
      "description": "When **true,** the information in the tab is italic."
    },
    "locked": {
      "type": "string",
      "description": "When **true,** the signer cannot change the data of the custom tab."
    },
    "shared": {
      "type": "string",
      "description": "When **true,** this custom tab is shared."
    },
    "source": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "status": {
      "type": "string",
      "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`)."
    },
    "caption": {
      "type": "string",
      "description": ""
    },
    "formula": {
      "type": "string",
      "description": "Contains the formula\nfor calculating the value of\nthis tab.\n\nUse a tab's `tabLabel`,\nenclosed in brackets,\nto refer to it.\n\nFor example,\nyou want to present the total cost\nof two items, tax included.\n\nThe cost of each item is stored\nin number tabs labeled Item1 and Item2.\nThe tax rate is in a number tab\nlabeled TaxRate.\n\nThe formula string for this property\nwould be:\n`([Item1] + [Item2]) * (1 + [TaxRate])`\n\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nMaximum Length: 2000 characters\n\n[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html\n"
    },
    "tabType": {
      "type": "string",
      "description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
    },
    "tooltip": {
      "type": "string",
      "description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
    },
    "fontSize": {
      "type": "string",
      "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
    },
    "required": {
      "type": "string",
      "description": "When **true,** the signer is required to fill out this tab."
    },
    "tabLabel": {
      "type": "string",
      "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
    },
    "tabOrder": {
      "type": "string",
      "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs 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."
    },
    "fontColor": {
      "type": "string",
      "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
    },
    "formOrder": {
      "type": "string",
      "description": "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."
    },
    "maxLength": {
      "type": "string",
      "description": "An optional value that describes the maximum length of the property when the property is a string."
    },
    "underline": {
      "type": "string",
      "description": "When **true,** the information in the tab is underlined."
    },
    "xPosition": {
      "type": "string",
      "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
    },
    "yPosition": {
      "type": "string",
      "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
    },
    "documentId": {
      "type": "string",
      "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
    },
    "mergeField": {
      "$ref": "#/components/schemas/mergeField"
    },
    "pageNumber": {
      "type": "string",
      "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`."
    },
    "requireAll": {
      "type": "string",
      "description": "When **true** and shared is true, information must be entered in this field to complete the envelope. "
    },
    "anchorUnits": {
      "type": "string",
      "description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
    },
    "customTabId": {
      "type": "string",
      "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
    },
    "recipientId": {
      "type": "string",
      "description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
    },
    "anchorString": {
      "type": "string",
      "description": "Specifies the string to find in the document and use as the basis for tab placement."
    },
    "boldMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "fontMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "localePolicy": {
      "$ref": "#/components/schemas/localePolicyTab"
    },
    "nameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorXOffset": {
      "type": "string",
      "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
    },
    "anchorYOffset": {
      "type": "string",
      "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
    },
    "formPageLabel": {
      "type": "string",
      "description": "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."
    },
    "mergeFieldXml": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "originalValue": {
      "type": "string",
      "description": "The initial value of the tab. "
    },
    "tabIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "valueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "widthMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "formPageNumber": {
      "type": "string",
      "description": "An integer specifying the order in which to present the guided form pages."
    },
    "heightMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "italicMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "lockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "senderRequired": {
      "type": "string",
      "description": "When **true,** the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope."
    },
    "sharedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "statusMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabGroupLabels": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
    },
    "templateLocked": {
      "type": "string",
      "description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
    },
    "captionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "disableAutoSize": {
      "type": "string",
      "description": "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."
    },
    "formulaMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientIdGuid": {
      "type": "string",
      "description": "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."
    },
    "tabTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "toolTipMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "fontSizeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requiredMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabLabelMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "templateRequired": {
      "type": "string",
      "description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
    },
    "fontColorMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "formOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "maxLengthMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "shareToRecipients": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "underlineMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "validationMessage": {
      "type": "string",
      "description": "The message displayed if the custom tab fails input validation (either custom of embedded)."
    },
    "validationPattern": {
      "type": "string",
      "description": "A regular expression used to validate input for the tab."
    },
    "xPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "yPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "documentIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "pageNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requireAllMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorCaseSensitive": {
      "type": "string",
      "description": "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.**\n\nFor 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.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n  $~><|^+=\n\n  For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n  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.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- 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.\n\n  Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n  Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
    },
    "anchorUnitsMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "customTabIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorMatchWholeWord": {
      "type": "string",
      "description": "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.**\n\nFor 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.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n  $~><|^+=\n\n  For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n  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.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- 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.\n\n  Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n  Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
    },
    "anchorStringMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorXOffsetMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorYOffsetMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "formPageLabelMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "originalValueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "concealValueOnDocument": {
      "type": "string",
      "description": "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.\n\nWhen 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.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes."
    },
    "conditionalParentLabel": {
      "type": "string",
      "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
    },
    "conditionalParentValue": {
      "type": "string",
      "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n"
    },
    "formPageNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "senderRequiredMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabGroupLabelsMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "templateLockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "disableAutoSizeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientIdGuidMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorIgnoreIfNotPresent": {
      "type": "string",
      "description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
    },
    "smartContractInformation": {
      "$ref": "#/components/schemas/smartContractInformation"
    },
    "templateRequiredMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorHorizontalAlignment": {
      "type": "string",
      "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `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.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
    },
    "anchorTabProcessorVersion": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "shareToRecipientsMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "validationMessageMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "validationPatternMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorCaseSensitiveMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorMatchWholeWordMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requireInitialOnSharedChange": {
      "type": "string",
      "description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field."
    },
    "concealValueOnDocumentMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "conditionalParentLabelMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "conditionalParentValueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorIgnoreIfNotPresentMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorAllowWhiteSpaceInCharacters": {
      "type": "string",
      "description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, 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.\n\nSecond, 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.\n\nThe default value is **true.**\n"
    },
    "anchorHorizontalAlignmentMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorTabProcessorVersionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requireInitialOnSharedChangeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorAllowWhiteSpaceInCharactersMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "A tab that allows the recipient to enter any type of text.\n",
  "x-ms-summary": "A tab that allows the recipient to enter any type of text.\n",
  "x-ds-definition-name": "text"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the custom field."
    },
    "show": {
      "type": "string",
      "description": "When **true,** the field displays in the **Envelope Custom Fields** section when a user creates or sends an envelope."
    },
    "value": {
      "type": "string",
      "description": "The value of the custom field. The user who creates or sends the envelope provides this value. Maximum length: 100 characters."
    },
    "fieldId": {
      "type": "string",
      "description": "The ID of the custom field."
    },
    "required": {
      "type": "string",
      "description": "When **true,** senders are required to enter or select information for the field before they can send the envelope."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "configurationType": {
      "type": "string",
      "description": "If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`."
    }
  },
  "description": "This object represents a free text custom field where envelope creators and senders can enter custom data.",
  "x-ms-summary": "This object represents a free text custom field where envelope creators and senders can enter custom data.",
  "x-ds-definition-name": "textCustomField"
}

{
  "type": "object",
  "properties": {
    "bold": {
      "type": "string",
      "description": "When **true,** the information in the tab is bold."
    },
    "font": {
      "type": "string",
      "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
    },
    "name": {
      "type": "string",
      "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n\nIf the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text."
    },
    "tabId": {
      "type": "string",
      "description": "The unique identifier for the tab."
    },
    "value": {
      "type": "string",
      "description": "Specifies the value of the tab. "
    },
    "width": {
      "type": "string",
      "description": "The width of the tab in pixels.\nMust be an integer."
    },
    "height": {
      "type": "string",
      "description": "The height of the tab in pixels.\nMust be an integer."
    },
    "italic": {
      "type": "string",
      "description": "When **true,** the information in the tab is italic."
    },
    "locked": {
      "type": "string",
      "description": "When **true,** the signer cannot change the data of the custom tab."
    },
    "source": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "status": {
      "type": "string",
      "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).\n"
    },
    "caption": {
      "type": "string",
      "description": ""
    },
    "tabType": {
      "type": "string",
      "description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
    },
    "tooltip": {
      "type": "string",
      "description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
    },
    "fontSize": {
      "type": "string",
      "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
    },
    "required": {
      "type": "string",
      "description": "When **true,** the signer is required to fill out this tab."
    },
    "tabLabel": {
      "type": "string",
      "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
    },
    "tabOrder": {
      "type": "string",
      "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs 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."
    },
    "fontColor": {
      "type": "string",
      "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
    },
    "formOrder": {
      "type": "string",
      "description": "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."
    },
    "maxLength": {
      "type": "string",
      "description": "An optional value that describes the maximum length of the property when the property is a string."
    },
    "underline": {
      "type": "string",
      "description": "When **true,** the information in the tab is underlined."
    },
    "xPosition": {
      "type": "string",
      "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
    },
    "yPosition": {
      "type": "string",
      "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
    },
    "documentId": {
      "type": "string",
      "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
    },
    "mergeField": {
      "$ref": "#/components/schemas/mergeField"
    },
    "pageNumber": {
      "type": "string",
      "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`."
    },
    "anchorUnits": {
      "type": "string",
      "description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
    },
    "customTabId": {
      "type": "string",
      "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
    },
    "recipientId": {
      "type": "string",
      "description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
    },
    "anchorString": {
      "type": "string",
      "description": "Specifies the string to find in the document and use as the basis for tab placement."
    },
    "boldMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "fontMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "localePolicy": {
      "$ref": "#/components/schemas/localePolicyTab"
    },
    "nameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorXOffset": {
      "type": "string",
      "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
    },
    "anchorYOffset": {
      "type": "string",
      "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
    },
    "formPageLabel": {
      "type": "string",
      "description": "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."
    },
    "mergeFieldXml": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "originalValue": {
      "type": "string",
      "description": "The initial value of the tab. "
    },
    "tabIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "valueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "widthMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "formPageNumber": {
      "type": "string",
      "description": "An integer specifying the order in which to present the guided form pages."
    },
    "heightMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "italicMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "lockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "statusMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabGroupLabels": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
    },
    "templateLocked": {
      "type": "string",
      "description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
    },
    "captionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "disableAutoSize": {
      "type": "string",
      "description": "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."
    },
    "recipientIdGuid": {
      "type": "string",
      "description": "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."
    },
    "tabTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "toolTipMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "fontSizeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requiredMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabLabelMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "templateRequired": {
      "type": "string",
      "description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
    },
    "fontColorMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "formOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "maxLengthMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "underlineMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "xPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "yPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "documentIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "pageNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorCaseSensitive": {
      "type": "string",
      "description": "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.**\n\nFor 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.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n  $~><|^+=\n\n  For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n  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.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- 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.\n\n  Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n  Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
    },
    "anchorUnitsMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "customTabIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorMatchWholeWord": {
      "type": "string",
      "description": "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.**\n\nFor 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.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n  $~><|^+=\n\n  For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n  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.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- 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.\n\n  Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n  Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
    },
    "anchorStringMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorXOffsetMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorYOffsetMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "formPageLabelMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "originalValueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "concealValueOnDocument": {
      "type": "string",
      "description": "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.\n\nWhen 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.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes."
    },
    "conditionalParentLabel": {
      "type": "string",
      "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
    },
    "conditionalParentValue": {
      "type": "string",
      "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n"
    },
    "formPageNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabGroupLabelsMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "templateLockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "disableAutoSizeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientIdGuidMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorIgnoreIfNotPresent": {
      "type": "string",
      "description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
    },
    "smartContractInformation": {
      "$ref": "#/components/schemas/smartContractInformation"
    },
    "templateRequiredMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorHorizontalAlignment": {
      "type": "string",
      "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `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.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
    },
    "anchorTabProcessorVersion": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "anchorCaseSensitiveMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorMatchWholeWordMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "concealValueOnDocumentMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "conditionalParentLabelMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "conditionalParentValueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorIgnoreIfNotPresentMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorAllowWhiteSpaceInCharacters": {
      "type": "string",
      "description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, 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.\n\nSecond, 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.\n\nThe default value is **true.**\n"
    },
    "anchorHorizontalAlignmentMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorTabProcessorVersionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorAllowWhiteSpaceInCharactersMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "A tab that displays the recipient's title.\n",
  "x-ms-summary": "A tab that displays the recipient's title.\n",
  "x-ds-definition-name": "title"
}

{
  "type": "object",
  "properties": {
    "sentCount": {
      "type": "string",
      "description": "The number of envelopes the user has sent. "
    },
    "signedCount": {
      "type": "string",
      "description": "The number of envelopes the user has signed. "
    },
    "lastSentDateTime": {
      "type": "string",
      "description": "The date and time the user last sent an envelope. "
    },
    "lastSignedDateTime": {
      "type": "string",
      "description": "The date and time the user last signed an envelope."
    }
  },
  "description": "A complex element consisting of: \n\n* lastSentDateTime - the date and time the user last sent an envelope. \n* lastSignedDateTime - the date and time the user last signed an envelope.\n* sentCount - the number of envelopes the user has sent.\n* signedCount - the number of envelopes the user has signed.",
  "x-ms-summary": "A complex element consisting of: \n\n* lastSentDateTime - the date and time the user last sent an envelope. \n* lastSignedDateTime - the date and time the user last signed an envelope.\n* sentCount - the number of envelopes the user has sent.\n* signedCount - the number of envelopes the user has signed.",
  "x-ds-definition-name": "usageHistory"
}

{
  "type": "object",
  "properties": {
    "canViewUsers": {
      "type": "string",
      "description": ""
    },
    "canManageUsers": {
      "type": "string",
      "description": "**True** if the user can manage users."
    },
    "canManageAdmins": {
      "type": "string",
      "description": "**True** if the user can manage administrators."
    },
    "canManageStamps": {
      "type": "string",
      "description": ""
    },
    "canManageConnect": {
      "type": "string",
      "description": ""
    },
    "canManageSharing": {
      "type": "string",
      "description": "**True** if the user can manage sharing."
    },
    "canManageReporting": {
      "type": "string",
      "description": "**True** if the user can manage reporting."
    },
    "canManageSigningGroups": {
      "type": "string",
      "description": "**True** if the user can manage signing groups."
    },
    "canManageUsersMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageAdminsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageStampsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageAccountSettings": {
      "type": "string",
      "description": "**True** if the user can manage account settings."
    },
    "canManageConnectMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageJointAgreements": {
      "type": "string",
      "description": ""
    },
    "canManageSharingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageEnvelopeTransfer": {
      "type": "string",
      "description": ""
    },
    "canManageDocumentRetention": {
      "type": "string",
      "description": ""
    },
    "canManageGroupsButNotUsers": {
      "type": "string",
      "description": ""
    },
    "canManageReportingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageSigningGroupsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageAccountSecuritySettings": {
      "type": "string",
      "description": "**True** if the user can manage account security settings."
    },
    "canManageAccountSettingsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageJointAgreementsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageEnvelopeTransferMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageDocumentRetentionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageGroupsButNotUsersMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageAccountSecuritySettingsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "description": "Describes which account management capabilities a user has.",
  "x-ms-summary": "Describes which account management capabilities a user has.",
  "x-ds-definition-name": "userAccountManagementGranularInformation"
}

{
  "type": "object",
  "properties": {
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the workspace user authorization was created."
    },
    "endDate": {
      "type": "string",
      "description": "The UTC DateTime at which the authorization will expire."
    },
    "modified": {
      "type": "string",
      "description": "The UTC DateTime when the workspace user authorization was last updated."
    },
    "agentUser": {
      "$ref": "#/components/schemas/authorizationUser"
    },
    "createdBy": {
      "type": "string",
      "description": "The name and email of the user who created the authorization, in the following format: `[Francis Beagle email@example.com]`"
    },
    "startDate": {
      "type": "string",
      "description": "The UTC DateTime at which the authorization will start."
    },
    "modifiedBy": {
      "type": "string",
      "description": "The name and email of the user who created the authorization, in the following format: `[Francis Beagle email@example.com]`"
    },
    "permission": {
      "type": "string",
      "description": "The [permission level](https://raw.githubusercontent.com) to grant the agent. Valid values:\n* `Send`\n* `Manage`\n* `Sign`\n* `Edit`\n\nThis property is required."
    },
    "principalUser": {
      "$ref": "#/components/schemas/authorizationUser"
    },
    "authorizationId": {
      "type": "string",
      "description": "The ID of the user authorization."
    }
  },
  "description": "A complex object describing a user authorization.",
  "x-ms-summary": "A complex object describing a user authorization.",
  "x-ds-definition-name": "userAuthorization"
}

{
  "type": "object",
  "properties": {
    "endDate": {
      "type": "string",
      "description": "The UTC DateTime to end the authorization. The default value is the max UTC value (`9999-12-31T23:59:59.0000000+00:00`)."
    },
    "agentUser": {
      "$ref": "#/components/schemas/authorizationUser"
    },
    "startDate": {
      "type": "string",
      "description": "The UTC DateTime to initiate the authorization. The default value is the current date and time."
    },
    "permission": {
      "type": "string",
      "description": "The permission level to grant the agent. Valid values:\n* `Send`\n* `Manage`\n* `Sign`\n\nThis property is required."
    }
  },
  "description": "The request object to create a user authorization.",
  "x-ms-summary": "The request object to create a user authorization.",
  "x-ds-definition-name": "userAuthorizationCreateRequest"
}

{
  "type": "object",
  "properties": {
    "endDate": {
      "type": "string",
      "description": "The UTC DateTime to end the authorization. The default value is the max UTC value: `9999-12-31T23:59:59.0000000+00:00`."
    },
    "agentUser": {
      "$ref": "#/components/schemas/authorizationUser"
    },
    "startDate": {
      "type": "string",
      "description": "The UTC DateTime to initiate the authorization. The default value is the current date and time."
    },
    "permission": {
      "type": "string",
      "description": "The permission level to grant the agent. Valid values:\n\n- `Send`\n- `Manage`\n- `Sign`\n\nThis property is required if you are creating a new authorization."
    },
    "authorizationId": {
      "type": "string",
      "description": "The ID of the user authorization. This property is required to update an existing authorization."
    }
  },
  "description": "A user authorizations to create or update.",
  "x-ms-summary": "A user authorizations to create or update.",
  "x-ds-definition-name": "userAuthorizationCreateRequestWithId"
}

{
  "type": "object",
  "properties": {
    "success": {
      "type": "string",
      "description": ""
    },
    "errorMessage": {
      "type": "string",
      "description": ""
    },
    "authorizationId": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "userAuthorizationIdWithStatus"
}

{
  "type": "object",
  "properties": {
    "endDate": {
      "type": "string",
      "description": "The end date for the user authorization. The default value is the max UTC value: `9999-12-31T23:59:59.0000000+00:00`."
    },
    "startDate": {
      "type": "string",
      "description": "The start date for the user authorization. The default value is the current date and time."
    }
  },
  "description": "The request object to update a user authorization.",
  "x-ms-summary": "The request object to update a user authorization.",
  "x-ds-definition-name": "userAuthorizationUpdateRequest"
}

{
  "type": "object",
  "properties": {
    "success": {
      "type": "string",
      "description": ""
    },
    "errorMessage": {
      "type": "string",
      "description": ""
    },
    "authorization": {
      "$ref": "#/components/schemas/userAuthorization"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "userAuthorizationWithStatus"
}

{
  "type": "object",
  "properties": {
    "nextUri": {
      "type": "string",
      "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
    },
    "endPosition": {
      "type": "string",
      "description": "The last index position in the result set. "
    },
    "previousUri": {
      "type": "string",
      "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
    },
    "totalSetSize": {
      "type": "string",
      "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
    },
    "resultSetSize": {
      "type": "string",
      "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
    },
    "startPosition": {
      "type": "string",
      "description": "The starting index position of the current result set."
    },
    "authorizations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userAuthorization"
      },
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "userAuthorizations"
}

{
  "type": "object",
  "properties": {
    "authorizations": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "userAuthorizationsDeleteRequest"
}

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userAuthorizationIdWithStatus"
      },
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "userAuthorizationsDeleteResponse"
}

{
  "type": "object",
  "properties": {
    "authorizations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userAuthorizationCreateRequestWithId"
      },
      "description": "The list of user authorizations to create and/or update."
    }
  },
  "description": "An object that describes the user authorizations to create or update.\n",
  "x-ms-summary": "An object that describes the user authorizations to create or update.\n",
  "x-ds-definition-name": "userAuthorizationsRequest"
}

{
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userAuthorizationWithStatus"
      },
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "userAuthorizationsResponse"
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "A URI containing the user ID."
    },
    "email": {
      "type": "string",
      "description": "The user's email address."
    },
    "userId": {
      "type": "string",
      "description": "The ID of the user to access."
    },
    "userName": {
      "type": "string",
      "description": "The name of the user."
    },
    "userType": {
      "type": "string",
      "description": "The type of user, for example `CompanyUser`."
    },
    "accountId": {
      "type": "string",
      "description": "The account ID associated with the envelope."
    },
    "ipAddress": {
      "type": "string",
      "description": ""
    },
    "userStatus": {
      "type": "string",
      "description": "Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`\n"
    },
    "accountName": {
      "type": "string",
      "description": "The name on the account."
    },
    "loginStatus": {
      "type": "string",
      "description": "When **true,** indicates that the user is logged in. This is a read-only property."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "membershipId": {
      "type": "string",
      "description": "The user's membership ID."
    },
    "sendActivationEmail": {
      "type": "string",
      "description": "This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](https://raw.githubusercontent.com)."
    },
    "activationAccessCode": {
      "type": "string",
      "description": "Access code provided to the user to activate the account."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "userInfo"
}

{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userInfo"
      },
      "description": "An array of `userInfo` objects containing information about the users in the group."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "userInfoList"
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "A URI containing the user ID."
    },
    "email": {
      "type": "string",
      "description": "The user's email address."
    },
    "title": {
      "type": "string",
      "description": "The title of the user."
    },
    "userId": {
      "type": "string",
      "description": "The ID of the user to access.\n\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings."
    },
    "company": {
      "type": "string",
      "description": "The name of the user's company."
    },
    "isAdmin": {
      "type": "string",
      "description": "Determines if the feature set is actively set as part of the plan."
    },
    "jobTitle": {
      "type": "string",
      "description": "The user's job title."
    },
    "lastName": {
      "type": "string",
      "description": "The user's last name. \nMaximum Length: 50 characters."
    },
    "password": {
      "type": "string",
      "description": "The user's encrypted password hash."
    },
    "userName": {
      "type": "string",
      "description": "The name of the user."
    },
    "userType": {
      "type": "string",
      "description": "The type of user, for example `CompanyUser`."
    },
    "firstName": {
      "type": "string",
      "description": "The user's first name. \nMaximum Length: 50 characters."
    },
    "groupList": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/group"
      },
      "description": "A list of the group information for groups to add the user to.\nUse [UserGroups: listGroups](https://raw.githubusercontent.com) to get information about groups.\n\nWhen setting a user's group, only the `groupId` is required.\n"
    },
    "lastLogin": {
      "type": "string",
      "description": "The date and time when the user last logged in to the system."
    },
    "subscribe": {
      "type": "string",
      "description": ""
    },
    "middleName": {
      "type": "string",
      "description": "The user's middle name. \nLimit: 50 characters."
    },
    "suffixName": {
      "type": "string",
      "description": "The suffix for the user's name, such as Jr, IV, PhD, etc.\n\nLimit: 50 characters. "
    },
    "userStatus": {
      "type": "string",
      "description": "Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`\n"
    },
    "countryCode": {
      "type": "string",
      "description": "The two-letter code for the user's country."
    },
    "homeAddress": {
      "$ref": "#/components/schemas/addressInformation"
    },
    "loginStatus": {
      "type": "string",
      "description": "Boolean value that indicates whether the user is currently logged in or not."
    },
    "workAddress": {
      "$ref": "#/components/schemas/addressInformation"
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "isNAREnabled": {
      "type": "string",
      "description": "When **true,** National Association of Realtors (NAR) signature logos are enabled for the user."
    },
    "userSettings": {
      "$ref": "#/components/schemas/userSettingsInformation"
    },
    "customSettings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "The name/value pair information for the user custom setting."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the item was created."
    },
    "hasRemoteNotary": {
      "type": "boolean",
      "description": ""
    },
    "profileImageUri": {
      "type": "string",
      "description": "The URL for retrieving the user's profile image."
    },
    "defaultAccountId": {
      "type": "string",
      "description": "The default account ID associated with the user."
    },
    "initialsImageUri": {
      "type": "string",
      "description": "The URI for retrieving the image of the user's initials."
    },
    "isAlternateAdmin": {
      "type": "string",
      "description": ""
    },
    "signatureImageUri": {
      "type": "string",
      "description": "An endpoint URI that you can use to retrieve the user's signature image."
    },
    "passwordExpiration": {
      "type": "string",
      "description": "If password expiration is enabled, the date-time when the user's password expires."
    },
    "permissionProfileId": {
      "type": "string",
      "description": "The ID of the permission profile.\n\nUse [AccountPermissionProfiles: list](https://raw.githubusercontent.com)\nto get a list of permission profiles and their IDs.\n\nYou can also download a CSV file of all permission profiles\nand their IDs from the **Settings > Permission Profiles** page\nof your eSignature account page.\n"
    },
    "sendActivationEmail": {
      "type": "string",
      "description": "This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](https://raw.githubusercontent.com)."
    },
    "activationAccessCode": {
      "type": "string",
      "description": "Access code provided to the user to activate the account."
    },
    "enableConnectForUser": {
      "type": "string",
      "description": "Boolean value that specifies whether the user is enabled for updates from DocuSign Connect."
    },
    "connectConfigurations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectUserObject"
      },
      "description": "Object representing the user's custom Connect configuration."
    },
    "forgottenPasswordInfo": {
      "$ref": "#/components/schemas/forgottenPasswordInformation"
    },
    "permissionProfileName": {
      "type": "string",
      "description": "The name of the account permission profile. \n\nExample: `Account Administrator`"
    },
    "userAddedToAccountDateTime": {
      "type": "string",
      "description": "The date and time that the user was added to the account."
    },
    "userProfileLastModifiedDate": {
      "type": "string",
      "description": "The date and time that the user's profile was last modified."
    },
    "sendActivationOnInvalidLogin": {
      "type": "string",
      "description": "When **true,** specifies that an additional activation email be sent if user's log on fails before the account is activated."
    }
  },
  "description": "User information.",
  "x-ms-summary": "User information.",
  "x-ds-definition-name": "userInformation"
}

{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userInformation"
      },
      "description": "User management information."
    },
    "nextUri": {
      "type": "string",
      "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
    },
    "endPosition": {
      "type": "string",
      "description": "The last index position in the result set. "
    },
    "previousUri": {
      "type": "string",
      "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
    },
    "totalSetSize": {
      "type": "string",
      "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
    },
    "resultSetSize": {
      "type": "string",
      "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
    },
    "startPosition": {
      "type": "string",
      "description": "The starting index position of the current result set."
    }
  },
  "description": "Contains a list of account users.",
  "x-ms-summary": "Contains a list of account users.",
  "x-ds-definition-name": "userInformationList"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The user's email address for the associated account."
    },
    "newPassword": {
      "type": "string",
      "description": "The user's new password."
    },
    "currentPassword": {
      "type": "string",
      "description": "The user's current password to be changed."
    },
    "forgottenPasswordInfo": {
      "$ref": "#/components/schemas/forgottenPasswordInformation"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "userPasswordInformation"
}

{
  "type": "object",
  "properties": {
    "userId": {
      "type": "string",
      "description": "The ID of the user to access.\n\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings."
    },
    "passwordRules": {
      "$ref": "#/components/schemas/accountPasswordRules"
    }
  },
  "description": "Contains details about the password rules for a user.",
  "x-ms-summary": "Contains details about the password rules for a user.",
  "x-ds-definition-name": "userPasswordRules"
}

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "The title of the user."
    },
    "address": {
      "$ref": "#/components/schemas/addressInformation"
    },
    "companyName": {
      "type": "string",
      "description": "The name of the user's company."
    },
    "userDetails": {
      "$ref": "#/components/schemas/userInformation"
    },
    "usageHistory": {
      "$ref": "#/components/schemas/usageHistory"
    },
    "displayProfile": {
      "type": "string",
      "description": "When **true,** the user's ID card can be viewed from signed documents and envelope history."
    },
    "profileImageUri": {
      "type": "string",
      "description": "The URL for retrieving the user's profile image."
    },
    "displayPersonalInfo": {
      "type": "string",
      "description": "When **true,** the user's address and phone number display on the ID card."
    },
    "displayUsageHistory": {
      "type": "string",
      "description": "When **true,** the user's usage information displays on the ID card."
    },
    "authenticationMethods": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/authenticationMethod"
      },
      "description": "Indicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation. "
    },
    "displayOrganizationInfo": {
      "type": "string",
      "description": " When **true,** the user's company and title information display on the ID card. "
    },
    "userProfileLastModifiedDate": {
      "type": "string",
      "description": "The date and time that the user's profile was last modified."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "userProfile"
}

{
  "type": "object",
  "properties": {
    "locale": {
      "type": "string",
      "description": "The user's locale code. Valid values are:\n- `zh_CN`\n- `zh_TW`\n- `nl`\n- `en`\n- `fr`\n- `de`\n- `it`\n- `ja`\n- `ko`\n- `pt`\n- `pt_BR`\n- `ru`\n- `es`"
    },
    "bulkSend": {
      "type": "string",
      "description": "When **true,** this user can use the bulk send feature for the account."
    },
    "webForms": {
      "type": "string",
      "description": ""
    },
    "adminOnly": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "newSendUI": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "modifiedBy": {
      "type": "string",
      "description": "The user ID (GUID) of the user who last modified this user record. This property is read-only."
    },
    "enableDSPro": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "timezoneDST": {
      "type": "string",
      "description": "When true, daylight savings time is in effect for this user's time zone."
    },
    "localePolicy": {
      "$ref": "#/components/schemas/localePolicy"
    },
    "modifiedDate": {
      "type": "string",
      "description": "The date on which this user record was last modified."
    },
    "modifiedPage": {
      "type": "string",
      "description": "Note referencing the page that modified this user record."
    },
    "timezoneMask": {
      "type": "string",
      "description": "The custom DateTime format setting for this user."
    },
    "vaultingMode": {
      "type": "string",
      "description": "Indicates the specified Vaulting mode:\n- `none`\n- `estored`\n- `electronic_original`"
    },
    "powerFormMode": {
      "type": "string",
      "description": "Indicates the Power Form mode setting for the user:\n- `none`\n- `admin`\n- `user`"
    },
    "apiCanExportAC": {
      "type": "string",
      "description": "When **true,** this user can export authoritative copy for the account."
    },
    "enableVaulting": {
      "type": "string",
      "description": "When **true,** Vaulting is enabled for the account."
    },
    "localeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "timezoneOffset": {
      "type": "string",
      "description": "The timezone offset for the user. Valid values:\n- `tz_01_afghanistan`\n- `tz_02_alaskan`\n- `tz_03_arab`\n- `tz_04_arabian`\n- `tz_05_arabic`\n- `tz_06_argentina`\n- `tz_07_atlantic`\n- `tz_08_aus_central`\n- `tz_09_aus_eastern`\n- `tz_10_azerbaijan`\n- `tz_11_azores`\n- `tz_12_bangladesh`\n- `tz_13_canada_central`\n- `tz_14_cape_verde`\n- `tz_15_caucasus`\n- `tz_16_central_australia`\n- `tz_17_central_america`\n- `tz_18_central_asia`\n- `tz_19_central_brazilian`\n- `tz_20_central_europe`\n- `tz_21_central_european`\n- `tz_22_central_pacific`\n- `tz_23_central`\n- `tz_24_central_mexico`\n- `tz_25_china`\n- `tz_26_dateline`\n- `tz_27_east_africa`\n- `tz_28_east_australia`\n- `tz_29_east_europe`\n- `tz_30_east_south_america`\n- `tz_31_eastern`\n- `tz_32_egypt`\n- `tz_33_ekaterinburg`\n- `tz_34_fiji`\n- `tz_35_fli`\n- `tz_36_georgian`\n- `tz_37_gmt`\n- `tz_38_greenland`\n- `tz_39_greenwich`\n- `tz_40_gtb`\n- `tz_41_hawaiian`\n- `tz_42_india`\n- `tz_43_iran`\n- `tz_44_israel`\n- `tz_45_jordan`\n- `tz_46_kaliningrad`\n- `tz_47_kamchatka`\n- `tz_48_korea`\n- `tz_49_magadan`\n- `tz_50_mauritius`\n- `tz_51_mid_atlantic`\n- `tz_52_middle_east`\n- `tz_53_montevideo`\n- `tz_54_morocco`\n- `tz_55_mountain`\n- `tz_56_mountain_mexico`\n- `tz_57_myanmar`\n- `tz_58_north_central_asia`\n- `tz_59_namibia`\n- `tz_60_nepal`\n- `tz_61_new_zealand`\n- `tz_62_new_foundland`\n- `tz_63_north_asia_east`\n- `tz_64_north_asia`\n- `tz_65_pacific_sa`\n- `tz_66_pacific`\n- `tz_67_pacific_mexico`\n- `tz_68_pakistan`\n- `tz_69_paraguay`\n- `tz_70_romance`\n- `tz_71_russian`\n- `tz_72_sa_eastern`\n- `tz_73_sa_pacific`\n- `tz_74_sa_western`\n- `tz_75_samoa`\n- `tz_76_se_asia`\n- `tz_77_singapore`\n- `tz_78_south_africa`\n- `tz_79_sriLanka`\n- `tz_80_syria`\n- `tz_81_taipei`\n- `tz_82_tasmania`\n- `tz_83_tokyo`\n- `tz_84_tonga`\n- `tz_85_turkey`\n- `tz_86_ulaanbaatar`\n- `tz_87_us_eastern`\n- `tz_88_us_mountain`\n- `tz_89_venezuela`\n- `tz_90_vladivostok`\n- `tz_91_west_australia`\n- `tz_92_west_central_africa`\n- `tz_93_west_europe`\n- `tz_94_west_asia`\n- `tz_95_west_pacific`\n- `tz_96_yakutsk`"
    },
    "canSendEnvelope": {
      "type": "string",
      "description": "When **true,** this user can send envelopes on the account."
    },
    "canSignEnvelope": {
      "type": "string",
      "description": "When **true,** this user can sign envelopes."
    },
    "expressSendOnly": {
      "type": "string",
      "description": "When **false,** this user can apply tabs to documents during the sending experience."
    },
    "sealIdentifiers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/sealIdentifier"
      },
      "description": "Information about the seals associated with this user."
    },
    "allowAutoTagging": {
      "type": "string",
      "description": "When **true,** the API returns suggested tabs for documents for this user."
    },
    "bulkSendMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canChargeAccount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "canLockEnvelopes": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "canManageAccount": {
      "type": "string",
      "description": "When **true,** this user is an administrator for the account."
    },
    "canUseScratchpad": {
      "type": "string",
      "description": "When **true,** this user can use a scratchpad to edit information."
    },
    "webFormsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "adminOnlyMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowTransactions": {
      "type": "string",
      "description": ""
    },
    "newSendUIMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageTemplates": {
      "type": "string",
      "description": "When **true,** this user can manage templates for the account."
    },
    "canSendAPIRequests": {
      "type": "string",
      "description": "When **true,** this user can send API requests on the account."
    },
    "modifiedByMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSendOnBehalfOf": {
      "type": "string",
      "description": "When **true,** this user can send envelopes \"on behalf of\" other users through the API."
    },
    "disableOtherActions": {
      "type": "string",
      "description": "When **true,** this user can access the **Other Actions** menu."
    },
    "enableDSProMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "templateApplyNotify": {
      "type": "string",
      "description": "When **true,** the system notifies this user before applying a matching template."
    },
    "timezoneDSTMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "timezoneSendingPref": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "timezoneSigningPref": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "allowEsealRecipients": {
      "type": "string",
      "description": "When **true,** this user can create [electronic seal recipients][eseal].\n\n[eseal]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient"
    },
    "apiAccountWideAccess": {
      "type": "string",
      "description": "When **true,** indicates that this user can send envelope-specific API requests on the account."
    },
    "canCreateTransaction": {
      "type": "string",
      "description": ""
    },
    "canDeleteTransaction": {
      "type": "string",
      "description": ""
    },
    "canManageDistributor": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "canUseSmartContracts": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "manageClickwrapsMode": {
      "type": "string",
      "description": "When **true,** this user can create and manage [Clickwraps](https://raw.githubusercontent.com)."
    },
    "modifiedDateMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "modifiedPageMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "templateAutoMatching": {
      "type": "string",
      "description": "When **true,** the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from."
    },
    "timezoneMaskMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "vaultingModeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableDocumentUpload": {
      "type": "string",
      "description": "When **true,** this user is prohibited from uploading documents during sending."
    },
    "powerFormModeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "apiCanExportACMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canSendEnvelopesViaSMS": {
      "type": "string",
      "description": ""
    },
    "enableTransactionPoint": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "enableVaultingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "templateActiveCreation": {
      "type": "string",
      "description": "When **true,** a new template is created each time the user sends an envelope."
    },
    "timezoneOffsetMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowEnvelopeTransferTo": {
      "type": "string",
      "description": "When **true,** this user can participate in envelope transfers on the account."
    },
    "canSendEnvelopeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canSignEnvelopeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSignerAttachments": {
      "type": "string",
      "description": "When **true,** this user can use the signing attachments feature."
    },
    "canChargeAccountMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canEditSharedAddressbook": {
      "type": "string",
      "description": "When true, this user can edit the shared address book for the account."
    },
    "canLockEnvelopesMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageAccountMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canUseScratchpadMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "senderEmailNotifications": {
      "$ref": "#/components/schemas/senderEmailNotifications"
    },
    "signerEmailNotifications": {
      "$ref": "#/components/schemas/signerEmailNotifications"
    },
    "transactionPointUserName": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "accountManagementGranular": {
      "$ref": "#/components/schemas/userAccountManagementGranularInformation"
    },
    "allowTransactionsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSequentialSigningUI": {
      "type": "string",
      "description": "When **true,** the account can define the routing order\nof recipients for envelopes sent by using the DocuSign application.\n\n**Note:** Only SysAdmin users can change this setting.\n"
    },
    "enableSignOnPaperOverride": {
      "type": "string",
      "description": "When **true,** a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically.\n\n**Note:** Only Admin users can change this setting."
    },
    "templatePageLevelMatching": {
      "type": "string",
      "description": "When **true,** users see template matching functionality."
    },
    "allowSupplementalDocuments": {
      "type": "string",
      "description": "When **true,** this user can include supplemental documents."
    },
    "allowedOrchestrationAccess": {
      "type": "string",
      "description": ""
    },
    "canManageTemplatesMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canSendAPIRequestsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSequentialSigningAPI": {
      "type": "string",
      "description": "When **true,** the account can define the routing\norder of recipients for envelopes sent by using the eSignature API.\n\n**Note:** Only SysAdmin users can change this setting."
    },
    "allowSendOnBehalfOfMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableOtherActionsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "recipientViewedNotification": {
      "type": "string",
      "description": "When **true,** this user receives notifications when envelopes are viewed."
    },
    "templateApplyNotifyMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "templateMatchingSensitivity": {
      "type": "string",
      "description": "Percentage used when matching templates."
    },
    "timezoneSendingPrefMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "timezoneSigningPrefMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "transactionPointSiteNameURL": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "allowEsealRecipientsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "apiAccountWideAccessMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canCreateTransactionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canDeleteTransactionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canManageDistributorMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canUseSmartContractsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "manageClickwrapsModeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "templateAutoMatchingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableDocumentUploadMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "supplementalDocumentsMustRead": {
      "type": "string",
      "description": "When **true,** this user must both view and accept supplemental documents."
    },
    "supplementalDocumentsMustView": {
      "type": "string",
      "description": "When **true,** this user must view supplemental documents."
    },
    "canSendEnvelopesViaSMSMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableTransactionPointMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "templateActiveCreationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowEnvelopeTransferToMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowRecipientLanguageSelection": {
      "type": "string",
      "description": "When **true,** this user can set the language used in the standard email format for a recipient when creating an envelope."
    },
    "canDeleteDocumentsInTransaction": {
      "type": "string",
      "description": ""
    },
    "enableSignerAttachmentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "supplementalDocumentsMustAccept": {
      "type": "string",
      "description": "When **true,** this user must accept supplemental documents."
    },
    "canEditSharedAddressbookMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "selfSignedRecipientEmailDocument": {
      "type": "string",
      "description": "Sets how self-signed documents are presented to the email recipients.\nValid values are:\n\n- `include_pdf`: A PDF of the completed document is attached to the email.\n- `include_link`: A secure link to the self-signed documents is included\n   in the email.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "transactionPointUserNameMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSequentialSigningUIMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSignOnPaperOverrideMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "templatePageLevelMatchingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSupplementalDocumentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowedOrchestrationAccessMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "anchorTagVersionedPlacementEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign.\n"
    },
    "enableSequentialSigningAPIMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "recipientViewedNotificationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "templateMatchingSensitivityMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "transactionPointSiteNameURLMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "supplementalDocumentIncludeInDownload": {
      "type": "string",
      "description": "When **true,** this user gets supplemental documents when downloading documents."
    },
    "supplementalDocumentsMustReadMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "supplementalDocumentsMustViewMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowRecipientLanguageSelectionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canDeleteDocumentsInTransactionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableKeyTermsSuggestionsByDocumentType": {
      "type": "string",
      "description": ""
    },
    "supplementalDocumentsMustAcceptMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "selfSignedRecipientEmailDocumentMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableKeyTermsSuggestionsByDocumentTypeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowPowerFormsAdminToAccessAllPowerFormEnvelope": {
      "type": "string",
      "description": "When **true** and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is **false.**"
    },
    "allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "description": "Properties that configure the settings for a user. Some elements of this object have a `metadata` property, which includes the following:\n- `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`)\n- `uiHint`: Internally used to build UIs (can be `available` or `hidden`)\n- `options`: The values supported for this setting (not all settings have this element)",
  "x-ms-summary": "Properties that configure the settings for a user. Some elements of this object have a `metadata` property, which includes the following:\n- `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`)\n- `uiHint`: Internally used to build UIs (can be `available` or `hidden`)\n- `options`: The values supported for this setting (not all settings have this element)",
  "x-ds-definition-name": "userSettingsInformation"
}

{
  "type": "object",
  "properties": {
    "user": {
      "$ref": "#/components/schemas/userInfo"
    },
    "shared": {
      "type": "string",
      "description": "How the item is shared. One of:\n\n- `not_shared`\n- `shared_to`\n- `shared_from`\n- `shared_to_and_from`\n"
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    }
  },
  "description": "Information about a shared item.",
  "x-ms-summary": "Information about a shared item.",
  "x-ds-definition-name": "userSharedItem"
}

{
  "type": "object",
  "properties": {
    "nrdsId": {
      "type": "string",
      "description": "The National Association of Realtors (NAR) membership ID for a user who is a realtor."
    },
    "status": {
      "type": "string",
      "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."
    },
    "imageType": {
      "type": "string",
      "description": "Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`"
    },
    "isDefault": {
      "type": "string",
      "description": "Boolean that specifies whether the signature is the default signature for the user."
    },
    "stampType": {
      "type": "string",
      "description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null"
    },
    "externalID": {
      "type": "string",
      "description": "Optionally specify an external identifier for the user's signature."
    },
    "nrdsStatus": {
      "type": "string",
      "description": "The realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are:\n\n- `Active`\n- `Inactive`\n- `Terminate`\n- `Provisional`\n- `Deceased`\n- `Suspend`\n- `Unknown`"
    },
    "customField": {
      "type": "string",
      "description": ""
    },
    "imageBase64": {
      "type": "string",
      "description": "A Base64-encoded representation of the signature image."
    },
    "signatureId": {
      "type": "string",
      "description": "Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID."
    },
    "stampFormat": {
      "type": "string",
      "description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. "
    },
    "stampSizeMM": {
      "type": "string",
      "description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "nrdsLastName": {
      "type": "string",
      "description": "The realtor's last name."
    },
    "phoneticName": {
      "type": "string",
      "description": "The phonetic spelling of the `signatureName`."
    },
    "signatureFont": {
      "type": "string",
      "description": "The font type for the signature, if the signature is not drawn. The supported font types are:\n\n\"7_DocuSign\", \"1_DocuSign\", \"6_DocuSign\", \"8_DocuSign\", \"3_DocuSign\", \"Mistral\", \"4_DocuSign\", \"2_DocuSign\", \"5_DocuSign\", \"Rage Italic\"\n"
    },
    "signatureName": {
      "type": "string",
      "description": "Specifies the user's signature name."
    },
    "signatureType": {
      "type": "string",
      "description": "Specifies the type of signature."
    },
    "stampImageUri": {
      "type": "string",
      "description": "The URI for retrieving the image of the user's stamp."
    },
    "adoptedDateTime": {
      "type": "string",
      "description": "The date and time the user adopted their signature."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the item was created."
    },
    "signatureRights": {
      "type": "string",
      "description": "The rights that the user has to the signature. Valid values are:\n\n- `none`\n- `read`\n- `admin`"
    },
    "initialsImageUri": {
      "type": "string",
      "description": "The URI for retrieving the image of the user's initials."
    },
    "signatureImageUri": {
      "type": "string",
      "description": "An endpoint URI that you can use to retrieve the user's signature image."
    },
    "signatureInitials": {
      "type": "string",
      "description": " The initials associated with the signature."
    },
    "initials150ImageId": {
      "type": "string",
      "description": "The ID of the user's initials image."
    },
    "dateStampProperties": {
      "$ref": "#/components/schemas/dateStampProperties"
    },
    "signature150ImageId": {
      "type": "string",
      "description": "The ID of the user's signature image."
    },
    "lastModifiedDateTime": {
      "type": "string",
      "description": "The date and time that the item was last modified."
    },
    "disallowUserResizeStamp": {
      "type": "string",
      "description": "When **true,** users may not resize the stamp."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "userSignature"
}

{
  "type": "object",
  "properties": {
    "nrdsId": {
      "type": "string",
      "description": "The National Association of Realtors (NAR) membership ID for a user who is a realtor."
    },
    "imageType": {
      "type": "string",
      "description": "Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`"
    },
    "isDefault": {
      "type": "string",
      "description": "Boolean that specifies whether the signature is the default signature for the user."
    },
    "externalID": {
      "type": "string",
      "description": "Optionally specify an external identifier for the user's signature."
    },
    "signatureId": {
      "type": "string",
      "description": "Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID."
    },
    "stampFormat": {
      "type": "string",
      "description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. "
    },
    "stampSizeMM": {
      "type": "string",
      "description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents."
    },
    "nrdsLastName": {
      "type": "string",
      "description": "The realtor's last name."
    },
    "phoneticName": {
      "type": "string",
      "description": "The phonetic spelling of the `signatureName`."
    },
    "signatureFont": {
      "type": "string",
      "description": "The font type to use for the signature if the signature is not drawn. The following font styles  are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`\n"
    },
    "signatureName": {
      "type": "string",
      "description": "Specifies the user's signature name."
    },
    "signatureType": {
      "type": "string",
      "description": "Specifies the type of signature."
    },
    "signatureInitials": {
      "type": "string",
      "description": "Specifies the user's signature in initials format."
    },
    "dateStampProperties": {
      "$ref": "#/components/schemas/dateStampProperties"
    },
    "disallowUserResizeStamp": {
      "type": "string",
      "description": "When **true,** users may not resize the stamp."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "userSignatureDefinition"
}

{
  "type": "object",
  "properties": {
    "userSignatures": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userSignature"
      },
      "description": "An array of  `userSignature` objects."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "userSignaturesInformation"
}

{
  "type": "object",
  "properties": {
    "userId": {
      "type": "string",
      "description": "The ID of the user to access.\n\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings."
    },
    "socialAccountInformation": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/socialAccountInformation"
      },
      "description": "Contains properties that map a DocuSign user to a social account such as Facebook or Yahoo."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "userSocialIdResult"
}

{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userInfo"
      },
      "description": "User management information."
    },
    "nextUri": {
      "type": "string",
      "description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
    },
    "endPosition": {
      "type": "string",
      "description": "The last index position in the result set. "
    },
    "previousUri": {
      "type": "string",
      "description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
    },
    "totalSetSize": {
      "type": "string",
      "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
    },
    "resultSetSize": {
      "type": "string",
      "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
    },
    "startPosition": {
      "type": "string",
      "description": "The starting index position of the current result set."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "usersResponse"
}

{
  "type": "object",
  "properties": {
    "bold": {
      "type": "string",
      "description": "When **true,** the information in the tab is bold."
    },
    "font": {
      "type": "string",
      "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
    },
    "tabId": {
      "type": "string",
      "description": "The unique identifier for the tab."
    },
    "width": {
      "type": "string",
      "description": "The width of the tab in pixels.\nMust be an integer."
    },
    "height": {
      "type": "string",
      "description": "The height of the tab in pixels.\nMust be an integer."
    },
    "italic": {
      "type": "string",
      "description": "When **true,** the information in the tab is italic."
    },
    "source": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "status": {
      "type": "string",
      "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`)."
    },
    "caption": {
      "type": "string",
      "description": ""
    },
    "tabType": {
      "type": "string",
      "description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
    },
    "tooltip": {
      "type": "string",
      "description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
    },
    "fontSize": {
      "type": "string",
      "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
    },
    "required": {
      "type": "string",
      "description": "When **true,** the recipient must click the **View** button for the supporting document prior to completing the signing process."
    },
    "tabLabel": {
      "type": "string",
      "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
    },
    "tabOrder": {
      "type": "string",
      "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs 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."
    },
    "fontColor": {
      "type": "string",
      "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
    },
    "formOrder": {
      "type": "string",
      "description": "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."
    },
    "underline": {
      "type": "string",
      "description": "When **true,** the information in the tab is underlined."
    },
    "xPosition": {
      "type": "string",
      "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\n"
    },
    "yPosition": {
      "type": "string",
      "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\n"
    },
    "buttonText": {
      "type": "string",
      "description": "The text to display on the button."
    },
    "documentId": {
      "type": "string",
      "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
    },
    "mergeField": {
      "$ref": "#/components/schemas/mergeField"
    },
    "pageNumber": {
      "type": "string",
      "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`."
    },
    "anchorUnits": {
      "type": "string",
      "description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
    },
    "customTabId": {
      "type": "string",
      "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
    },
    "recipientId": {
      "type": "string",
      "description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
    },
    "anchorString": {
      "type": "string",
      "description": "Specifies the string to find in the document and use as the basis for tab placement."
    },
    "boldMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "fontMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "localePolicy": {
      "$ref": "#/components/schemas/localePolicyTab"
    },
    "requiredRead": {
      "type": "string",
      "description": "When **true,** the recipient must read through the document."
    },
    "anchorXOffset": {
      "type": "string",
      "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
    },
    "anchorYOffset": {
      "type": "string",
      "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
    },
    "formPageLabel": {
      "type": "string",
      "description": "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."
    },
    "mergeFieldXml": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "tabIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "widthMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "formPageNumber": {
      "type": "string",
      "description": "An integer specifying the order in which to present the guided form pages."
    },
    "heightMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "italicMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "statusMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabGroupLabels": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
    },
    "templateLocked": {
      "type": "string",
      "description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
    },
    "captionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientIdGuid": {
      "type": "string",
      "description": "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."
    },
    "tabTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "toolTipMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "fontSizeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requiredMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabLabelMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "templateRequired": {
      "type": "string",
      "description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
    },
    "fontColorMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "formOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "underlineMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "xPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "yPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "buttonTextMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "documentIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "pageNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorCaseSensitive": {
      "type": "string",
      "description": "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.**\n\nFor 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.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n  $~><|^+=\n\n  For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n  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.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- 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.\n\n  Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n  Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
    },
    "anchorUnitsMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "customTabIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorMatchWholeWord": {
      "type": "string",
      "description": "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.**\n\nFor 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.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n  $~><|^+=\n\n  For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n  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.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- 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.\n\n  Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n  Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
    },
    "anchorStringMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorXOffsetMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorYOffsetMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "formPageLabelMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "conditionalParentLabel": {
      "type": "string",
      "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
    },
    "conditionalParentValue": {
      "type": "string",
      "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n"
    },
    "formPageNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabGroupLabelsMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "templateLockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientIdGuidMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorIgnoreIfNotPresent": {
      "type": "string",
      "description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
    },
    "smartContractInformation": {
      "$ref": "#/components/schemas/smartContractInformation"
    },
    "templateRequiredMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorHorizontalAlignment": {
      "type": "string",
      "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `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.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
    },
    "anchorTabProcessorVersion": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "anchorCaseSensitiveMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorMatchWholeWordMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "conditionalParentLabelMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "conditionalParentValueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorIgnoreIfNotPresentMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorAllowWhiteSpaceInCharacters": {
      "type": "string",
      "description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, 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.\n\nSecond, 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.\n\nThe default value is **true.**\n"
    },
    "anchorHorizontalAlignmentMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorTabProcessorVersionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorAllowWhiteSpaceInCharactersMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "This tab is used with the Approve tab to handle supplemental documents.",
  "x-ms-summary": "This tab is used with the Approve tab to handle supplemental documents.",
  "x-ds-definition-name": "view"
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "URL to the Review ID page."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "viewUrl"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the watermark."
    },
    "font": {
      "type": "string",
      "description": "The watermark's font. Valid values:\n\n- `courier`\n- `helvetica`\n- `timesnewroman`\n"
    },
    "enabled": {
      "type": "string",
      "description": "When **true,** the watermark will be applied to documents that are still in progress. When **false,** the watermark will not be applied."
    },
    "fontSize": {
      "type": "string",
      "description": "The watermark's font size. Valid values:\n\n* `30`\n* `40`\n* `50`\n* `60`\n* `70`\n* `80`\n* `90`"
    },
    "fontColor": {
      "type": "string",
      "description": "The watermark's font color. Valid values:\n\n* `black`\n* `blue`\n* `red`\n* `gray`\n* `yellow`"
    },
    "imageBase64": {
      "type": "string",
      "description": "The Base64 representation of the watermark image.\n\nThis property is read-only."
    },
    "displayAngle": {
      "type": "string",
      "description": "The display angle of the watermark. Valid values:\n\n* 0 (horizontal)\n* 45 (diagonal)\n* 90 (vertical)"
    },
    "transparency": {
      "type": "string",
      "description": "The transparency percentage of the watermark image. Valid values:\n\n* `5`\n* `10`\n* `15`\n* `20`\n* `25`\n* `30`\n* `35`\n* `40`\n* `45`"
    },
    "watermarkText": {
      "type": "string",
      "description": "The text for the watermark."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "watermark"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The full legal name of the recipient. Maximum Length: 100 characters.\n\n**Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set."
    },
    "note": {
      "type": "string",
      "description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n"
    },
    "tabs": {
      "$ref": "#/components/schemas/EnvelopeRecipientTabs"
    },
    "email": {
      "type": "string",
      "description": "The recipient's email address."
    },
    "status": {
      "type": "string",
      "description": "The recipient's status. This property is read-only. \n\nValid values:\n\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the documents in the envelope.\n- `delivered`: The recipient has viewed the documents in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`."
    },
    "userId": {
      "type": "string",
      "description": "The ID of the user to access.\n\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings."
    },
    "fullName": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "lastName": {
      "type": "string",
      "description": "The recipient's last name."
    },
    "notaryId": {
      "type": "string",
      "description": ""
    },
    "roleName": {
      "type": "string",
      "description": "Optional element. Specifies the role name associated with the recipient.<br/><br/>This property is required when you are working with template recipients."
    },
    "faxNumber": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "firstName": {
      "type": "string",
      "description": "The recipient's first name. Maximum Length: 50 characters."
    },
    "proofFile": {
      "$ref": "#/components/schemas/recipientProofFile"
    },
    "accessCode": {
      "type": "string",
      "description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required."
    },
    "statusCode": {
      "type": "string",
      "description": "The code associated with the recipient's status. This property is read-only."
    },
    "witnessFor": {
      "type": "string",
      "description": "The `recipientId` of the person or party for whom the recipient is a witness."
    },
    "delegatedBy": {
      "$ref": "#/components/schemas/delegationInfo"
    },
    "delegatedTo": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/delegationInfo"
      },
      "description": ""
    },
    "phoneNumber": {
      "$ref": "#/components/schemas/recipientPhoneNumber"
    },
    "recipientId": {
      "type": "string",
      "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."
    },
    "clientUserId": {
      "type": "string",
      "description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nIf the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to  **true,** an error is generated on sending.\n\n**Note:** This property is not returned by the [listStatusChanges](https://raw.githubusercontent.com) endpoint.\n\nMaximum length: 100 characters. \n"
    },
    "customFields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters."
    },
    "designatorId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "nameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "noteMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "routingOrder": {
      "type": "string",
      "description": "Specifies the routing order of the recipient in the envelope. "
    },
    "sentDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the envelope was sent. This property is read-only."
    },
    "emailMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientType": {
      "type": "string",
      "description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope."
    },
    "signatureInfo": {
      "$ref": "#/components/schemas/recipientSignatureInformation"
    },
    "totalTabCount": {
      "type": "string",
      "description": "The total number of tabs in the documents. This property is read-only."
    },
    "autoNavigation": {
      "type": "string",
      "description": "When **true,** autonavigation is set for the recipient.\n"
    },
    "canSignOffline": {
      "type": "string",
      "description": "When **true,** specifies that the signer can perform the signing ceremony offline."
    },
    "completedCount": {
      "type": "string",
      "description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only."
    },
    "creationReason": {
      "type": "string",
      "description": "The reason why the recipient was created (for example, `sender`). This property is read-only."
    },
    "declinedReason": {
      "type": "string",
      "description": "The reason the recipient declined the document. This property is read-only."
    },
    "deliveryMethod": {
      "type": "string",
      "description": "The delivery method. One of:\n\n- `email`\n- `fax`\n- `SMS`\n- `WhatsApp`\n- `offline`\n\nThe `SMS` and `WhatsApp` delivery methods\nare limited to `signer`, `carbonCopy`, and `certifiedDelivery`\nrecipients.\n\n**Related topics**\n\n- [Using SMS delivery with the eSignature API][smsconcept]\n- [How to request a signature by SMS delivery][howto]\n\n[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/\n[howto]: /docs/esign-rest-api/how-to/request-signature-sms/"
    },
    "signedDateTime": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "signingGroupId": {
      "type": "string",
      "description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
    },
    "suppressEmails": {
      "type": "string",
      "description": "When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox."
    },
    "templateLocked": {
      "type": "string",
      "description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
    },
    "witnessForGuid": {
      "type": "string",
      "description": "Not used. Use the `witnessFor` property instead."
    },
    "isBulkRecipient": {
      "type": "string",
      "description": "Reserved for DocuSign.\n"
    },
    "recipientIdGuid": {
      "type": "string",
      "description": "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."
    },
    "requireIdLookup": {
      "type": "string",
      "description": "When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. "
    },
    "agentCanEditName": {
      "type": "string",
      "description": "Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account."
    },
    "declinedDateTime": {
      "type": "string",
      "description": "The date and time the recipient declined the document. This property is read-only."
    },
    "defaultRecipient": {
      "type": "string",
      "description": "When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient."
    },
    "designatorIdGuid": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "fullNameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "lastNameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "signingGroupName": {
      "type": "string",
      "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. "
    },
    "templateRequired": {
      "type": "string",
      "description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
    },
    "agentCanEditEmail": {
      "type": "string",
      "description": "Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account."
    },
    "bulkRecipientsUri": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "deliveredDateTime": {
      "type": "string",
      "description": "The date and time that the envelope was delivered to the recipient. This property is read-only."
    },
    "emailNotification": {
      "$ref": "#/components/schemas/recipientEmailNotification"
    },
    "excludedDocuments": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent."
    },
    "faxNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "firstNameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "offlineAttributes": {
      "$ref": "#/components/schemas/offlineAttributes"
    },
    "signingGroupUsers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userInfo"
      },
      "description": "A complex type that contains information about users in the signing group."
    },
    "smsAuthentication": {
      "$ref": "#/components/schemas/recipientSMSAuthentication"
    },
    "accessCodeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "consentDetailsList": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/consentDetails"
      },
      "description": ""
    },
    "documentVisibility": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentVisibility"
      },
      "description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true.**"
    },
    "requireSignOnPaper": {
      "type": "string",
      "description": "When **true,** the signer must print, sign, and upload or fax the signed documents to DocuSign."
    },
    "signInEachLocation": {
      "type": "string",
      "description": "When **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once)."
    },
    "autoRespondedReason": {
      "type": "string",
      "description": "Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only.\n"
    },
    "bulkSendV2Recipient": {
      "type": "string",
      "description": ""
    },
    "phoneAuthentication": {
      "$ref": "#/components/schemas/recipientPhoneAuthentication"
    },
    "addAccessCodeToEmail": {
      "type": "string",
      "description": "Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient."
    },
    "identityVerification": {
      "$ref": "#/components/schemas/recipientIdentityVerification"
    },
    "recipientAttachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientAttachment"
      },
      "description": "Reserved for DocuSign."
    },
    "routingOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "notarySignerEmailSent": {
      "type": "string",
      "description": ""
    },
    "recipientSuppliesTabs": {
      "type": "string",
      "description": "When **true,** specifies that the recipient creates the tabs."
    },
    "recipientTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "socialAuthentications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/socialAuthentication"
      },
      "description": "Deprecated."
    },
    "deliveryMethodMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requireUploadSignature": {
      "type": "string",
      "description": "When **true,** the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal DocuSign account."
    },
    "signingGroupIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "additionalNotifications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientAdditionalNotification"
      },
      "description": "An array of additional notification objects."
    },
    "idCheckInformationInput": {
      "$ref": "#/components/schemas/idCheckInformationInput"
    },
    "isBulkRecipientMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requireIdLookupMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "idCheckConfigurationName": {
      "type": "string",
      "description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The  recipient must answer detailed security questions. \n\n**Example:** Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node."
    },
    "recipientFeatureMetadata": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/featureAvailableMetadata"
      },
      "description": "Metadata about the features that are supported for the recipient type. This property is read-only."
    },
    "requireSignerCertificate": {
      "type": "string",
      "description": "By default, DocuSign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing.\n\nThis parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. \n\nSet this parameter to `safe` to use a SAFE-BioPharma certificate.\n\nThe signer must be enrolled in the SAFE program to sign with a SAFE certificate."
    },
    "embeddedRecipientStartURL": {
      "type": "string",
      "description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nWhen `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` "
    },
    "lockedRecipientSmsEditable": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "signInEachLocationMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientSignatureProviders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientSignatureProvider"
      },
      "description": "The default signature provider is the DocuSign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](https://raw.githubusercontent.com)"
    },
    "emailRecipientPostSigningURL": {
      "type": "string",
      "description": ""
    },
    "recipientAuthenticationStatus": {
      "$ref": "#/components/schemas/authenticationStatus"
    },
    "idCheckConfigurationNameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "lockedRecipientPhoneAuthEditable": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "allowSystemOverrideForLockedRecipient": {
      "type": "string",
      "description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."
    },
    "inheritEmailNotificationConfiguration": {
      "type": "string",
      "description": "When **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. "
    }
  },
  "description": "A complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.",
  "x-ms-summary": "A complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope.",
  "x-ds-definition-name": "witness"
}

{
  "type": "object",
  "properties": {
    "resumeDate": {
      "type": "string",
      "description": "The ISO 8601 timestamp of when the envelope is scheduled to be sent, if applicable. Its value is the maximum of the `resumeDate` property on `scheduledSending` and the `resumeDate` property on the current `workflowStep`.\n\nThis property is read-only."
    },
    "workflowSteps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/workflowStep"
      },
      "description": "An array of workflow steps."
    },
    "workflowStatus": {
      "type": "string",
      "description": "The status of the workflow:\n\n- `paused` if the workflow is paused\n- `in_progress` if the workflow is in progress"
    },
    "scheduledSending": {
      "$ref": "#/components/schemas/scheduledSending"
    },
    "currentWorkflowStepId": {
      "type": "string",
      "description": "The `workflowStepId` of the current step.\nThis is not an index into the `workflowSteps` array in this object.\nSee the `workflowStep` object."
    }
  },
  "description": "Describes the workflow for an envelope.",
  "x-ms-summary": "Describes the workflow for an envelope.",
  "x-ds-definition-name": "workflow"
}

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "Indicates the action to perform. Valid values:\n\n- `pause_before`: The workflow should pause before the trigger described by `triggerOnItem` is reached.\n"
    },
    "itemId": {
      "type": "string",
      "description": "The unique ID of the item being triggered."
    },
    "status": {
      "type": "string",
      "description": "The status of the step. Valid values:\n\n- `inactive`\n- `in_progress`\n- `paused`\n- `pending`\n- `completed`\n\nThis property is read-only."
    },
    "completedDate": {
      "type": "string",
      "description": "The timestamp of when the workflow step transitioned to `completed` status.\n\nThis property is read-only."
    },
    "triggerOnItem": {
      "type": "string",
      "description": "The type of item that triggers this workflow step. Valid values:\n\n* `routing_order`"
    },
    "triggeredDate": {
      "type": "string",
      "description": "The timestamp of when the workflow step transitioned to `in_progress` status.\n\nThis property is read-only."
    },
    "delayedRouting": {
      "$ref": "#/components/schemas/delayedRouting"
    },
    "workflowStepId": {
      "type": "string",
      "description": "A unique identifier for this workflow step.\n\nThis property is read-only."
    },
    "recipientRouting": {
      "$ref": "#/components/schemas/recipientRouting"
    }
  },
  "description": "Describes a single step in a workflow.",
  "x-ms-summary": "Describes a single step in a workflow.",
  "x-ds-definition-name": "workflowStep"
}

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."
    },
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the workspace user authorization was created."
    },
    "settings": {
      "$ref": "#/components/schemas/workspaceSettings"
    },
    "workspaceId": {
      "type": "string",
      "description": "The ID of the workspace, always populated."
    },
    "lastModified": {
      "type": "string",
      "description": "Utc date and time the comment was last updated (can only be done by creator.)"
    },
    "workspaceUri": {
      "type": "string",
      "description": "The relative URI for accessing the workspace."
    },
    "workspaceName": {
      "type": "string",
      "description": "The name of the workspace."
    },
    "workspaceBaseUrl": {
      "type": "string",
      "description": "The relative URL for accessing the workspace."
    },
    "billableAccountId": {
      "type": "string",
      "description": "The ID of the account to bill."
    },
    "callerInformation": {
      "$ref": "#/components/schemas/workspaceUser"
    },
    "createdByInformation": {
      "$ref": "#/components/schemas/workspaceUser"
    },
    "workspaceDescription": {
      "type": "string",
      "description": "Text describing the purpose of the workspace."
    },
    "lastModifiedByInformation": {
      "$ref": "#/components/schemas/workspaceUser"
    }
  },
  "description": "A DocuSign workspace is a collaboration area for sharing files and data.",
  "x-ms-summary": "A DocuSign workspace is a collaboration area for sharing files and data.",
  "x-ds-definition-name": "workspace"
}

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/workspaceItem"
      },
      "description": "A list of workspace items."
    },
    "folder": {
      "$ref": "#/components/schemas/workspaceItem"
    },
    "endPosition": {
      "type": "string",
      "description": "The last index position in the result set. "
    },
    "workspaceId": {
      "type": "string",
      "description": "The ID of the workspace, always populated."
    },
    "totalSetSize": {
      "type": "string",
      "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
    },
    "parentFolders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/workspaceItem"
      },
      "description": ""
    },
    "resultSetSize": {
      "type": "string",
      "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
    },
    "startPosition": {
      "type": "string",
      "description": "The starting index position of the current result set."
    }
  },
  "description": "This object's properties describe the contents of a workspace folder.",
  "x-ms-summary": "This object's properties describe the contents of a workspace folder.",
  "x-ds-definition-name": "workspaceFolderContents"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique ID for the Salesforce object."
    },
    "uri": {
      "type": "string",
      "description": "A URI containing the user ID."
    },
    "name": {
      "type": "string",
      "description": "The name of the file or folder."
    },
    "type": {
      "type": "string",
      "description": "The type of the workspace item. Valid values are file, folder."
    },
    "sha256": {
      "type": "string",
      "description": "A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content of a file. DocuSign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the upload is refused."
    },
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the workspace item was created."
    },
    "fileUri": {
      "type": "string",
      "description": "The URI for retrieving the file."
    },
    "fileSize": {
      "type": "string",
      "description": "The size of the file in bytes."
    },
    "isPublic": {
      "type": "string",
      "description": " When **true,** the item is public."
    },
    "extension": {
      "type": "string",
      "description": "The file extension of a file item."
    },
    "pageCount": {
      "type": "string",
      "description": "The number of pages in a file."
    },
    "thumbnail": {
      "$ref": "#/components/schemas/page"
    },
    "thumbWidth": {
      "type": "string",
      "description": "The width of the thumbnail image."
    },
    "contentType": {
      "type": "string",
      "description": "If the item is a file, this property specifies the content type of the file."
    },
    "createdById": {
      "type": "string",
      "description": "The ID of the user who created the workspace item."
    },
    "thumbHeight": {
      "type": "string",
      "description": "The height of the thumbnail image."
    },
    "lastModified": {
      "type": "string",
      "description": "The UTC date and time that the comment was last updated.\n\n**Note:** This can only be done by the creator."
    },
    "parentFolderId": {
      "type": "string",
      "description": "The ID of the parent folder, or the special value `root` for the root folder."
    },
    "parentFolderUri": {
      "type": "string",
      "description": "The URI of the parent folder."
    },
    "lastModifiedById": {
      "type": "string",
      "description": "The ID of the user who last modified the item."
    },
    "userAuthorization": {
      "$ref": "#/components/schemas/workspaceUserAuthorization"
    },
    "callerAuthorization": {
      "$ref": "#/components/schemas/workspaceUserAuthorization"
    },
    "createdByInformation": {
      "$ref": "#/components/schemas/workspaceUser"
    },
    "lastModifiedByInformation": {
      "$ref": "#/components/schemas/workspaceUser"
    }
  },
  "description": "This object represents an item in a workspace, which can be either a file or folder.",
  "x-ms-summary": "This object represents an item in a workspace, which can be either a file or folder.",
  "x-ds-definition-name": "workspaceItem"
}

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/workspaceItem"
      },
      "description": "A list of workspace items."
    }
  },
  "description": "An array of objects that describe the items in a workspace.",
  "x-ms-summary": "An array of objects that describe the items in a workspace.",
  "x-ds-definition-name": "workspaceItemList"
}

{
  "type": "object",
  "properties": {
    "workspaces": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/workspace"
      },
      "description": "A list of workspaces."
    },
    "endPosition": {
      "type": "string",
      "description": "The last index position in the result set. "
    },
    "totalSetSize": {
      "type": "string",
      "description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
    },
    "resultSetSize": {
      "type": "string",
      "description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
    },
    "startPosition": {
      "type": "string",
      "description": "The starting index position of the current result set."
    }
  },
  "description": "This object contains a list of available workspaces.",
  "x-ms-summary": "This object contains a list of available workspaces.",
  "x-ds-definition-name": "workspaceList"
}

{
  "type": "object",
  "properties": {
    "commentsAllowed": {
      "type": "string",
      "description": "When **true,** commenting on the documents in the workspace is allowed."
    }
  },
  "description": "This object provides information about the settings for the workspace.",
  "x-ms-summary": "This object provides information about the settings for the workspace.",
  "x-ds-definition-name": "workspaceSettings"
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Type of the user. Valid values: type_owner, type_participant."
    },
    "email": {
      "type": "string",
      "description": "The workspace user's email address."
    },
    "status": {
      "type": "string",
      "description": "Filters the results by user status.\nYou can specify a comma-separated\nlist of the following statuses:\n\n* ActivationRequired \n* ActivationSent \n* Active\n* Closed \n* Disabled"
    },
    "userId": {
      "type": "string",
      "description": "The ID of the workspace user."
    },
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the workspace user was created."
    },
    "userName": {
      "type": "string",
      "description": "The name of workspace user."
    },
    "accountId": {
      "type": "string",
      "description": "The account ID associated with the workspace user."
    },
    "accountName": {
      "type": "string",
      "description": "The name of the account that the workspace user belongs to."
    },
    "activeSince": {
      "type": "string",
      "description": "The UTC DateTime when the user joined the workspace."
    },
    "createdById": {
      "type": "string",
      "description": "The ID of the user who created this workspace user."
    },
    "workspaceId": {
      "type": "string",
      "description": "The ID of the workspace."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "lastModified": {
      "type": "string",
      "description": "The UTC DateTime that the workspace user was last modified."
    },
    "workspaceUserId": {
      "type": "string",
      "description": "The ID of the workspace user."
    },
    "lastModifiedById": {
      "type": "string",
      "description": "The ID of the user who last modified the workspace user."
    },
    "workspaceUserUri": {
      "type": "string",
      "description": "The URI for accessing the workspace user."
    },
    "invitationEmailBlurb": {
      "type": "string",
      "description": "The text of the workspace invitation email message sent to the user."
    },
    "workspaceUserBaseUrl": {
      "type": "string",
      "description": "The URL for accessing the workspace user."
    },
    "invitationEmailSubject": {
      "type": "string",
      "description": "The subject line of the workspace invitation email message sent to the user."
    }
  },
  "description": "This object represents the workspace user. This property is only returned in response to user specific GET call. ",
  "x-ms-summary": "This object represents the workspace user. This property is only returned in response to user specific GET call. ",
  "x-ds-definition-name": "workspaceUser"
}

{
  "type": "object",
  "properties": {
    "canMove": {
      "type": "string",
      "description": "When **true,** the workspace user can move the items in the workspace."
    },
    "canView": {
      "type": "string",
      "description": "When **true,** the workspace user can view the items in the workspace."
    },
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the workspace user authorization was created."
    },
    "modified": {
      "type": "string",
      "description": "The UTC DateTime when the workspace user authorization was last modified."
    },
    "canDelete": {
      "type": "string",
      "description": "When **true,** the workspace user can delete items from the workspace."
    },
    "canTransact": {
      "type": "string",
      "description": "When **true,** the workspace user can create transactions from the workspace."
    },
    "createdById": {
      "type": "string",
      "description": "The ID of the user who created the workspace user authorization. "
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "modifiedById": {
      "type": "string",
      "description": "The ID of the user who last modified the workspace user authorization."
    },
    "workspaceUserId": {
      "type": "string",
      "description": "The ID of the workspace user."
    },
    "workspaceUserInformation": {
      "$ref": "#/components/schemas/workspaceUser"
    }
  },
  "description": "Provides properties that describe user authorization to a workspace.",
  "x-ms-summary": "Provides properties that describe user authorization to a workspace.",
  "x-ds-definition-name": "workspaceUserAuthorization"
}

{
  "type": "object",
  "properties": {
    "bold": {
      "type": "string",
      "description": "When **true,** the information in the tab is bold."
    },
    "font": {
      "type": "string",
      "description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
    },
    "name": {
      "type": "string",
      "description": "The name of the tab. For example, `Sign Here` or `Initial Here`.\n\nIf the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text."
    },
    "tabId": {
      "type": "string",
      "description": "The unique identifier for the tab."
    },
    "value": {
      "type": "string",
      "description": "Specifies the value of the tab. "
    },
    "width": {
      "type": "string",
      "description": "The width of the tab in pixels.\nMust be an integer."
    },
    "height": {
      "type": "string",
      "description": "The height of the tab in pixels.\nMust be an integer."
    },
    "italic": {
      "type": "string",
      "description": "When **true,** the information in the tab is italic."
    },
    "locked": {
      "type": "string",
      "description": "When **true,** the signer cannot change the data of the custom tab."
    },
    "shared": {
      "type": "string",
      "description": "When **true,** this custom tab is shared."
    },
    "source": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "status": {
      "type": "string",
      "description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`).\n"
    },
    "caption": {
      "type": "string",
      "description": ""
    },
    "tabType": {
      "type": "string",
      "description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
    },
    "tooltip": {
      "type": "string",
      "description": "The text of a tooltip that appears when a user hovers over a form field or tab.\n"
    },
    "fontSize": {
      "type": "string",
      "description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
    },
    "required": {
      "type": "string",
      "description": "When **true,** the signer is required to fill out this tab."
    },
    "tabLabel": {
      "type": "string",
      "description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
    },
    "tabOrder": {
      "type": "string",
      "description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs 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."
    },
    "useDash4": {
      "type": "string",
      "description": "When **true,** ZIP+4 format is used."
    },
    "fontColor": {
      "type": "string",
      "description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
    },
    "formOrder": {
      "type": "string",
      "description": "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."
    },
    "maxLength": {
      "type": "string",
      "description": "An optional value that describes the maximum length of the property when the property is a string."
    },
    "underline": {
      "type": "string",
      "description": "When **true,** the information in the tab is underlined."
    },
    "xPosition": {
      "type": "string",
      "description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
    },
    "yPosition": {
      "type": "string",
      "description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
    },
    "documentId": {
      "type": "string",
      "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
    },
    "mergeField": {
      "$ref": "#/components/schemas/mergeField"
    },
    "pageNumber": {
      "type": "string",
      "description": "The page number on which the tab is located. For supplemental documents, this value must be `1`."
    },
    "requireAll": {
      "type": "string",
      "description": "When **true** and shared is true, information must be entered in this field to complete the envelope. "
    },
    "anchorUnits": {
      "type": "string",
      "description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
    },
    "customTabId": {
      "type": "string",
      "description": "The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties."
    },
    "recipientId": {
      "type": "string",
      "description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`.\n"
    },
    "anchorString": {
      "type": "string",
      "description": "Specifies the string to find in the document and use as the basis for tab placement."
    },
    "boldMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "fontMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "localePolicy": {
      "$ref": "#/components/schemas/localePolicyTab"
    },
    "nameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorXOffset": {
      "type": "string",
      "description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
    },
    "anchorYOffset": {
      "type": "string",
      "description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
    },
    "formPageLabel": {
      "type": "string",
      "description": "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."
    },
    "mergeFieldXml": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "originalValue": {
      "type": "string",
      "description": "The initial value of the tab. "
    },
    "tabIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "valueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "widthMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "formPageNumber": {
      "type": "string",
      "description": "An integer specifying the order in which to present the guided form pages."
    },
    "heightMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "italicMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "lockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "senderRequired": {
      "type": "string",
      "description": "When **true,** the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope."
    },
    "sharedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "statusMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabGroupLabels": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
    },
    "templateLocked": {
      "type": "string",
      "description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
    },
    "captionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "disableAutoSize": {
      "type": "string",
      "description": "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."
    },
    "recipientIdGuid": {
      "type": "string",
      "description": "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."
    },
    "tabTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "toolTipMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "fontSizeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requiredMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabLabelMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "templateRequired": {
      "type": "string",
      "description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
    },
    "useDash4Metadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "fontColorMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "formOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "maxLengthMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "shareToRecipients": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "underlineMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "validationMessage": {
      "type": "string",
      "description": "The message displayed if the custom tab fails input validation (either custom of embedded)."
    },
    "validationPattern": {
      "type": "string",
      "description": "A regular expression used to validate input for the tab."
    },
    "xPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "yPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "documentIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "pageNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requireAllMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorCaseSensitive": {
      "type": "string",
      "description": "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.**\n\nFor 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.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n  $~><|^+=\n\n  For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n  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.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- 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.\n\n  Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n  Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
    },
    "anchorUnitsMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "customTabIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorMatchWholeWord": {
      "type": "string",
      "description": "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.**\n\nFor 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.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n  $~><|^+=\n\n  For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n  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.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- 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.\n\n  Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n  Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
    },
    "anchorStringMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorXOffsetMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorYOffsetMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "formPageLabelMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "originalValueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "concealValueOnDocument": {
      "type": "string",
      "description": "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.\n\nWhen 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.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes."
    },
    "conditionalParentLabel": {
      "type": "string",
      "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
    },
    "conditionalParentValue": {
      "type": "string",
      "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n"
    },
    "formPageNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "senderRequiredMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabGroupLabelsMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "templateLockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "disableAutoSizeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientIdGuidMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorIgnoreIfNotPresent": {
      "type": "string",
      "description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
    },
    "smartContractInformation": {
      "$ref": "#/components/schemas/smartContractInformation"
    },
    "templateRequiredMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorHorizontalAlignment": {
      "type": "string",
      "description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `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.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
    },
    "anchorTabProcessorVersion": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "shareToRecipientsMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "validationMessageMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "validationPatternMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorCaseSensitiveMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorMatchWholeWordMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requireInitialOnSharedChange": {
      "type": "string",
      "description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field."
    },
    "concealValueOnDocumentMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "conditionalParentLabelMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "conditionalParentValueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorIgnoreIfNotPresentMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorAllowWhiteSpaceInCharacters": {
      "type": "string",
      "description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, 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.\n\nSecond, 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.\n\nThe default value is **true.**\n"
    },
    "anchorHorizontalAlignmentMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorTabProcessorVersionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requireInitialOnSharedChangeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "anchorAllowWhiteSpaceInCharactersMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "A tab that allows the recipient to enter a ZIP code. The ZIP\ncode can be five digits or nine digits in the ZIP+4 format.\nThe zip code can be typed with or without dashes. It uses\nthe same parameters as a Text tab, with the validation\nmessage and pattern set for ZIP code information.\n",
  "x-ms-summary": "A tab that allows the recipient to enter a ZIP code. The ZIP\ncode can be five digits or nine digits in the ZIP+4 format.\nThe zip code can be typed with or without dashes. It uses\nthe same parameters as a Text tab, with the validation\nmessage and pattern set for ZIP code information.\n",
  "x-ds-definition-name": "zip"
}