DocuSign

{
  "type": "object",
  "properties": {
    "brands": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/brand"
      },
      "description": "A list of brands."
    },
    "senderBrandIdDefault": {
      "type": "string",
      "description": "The brand that envelope senders see when a brand is not explicitly set."
    },
    "recipientBrandIdDefault": {
      "type": "string",
      "description": "The brand that envelope recipients see when a brand is not explicitly set."
    }
  },
  "x-ds-order": "10",
  "description": "The AccountBrands resource enables you to use account-level brands to customize the styles and text that recipients see.",
  "x-ms-summary": "The AccountBrands resource enables you to use account-level brands to customize the styles and text that recipients see.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "brandsResponse"
}

{
  "type": "object",
  "properties": {
    "pdfId": {
      "type": "string",
      "description": "**Deprecated.** \n\nThe `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. "
    },
    "custom": {
      "type": "string",
      "description": "When **true,** indicates that the consumer disclosure is a custom disclosure. The default is **false.**"
    },
    "useBrand": {
      "type": "string",
      "description": "When **true,** specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience.  \n\nWhen **false** (default), or if the signing brand does not specify a company name, the account name is used instead.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. "
    },
    "esignText": {
      "type": "string",
      "description": "The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting.\n\n**Note:** If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting."
    },
    "changeEmail": {
      "type": "string",
      "description": "If the customer needs to change their email address, this is the email address to which they should the change request.\n\nMaximum length: 100 characters."
    },
    "companyName": {
      "type": "string",
      "description": "Specifies the company name used in the disclosure. The default value is the account name.\n\nHowever, if your account uses signing brands that specify a company name, you can substitute the brand's company name by setting the `useBrand` property to **true.** Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true.**"
    },
    "enableEsign": {
      "type": "string",
      "description": "When **true** (default), indicates that eSign is enabled."
    },
    "companyPhone": {
      "type": "string",
      "description": "The phone number of the company associated with the consumer disclosure, as a free-formatted string."
    },
    "languageCode": {
      "type": "string",
      "description": "The code for the language version of the disclosure. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`."
    },
    "withdrawCity": {
      "type": "string",
      "description": "Contains the city of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 50 characters. "
    },
    "withdrawEmail": {
      "type": "string",
      "description": "Contains the email address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawOther": {
      "type": "string",
      "description": "Contains any other information needed to withdraw consent.\n\nMaximum length: 255 characters.\n\nExample:\n\n`We do not need any other information from you to withdraw consent.`"
    },
    "withdrawPhone": {
      "type": "string",
      "description": "Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string.\n\nMaximum length: 20 characters. "
    },
    "withdrawState": {
      "type": "string",
      "description": "Contains the state of the postal address to which a customer can send a consent withdrawal notification.\n\nExample: `PA`"
    },
    "accountEsignId": {
      "type": "string",
      "description": "The GUID of the account associated with the consumer disclosure."
    },
    "esignAgreement": {
      "type": "string",
      "description": "The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting."
    },
    "withdrawByMail": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw consent by postal mail. The default is **false.**"
    },
    "allowCDWithdraw": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false.**\n**Note:** Only Admin users can change this setting."
    },
    "copyCostPerPage": {
      "type": "string",
      "description": "The cost per page if the customer requests paper copies.\n\nExample: \n\n`0.0000`"
    },
    "withdrawByEmail": {
      "type": "string",
      "description": "When **true** (default), indicates that the customer can withdraw consent by email."
    },
    "withdrawByPhone": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw consent by phone. The default is **false.**"
    },
    "changeEmailOther": {
      "type": "string",
      "description": "Other information about the requirements for the user to change their email address.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We do not require any other information from you to change your email address.`"
    },
    "copyRequestEmail": {
      "type": "string",
      "description": "The email address to which the customer should send a request for copies of a document.\n\nMaximum length: 100 characters."
    },
    "mustAgreeToEsign": {
      "type": "string",
      "description": "When **true,** the  recipient must agree to the consumer disclosure. The value of this property is read-only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions."
    },
    "withdrawPostalCode": {
      "type": "string",
      "description": "Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 20 characters. "
    },
    "withdrawAddressLine1": {
      "type": "string",
      "description": "Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawAddressLine2": {
      "type": "string",
      "description": "Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawConsequences": {
      "type": "string",
      "description": "Text indicating the consequences of withdrawing consent.\n\nMaximum length: 255 characters."
    },
    "allowCDWithdrawMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "copyFeeCollectionMethod": {
      "type": "string",
      "description": "Specifies the fee collection method for cases in which the customer requires paper copies of the document.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We will bill you for any fees at that time, if any.`"
    },
    "useConsumerDisclosureWithinAccount": {
      "type": "string",
      "description": "When **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement."
    },
    "useConsumerDisclosureWithinAccountMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "x-ds-order": "20",
  "description": "Details about account consumer disclosures.",
  "x-ms-summary": "Details about account consumer disclosures.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "consumerDisclosure"
}

{
  "type": "object",
  "properties": {
    "listCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/listCustomField"
      },
      "description": "An array of list custom fields."
    },
    "textCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/textCustomField"
      },
      "description": "An array of text custom fields."
    }
  },
  "x-ds-order": "30",
  "description": "An `accountCustomField` is an envelope custom field that you set at the account level.\nApplying custom fields enables account administrators to group and manage envelopes.\n",
  "x-ms-summary": "An `accountCustomField` is an envelope custom field that you set at the account level.\nApplying custom fields enables account administrators to group and manage envelopes.\n",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "customFields"
}

{
  "type": "object",
  "properties": {
    "expirePassword": {
      "type": "string",
      "description": "When **true,** passwords expire. The default value is `false`."
    },
    "questionsRequired": {
      "type": "string",
      "description": "The number of security questions required to confirm the user’s identity before the user can reset their password. The default value is `0`."
    },
    "expirePasswordDays": {
      "type": "string",
      "description": "The number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true.**"
    },
    "lockoutDurationType": {
      "type": "string",
      "description": "The interval associated with the user lockout after a failed login attempt.\n\nPossible values are:\n\n- `minutes` (default)\n- `hours`\n- `days`"
    },
    "passwordIncludeDigit": {
      "type": "string",
      "description": "When **true,** passwords must include a digit. The default value is `false`."
    },
    "passwordStrengthType": {
      "type": "string",
      "description": "The type of password strength. Possible values are:\n\n- `basic`: The minimum password length is 6 characters with no other password requirements.\n- `medium`: The minimum password length is 7 characters. Passwords must also have one uppercase letter, one lowercase letter, and one number or special character.\n- `strong`: The minimum password length is 9 characters. Passwords must also have one uppercase letter, one lowercase letter, one number, and one special character.\n- `custom`: This option enables you to customize password requirements, including the following properties:\n\n   - `minimumPasswordLength`\n   - `minimumPasswordAgeDays`\n   - `passwordIncludeDigit`\n   - `passwordIncludeDigitOrSpecialCharacter`\n   - `passwordIncludeLowerCase`\n   - `passwordIncludeSpecialCharacter`\n   - `passwordIncludeUpperCase`\n   - `questionsRequired`"
    },
    "minimumPasswordLength": {
      "type": "string",
      "description": "The minimum number of characters in the password. This value must be a number between `6` and `15`. The default value is `6`."
    },
    "lockoutDurationMinutes": {
      "type": "string",
      "description": "The number of minutes a user is locked out of the system after three failed login attempts. The default value is `2`."
    },
    "minimumPasswordAgeDays": {
      "type": "string",
      "description": "The minimum number of days after a password is set before it can be changed. This value can be `0` or more days. The default value is `0`."
    },
    "passwordIncludeLowerCase": {
      "type": "string",
      "description": "When **true,** passwords must include a lowercase letter. The default value is `false`."
    },
    "passwordIncludeUpperCase": {
      "type": "string",
      "description": "When **true,** passwords must include an uppercase letter. The default value is `false`."
    },
    "questionsRequiredMetadata": {
      "$ref": "#/components/schemas/accountPasswordQuestionsRequired"
    },
    "expirePasswordDaysMetadata": {
      "$ref": "#/components/schemas/accountPasswordExpirePasswordDays"
    },
    "lockoutDurationTypeMetadata": {
      "$ref": "#/components/schemas/accountPasswordLockoutDurationType"
    },
    "passwordStrengthTypeMetadata": {
      "$ref": "#/components/schemas/accountPasswordStrengthType"
    },
    "minimumPasswordLengthMetadata": {
      "$ref": "#/components/schemas/accountMinimumPasswordLength"
    },
    "lockoutDurationMinutesMetadata": {
      "$ref": "#/components/schemas/accountPasswordLockoutDurationMinutes"
    },
    "minimumPasswordAgeDaysMetadata": {
      "$ref": "#/components/schemas/accountPasswordMinimumPasswordAgeDays"
    },
    "passwordIncludeSpecialCharacter": {
      "type": "string",
      "description": "When **true,** passwords must include a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."
    },
    "passwordIncludeDigitOrSpecialCharacter": {
      "type": "string",
      "description": "When **true,** passwords must include either a digit or a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."
    }
  },
  "x-ds-order": "190",
  "description": "Contains details about the password rules for an account.",
  "x-ms-summary": "Contains details about the password rules for an account.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "accountPasswordRules"
}

{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userInformation"
      },
      "description": "A list of user objects containing information about the users who are associated with the account permission profile."
    },
    "settings": {
      "$ref": "#/components/schemas/accountRoleSettings"
    },
    "userCount": {
      "type": "string",
      "description": "The total number of users in the group associated with the account permission profile."
    },
    "modifiedDateTime": {
      "type": "string",
      "description": "The date and time when the permission profile was last modified."
    },
    "modifiedByUsername": {
      "type": "string",
      "description": "The username of the user who last modified the permission profile."
    },
    "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"
    },
    "permissionProfileName": {
      "type": "string",
      "description": "The name of the account permission profile. \n\nExample: `Account Administrator`"
    }
  },
  "x-ds-order": "70",
  "description": "The AccountPermissionProfiles resource provides methods that allow you to manage permission profiles for groups of account users.",
  "x-ms-summary": "The AccountPermissionProfiles resource provides methods that allow you to manage permission profiles for groups of account users.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "permissionProfile"
}

{
  "type": "object",
  "properties": {
    "seals": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/sealIdentifier"
      },
      "description": "A list of electronic seals to apply to documents."
    }
  },
  "x-ds-order": "10",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "accountSeals"
}

{
  "type": "object",
  "properties": {
    "signatureProviders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/accountSignatureProvider"
      },
      "description": "Names of electronic or digital signature providers that can be used."
    }
  },
  "x-ds-order": "30",
  "description": "This resource provides information on the Standards Based Signature providers that have been provisioned for an account.\n",
  "x-ms-summary": "This resource provides information on the Standards Based Signature providers that have been provisioned for an account.\n",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "accountSignatureProviders"
}

{
  "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": ""
    },
    "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 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."
    },
    "stampImageUri": {
      "type": "string",
      "description": "The URI for retrieving the image of the user's stamp."
    },
    "signatureUsers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signatureUser"
      },
      "description": ""
    },
    "adoptedDateTime": {
      "type": "string",
      "description": "The UTC date and time when the user adopted the signature."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the item was created."
    },
    "signatureGroups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signatureGroup"
      },
      "description": ""
    },
    "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": "Specifies the user's signature in initials format."
    },
    "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."
    }
  },
  "x-ds-order": "40",
  "description": "AccountSignatures represent stamps used to sign documents.",
  "x-ms-summary": "AccountSignatures represent stamps used to sign documents.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "accountSignature"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "object",
  "properties": {
    "allowTabOrder": {
      "type": "string",
      "description": "When **true,** account users can set a tab order for the signing process.\n\n**Note:** Only Admin users can change this setting."
    },
    "drawTabsEnabled": {
      "type": "string",
      "description": ""
    },
    "listTabsEnabled": {
      "type": "string",
      "description": "When **true,** list tabs are enabled."
    },
    "noteTabsEnabled": {
      "type": "string",
      "description": "When **true,** note tabs are enabled."
    },
    "tabScaleEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "textTabsEnabled": {
      "type": "string",
      "description": "When **true,** text tabs are enabled."
    },
    "drawTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "listTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "noteTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "radioTabsEnabled": {
      "type": "string",
      "description": "When **true,** radio button tabs are enabled."
    },
    "tabScaleMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "textTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "radioTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "tabLockingEnabled": {
      "type": "string",
      "description": "When **true,** tab locking is enabled.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "prefillTabsEnabled": {
      "type": "string",
      "description": ""
    },
    "tabLocationEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "tabLockingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "checkboxTabsEnabled": {
      "type": "string",
      "description": "When **true,** checkbox tabs are enabled."
    },
    "prefillTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "tabDataLabelEnabled": {
      "type": "string",
      "description": "When **true,** [data\nlabels](https://support.docusign.com/en/videos/Data-Labels) are enabled.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "tabLocationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "checkBoxTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dataFieldSizeEnabled": {
      "type": "string",
      "description": "When **true,** setting character limits for input fields is enabled."
    },
    "numericalTabsEnabled": {
      "type": "string",
      "description": ""
    },
    "tabDataLabelMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowTabOrderMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dataFieldRegexEnabled": {
      "type": "string",
      "description": "When **true,** regular expressions are enabled for tabs that contain data fields."
    },
    "dataFieldSizeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "numericalTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dataFieldRegexMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "calculatedFieldsEnabled": {
      "type": "string",
      "description": "When **true,** [calculated fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) are enabled for tabs."
    },
    "savingCustomTabsEnabled": {
      "type": "string",
      "description": "When **true,** saving custom tabs is enabled."
    },
    "sharedCustomTabsEnabled": {
      "type": "string",
      "description": "When **true,** shared custom tabs are enabled."
    },
    "calculatedFieldsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "savingCustomTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "sharedCustomTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "tabTextFormattingEnabled": {
      "type": "string",
      "description": "When **true,** text formatting (such as font type, font size,\nfont color, bold, italic, and underline) is enabled for tabs that\nsupport formatting.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "approveDeclineTabsEnabled": {
      "type": "string",
      "description": "When **true,** approve and decline tabs are enabled."
    },
    "firstLastEmailTabsEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "tabTextFormattingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "approveDeclineTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "firstLastEmailTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "senderToChangeTabAssignmentsEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "senderToChangeTabAssignmentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "x-ds-order": "100",
  "description": "Tab settings determine the tab types and tab functionality that are enabled for an account.",
  "x-ms-summary": "Tab settings determine the tab types and tab functionality that are enabled for an account.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "tabAccountSettings"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique ID for the Salesforce object."
    },
    "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"
    },
    "enabled": {
      "type": "string",
      "description": ""
    },
    "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"
    },
    "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"
    },
    "imageBase64": {
      "type": "string",
      "description": ""
    },
    "displayAngle": {
      "type": "string",
      "description": ""
    },
    "transparency": {
      "type": "string",
      "description": ""
    },
    "watermarkText": {
      "type": "string",
      "description": ""
    }
  },
  "x-ds-order": "200",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "watermark"
}

{
  "type": "object",
  "properties": {
    "brands": {
      "$ref": "#/components/schemas/AccountBrands"
    },
    "planName": {
      "type": "string",
      "description": "The name of the billing plan used for the account.\n\nExamples: \n\n- `Personal - Annual`\n- `Unlimited Envelope Subscription - Annual Billing`"
    },
    "dssValues": {
      "type": "object",
      "description": "",
      "additionalProperties": {
        "type": "string"
      }
    },
    "canUpgrade": {
      "type": "string",
      "description": "When **true,** specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response."
    },
    "seatsInUse": {
      "type": "string",
      "description": "The number of users currently active on the account."
    },
    "accountName": {
      "type": "string",
      "description": "The name on the account."
    },
    "createdDate": {
      "type": "string",
      "description": "The creation date of the account in UTC timedate format."
    },
    "isDowngrade": {
      "type": "string",
      "description": "When **true,** the account has been downgraded from a premium account type. Otherwise **false.**"
    },
    "planEndDate": {
      "type": "string",
      "description": "The date that the current plan will end."
    },
    "currencyCode": {
      "type": "string",
      "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.\n"
    },
    "seatsAllowed": {
      "type": "string",
      "description": "The number of active users the account can have at one time."
    },
    "accountIdGuid": {
      "type": "string",
      "description": "The GUID associated with the account ID."
    },
    "currentPlanId": {
      "type": "string",
      "description": "ID of the plan used to create this account."
    },
    "paymentMethod": {
      "type": "string",
      "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
    },
    "planStartDate": {
      "type": "string",
      "description": "The date that the Account started using the current plan."
    },
    "billingProfile": {
      "type": "string",
      "description": "The type of billing method on the account. Valid values are: \n\n- `direct`\n- `web`"
    },
    "suspensionDate": {
      "type": "string",
      "description": "The date on which the account was suspended."
    },
    "accountSettings": {
      "$ref": "#/components/schemas/accountSettingsInformation"
    },
    "distributorCode": {
      "type": "string",
      "description": "The code that identifies the billing plan groups and plans for the new account."
    },
    "recipientDomains": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientDomain"
      },
      "description": ""
    },
    "suspensionStatus": {
      "type": "string",
      "description": "Indicates whether the account is currently suspended."
    },
    "connectPermission": {
      "type": "string",
      "description": ""
    },
    "envelopeUnitPrice": {
      "type": "string",
      "description": "The price of sending an envelope, represented in the account's local currency."
    },
    "externalAccountId": {
      "type": "string",
      "description": "The Account ID displayed on the user's Account page."
    },
    "status21CFRPart11": {
      "type": "string",
      "description": "The status of the account content per (Title 21 CFR Part 11)[https://www.fda.gov/regulatory-information/search-fda-guidance-documents/part-11-electronic-records-electronic-signatures-scope-and-application]. This regulation defines the criteria under which electronic records and electronic signatures are considered trustworthy."
    },
    "docuSignLandingUrl": {
      "type": "string",
      "description": "URL of the landing page used to create the account."
    },
    "planClassification": {
      "type": "string",
      "description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`"
    },
    "displayApplianceUrl": {
      "type": "string",
      "description": ""
    },
    "useDisplayAppliance": {
      "type": "boolean",
      "description": ""
    },
    "billingPeriodEndDate": {
      "type": "string",
      "description": "The billing period end date in UTC timedate format."
    },
    "allowTransactionRooms": {
      "type": "string",
      "description": "When **true,** the transaction rooms feature exposed through the Workspaces API is enabled."
    },
    "billingPeriodStartDate": {
      "type": "string",
      "description": "The billing period start date in UTC timedate format."
    },
    "envelopeSendingBlocked": {
      "type": "string",
      "description": "When **true,** the ability to send envelopes is blocked. When **false,** envelopes can be sent."
    },
    "displayApplianceStartUrl": {
      "type": "string",
      "description": ""
    },
    "billingPeriodDaysRemaining": {
      "type": "string",
      "description": "Number of days remaining in the current billing period."
    },
    "billingPeriodEnvelopesSent": {
      "type": "string",
      "description": "The number of envelopes that have been sent in the current billing period."
    },
    "billingPeriodEnvelopesAllowed": {
      "type": "string",
      "description": "The number of envelopes that can be sent in the current billing period (can be unlimited)."
    },
    "forgottenPasswordQuestionsCount": {
      "type": "string",
      "description": " A complex element that contains up to four Question/Answer pairs for forgotten password information for a user."
    }
  },
  "x-ds-order": "1",
  "description": "Account management",
  "x-ms-summary": "Account management",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "accountInformation"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "object",
  "properties": {
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the workspace user authorization was created."
    },
    "endDate": {
      "type": "string",
      "description": ""
    },
    "modified": {
      "type": "string",
      "description": ""
    },
    "agentUser": {
      "$ref": "#/components/schemas/authorizationUser"
    },
    "createdBy": {
      "type": "string",
      "description": ""
    },
    "startDate": {
      "type": "string",
      "description": ""
    },
    "modifiedBy": {
      "type": "string",
      "description": "The user ID (GUID) of the user who last modified this user record. This property is read-only."
    },
    "permission": {
      "type": "string",
      "description": ""
    },
    "principalUser": {
      "$ref": "#/components/schemas/authorizationUser"
    },
    "authorizationId": {
      "type": "string",
      "description": ""
    }
  },
  "x-ds-order": "100",
  "description": "Authorizations allow you to share access between users on an account.",
  "x-ms-summary": "Authorizations allow you to share access between users on an account.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "userAuthorization"
}

{
  "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."
    },
    "bccEmailArchiveHistory": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bccEmailArchiveHistory"
      },
      "description": "A list of changes to the BCC email archive configuration."
    }
  },
  "x-ds-order": "120",
  "description": "The `EmailArchive` resource provides methods for managing your email archive configuration, which consists of the BCC email address or addresses that you want to use to archive DocuSign emails. Each account can use up to five BCC email addresses for archiving purposes.\n",
  "x-ms-summary": "The `EmailArchive` resource provides methods for managing your email archive configuration, which consists of the BCC email address or addresses that you want to use to archive DocuSign emails. Each account can use up to five BCC email addresses for archiving purposes.\n",
  "x-ds-category": "EmailArchive",
  "x-ds-definition-name": "bccEmailArchiveHistoryList"
}

{
  "type": "object",
  "properties": {
    "billingPlan": {
      "$ref": "#/components/schemas/accountBillingPlan"
    },
    "taxExemptId": {
      "type": "string",
      "description": ""
    },
    "paymentMethod": {
      "type": "string",
      "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
    },
    "billingAddress": {
      "$ref": "#/components/schemas/accountAddress"
    },
    "successorPlans": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingPlan"
      },
      "description": "A list of billing plans that the current billing plan can be rolled into."
    },
    "entityInformation": {
      "$ref": "#/components/schemas/billingEntityInformationResponse"
    },
    "referralInformation": {
      "$ref": "#/components/schemas/referralInformation"
    },
    "creditCardInformation": {
      "$ref": "#/components/schemas/creditCardInformation"
    },
    "downgradePlanInformation": {
      "$ref": "#/components/schemas/downgradePlanUpdateResponse"
    },
    "downgradeRequestInformation": {
      "$ref": "#/components/schemas/downgradeRequestInformation"
    },
    "paymentProcessorInformation": {
      "$ref": "#/components/schemas/paymentProcessorInformation"
    },
    "directDebitProcessorInformation": {
      "$ref": "#/components/schemas/directDebitProcessorInformation"
    },
    "billingAddressIsCreditCardAddress": {
      "type": "string",
      "description": "When **true,** the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different."
    }
  },
  "x-ds-order": "10",
  "description": "Billing plans",
  "x-ms-summary": "Billing plans",
  "x-ds-category": "Billing",
  "x-ds-definition-name": "accountBillingPlanResponse"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "object",
  "required": [
    "file.xml"
  ],
  "properties": {
    "file.xml": {
      "type": "string",
      "format": "binary",
      "description": "Brand resource XML file."
    }
  }
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the bulk send list."
    },
    "listId": {
      "type": "string",
      "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list."
    },
    "bulkCopies": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkSendingCopy"
      },
      "description": "An array of `bulkCopy` objects. Each object represents an instance or copy of an envelope and contains details such as the recipient, custom fields, tabs, and other information."
    }
  },
  "x-ds-order": "120",
  "description": "The bulk send list resource provides methods that enable you to create and manage bulk sending lists, which you can use to send multiple copies of an envelope in a single batch. \n\n**Note:** The Bulk Send feature is only available on Business Pro and Enterprise Pro plans.",
  "x-ms-summary": "The bulk send list resource provides methods that enable you to create and manage bulk sending lists, which you can use to send multiple copies of an envelope in a single batch. \n\n**Note:** The Bulk Send feature is only available on Business Pro and Enterprise Pro plans.",
  "x-ds-category": "BulkEnvelopes",
  "x-ds-definition-name": "bulkSendingList"
}

{
  "type": "object",
  "properties": {
    "checksum": {
      "type": "string",
      "description": "A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. 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 commit action is refused."
    },
    "committed": {
      "type": "string",
      "description": "When **true,** the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests. "
    },
    "totalSize": {
      "type": "string",
      "description": "The total size of the parts of the chunked upload.\n\n**Note:** When a chunked upload is used as an envelope document, it is subject to the PDF size limit (25 MB) and page count limit that apply to all envelope documents."
    },
    "maxTotalSize": {
      "type": "string",
      "description": "The maximum total size allowed for a chunked upload. This value is configured per DocuSign environment, account, or integrator. The default value is 50 MB."
    },
    "chunkedUploadId": {
      "type": "string",
      "description": "The ID of the chunked upload. "
    },
    "chunkedUploadUri": {
      "type": "string",
      "description": "The URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests. "
    },
    "chunkedUploadParts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/chunkedUploadPart"
      },
      "description": "A list of the parts that compose the chunked upload, including their byte sizes. The list must be contiguous before you can commit the chunked upload."
    },
    "expirationDateTime": {
      "type": "string",
      "description": "The UTC time at which the chunked upload expires and is no longer addressable. \n\n**Note:** The length of time before expiration is configurable, and begins when you initiate the chunked upload. You must fully upload and use a chunked upload within this time. The default value for this duration is 20 minutes."
    },
    "maxChunkedUploadParts": {
      "type": "string",
      "description": "The maximum number of parts allowed for a chunked upload. This value is configurable per DocuSign environment, account, or integrator. The default value is 128. The maximum possible value is 256.  \n"
    }
  },
  "x-ds-order": "150",
  "description": "The ChunkedUploads resource provides methods to complete integrity checks, and to add, commit, retrieve, initiate and delete chunked uploads.",
  "x-ms-summary": "The ChunkedUploads resource provides methods to complete integrity checks, and to add, commit, retrieve, initiate and delete chunked uploads.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "chunkedUploadResponse"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique ID for the Salesforce object."
    },
    "name": {
      "type": "string",
      "description": "The name of the cloud storage item."
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/externalFile"
      },
      "description": "A list of objects that contain information about a file or folder in cloud storage."
    },
    "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. "
    },
    "errorDetails": {
      "$ref": "#/components/schemas/externalDocServiceErrorDetails"
    },
    "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."
    }
  },
  "x-ds-order": "10",
  "description": "Cloud storage",
  "x-ms-summary": "Cloud storage",
  "x-ds-category": "CloudStorage",
  "x-ds-definition-name": "externalFolder"
}

{
  "type": "object",
  "properties": {
    "storageProviders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/cloudStorageProvider"
      },
      "description": "An Array containing the storage providers associated with the user."
    }
  },
  "x-ds-order": "20",
  "description": "The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.",
  "x-ms-summary": "The CloudStorageProviders resource provides methods that allow you to manage the cloud storage providers associate with an account.",
  "x-ds-category": "CloudStorage",
  "x-ds-definition-name": "cloudStorageProviders"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique ID for the Salesforce object."
    },
    "hmac": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "read": {
      "type": "boolean",
      "description": "Indicates if the comment has been read by the target recipient of the comment."
    },
    "text": {
      "type": "string",
      "description": "Specifies the text that is shown in the dropdown list. "
    },
    "tabId": {
      "type": "string",
      "description": "The unique identifier for the tab."
    },
    "subject": {
      "type": "string",
      "description": ""
    },
    "mentions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of userIds that are mentioned directly in the body of a comment."
    },
    "threadId": {
      "type": "string",
      "description": "The unique identifier for the comment thread."
    },
    "timestamp": {
      "type": "string",
      "description": ""
    },
    "visibleTo": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "sentByEmail": {
      "type": "string",
      "description": ""
    },
    "sentByUserId": {
      "type": "string",
      "description": ""
    },
    "sentByImageId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "sentByFullName": {
      "type": "string",
      "description": ""
    },
    "sentByInitials": {
      "type": "string",
      "description": ""
    },
    "signingGroupId": {
      "type": "string",
      "description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
    },
    "signingGroupName": {
      "type": "string",
      "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. "
    },
    "sentByRecipientId": {
      "type": "string",
      "description": ""
    },
    "threadOriginatorId": {
      "type": "string",
      "description": "The userId of the user who created the thread."
    },
    "timeStampFormatted": {
      "type": "string",
      "description": ""
    }
  },
  "x-ds-order": "160",
  "description": "Details about envelope comments.",
  "x-ms-summary": "Details about envelope comments.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "comment"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the Connect configuration. The name helps identify the configuration in the list."
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `urlToPublishTo` property.\n\nSet this property when you are using the [JSON SIM event model](https://raw.githubusercontent.com). If you are instead using any of [the legacy event message formats](https://raw.githubusercontent.com), set either the `envelopeEvents` property or the `recipientEvents` property.\n\nThe [possible event statuses](/platform/webhooks/connect/improved-json-sim-event-model/#eventreference) are:\n\n* `envelope-created`\n* `envelope-sent`\n* `envelope-resent`\n* `envelope-delivered`\n* `envelope-completed`\n* `envelope-declined`\n* `envelope-voided`\n* `recipient-authenticationfailed`\n* `recipient-autoresponded`\n* `recipient-declined`\n* `recipient-delivered`\n* `recipient-completed`\n* `recipient-sent`\n* `recipient-resent`\n* `template-created`\n* `template-modified`\n* `template-deleted`\n* `envelope-corrected`\n* `envelope-purge`\n* `envelope-deleted`\n* `envelope-discard`\n* `recipient-reassign`\n* `recipient-delegate`\n* `recipient-finish-later`\n* `click-agreed`\n* `click-declined`\n"
    },
    "userIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A comma-separated list of user IDs. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener.\n\nBy default, the users will be included in the configuration. If you want to exclude the users, set the `allUsersExcept` property to **true.**\n\n**Note:** If `allUsers` is set to `false`, then you must provide a list of user IDs."
    },
    "allUsers": {
      "type": "string",
      "description": "When **true,** the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. The default value is **false.**\n\n**Note:** If this property is **false,** make sure you set the `userIds` property to a non-empty array of user IDs."
    },
    "groupIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "password": {
      "type": "string",
      "description": "The user's encrypted password hash."
    },
    "userName": {
      "type": "string",
      "description": "The name of the user."
    },
    "connectId": {
      "type": "string",
      "description": "The DocuSign-generated ID for the Connect configuration. This property is read-only."
    },
    "enableLog": {
      "type": "string",
      "description": "When **true,** Connect logging is turned on. DocuSign recommends that you enable this functionality to help troubleshoot any issues. \n\nYou can have a maximum of 100 active logs in your account. You can view the entries in active logs in the **Logs** tab in the Connect console."
    },
    "eventData": {
      "$ref": "#/components/schemas/connectEventData"
    },
    "sfObjects": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectSalesforceObject"
      },
      "description": "An array of Salesforce objects."
    },
    "disabledBy": {
      "type": "string",
      "description": ""
    },
    "includeHMAC": {
      "type": "string",
      "description": "When **true,** a Hash-based Message Authentication Code (HMAC) signature is included in messages sent through Connect.\nFor more information, see [Using HMAC Security with DocuSign Connect](https://raw.githubusercontent.com)."
    },
    "deliveryMode": {
      "type": "string",
      "description": ""
    },
    "includeOAuth": {
      "type": "string",
      "description": ""
    },
    "soapNamespace": {
      "type": "string",
      "description": "The namespace of the SOAP interface.\n\n**Note:** If `useSoapInterface` is set to **true,** you must set this value."
    },
    "allUsersExcept": {
      "type": "string",
      "description": "This flag allows you to toggle between including and excluding specified users from the configuration. When **false,** the users corresponding to the IDs in `userIds` will be included in the configuration. Conversely, when **true,** the users will be excluded from the configuration. The default value is **false.**"
    },
    "envelopeEvents": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of strings that lists envelope-related events to track through Connect. The possible event values are: \n\n- `sent`: An envelope has the status `sent` in the following scenarios:\n   - When the envelope has been sent to recipients.\n   - When using remote signing, this event is triggered when the email notification with a link to the documents is sent to at least one recipient.\n   - When using embedded signing, this event is triggered when the link is ready for the recipient to sign the envelope.\n\n   An envelope remains in this state until all recipients have viewed or taken action on the envelope.\n\n- `delivered`: This status is triggered when all recipients have opened the envelope, selected the **Continue** button in the interface, and viewed the documents.\n- `completed`: This status is triggered when all recipients have completed their assigned actions on an envelope.\n- `declined`: This status is triggered when a recipient has declined to sign the envelope.\n- `voided`: The voided status indicates that the sender has voided the envelope.\n\n**Note:** In previous versions of the API, this value was a single comma-separated string.\n"
    },
    "senderOverride": {
      "type": "string",
      "description": ""
    },
    "urlToPublishTo": {
      "type": "string",
      "description": "The endpoint to which Connect should send webhook notification messages via an HTTPS POST request. The URL must start with `https`. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not acceptable, but you can use free certificates from Let's Encrypt.\n\nThe maximum length of this property is 4096 bytes."
    },
    "recipientEvents": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of strings that lists of recipient-related events that trigger a notification\nto your webhook Connect listener. The possible event values are:\n\n- `sent`: If a recipient type is set to receive an email notification to take action on an envelope, the recipient status is set to `sent` upon delivery of the email.\n- `delivered`: The recipient has viewed the documents in the envelope. This recipient status does not indicate email delivery of the documents in the envelope.\n- `completed`: The recipient has completed their assigned actions on an envelope.\n- `declined`: The recipient has declined to sign a document in the envelope.\n- `authenticationfailed`: At least one signer has failed the authentication check on the document. If this occurs, you have two options:\n   - Send a reminder to the recipients, which provides the signer with another chance to access and pass the authentication.\n   - Correct the document and modify the authentication setting.\n- `autoresponded`: The recipient's email system sent back an automatic response. This status is only used when **Send-on-behalf-of** is turned off for the account.\n\n**Note:** In previous versions of the API, this value was a single comma-separated string.\n"
    },
    "externalFolderId": {
      "type": "string",
      "description": "The ID of an external folder."
    },
    "includeDocuments": {
      "type": "string",
      "description": "When **true,**\nConnect attaches the envelope documents\nto the payloads of your event notification messages.\n\n**Note:** Consider resources and scaling when adding documents\nto your event payloads. Documents attached to these messages\nare sent as base64 strings,\nwhich are larger than binary document data.\nThis can significantly increase your payload size,\nopening up windows for failure.\nIf you include documents,\nyou must build your application to scale in these situations."
    },
    "requireMutualTls": {
      "type": "string",
      "description": "When **true,** [Mutual TLS](https://raw.githubusercontent.com) authentication is enabled."
    },
    "useSoapInterface": {
      "type": "string",
      "description": "When **true,** indicates that the `urlToPublishTo` property contains a SOAP endpoint."
    },
    "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`."
    },
    "integratorManaged": {
      "type": "string",
      "description": ""
    },
    "salesforceAuthcode": {
      "type": "string",
      "description": ""
    },
    "externalFolderLabel": {
      "type": "string",
      "description": "The label for an external folder."
    },
    "allowEnvelopePublish": {
      "type": "string",
      "description": "When **true,** data is sent to the `urlToPublishTo` web address. The default value for this property is **false,** which will stop sending data while maintaining the Connect configuration information."
    },
    "salesforceApiVersion": {
      "type": "string",
      "description": "The version of the Salesforce API that you are using."
    },
    "includeCertSoapHeader": {
      "type": "string",
      "description": "When **true,** a certificate for a SOAP header is included in messages sent through Connect."
    },
    "includeDocumentFields": {
      "type": "string",
      "description": "When **true,** the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. "
    },
    "salesforceCallBackUrl": {
      "type": "string",
      "description": ""
    },
    "senderSelectableItems": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "This property sets the items that are available for selection when adding or editing Connect objects. "
    },
    "allowSalesforcePublish": {
      "type": "string",
      "description": "When **true,** DocuSign sends data to the designated Salesforce account through Connect. The default value is **true.**"
    },
    "requiresAcknowledgement": {
      "type": "string",
      "description": "When **true,** event delivery acknowledgements are enabled for your Connect configuration.\n\nDocuSign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back.\n\n#### When **true** and Send Individual Messages (SIM) mode is activated\n\nIf the HTTP status response to a notification message is not in the range of 200-299,\nthen the message delivery failed, and the configuration is marked as down.\n\nThe message will be queued and retried once per day.\nWhile a Connect configuration is marked down, subsequent notifications will not be tried. Instead they will be immediately queued with the reason `Pending`.\nWhen a message succeeds, all queued messages for the configuration will be tried immediately, in order.\n\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When **true** and SIM mode is not activated\n\nIf the HTTP Status response to a notification message is not in the range of 200-299,  then the message delivery failed, and the message is queued.\n\nThe message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription).  Subsequent notifications will be tried when they occur.\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When **false**\n\nWhen `requiresAcknowledgement` is set to **false** and you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually.\n\n"
    },
    "includeEnvelopeVoidReason": {
      "type": "string",
      "description": "When **true,** Connect will include the voidedReason for voided envelopes."
    },
    "includeTimeZoneInformation": {
      "type": "string",
      "description": "When **true,** Connect will include the envelope time zone information."
    },
    "includeCertificateOfCompletion": {
      "type": "string",
      "description": "When **true,** the Connect Service includes the Certificate of Completion with completed envelopes. "
    },
    "signMessageWithX509Certificate": {
      "type": "string",
      "description": "When **true,** Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. "
    },
    "includeSenderAccountasCustomField": {
      "type": "string",
      "description": "When **true,** Connect will include the sender account as Custom Field in the data."
    },
    "salesforceDocumentsAsContentFiles": {
      "type": "string",
      "description": "When **true,** DocuSign can use documents in your Salesforce account for sending and signing."
    }
  },
  "x-ds-order": "10",
  "description": "Contains information about a DocuSign Connect configuration.",
  "x-ms-summary": "Contains information about a DocuSign Connect configuration.",
  "x-ds-category": "Connect",
  "x-ds-definition-name": "connectCustomConfiguration"
}

{
  "type": "object",
  "properties": {
    "logs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectLog"
      },
      "description": "A list of Connect general logs."
    },
    "type": {
      "type": "string",
      "description": "The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`\n"
    },
    "failures": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectLog"
      },
      "description": "A list of Connect failure logs."
    },
    "totalRecords": {
      "type": "string",
      "description": "The count of records in the log list."
    }
  },
  "x-ds-order": "20",
  "description": "Connect event logging information. This object contains sections for regular Connect logs and for Connect failures. ",
  "x-ms-summary": "Connect event logging information. This object contains sections for regular Connect logs and for Connect failures. ",
  "x-ds-category": "Connect",
  "x-ds-definition-name": "connectLogs"
}

{
  "type": "object",
  "properties": {
    "logs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectLog"
      },
      "description": "A list of Connect general logs."
    },
    "type": {
      "type": "string",
      "description": "The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`\n"
    },
    "failures": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectLog"
      },
      "description": "A list of Connect failure logs."
    },
    "totalRecords": {
      "type": "string",
      "description": "The count of records in the log list."
    }
  },
  "x-ds-order": "50",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Connect",
  "x-ds-definition-name": "connectLogs"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the contact."
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The email address or addresses associated with the contact."
    },
    "shared": {
      "type": "string",
      "description": "When **true,** the contact is shared. For more information, see [Shared Contacts](https://support.docusign.com/s/document-item?bundleId=jux1643235969954&topicId=twh1578456324503.html).\n\n**Note:** The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact:\n\n- Sending an envelope by using SMS\n- Using phone authentication\n\nYou must ask the user who added the contact for the phone number and then manually enter it into the authentication box."
    },
    "isOwner": {
      "type": "boolean",
      "description": "When **true,** the current user is the owner of the contact."
    },
    "contactId": {
      "type": "string",
      "description": "The ID of a contact person in the account's address book."
    },
    "contactUri": {
      "type": "string",
      "description": "The URI for retrieving information about the contact."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "organization": {
      "type": "string",
      "description": "The name of the contact's organization."
    },
    "signingGroup": {
      "type": "string",
      "description": "If the contact belongs to a signing group, this property contains the `signingGroupId`."
    },
    "cloudProvider": {
      "type": "string",
      "description": "The cloud service that provided the contact. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)\n\n<!-- Future:\n\n- `Box`\n- `GoogleDrive`\n- `Dropbox`\n- `SalesForce`\n- `SkyDrive`\n\n-->"
    },
    "roomContactType": {
      "type": "string",
      "description": ""
    },
    "signingGroupName": {
      "type": "string",
      "description": "The name of the signing group that the contact belongs to."
    },
    "contactPhoneNumbers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contactPhoneNumber"
      },
      "description": "A list of the contact's phone numbers.\n\n**Note:** The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact:\n\n- Sending an envelope by using SMS\n- Using phone authentication\n\nYou must ask the user who added the contact for the phone number and then manually enter it into the authentication box."
    },
    "notaryContactDetails": {
      "$ref": "#/components/schemas/notaryContactDetails"
    },
    "cloudProviderContainerId": {
      "type": "string",
      "description": "The ID of the container at the cloud provider. For example, this might be the room ID for a DocuSign Transaction Room."
    }
  },
  "x-ds-order": "50",
  "description": "The `Contacts` resource enables you to manage the contact in an account's address book.",
  "x-ms-summary": "The `Contacts` resource enables you to manage the contact in an account's address book.",
  "x-ds-category": "Users",
  "x-ds-definition-name": "contact"
}

{
  "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 custom tab."
    },
    "type": {
      "type": "string",
      "description": "The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "If the tab is a list, this represents the values that are possible for the tab."
    },
    "width": {
      "type": "string",
      "description": "The width of the tab in pixels.\nMust be an integer."
    },
    "anchor": {
      "type": "string",
      "description": "An optional string that is used to auto-match tabs to strings located in the documents of an envelope."
    },
    "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."
    },
    "editable": {
      "type": "string",
      "description": "When **true,** the custom tab is editable. Otherwise the custom tab cannot be modified."
    },
    "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."
    },
    "selected": {
      "type": "string",
      "description": "When **true,** the radio button is selected."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "underline": {
      "type": "string",
      "description": "When **true,** the information in the tab is underlined."
    },
    "mergeField": {
      "$ref": "#/components/schemas/mergeField"
    },
    "requireAll": {
      "type": "string",
      "description": "When **true** and shared is true, information must be entered in this field to complete the envelope. "
    },
    "scaleValue": {
      "type": "string",
      "description": "Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size."
    },
    "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 property can only be used when adding new tabs for a recipient. When used, the new tab inherits all of the custom tab properties."
    },
    "initialValue": {
      "type": "string",
      "description": "The original value of the tab."
    },
    "lastModified": {
      "type": "string",
      "description": "The UTC DateTime this object was last modified. This is in ISO 8601 format."
    },
    "localePolicy": {
      "$ref": "#/components/schemas/localePolicyTab"
    },
    "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"
    },
    "collaborative": {
      "type": "string",
      "description": ""
    },
    "maximumLength": {
      "type": "string",
      "description": "The maximum number of entry characters supported by the custom tab."
    },
    "numericalValue": {
      "type": "string",
      "description": ""
    },
    "validationType": {
      "type": "string",
      "description": "Specifies how numerical data is validated. Valid values:\n\n- `number`\n- `currency`\n"
    },
    "createdByUserId": {
      "type": "string",
      "description": "The userId of the DocuSign user who created this object."
    },
    "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."
    },
    "includedInEmail": {
      "type": "string",
      "description": "When **true,** the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs."
    },
    "paymentItemCode": {
      "type": "string",
      "description": "If the custom tab is for a payment request, this is the external code for the item associated with the charge. For example, this might be your product id.\n\nExample: `SHAK1`\n\nMaximum Length: 100 characters."
    },
    "paymentItemName": {
      "type": "string",
      "description": "If the custom tab is for a payment request, this is the name of the item associated with the charge.\n\nMaximum Length: 100 characters.\n\nExample: `Hamlet`"
    },
    "maxNumericalValue": {
      "type": "string",
      "description": ""
    },
    "minNumericalValue": {
      "type": "string",
      "description": ""
    },
    "stampTypeMetadata": {
      "$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."
    },
    "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/"
    },
    "signatureProviderId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "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"
    },
    "createdByDisplayName": {
      "type": "string",
      "description": "The user name of the DocuSign user who created this object."
    },
    "lastModifiedByUserId": {
      "type": "string",
      "description": "The userId of the DocuSign user who last modified this object."
    },
    "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."
    },
    "paymentItemDescription": {
      "type": "string",
      "description": "If the custom tab is for a payment request, this is the description of the item associated with the charge.\n\nExample: `The Danish play by Shakespeare`\n\nMaximum Length: 100 characters."
    },
    "anchorIgnoreIfNotPresent": {
      "type": "string",
      "description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
    },
    "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"
    },
    "lastModifiedByDisplayName": {
      "type": "string",
      "description": "The User Name of the DocuSign user who last modified this object."
    },
    "requireInitialOnSharedChange": {
      "type": "string",
      "description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field."
    }
  },
  "x-ds-order": "10",
  "description": "Custom tabs",
  "x-ms-summary": "Custom tabs",
  "x-ds-category": "CustomTabs",
  "x-ds-definition-name": "tabMetadata"
}

{
  "type": "object",
  "properties": {
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "docGenFormFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/docGenFormFields"
      },
      "description": ""
    }
  },
  "x-ds-order": "100",
  "description": "Document Generation for eSignature allows you to\ndynamically generate\ndocuments from a Word template to send for\nsignature within the eSignature sending workflow.",
  "x-ms-summary": "Document Generation for eSignature allows you to\ndynamically generate\ndocuments from a Word template to send for\nsignature within the eSignature sending workflow.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "docGenFormFieldResponse"
}

{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentHtmlDefinitionOriginal"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "x-ds-order": "100",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "documentHtmlDefinitionOriginals"
}

{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "x-ds-order": "230",
  "description": "This resource is used to create a responsive preview of a specific document.",
  "x-ms-summary": "This resource is used to create a responsive preview of a specific document.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "documentHtmlDefinitions"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "object",
  "properties": {
    "apiKey": {
      "type": "string",
      "description": ""
    },
    "password": {
      "type": "string",
      "description": "The user's encrypted password hash."
    },
    "userName": {
      "type": "string",
      "description": "The name of the user."
    },
    "organization": {
      "type": "string",
      "description": ""
    },
    "eNoteConfigured": {
      "type": "string",
      "description": ""
    },
    "connectConfigured": {
      "type": "string",
      "description": ""
    }
  },
  "x-ds-order": "110",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "eNoteConfiguration"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the attachment."
    },
    "label": {
      "type": "string",
      "description": "A label for the attachment. Potential values include: \n\n- `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.\n- `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property. "
    },
    "attachmentId": {
      "type": "string",
      "description": "The unique identifier for the attachment."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "accessControl": {
      "type": "string",
      "description": "Valid values are `sender` and `senderAndAllRecipients`."
    },
    "attachmentType": {
      "type": "string",
      "description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`"
    }
  },
  "x-ds-order": "60",
  "description": "The EnvelopeAttachments resource provides methods that allow you to\nassociate files with an envelope.",
  "x-ms-summary": "The EnvelopeAttachments resource provides methods that allow you to\nassociate files with an envelope.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "envelopeAttachment"
}

{
  "type": "object",
  "properties": {
    "pdfId": {
      "type": "string",
      "description": "**Deprecated.** \n\nThe `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. "
    },
    "custom": {
      "type": "string",
      "description": "When **true,** indicates that the consumer disclosure is a custom disclosure. The default is **false.**"
    },
    "useBrand": {
      "type": "string",
      "description": "When **true,** specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience.  \n\nWhen **false** (default), or if the signing brand does not specify a company name, the account name is used instead.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. "
    },
    "esignText": {
      "type": "string",
      "description": "The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting.\n\n**Note:** If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting."
    },
    "changeEmail": {
      "type": "string",
      "description": "If the customer needs to change their email address, this is the email address to which they should the change request."
    },
    "companyName": {
      "type": "string",
      "description": "Specifies the company name used in the disclosure. The default value is the account name.\n\nHowever, if your account uses signing brands that specify a company name, you can substitute the brand's company name by setting the `useBrand` property to **true.** Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true.**\n"
    },
    "enableEsign": {
      "type": "string",
      "description": "When **true** (default), indicates that eSign is enabled."
    },
    "companyPhone": {
      "type": "string",
      "description": "The phone number of the company associated with the consumer disclosure, as a free-formatted string."
    },
    "languageCode": {
      "type": "string",
      "description": "The simple type enumeration for the language to use when displaying the disclosure. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`."
    },
    "withdrawCity": {
      "type": "string",
      "description": "Contains the city of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 50 characters. "
    },
    "withdrawEmail": {
      "type": "string",
      "description": "Contains the email address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawOther": {
      "type": "string",
      "description": "Contains any other information needed to withdraw consent.\n\nMaximum length: 255 characters.\n\nExample:\n\n`We do not need any other information from you to withdraw consent.`"
    },
    "withdrawPhone": {
      "type": "string",
      "description": "Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string.\n\nMaximum length: 20 characters. "
    },
    "withdrawState": {
      "type": "string",
      "description": "Contains the state of the postal address to which a customer can send a consent withdrawal notification.\n\nExample: `PA`"
    },
    "accountEsignId": {
      "type": "string",
      "description": "The GUID of the account associated with the consumer disclosure."
    },
    "esignAgreement": {
      "type": "string",
      "description": "The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting."
    },
    "withdrawByMail": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw consent by postal mail. The default is **false.**"
    },
    "allowCDWithdraw": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false.**\n**Note:** Only Admin users can change this setting."
    },
    "copyCostPerPage": {
      "type": "string",
      "description": "The cost per page if the customer requests paper copies.\n\nExample: \n\n`0.0000`"
    },
    "withdrawByEmail": {
      "type": "string",
      "description": "When **true** (default), indicates that the customer can withdraw consent by email."
    },
    "withdrawByPhone": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw consent by phone. The default is **false.**"
    },
    "changeEmailOther": {
      "type": "string",
      "description": "Other information about the requirements for the user to change their email address.\n\nExample: \n\n`We do not require any other information from you to change your email address.`"
    },
    "copyRequestEmail": {
      "type": "string",
      "description": "The email address to which the customer should send a request for copies of a document.\n\nMaximum length: 100 characters."
    },
    "mustAgreeToEsign": {
      "type": "string",
      "description": "When **true,** the  recipient must agree to the consumer disclosure. The value of this property is read-only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions."
    },
    "withdrawPostalCode": {
      "type": "string",
      "description": "Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 20 characters. "
    },
    "withdrawAddressLine1": {
      "type": "string",
      "description": "Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawAddressLine2": {
      "type": "string",
      "description": "Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawConsequences": {
      "type": "string",
      "description": "Text indicating the consequences of withdrawing consent.\n\nMaximum length: 255 characters."
    },
    "allowCDWithdrawMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "copyFeeCollectionMethod": {
      "type": "string",
      "description": "Specifies the fee collection method for cases in which the customer requires paper copies of the document.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We will bill you for any fees at that time, if any.`"
    },
    "useConsumerDisclosureWithinAccount": {
      "type": "string",
      "description": "When **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement."
    },
    "useConsumerDisclosureWithinAccountMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "x-ds-order": "90",
  "description": "Details about envelope consumer disclosures.",
  "x-ms-summary": "Details about envelope consumer disclosures.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "consumerDisclosure"
}

{
  "type": "object",
  "properties": {
    "listCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/listCustomField"
      },
      "description": "An array of list custom fields."
    },
    "textCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/textCustomField"
      },
      "description": "An array of text custom fields."
    }
  },
  "x-ds-order": "70",
  "description": "An envelope custom field enables you to collect custom data about envelopes on a per-envelope basis. You can then use the custom data for sorting, organizing, searching, and other downstream processes. For example, you can use custom fields to copy envelopes or data to multiple areas in Salesforce. eOriginal customers can eVault their documents from the web app on a per-envelope basis by setting an envelope custom field with a name like \"eVault with eOriginal?\" to \"Yes\" or \"No\".\n\nWhen a user creates an envelope, the envelope custom fields display in the **Envelope Settings** section of the DocuSign console. Envelope recipients do not see the envelope custom fields. For more information, see [Envelope Custom Fields](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=qor1583277385137.html).",
  "x-ms-summary": "An envelope custom field enables you to collect custom data about envelopes on a per-envelope basis. You can then use the custom data for sorting, organizing, searching, and other downstream processes. For example, you can use custom fields to copy envelopes or data to multiple areas in Salesforce. eOriginal customers can eVault their documents from the web app on a per-envelope basis by setting an envelope custom field with a name like \"eVault with eOriginal?\" to \"Yes\" or \"No\".\n\nWhen a user creates an envelope, the envelope custom fields display in the **Envelope Settings** section of the DocuSign console. Envelope recipients do not see the envelope custom fields. For more information, see [Envelope Custom Fields](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=qor1583277385137.html).",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "customFields"
}

{
  "type": "object",
  "properties": {
    "documentFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements: \n\n* name - A string that can be a maximum of 50 characters. \n* value - A string that can be a maximum of 200 characters.\n\n*IMPORTANT*: If you are using xml, the name/value pair is contained in a nameValue element. \n"
    }
  },
  "x-ds-order": "60",
  "description": "Envelope document fields",
  "x-ms-summary": "Envelope document fields",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "documentFieldsInformation"
}

{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentHtmlDefinitionOriginal"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "x-ds-order": "220",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "documentHtmlDefinitionOriginals"
}

{
  "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/"
    }
  },
  "x-ds-order": "50",
  "description": "Document tabs are tabs that are associated with a document rather than with a recipient.",
  "x-ms-summary": "Document tabs are tabs that are associated with a document rather than with a recipient.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "tabs"
}

{
  "type": "object",
  "properties": {
    "documentVisibility": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentVisibility"
      },
      "description": "An array of `documentVisibility` objects that specifies which documents are visible to which recipients."
    }
  },
  "x-ds-order": "170",
  "description": "Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.\n\n**Note:** Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=eui1578456411411.html).",
  "x-ms-summary": "Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.\n\n**Note:** Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=eui1578456411411.html).",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "documentVisibilityList"
}

{
  "type": "object",
  "properties": {
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "envelopeDocuments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeDocument"
      },
      "description": "An array of document objects."
    }
  },
  "x-ds-order": "40",
  "description": "Envelope documents",
  "x-ms-summary": "Envelope documents",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "envelopeDocumentsResult"
}

{
  "type": "object",
  "properties": {
    "bccEmailAddresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bccEmailAddress"
      },
      "description": "An array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters.\n\nWhile this property is an array, note that it takes only a single email address.\n\n**Note:** Only users with the `canManageAccount` setting set to **true** can use this option. \n\nDocuSign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. \n\n**Example:** if your account has BCC for Email Archive set up for the email address archive@mycompany.com and you send an envelope using the BCC Email Override to send a BCC email to salesarchive@mycompany.com, then a copy of the envelope is only sent to the salesarchive@mycompany.com email address."
    },
    "replyEmailNameOverride": {
      "type": "string",
      "description": "The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters."
    },
    "replyEmailAddressOverride": {
      "type": "string",
      "description": "The Reply To email address to use for email replies, instead of the one that is configured at the account level. DocuSign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters."
    }
  },
  "x-ds-order": "30",
  "description": "Envelope email settings",
  "x-ms-summary": "Envelope email settings",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "emailSettings"
}

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Indicates the envelope status. Valid values are:\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n"
    },
    "formData": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/formDataItem"
      },
      "description": "An array of form data objects."
    },
    "envelopeId": {
      "type": "string",
      "description": "The ID of the envelope."
    },
    "emailSubject": {
      "type": "string",
      "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.\n"
    },
    "sentDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the envelope was sent. This property is read-only."
    },
    "prefillFormData": {
      "$ref": "#/components/schemas/prefillFormData"
    },
    "recipientFormData": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientFormData"
      },
      "description": "An array of form data objects that are associated with specific recipients."
    }
  },
  "x-ds-order": "160",
  "description": "This object contains the data that recipients have entered into the form fields associated with an envelope.",
  "x-ms-summary": "This object contains the data that recipients have entered into the form fields associated with an envelope.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "envelopeFormData"
}

{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentHtmlDefinitionOriginal"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "x-ds-order": "240",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "documentHtmlDefinitionOriginals"
}

{
  "type": "object",
  "properties": {
    "lockType": {
      "type": "string",
      "description": "The type of lock.  Currently `edit` is the only supported type."
    },
    "lockToken": {
      "type": "string",
      "description": "A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock."
    },
    "lockedByApp": {
      "type": "string",
      "description": "The human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "lockedByUser": {
      "$ref": "#/components/schemas/userInfo"
    },
    "useScratchPad": {
      "type": "string",
      "description": "When **true,** a scratchpad is used to edit information.\n "
    },
    "lockedUntilDateTime": {
      "type": "string",
      "description": "The date and time that the lock expires."
    },
    "lockDurationInSeconds": {
      "type": "string",
      "description": "\nThe number of seconds until the lock expires when there is no activity on the envelope.\n\nThe default value is 300 seconds. The maximum value is 1,800 seconds.\n\nThe lock duration can be extended.\n"
    }
  },
  "x-ds-order": "80",
  "description": "Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope.\n",
  "x-ms-summary": "Envelope locks let you lock an envelope to prevent any changes while you are updating an envelope.\n",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "lockInformation"
}

{
  "type": "object",
  "properties": {
    "errorCount": {
      "type": "string",
      "description": ""
    },
    "resultsUri": {
      "type": "string",
      "description": ""
    },
    "envelopeCount": {
      "type": "string",
      "description": ""
    },
    "submissionDate": {
      "type": "string",
      "description": ""
    },
    "fileLevelErrors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "processingStatus": {
      "type": "string",
      "description": ""
    },
    "submittedByUserInfo": {
      "$ref": "#/components/schemas/userInfo"
    },
    "applyConnectSettings": {
      "type": "string",
      "description": ""
    },
    "processedEnvelopeCount": {
      "type": "string",
      "description": ""
    },
    "envelopeLevelErrorRollups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopePublishTransactionErrorRollup"
      },
      "description": ""
    },
    "envelopePublishTransactionId": {
      "type": "string",
      "description": ""
    },
    "noActionRequiredEnvelopeCount": {
      "type": "string",
      "description": ""
    },
    "submittedForPublishingEnvelopeCount": {
      "type": "string",
      "description": ""
    }
  },
  "x-ds-order": "100",
  "description": "The EnvelopePublish resource allows you to submit existing envelopes to any webhook.\n",
  "x-ms-summary": "The EnvelopePublish resource allows you to submit existing envelopes to any webhook.\n",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "envelopePublishTransaction"
}

{
  "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/"
    }
  },
  "x-ds-order": "50",
  "description": "All of the tabs associated with a recipient. Each property is a list of a type of tab.\n",
  "x-ms-summary": "All of the tabs associated with a recipient. Each property is a list of a type of tab.\n",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "tabs"
}

{
  "type": "object",
  "properties": {
    "seals": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/sealSign"
      },
      "description": "A list of electronic seals to apply to documents."
    },
    "agents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/agent"
      },
      "description": "A list of agent recipients assigned to the documents."
    },
    "editors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/editor"
      },
      "description": "A list of users who can edit the envelope."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signer"
      },
      "description": "A list of signers on the envelope."
    },
    "notaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/notaryRecipient"
      },
      "description": "A list of notary recipients on the envelope."
    },
    "witnesses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/witness"
      },
      "description": "A list of signers who act as witnesses on the envelope."
    },
    "carbonCopies": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/carbonCopy"
      },
      "description": "A list of carbon copy recipients assigned to the documents."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "participants": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/participant"
      },
      "description": ""
    },
    "intermediaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/intermediary"
      },
      "description": "Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added)."
    },
    "recipientCount": {
      "type": "string",
      "description": "The number of recipients in the envelope."
    },
    "inPersonSigners": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/inPersonSigner"
      },
      "description": "Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected."
    },
    "certifiedDeliveries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/certifiedDelivery"
      },
      "description": "A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents."
    },
    "currentRoutingOrder": {
      "type": "string",
      "description": "The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions."
    }
  },
  "x-ds-order": "20",
  "description": "Envelope recipients",
  "x-ms-summary": "Envelope recipients",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "recipients"
}

{
  "type": "object",
  "properties": {
    "templates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/templateSummary"
      },
      "description": "An array of `templateSummary` objects that contain information about templates."
    }
  },
  "x-ds-order": "85",
  "description": "Envelope templates",
  "x-ms-summary": "Envelope templates",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "templateInformation"
}

{
  "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."
    },
    "envelopeTransferRules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeTransferRule"
      },
      "description": "Contains information about a specific envelope transfer rule."
    }
  },
  "x-ds-order": "120",
  "description": "This resource provides methods that enable account administrators to create and manage envelope transfer rules.",
  "x-ms-summary": "This resource provides methods that enable account administrators to create and manage envelope transfer rules.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "envelopeTransferRuleInformation"
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The view URL to be navigated to."
    }
  },
  "x-ds-order": "1",
  "description": "Provides a URL that you can embed in your application\nto provide access to the DocuSign UI.\n\n### Related topics\n\n- [Embedded signing and sending](https://raw.githubusercontent.com)\n- [Send an envelope via your app](https://raw.githubusercontent.com)\n- [Introducing customizable embedded sending](https://www.docusign.com/blog/developers/introducing-customizable-embedded-sending)\n\n",
  "x-ms-summary": "Provides a URL that you can embed in your application\nto provide access to the DocuSign UI.\n\n### Related topics\n\n- [Embedded signing and sending](https://raw.githubusercontent.com)\n- [Send an envelope via your app](https://raw.githubusercontent.com)\n- [Introducing customizable embedded sending](https://www.docusign.com/blog/developers/introducing-customizable-embedded-sending)\n\n",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "viewUrl"
}

{
  "type": "object",
  "properties": {
    "resumeDate": {
      "type": "string",
      "description": ""
    },
    "workflowSteps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/workflowStep"
      },
      "description": ""
    },
    "workflowStatus": {
      "type": "string",
      "description": ""
    },
    "scheduledSending": {
      "$ref": "#/components/schemas/scheduledSending"
    },
    "currentWorkflowStepId": {
      "type": "string",
      "description": ""
    }
  },
  "x-ds-order": "300",
  "description": "Describes the workflow for an envelope or template.",
  "x-ms-summary": "Describes the workflow for an envelope or template.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "workflow"
}

{
  "type": "object",
  "properties": {
    "holder": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "sender": {
      "$ref": "#/components/schemas/userInfo"
    },
    "status": {
      "type": "string",
      "description": "* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n"
    },
    "brandId": {
      "type": "string",
      "description": "The ID of the brand."
    },
    "folders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folder"
      },
      "description": "A list of folder objects."
    },
    "location": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "workflow": {
      "$ref": "#/components/schemas/workflow"
    },
    "anySigner": {
      "type": "string",
      "description": "Deprecated. This feature has been replaced by signing groups."
    },
    "brandLock": {
      "type": "string",
      "description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope."
    },
    "powerForm": {
      "$ref": "#/components/schemas/powerForm"
    },
    "emailBlurb": {
      "type": "string",
      "description": "This is the same as the email body. If specified it is included in the email body for all envelope recipients."
    },
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "hasWavFile": {
      "type": "string",
      "description": "When **true,** indicates that a .wav file used for voice authentication is included in the envelope. "
    },
    "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"
    },
    "recipients": {
      "$ref": "#/components/schemas/EnvelopeRecipients"
    },
    "allowMarkup": {
      "type": "string",
      "description": "When **true,** the Document Markup feature is enabled.\n\n**Note:**  To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.\n"
    },
    "envelopeUri": {
      "type": "string",
      "description": "The URI for retrieving the envelope or envelopes."
    },
    "expireAfter": {
      "type": "string",
      "description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
    },
    "hasComments": {
      "type": "string",
      "description": "When **true,** indicates that users have added comments to the envelope."
    },
    "messageLock": {
      "type": "string",
      "description": "When **true,** prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope."
    },
    "asynchronous": {
      "type": "string",
      "description": "When **true,** the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n\n**Note:** A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](https://raw.githubusercontent.com) or by checking the\nConnect notification."
    },
    "customFields": {
      "$ref": "#/components/schemas/AccountCustomFields"
    },
    "documentsUri": {
      "type": "string",
      "description": "The URI for retrieving all of the documents associated with the envelope as separate files."
    },
    "emailSubject": {
      "type": "string",
      "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.\n"
    },
    "notification": {
      "$ref": "#/components/schemas/notification"
    },
    "sentDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the envelope was sent. This property is read-only."
    },
    "templatesUri": {
      "type": "string",
      "description": "The URI for retrieving the templates."
    },
    "voidedReason": {
      "type": "string",
      "description": "The reason the envelope or template was voided.\n\n**Note:** The string is truncated to the first 200 characters.\n"
    },
    "allowComments": {
      "type": "string",
      "description": "When **true,** users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document."
    },
    "allowReassign": {
      "type": "string",
      "description": "When **true,** the recipient can redirect an envelope to a more appropriate recipient."
    },
    "emailSettings": {
      "$ref": "#/components/schemas/emailSettings"
    },
    "enableWetSign": {
      "type": "string",
      "description": "When **true,** the signer is allowed to print the document and sign it on paper."
    },
    "expireEnabled": {
      "type": "string",
      "description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
    },
    "is21CFRPart11": {
      "type": "string",
      "description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."
    },
    "recipientsUri": {
      "type": "string",
      "description": "Contains a URI for an endpoint that you can use to retrieve the recipients."
    },
    "transactionId": {
      "type": "string",
      "description": " Used to identify an envelope. The ID is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned."
    },
    "useDisclosure": {
      "type": "string",
      "description": "When **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **false,** the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information."
    },
    "attachmentsUri": {
      "type": "string",
      "description": "Contains a URL for retrieving the attachments that are associated with the envelope."
    },
    "autoNavigation": {
      "type": "string",
      "description": "When **true,** autonavigation is set for the recipient.\n"
    },
    "certificateUri": {
      "type": "string",
      "description": "The URI for retrieving certificate information."
    },
    "documentBase64": {
      "type": "string",
      "description": "The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding."
    },
    "expireDateTime": {
      "type": "string",
      "description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
    },
    "recipientsLock": {
      "type": "string",
      "description": "When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope."
    },
    "statusDateTime": {
      "type": "string",
      "description": "The DateTime that the envelope changed status (i.e. was created or sent.)"
    },
    "voidedDateTime": {
      "type": "string",
      "description": "The date and time the envelope or template was voided."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the item was created."
    },
    "customFieldsUri": {
      "type": "string",
      "description": "The URI for retrieving custom fields."
    },
    "deletedDateTime": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "lockInformation": {
      "$ref": "#/components/schemas/EnvelopeLocks"
    },
    "notificationUri": {
      "type": "string",
      "description": "The URI for retrieving notifications."
    },
    "signingLocation": {
      "type": "string",
      "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`."
    },
    "allowViewHistory": {
      "type": "string",
      "description": "When **true,** recipients can view the history of the envelope."
    },
    "declinedDateTime": {
      "type": "string",
      "description": "The date and time the recipient declined the document. This property is read-only."
    },
    "envelopeLocation": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "envelopeMetadata": {
      "$ref": "#/components/schemas/envelopeMetadata"
    },
    "purgeRequestDate": {
      "type": "string",
      "description": "The date that a purge was requested."
    },
    "authoritativeCopy": {
      "type": "string",
      "description": "When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"
    },
    "completedDateTime": {
      "type": "string",
      "description": "Specifies the date and time this item was completed."
    },
    "copyRecipientData": {
      "type": "string",
      "description": ""
    },
    "deliveredDateTime": {
      "type": "string",
      "description": "The date and time that the envelope was delivered to the recipient. This property is read-only."
    },
    "envelopeDocuments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeDocument"
      },
      "description": "An array containing information about the documents that are included in the envelope."
    },
    "isDynamicEnvelope": {
      "type": "string",
      "description": "When **true,** indicates that the envelope is a dynamic envelope."
    },
    "burnDefaultTabData": {
      "type": "string",
      "description": ""
    },
    "envelopeIdStamping": {
      "type": "string",
      "description": "When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed."
    },
    "externalEnvelopeId": {
      "type": "string",
      "description": "May contain an external identifier for the envelope."
    },
    "hasFormDataChanged": {
      "type": "string",
      "description": "Specifies if the `EnvelopeFormData` associated with any forms in the envelope has changed."
    },
    "purgeCompletedDate": {
      "type": "string",
      "description": "The date that a purge was completed."
    },
    "envelopeAttachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/attachment"
      },
      "description": "An array of attachment objects that provide information about the attachments that are associated with the envelope."
    },
    "initialSentDateTime": {
      "type": "string",
      "description": "The date and time the envelope was initially sent."
    },
    "documentsCombinedUri": {
      "type": "string",
      "description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file."
    },
    "lastModifiedDateTime": {
      "type": "string",
      "description": "The date and time that the item was last modified."
    },
    "signerCanSignOnMobile": {
      "type": "string",
      "description": "When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "statusChangedDateTime": {
      "type": "string",
      "description": "The data and time that the status changed."
    },
    "envelopeCustomMetadata": {
      "$ref": "#/components/schemas/envelopeCustomMetadata"
    },
    "accessControlListBase64": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "enforceSignerVisibility": {
      "type": "string",
      "description": "When **true,** signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by 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 by using this setting when an envelope is sent.\n\n**Note:** To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true.**\n\n[docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/"
    },
    "authoritativeCopyDefault": {
      "type": "string",
      "description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`."
    },
    "disableResponsiveDocument": {
      "type": "string",
      "description": "When **true,** responsive documents are disabled for the envelope."
    },
    "isSignatureProviderEnvelope": {
      "type": "string",
      "description": "When **true,** indicates that the envelope is a signature-provided envelope."
    }
  },
  "x-ds-order": "10",
  "description": "Envelope creation, management",
  "x-ms-summary": "Envelope creation, management",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "envelope"
}

{
  "type": "object",
  "properties": {
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "favoriteTemplates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/favoriteTemplatesContentItem"
      },
      "description": ""
    },
    "templatesUpdatedCount": {
      "type": "integer",
      "format": "int32",
      "description": "The number of templates successfully updated by the call. This property is read-only."
    }
  },
  "x-ds-order": "270",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "favoriteTemplatesInfo"
}

{
  "type": "object",
  "properties": {
    "folders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folder"
      },
      "description": "A list of folder objects."
    },
    "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. "
    },
    "envelopes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeSummary"
      },
      "description": "A list of envelopes in this folder."
    },
    "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."
    }
  },
  "x-ds-order": "10",
  "description": "Folders allow you to organize envelopes and templates.",
  "x-ms-summary": "Folders allow you to organize envelopes and templates.",
  "x-ds-category": "Folders",
  "x-ds-definition-name": "foldersResponse"
}

{
  "type": "object",
  "properties": {
    "brandOptions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/brand"
      },
      "description": "A list of brands."
    },
    "senderBrandIdDefault": {
      "type": "string",
      "description": "The brand that envelope senders see when a brand is not explicitly set."
    },
    "recipientBrandIdDefault": {
      "type": "string",
      "description": "The brand that envelope recipients see when a brand is not explicitly set."
    }
  },
  "x-ds-order": "30",
  "description": "If your account includes multiple signing brands, you can use the groups functionality to assign different brands to different groups. This resource enables you to manage group brands.",
  "x-ms-summary": "If your account includes multiple signing brands, you can use the groups functionality to assign different brands to different groups. This resource enables you to manage group brands.",
  "x-ds-category": "UserGroups",
  "x-ds-definition-name": "brandsResponse"
}

{
  "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."
    },
    "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."
    }
  },
  "x-ds-order": "20",
  "description": "Groups' users",
  "x-ms-summary": "Groups' users",
  "x-ds-category": "UserGroups",
  "x-ds-definition-name": "usersResponse"
}

{
  "type": "object",
  "properties": {
    "groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/group"
      },
      "description": "A collection group objects containing information about the groups."
    },
    "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."
    }
  },
  "x-ds-order": "10",
  "description": "Group information",
  "x-ms-summary": "Group information",
  "x-ds-category": "UserGroups",
  "x-ds-definition-name": "groupInformation"
}

{
  "type": "object",
  "properties": {
    "identityVerification": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/accountIdentityVerificationWorkflow"
      },
      "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](https://raw.githubusercontent.com) method in the [IdentityVerifications](https://raw.githubusercontent.com) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)."
    }
  },
  "x-ds-order": "30",
  "description": "Identity Verification enables you to verify a signer's identity before they can access a document. The `IdentityVerifications` resource provides a method that enables you to list the workflows that are available to an account.",
  "x-ms-summary": "Identity Verification enables you to verify a signer's identity before they can access a document. The `IdentityVerifications` resource provides a method that enables you to list the workflows that are available to an account.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "accountIdentityVerificationResponse"
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "balance": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "dueDate": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "invoiceId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "invoiceUri": {
      "type": "string",
      "description": "Contains a URI for an endpoint that you can use to retrieve invoice information."
    },
    "invoiceItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingInvoiceItem"
      },
      "description": "Reserved for DocuSign."
    },
    "pdfAvailable": {
      "type": "string",
      "description": ""
    },
    "invoiceNumber": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "taxableAmount": {
      "type": "string",
      "description": ""
    },
    "nonTaxableAmount": {
      "type": "string",
      "description": ""
    }
  },
  "x-ds-order": "20",
  "description": "Invoices",
  "x-ms-summary": "Invoices",
  "x-ds-category": "Billing",
  "x-ds-definition-name": "billingInvoice"
}

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "string",
      "description": ""
    },
    "userInfo": {
      "$ref": "#/components/schemas/userInformation"
    },
    "searchable": {
      "type": "string",
      "description": ""
    },
    "createdDate": {
      "type": "string",
      "description": "The creation date of the account in UTC timedate format."
    }
  },
  "x-ds-order": "280",
  "description": "Use DocuSign eNotary to notarize documents digitally.\nCheck the [DocuSign eNotary support documentation](https://support.docusign.com/s/document-item?bundleId=gko1642535666104&topicId=jiv1635359045452.html)\nto see which jurisdictions are supported.\n",
  "x-ms-summary": "Use DocuSign eNotary to notarize documents digitally.\nCheck the [DocuSign eNotary support documentation](https://support.docusign.com/s/document-item?bundleId=gko1642535666104&topicId=jiv1635359045452.html)\nto see which jurisdictions are supported.\n",
  "x-ds-category": "Notary",
  "x-ds-definition-name": "notary"
}

{
  "type": "object",
  "properties": {
    "signerName": {
      "type": "string",
      "description": "The in-person signer's full legal name.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n"
    },
    "createdDate": {
      "type": "string",
      "description": "The creation date of the account in UTC timedate format."
    },
    "documentName": {
      "type": "string",
      "description": ""
    },
    "jurisdiction": {
      "$ref": "#/components/schemas/jurisdiction"
    },
    "notaryJournalId": {
      "type": "string",
      "description": ""
    },
    "notaryJournalMetaData": {
      "$ref": "#/components/schemas/notaryJournalMetaData"
    }
  },
  "x-ds-order": "220",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "notaryJournal"
}

{
  "type": "object",
  "properties": {
    "county": {
      "type": "string",
      "description": ""
    },
    "sealType": {
      "type": "string",
      "description": ""
    },
    "commissionId": {
      "type": "string",
      "description": ""
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "jurisdiction": {
      "$ref": "#/components/schemas/jurisdiction"
    },
    "registeredName": {
      "type": "string",
      "description": ""
    },
    "commissionExpiration": {
      "type": "string",
      "description": ""
    }
  },
  "x-ds-order": "290",
  "description": "Creating, updating, and deleting notary jurisdiction objects.",
  "x-ms-summary": "Creating, updating, and deleting notary jurisdiction objects.",
  "x-ds-category": "Notary",
  "x-ds-definition-name": "notaryJurisdiction"
}

{
  "type": "object",
  "properties": {
    "emailNotifications": {
      "$ref": "#/components/schemas/notificationDefaultSettings"
    },
    "apiEmailNotifications": {
      "$ref": "#/components/schemas/notificationDefaultSettings"
    }
  },
  "x-ds-order": "120",
  "description": "The `NotificationDefaults` resource provides methods that enable you to manage the default notifications for envelopes.",
  "x-ms-summary": "The `NotificationDefaults` resource provides methods that enable you to manage the default notifications for envelopes.",
  "x-ds-category": "Accounts",
  "x-ds-definition-name": "notificationDefaults"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "object",
  "properties": {
    "config": {
      "$ref": "#/components/schemas/paymentGatewayAccountSetting"
    },
    "isLegacy": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "isEnabled": {
      "type": "string",
      "description": "When **true,** the payment gateway account is enabled."
    },
    "displayName": {
      "type": "string",
      "description": "A user-defined name for a connected gateway account.\n\nThis name is used in the Admin panel in the list of connected accounts and in Tagger in the payment gateway selector.\n\nThe human-readable version of `paymentGatewayAccountId`."
    },
    "lastModified": {
      "type": "string",
      "description": "The UTC DateTime that the payment gateway account was last updated."
    },
    "paymentGateway": {
      "type": "string",
      "description": "Payment gateway used by the connected gateway account.\nThis is the name used by the API.\nFor a human-readable version use `paymentGatewayDisplayName`.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`\n* `CyberSource`\n* `Zuora`\n* `Elavon`"
    },
    "allowCustomMetadata": {
      "type": "boolean",
      "description": "When **true,** the sender can pass custom metadata about the payment to the payment gateway. You pass in this metadata on an EnvelopeRecipientTab, in the `customMetadata` property under `paymentDetails`. \n\nFor example, this property is set to **true** for the Authorize.net gateway by default. As a result, the extra metadata that you send displays for the Authorize.net transaction in the merchant gateway portal under **Description.**\n\n**Note:** This property is read-only and cannot be changed."
    },
    "supportedCurrencies": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of ISO 4217 currency codes for the currencies that the payment gateway account supports.\n\nExamples: \n\n- `USD`\n- `CAD`\n- `EUR`\n- `HKD`"
    },
    "payPalLegacySettings": {
      "$ref": "#/components/schemas/payPalLegacySettings"
    },
    "zeroDecimalCurrencies": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "paymentGatewayAccountId": {
      "type": "string",
      "description": "A GUID that identifies the payment gateway account. For a human-readable version use `displayName`."
    },
    "supportedPaymentMethods": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of paymentMethodWithOptions objects that specify the payment methods that are available for the gateway."
    },
    "paymentGatewayDisplayName": {
      "type": "string",
      "description": "The display name of the payment gateway that the connected gateway account uses.\nThis is the human-readable version of `paymentGateway`.\n\nPossible values are:\n\n* Stripe\n* Braintree\n* Authorize.Net\n* CyberSource\n* Zuora\n* Elavon"
    },
    "supportedPaymentMethodsWithOptions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/paymentMethodWithOptions"
      },
      "description": "An array of `paymentMethodWithOptions` objects that specify the payment methods that are available for the gateway, as well as the payment options that are compatible with each payment method."
    }
  },
  "x-ds-order": "210",
  "description": "Information about a connected payment gateway account.",
  "x-ms-summary": "Information about a connected payment gateway account.",
  "x-ds-category": "Payments",
  "x-ds-definition-name": "paymentGatewayAccount"
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "paymentId": {
      "type": "string",
      "description": "The ID of the payment."
    },
    "description": {
      "type": "string",
      "description": "A sender-defined description of the line item.\n"
    },
    "paymentDate": {
      "type": "string",
      "description": ""
    },
    "paymentNumber": {
      "type": "string",
      "description": "When **true,** a PDF version of the invoice is available. \n\nTo get the PDF, make the call again and change \"Accept:\" in the header to \"Accept: application/pdf\"."
    }
  },
  "x-ds-order": "30",
  "description": "Payments",
  "x-ms-summary": "Payments",
  "x-ds-category": "Billing",
  "x-ds-definition-name": "billingPaymentItem"
}

{
  "type": "object",
  "properties": {
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "recipients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/powerFormFormDataRecipient"
      },
      "description": "An array of powerform recipients."
    }
  },
  "x-ds-order": "90",
  "description": "Data that recipients have entered in PowerForm fields.",
  "x-ms-summary": "Data that recipients have entered in PowerForm fields.",
  "x-ds-category": "PowerForms",
  "x-ds-definition-name": "powerFormFormDataEnvelope"
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "The URI for the PowerForm."
    },
    "name": {
      "type": "string",
      "description": "The name of the PowerForm."
    },
    "isActive": {
      "type": "string",
      "description": "When **true,** indicates that the PowerForm is active and can be sent to recipients. This is the default value.\n\n\nWhen **false,** the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL. \n\nIf a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender."
    },
    "lastUsed": {
      "type": "string",
      "description": "The date and time that the PowerForm was last used."
    },
    "createdBy": {
      "type": "string",
      "description": "The ID of the user who created the PowerForm. This property is returned in a response only when you set the `include_created_by` query parameter to **true.**"
    },
    "emailBody": {
      "type": "string",
      "description": "For a PowerForm that is sent by email, this is the body of the email message sent to the recipients.\n\nMaximum length: 10000 characters."
    },
    "envelopes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelope"
      },
      "description": "An array of envelope objects that contain information about the envelopes that are associated with the PowerForm."
    },
    "timesUsed": {
      "type": "string",
      "description": "The number of times the PowerForm has been used. "
    },
    "recipients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/powerFormRecipient"
      },
      "description": "An array of `powerFormRecipient` objects.\n\n**Note:** For self-service documents where you do not know who the recipients are in advance, you can enter generic information for the `role` property and leave other details (such as `name` and `email`) blank."
    },
    "senderName": {
      "type": "string",
      "description": "The name of the sender. \n\n**Note:** The default sender for a PowerForm is the PowerForm Administrator who created it."
    },
    "templateId": {
      "type": "string",
      "description": "The ID of the template used to create the PowerForm."
    },
    "powerFormId": {
      "type": "string",
      "description": "The ID of the PowerForm."
    },
    "signingMode": {
      "type": "string",
      "description": "The signing method to use. Valid values are:\n\n- `email`: This mode verifies the recipient's identity by using email authentication before the recipient can sign a document.\n\n- `direct`: This mode does not require any verification. DocuSign recommends that you use this signing method only when another form of authentication is in use.\n\n**Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`.\n\nFor more information about signing modes, see the [overview of the Create method](https://raw.githubusercontent.com)."
    },
    "emailSubject": {
      "type": "string",
      "description": "Sets the envelope name for the envelopes that the PowerForm generates. One option is to make this property the same as the subject from the template.\n\nYou can customize the subject line to include a recipient's name or email address by using merge fields. For information about adding merge fields to the email subject, see [Template Email Subject Merge Fields](https://raw.githubusercontent.com).\n"
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "instructions": {
      "type": "string",
      "description": "The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. When you include instructions, they display as an introduction after the recipient accesses the PowerForm."
    },
    "powerFormUrl": {
      "type": "string",
      "description": "The URL for the PowerForm."
    },
    "senderUserId": {
      "type": "string",
      "description": "The ID of the sender."
    },
    "templateName": {
      "type": "string",
      "description": "The name of the template used to create the PowerForm."
    },
    "maxUseEnabled": {
      "type": "string",
      "description": "When **true,** you can set a maximum number of uses for the PowerForm."
    },
    "usesRemaining": {
      "type": "string",
      "description": "The number of times that the PowerForm can still be used. If no use limit is set, the value is `Unlimited`. "
    },
    "createdDateTime": {
      "type": "string",
      "description": "The date and time that the PowerForm was created."
    },
    "limitUseInterval": {
      "type": "string",
      "description": "The length of time before the same recipient can sign the same PowerForm again. This property is used in combination with the `limitUseIntervalUnits` property."
    },
    "limitUseIntervalUnits": {
      "type": "string",
      "description": "The units associated with the `limitUseInterval`. Valid values are:\n\n- `minutes`\n- `hours`\n- `days`\n- `weeks`\n- `months`\n\nFor example, to limit a recipient to signing once per year, set the `limitUseInterval` to 365 and the `limitUseIntervalUnits` to `days`.\n"
    },
    "limitUseIntervalEnabled": {
      "type": "string",
      "description": "When **true,** the `limitUseInterval` is enabled."
    }
  },
  "x-ds-order": "80",
  "description": "The PowerForms resource enables you to create fillable forms that you can email or make available for self service on the web.",
  "x-ms-summary": "The PowerForms resource enables you to create fillable forms that you can email or make available for self service on the web.",
  "x-ds-category": "PowerForms",
  "x-ds-definition-name": "powerForm"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "object",
  "properties": {
    "apiRequestLogging": {
      "type": "string",
      "description": " When **true,** enables API request logging for the user. "
    },
    "apiRequestLogMaxEntries": {
      "type": "string",
      "description": "Specifies the maximum number of API requests to log."
    },
    "apiRequestLogRemainingEntries": {
      "type": "string",
      "description": "Indicates the remaining number of API requests that can be logged."
    }
  },
  "x-ds-order": "10",
  "description": "Request logs",
  "x-ms-summary": "Request logs",
  "x-ds-category": "Diagnostics",
  "x-ds-definition-name": "diagnosticsSettingsInformation"
}

{
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Accounts"
}

{
  "type": "object",
  "properties": {
    "resources": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": ""
    }
  },
  "x-ds-order": "20",
  "description": "API resource information",
  "x-ms-summary": "API resource information",
  "x-ds-category": "Diagnostics",
  "x-ds-definition-name": "resourceInformation"
}

{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentHtmlDefinitionOriginal"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "x-ds-order": "100",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "documentHtmlDefinitionOriginals"
}

{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "x-ds-order": "250",
  "description": "This resource is used to create a responsive preview of all of the documents in an envelope.",
  "x-ms-summary": "This resource is used to create a responsive preview of all of the documents in an envelope.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "documentHtmlDefinitions"
}

{
  "type": "object",
  "properties": {
    "buildSHA": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "buildBranch": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "linkedSites": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "buildVersion": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "serviceVersions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/serviceVersion"
      },
      "description": ""
    },
    "buildBranchDeployedDateTime": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "x-ds-order": "30",
  "description": "API service information",
  "x-ms-summary": "API service information",
  "x-ds-category": "Diagnostics",
  "x-ds-definition-name": "serviceInformation"
}

{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signingGroupUser"
      },
      "description": "User management information."
    }
  },
  "x-ds-order": "20",
  "description": "Signing groups' users",
  "x-ms-summary": "Signing groups' users",
  "x-ds-category": "SigningGroups",
  "x-ds-definition-name": "signingGroupUsers"
}

{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signingGroupUser"
      },
      "description": "User management information."
    },
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the workspace user authorization was created."
    },
    "modified": {
      "type": "string",
      "description": "The date and time that the signing group was last modified."
    },
    "createdBy": {
      "type": "string",
      "description": "The name of the user who created the signing group."
    },
    "groupName": {
      "type": "string",
      "description": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name."
    },
    "groupType": {
      "type": "string",
      "description": "The group type. Possible values include:\n\n- `adminstrators`\n- `everyone`\n- `customGroup`\n- `sharedSigningGroup`\n\n<!-- More? To do -->"
    },
    "groupEmail": {
      "type": "string",
      "description": "The email address for the signing group. You can use a group email address to email all of the group members at the same time."
    },
    "modifiedBy": {
      "type": "string",
      "description": "The user ID (GUID) of the user who last modified this user record. This property is read-only."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "signingGroupId": {
      "type": "string",
      "description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
    }
  },
  "x-ds-order": "10",
  "description": "Signing groups",
  "x-ms-summary": "Signing groups",
  "x-ds-category": "SigningGroups",
  "x-ds-definition-name": "signingGroup"
}

{
  "type": "object",
  "properties": {
    "allowTabOrder": {
      "type": "string",
      "description": "When **true,** account users can set a tab order for the signing process.\n\n**Note:** Only Admin users can change this setting."
    },
    "drawTabsEnabled": {
      "type": "string",
      "description": ""
    },
    "listTabsEnabled": {
      "type": "string",
      "description": "When **true,** list tabs are enabled."
    },
    "noteTabsEnabled": {
      "type": "string",
      "description": "When **true,** note tabs are enabled."
    },
    "tabScaleEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "textTabsEnabled": {
      "type": "string",
      "description": "When **true,** text tabs are enabled."
    },
    "drawTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "listTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "noteTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "radioTabsEnabled": {
      "type": "string",
      "description": "When **true,** radio button tabs are enabled."
    },
    "tabScaleMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "textTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "radioTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "tabLockingEnabled": {
      "type": "string",
      "description": "When **true,** tab locking is enabled.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "prefillTabsEnabled": {
      "type": "string",
      "description": ""
    },
    "tabLocationEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "tabLockingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "checkboxTabsEnabled": {
      "type": "string",
      "description": "When **true,** checkbox tabs are enabled."
    },
    "prefillTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "tabDataLabelEnabled": {
      "type": "string",
      "description": "When **true,** [data\nlabels](https://support.docusign.com/en/videos/Data-Labels) are enabled.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "tabLocationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "checkBoxTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dataFieldSizeEnabled": {
      "type": "string",
      "description": "When **true,** setting character limits for input fields is enabled."
    },
    "numericalTabsEnabled": {
      "type": "string",
      "description": ""
    },
    "tabDataLabelMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowTabOrderMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dataFieldRegexEnabled": {
      "type": "string",
      "description": "When **true,** regular expressions are enabled for tabs that contain data fields."
    },
    "dataFieldSizeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "numericalTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dataFieldRegexMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "calculatedFieldsEnabled": {
      "type": "string",
      "description": "When **true,** [calculated fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) are enabled for tabs."
    },
    "savingCustomTabsEnabled": {
      "type": "string",
      "description": "When **true,** saving custom tabs is enabled."
    },
    "sharedCustomTabsEnabled": {
      "type": "string",
      "description": "When **true,** shared custom tabs are enabled."
    },
    "calculatedFieldsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "savingCustomTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "sharedCustomTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "tabTextFormattingEnabled": {
      "type": "string",
      "description": "When **true,** text formatting (such as font type, font size,\nfont color, bold, italic, and underline) is enabled for tabs that\nsupport formatting.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "approveDeclineTabsEnabled": {
      "type": "string",
      "description": "When **true,** approve and decline tabs are enabled."
    },
    "firstLastEmailTabsEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "tabTextFormattingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "approveDeclineTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "firstLastEmailTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "senderToChangeTabAssignmentsEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "senderToChangeTabAssignmentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "x-ds-order": "120",
  "description": "Reserved for DocuSign.",
  "x-ms-summary": "Reserved for DocuSign.",
  "x-ds-category": "Envelopes",
  "x-ds-definition-name": "tabAccountSettings"
}

{
  "type": "object",
  "properties": {
    "listCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/listCustomField"
      },
      "description": "An array of list custom fields."
    },
    "textCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/textCustomField"
      },
      "description": "An array of text custom fields."
    }
  },
  "x-ds-order": "70",
  "description": "A template custom field enables you to prepopulate custom metadata for all new envelopes that are created by using a specific template. You can then use the custom data for sorting, organizing, searching, and other downstream processes.",
  "x-ms-summary": "A template custom field enables you to prepopulate custom metadata for all new envelopes that are created by using a specific template. You can then use the custom data for sorting, organizing, searching, and other downstream processes.",
  "x-ds-category": "Templates",
  "x-ds-definition-name": "customFields"
}

{
  "type": "object",
  "properties": {
    "documentFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "The array of name/value custom data strings to add to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the following elements: \n\n* `name` - A string that can be a maximum of 50 characters. \n* `value` - A string that can be a maximum of 200 characters.\n\n**Important:** If you are using XML, the name/value pair is contained in a `nameValue` element. \n"
    }
  },
  "x-ds-order": "60",
  "description": "Template document fields",
  "x-ms-summary": "Template document fields",
  "x-ds-category": "Templates",
  "x-ds-definition-name": "documentFieldsInformation"
}

{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentHtmlDefinitionOriginal"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "x-ds-order": "300",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Templates",
  "x-ds-definition-name": "documentHtmlDefinitionOriginals"
}

{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "x-ds-order": "280",
  "description": "This resource is used to create a responsive preview of a specific template document.",
  "x-ms-summary": "This resource is used to create a responsive preview of a specific template document.",
  "x-ds-category": "Templates",
  "x-ds-definition-name": "documentHtmlDefinitions"
}

{
  "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/"
    }
  },
  "x-ds-order": "50",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Templates",
  "x-ds-definition-name": "tabs"
}

{
  "type": "object",
  "properties": {
    "documentVisibility": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentVisibility"
      },
      "description": "An array of `documentVisibility` objects that specifies which documents are visible to which recipients."
    }
  },
  "x-ds-order": "180",
  "description": "Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.\n\n**Note:** Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=eui1578456411411.html).",
  "x-ms-summary": "Document Visibility enables senders to control the visibility of the documents in an envelope at the recipient level. For example, if the parties associated with a legal proceeding should have access to different documents, the Document Visibility feature enables you to keep all of the documents in the same envelope and set view permissions for the documents by recipient. This functionality is enabled for envelopes and templates. It is not available for PowerForms.\n\n**Note:** Before you use Document Visibility, you should be aware of the following information:\n\n- Document Visibility must be enabled for your account by your DocuSign administrator. \n- A document cannot be hidden from a recipient if the recipient has tabs assigned to them on the document. \n- When the Document Visibility setting hides a document from a recipient, the document also does not appear in the recipient's list of envelopes, documents, or page images.\n- Carbon Copy, Certified Delivery (Needs to Sign), Editor, and Agent recipients can always see all of the documents associated with the envelope or template.\n\nThe Document Visibility feature has multiple settings that specify the options that senders have when sending documents. For more information, see [Use Document Visibility to Control Recipient Access](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=eui1578456411411.html).",
  "x-ds-category": "Templates",
  "x-ds-definition-name": "templateDocumentVisibilityList"
}

{
  "type": "object",
  "properties": {
    "templateId": {
      "type": "string",
      "description": "The ID of the template. If a value is not provided, DocuSign generates a value. "
    },
    "templateDocuments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeDocument"
      },
      "description": "An array of document objects that contain information about the documents associated with the template."
    }
  },
  "x-ds-order": "40",
  "description": "Template documents",
  "x-ms-summary": "Template documents",
  "x-ds-category": "Templates",
  "x-ds-definition-name": "templateDocumentsResult"
}

{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentHtmlDefinitionOriginal"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "x-ds-order": "310",
  "description": "",
  "x-ms-summary": "",
  "x-ds-category": "Templates",
  "x-ds-definition-name": "documentHtmlDefinitionOriginals"
}

{
  "type": "object",
  "properties": {
    "lockType": {
      "type": "string",
      "description": "The type of lock.  Currently `edit` is the only supported type."
    },
    "lockToken": {
      "type": "string",
      "description": "A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock."
    },
    "lockedByApp": {
      "type": "string",
      "description": "Specifies the friendly name of  the application that is locking the envelope."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "lockedByUser": {
      "$ref": "#/components/schemas/userInfo"
    },
    "useScratchPad": {
      "type": "string",
      "description": "When **true,** a scratchpad is used to edit information.\n "
    },
    "lockedUntilDateTime": {
      "type": "string",
      "description": "The date and time that the lock expires."
    },
    "lockDurationInSeconds": {
      "type": "string",
      "description": "The number of seconds until the lock expires when there is no activity on the template.\n\nIf no value is entered, then the default value of 300 seconds is used. The maximum value is 1,800 seconds.\n\nThe lock duration can be extended.\n"
    }
  },
  "x-ds-order": "80",
  "description": "This section provides information about template locks. You use template locks to prevent others from making changes to a template while you are modifying it.",
  "x-ms-summary": "This section provides information about template locks. You use template locks to prevent others from making changes to a template while you are modifying it.",
  "x-ds-category": "Templates",
  "x-ds-definition-name": "lockInformation"
}

{
  "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/"
    }
  },
  "x-ds-order": "50",
  "description": "Template tabs",
  "x-ms-summary": "Template tabs",
  "x-ds-category": "Templates",
  "x-ds-definition-name": "tabs"
}

{
  "type": "object",
  "properties": {
    "seals": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/sealSign"
      },
      "description": "Specifies one or more electronic seals to apply on documents. For more information on Electronic Seals , see https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html"
    },
    "agents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/agent"
      },
      "description": "A list of agent recipients assigned to the documents."
    },
    "editors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/editor"
      },
      "description": "A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signer"
      },
      "description": "A list of signers on the envelope."
    },
    "notaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/notaryRecipient"
      },
      "description": "A list of notary recipients on the envelope."
    },
    "witnesses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/witness"
      },
      "description": "A list of signers who act as witnesses on the envelope."
    },
    "carbonCopies": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/carbonCopy"
      },
      "description": "A list of carbon copy recipients assigned to the documents."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "participants": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/participant"
      },
      "description": ""
    },
    "intermediaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/intermediary"
      },
      "description": "Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added)."
    },
    "recipientCount": {
      "type": "string",
      "description": "The number of recipients in the envelope."
    },
    "inPersonSigners": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/inPersonSigner"
      },
      "description": "Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected."
    },
    "certifiedDeliveries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/certifiedDelivery"
      },
      "description": "A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents."
    },
    "currentRoutingOrder": {
      "type": "string",
      "description": "The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions."
    }
  },
  "x-ds-order": "20",
  "description": "Template recipients",
  "x-ms-summary": "Template recipients",
  "x-ds-category": "Templates",
  "x-ds-definition-name": "recipients"
}

{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "x-ds-order": "290",
  "description": "This resource is used to create a responsive preview of all of the documents associated with a template.",
  "x-ms-summary": "This resource is used to create a responsive preview of all of the documents associated with a template.",
  "x-ds-category": "Templates",
  "x-ds-definition-name": "documentHtmlDefinitions"
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The URL that you navigate to in order to start the view."
    }
  },
  "x-ds-order": "55",
  "description": "A TemplateView contains a URL that you can embed in your application to generate a template view that uses the DocuSign user interface (UI).",
  "x-ms-summary": "A TemplateView contains a URL that you can embed in your application to generate a template view that uses the DocuSign user interface (UI).",
  "x-ds-category": "Templates",
  "x-ds-definition-name": "viewUrl"
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "Contains a URI that you can use to retreve the template."
    },
    "name": {
      "type": "string",
      "description": "The name of the template."
    },
    "owner": {
      "$ref": "#/components/schemas/userInfo"
    },
    "holder": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "sender": {
      "$ref": "#/components/schemas/userInfo"
    },
    "shared": {
      "type": "string",
      "description": "When **true,** indicates the template is shared with the **Everyone** group,\nand is shared with all users on the account.\n\nWhen **false,** the template is shared only with the groups you specify."
    },
    "status": {
      "type": "string",
      "description": "Indicates the envelope status. Valid values are:\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n"
    },
    "brandId": {
      "type": "string",
      "description": "The ID of the brand."
    },
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the workspace user authorization was created."
    },
    "folders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folder"
      },
      "description": "A list of folder objects."
    },
    "folderId": {
      "type": "string",
      "description": "The unique identifier for the folder that the template belongs to."
    },
    "lastUsed": {
      "type": "string",
      "description": "The date and time the template was last used."
    },
    "location": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "password": {
      "type": "string",
      "description": "The password for editing the template."
    },
    "workflow": {
      "$ref": "#/components/schemas/workflow"
    },
    "anySigner": {
      "type": "string",
      "description": "Deprecated. This feature has been replaced by signing groups."
    },
    "autoMatch": {
      "type": "string",
      "description": "By default, templates that have been used within\nthe last 60 days are included in auto-matching.\n\nBy explicitly setting `autoMatch`,\nyou can permanently include or exclude the template\nin auto matching.\n\nWhen **true** the template is included in auto-matching\nregardless of when it was last used.\n\nWhen **false** the template is never included in auto-matching."
    },
    "brandLock": {
      "type": "string",
      "description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope."
    },
    "documents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/document"
      },
      "description": "A complex element that contains details about the documents associated with the envelope."
    },
    "folderIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of folder IDs that the template is in."
    },
    "pageCount": {
      "type": "string",
      "description": "An integer value specifying the number of document pages in the template. "
    },
    "powerForm": {
      "$ref": "#/components/schemas/powerForm"
    },
    "emailBlurb": {
      "type": "string",
      "description": "This is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients."
    },
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "folderName": {
      "type": "string",
      "description": "The name of the folder the template belongs to."
    },
    "hasWavFile": {
      "type": "string",
      "description": "When **true,** indicates that the template includes a .wav file."
    },
    "powerForms": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/powerForm"
      },
      "description": "An array of PowerForm objects that contain information about any PowerForms that are included in the template."
    },
    "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"
    },
    "recipients": {
      "$ref": "#/components/schemas/EnvelopeRecipients"
    },
    "templateId": {
      "type": "string",
      "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. "
    },
    "allowMarkup": {
      "type": "string",
      "description": "When **true,** the Document Markup feature is enabled.\n\n**Note:**  To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.\n"
    },
    "description": {
      "type": "string",
      "description": "A sender-defined description of the line item.\n"
    },
    "envelopeUri": {
      "type": "string",
      "description": "The URI for retrieving the envelope or envelopes."
    },
    "expireAfter": {
      "type": "string",
      "description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
    },
    "hasComments": {
      "type": "string",
      "description": "When **true,** indicates that users have added comments to the envelope."
    },
    "messageLock": {
      "type": "string",
      "description": "When **true,** prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope."
    },
    "newPassword": {
      "type": "string",
      "description": "The user's new password."
    },
    "asynchronous": {
      "type": "string",
      "description": "When **true,** the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n\n**Note:** A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](https://raw.githubusercontent.com) or by checking the\nConnect notification."
    },
    "customFields": {
      "$ref": "#/components/schemas/AccountCustomFields"
    },
    "documentsUri": {
      "type": "string",
      "description": "The URI for retrieving all of the documents associated with the envelope as separate files."
    },
    "emailSubject": {
      "type": "string",
      "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.\n"
    },
    "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."
    },
    "notification": {
      "$ref": "#/components/schemas/notification"
    },
    "sentDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the envelope was sent. This property is read-only."
    },
    "templatesUri": {
      "type": "string",
      "description": "The URI for retrieving the templates."
    },
    "voidedReason": {
      "type": "string",
      "description": "The reason the envelope or template was voided.\n\n**Note:** The string is truncated to the first 200 characters.\n"
    },
    "allowComments": {
      "type": "string",
      "description": "When **true,** indicates that comments are allowed on the envelope."
    },
    "allowReassign": {
      "type": "string",
      "description": "When **true,** the recipient can redirect an envelope to a more appropriate recipient."
    },
    "emailSettings": {
      "$ref": "#/components/schemas/emailSettings"
    },
    "enableWetSign": {
      "type": "string",
      "description": "When **true,** the signer is allowed to print the document and sign it on paper."
    },
    "expireEnabled": {
      "type": "string",
      "description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
    },
    "favoritedByMe": {
      "type": "string",
      "description": ""
    },
    "is21CFRPart11": {
      "type": "string",
      "description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."
    },
    "recipientsUri": {
      "type": "string",
      "description": "Contains a URI for an endpoint that you can use to retrieve the recipients."
    },
    "transactionId": {
      "type": "string",
      "description": " Used to identify an envelope. The ID is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned."
    },
    "useDisclosure": {
      "type": "string",
      "description": "When **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **false,** the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information."
    },
    "attachmentsUri": {
      "type": "string",
      "description": "Contains a URL for retrieving the attachments that are associated with the envelope."
    },
    "autoNavigation": {
      "type": "string",
      "description": "When **true,** autonavigation is set for the recipient.\n"
    },
    "certificateUri": {
      "type": "string",
      "description": "The URI for retrieving certificate information."
    },
    "documentBase64": {
      "type": "string",
      "description": "The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding."
    },
    "expireDateTime": {
      "type": "string",
      "description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
    },
    "lastModifiedBy": {
      "$ref": "#/components/schemas/userInfo"
    },
    "recipientsLock": {
      "type": "string",
      "description": "When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope."
    },
    "statusDateTime": {
      "type": "string",
      "description": "The DateTime that the envelope changed status (i.e. was created or sent.)"
    },
    "voidedDateTime": {
      "type": "string",
      "description": "The date and time the envelope or template was voided."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the item was created."
    },
    "customFieldsUri": {
      "type": "string",
      "description": "The URI for retrieving custom fields."
    },
    "deletedDateTime": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "lockInformation": {
      "$ref": "#/components/schemas/EnvelopeLocks"
    },
    "notificationUri": {
      "type": "string",
      "description": "The URI for retrieving notifications."
    },
    "signingLocation": {
      "type": "string",
      "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`."
    },
    "allowViewHistory": {
      "type": "string",
      "description": "When **true,** recipients can view the history of the envelope."
    },
    "declinedDateTime": {
      "type": "string",
      "description": "The date and time the recipient declined the document. This property is read-only."
    },
    "envelopeLocation": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "envelopeMetadata": {
      "$ref": "#/components/schemas/envelopeMetadata"
    },
    "isAceGenTemplate": {
      "type": "string",
      "description": ""
    },
    "isDocGenTemplate": {
      "type": "string",
      "description": ""
    },
    "purgeRequestDate": {
      "type": "string",
      "description": "The date that a purge was requested."
    },
    "authoritativeCopy": {
      "type": "string",
      "description": "When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"
    },
    "completedDateTime": {
      "type": "string",
      "description": "Specifies the date and time this item was completed."
    },
    "copyRecipientData": {
      "type": "string",
      "description": ""
    },
    "deliveredDateTime": {
      "type": "string",
      "description": "The date and time that the envelope was delivered to the recipient. This property is read-only."
    },
    "envelopeDocuments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeDocument"
      },
      "description": "An array containing information about the documents that are included in the envelope."
    },
    "isDynamicEnvelope": {
      "type": "string",
      "description": "When **true,** indicates that the envelope is a dynamic envelope."
    },
    "passwordProtected": {
      "type": "string",
      "description": "When **true,** a password is required to edit the template."
    },
    "burnDefaultTabData": {
      "type": "string",
      "description": ""
    },
    "envelopeIdStamping": {
      "type": "string",
      "description": "When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed."
    },
    "externalEnvelopeId": {
      "type": "string",
      "description": "May contain an external identifier for the envelope."
    },
    "hasFormDataChanged": {
      "type": "string",
      "description": "Specifies if the `EnvelopeFormData` associated with any forms in the template has changed."
    },
    "purgeCompletedDate": {
      "type": "string",
      "description": "The date that a purge was completed."
    },
    "envelopeAttachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/attachment"
      },
      "description": "An array of attachment objects that provide information about the attachments that are associated with the envelope."
    },
    "initialSentDateTime": {
      "type": "string",
      "description": "The date and time the envelope that used the template was initially sent."
    },
    "documentsCombinedUri": {
      "type": "string",
      "description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file."
    },
    "lastModifiedDateTime": {
      "type": "string",
      "description": "The date and time the template was last modified."
    },
    "signerCanSignOnMobile": {
      "type": "string",
      "description": "When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "statusChangedDateTime": {
      "type": "string",
      "description": "The data and time that the status changed."
    },
    "envelopeCustomMetadata": {
      "$ref": "#/components/schemas/envelopeCustomMetadata"
    },
    "accessControlListBase64": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "enforceSignerVisibility": {
      "type": "string",
      "description": "When **true,** signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by 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 by using this setting when an envelope is sent.\n\n**Note:** To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true.**\n\n[docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/"
    },
    "authoritativeCopyDefault": {
      "type": "string",
      "description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`."
    },
    "autoMatchSpecifiedByUser": {
      "type": "string",
      "description": "When **true,** the template has been explicitly included in or excluded from auto-matching. The default is false.\nThis is a read-only property."
    },
    "disableResponsiveDocument": {
      "type": "string",
      "description": "When **true,** responsive documents are disabled for the envelope."
    },
    "isSignatureProviderEnvelope": {
      "type": "string",
      "description": "When **true,** indicates that the envelope is a signature-provided envelope."
    }
  },
  "x-ds-order": "10",
  "description": "Template management",
  "x-ms-summary": "Template management",
  "x-ds-category": "Templates",
  "x-ds-definition-name": "envelopeTemplate"
}

{
  "type": "object",
  "properties": {
    "customSettings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "The name/value pair information for the user custom setting."
    }
  },
  "x-ds-order": "30",
  "description": "Users' custom settings",
  "x-ms-summary": "Users' custom settings",
  "x-ds-category": "Users",
  "x-ds-definition-name": "customSettingsInformation"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "The user's job title.\n\nLimit: 100 characters."
    },
    "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."
    }
  },
  "x-ds-order": "20",
  "description": "Users' profiles",
  "x-ms-summary": "Users' profiles",
  "x-ds-category": "Users",
  "x-ds-definition-name": "userProfile"
}

{
  "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": "The format of the signature image, such as:\n\n- `GIF`\n- `PNG`\n- `JPG`\n- `PDF`\n- `BMP`"
    },
    "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": "An external ID for the signature or stamp.\n\n**Note:** If a recipient uses a stamp instead of a signature, this is the stamp vendor's serial number for the stamp."
    },
    "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": "Serialized information about any custom [eHanko stamps](https://support.docusign.com/s/articles/Sending-and-Signing-with-eHanko) that have been ordered from an eHanko provider, including the order status, purchase order id, time created, and time modified."
    },
    "imageBase64": {
      "type": "string",
      "description": "A Base64-encoded representation of the signature image."
    },
    "signatureId": {
      "type": "string",
      "description": "The ID associated with the signature name. You can use this property in the URI in place of the signature name. This enables the use of special characters (such as \"&\", \"<\", and \">\") in a signature name.\n\n**Note:** When you update a signature, its signature ID might change. In that case you need to use `signatureName` to get the new `signatureId`."
    },
    "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. Possible values include:\n\n- `RubberStamp`: A DocuSign pre-formatted signature style. This is the default value.\n- `Imported`: A signature image that the user uploaded.\n- `Drawn`: A freehand drawing of the user's signature and initials."
    },
    "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 date and time when the user created the signature."
    },
    "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 UTC date and time when the signature was last modified."
    },
    "disallowUserResizeStamp": {
      "type": "string",
      "description": "When **true,** users may not resize the stamp."
    }
  },
  "x-ds-order": "40",
  "description": "Users' signatures",
  "x-ms-summary": "Users' signatures",
  "x-ds-category": "Users",
  "x-ds-definition-name": "userSignature"
}

{
  "type": "string",
  "format": "binary"
}

{
  "type": "string",
  "format": "binary"
}

{
  "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 salutation for the user, such as Ms, Dr, Capt., etc.\n\nLimit: 10 characters."
    },
    "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 password."
    },
    "userName": {
      "type": "string",
      "description": "The user's full name.\n<!--\n`title` + `firstName` + `middleName` + `lastName` + `suffixName`\n-->"
    },
    "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": ""
    },
    "homeAddress": {
      "$ref": "#/components/schemas/addressInformation"
    },
    "loginStatus": {
      "type": "string",
      "description": "Shows the current status of the user's password. Possible values are: \n\n* password_reset\n* password_active\n* password_expired\n* password_locked\n* password_reset_failed \n"
    },
    "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 associated with the user."
    },
    "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": "The activation code a new user must enter when activating their 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 permission profile associated with the user."
    },
    "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."
    }
  },
  "x-ds-order": "10",
  "description": "The Users resource enables you to create and manage account users.",
  "x-ms-summary": "The Users resource enables you to create and manage account users.",
  "x-ds-category": "Users",
  "x-ds-definition-name": "userInformation"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the workspace item."
    },
    "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 workspace item. Valid values are:\n\n- `file`\n- `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 DateTime that the item was last modified."
    },
    "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"
    }
  },
  "x-ds-order": "130",
  "description": "This object contains information about a file or folder in a workspace.",
  "x-ms-summary": "This object contains information about a file or folder in a workspace.",
  "x-ds-category": "Workspaces",
  "x-ds-definition-name": "workspaceItem"
}

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The status of the workspace. Valid values are:\n\n- `active`\n- `closed`"
    },
    "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"
    }
  },
  "x-ds-order": "140",
  "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-category": "Workspaces",
  "x-ds-definition-name": "workspace"
}

{
  "type": "object",
  "properties": {
    "minimumLength": {
      "type": "string",
      "description": "Minimum length of the access code string."
    },
    "formatRequired": {
      "type": "string",
      "description": "Boolean specifying whether this format configuration is required."
    },
    "letterRequired": {
      "type": "string",
      "description": "Boolean specifying whether alphabetical characters are required in the access code string."
    },
    "numberRequired": {
      "type": "string",
      "description": "Boolean specifying whether numerical characters (0-9) are required in the access code string."
    },
    "minimumLengthMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "formatRequiredMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "letterRequiredMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "numberRequiredMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "specialCharacterRequired": {
      "type": "string",
      "description": "Boolean specifying whether special characters are required in the access code string. The string cannot contain the special characters '<', '>', '&', or '#'."
    },
    "specialCharacterRequiredMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "description": "Object specifying the format of the string provided to a recipient in order to access an envelope.",
  "x-ms-summary": "Object specifying the format of the string provided to a recipient in order to access an envelope.",
  "x-ds-definition-name": "accessCodeFormat"
}

{
  "type": "object",
  "properties": {
    "fax": {
      "type": "string",
      "description": "The fax number associated with the account."
    },
    "city": {
      "type": "string",
      "description": "The city associated with the address. Maximum length: 40 characters."
    },
    "email": {
      "type": "string",
      "description": "The email address associated with the account."
    },
    "phone": {
      "type": "string",
      "description": "The phone number associated with the account."
    },
    "state": {
      "type": "string",
      "description": "The state or province associated with the address. Maximum length: 40 characters."
    },
    "country": {
      "type": "string",
      "description": "The country associated with the address. Maximum length: 50 characters."
    },
    "address1": {
      "type": "string",
      "description": "The first line of the address. Maximum length: 100 characters."
    },
    "address2": {
      "type": "string",
      "description": "The second line of the address. Maximum length: 100 characters."
    },
    "lastName": {
      "type": "string",
      "description": "The last name of the user associated with the account."
    },
    "firstName": {
      "type": "string",
      "description": "The first name of the user associated with the account. Maximum Length: 50 characters."
    },
    "postalCode": {
      "type": "string",
      "description": "The postal code associated with the address. Maximum length: 20 characters."
    },
    "supportedCountries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/country"
      },
      "description": "An array of supported countries associated with the account."
    }
  },
  "description": "Contains information about the address associated with the account.",
  "x-ms-summary": "Contains information about the address associated with the account.",
  "x-ds-definition-name": "accountAddress"
}

{
  "type": "object",
  "properties": {
    "addOns": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/addOn"
      },
      "description": "Reserved for DocuSign."
    },
    "planId": {
      "type": "string",
      "description": "DocuSign's ID for the account plan."
    },
    "planName": {
      "type": "string",
      "description": "The name of the Billing Plan."
    },
    "productId": {
      "type": "string",
      "description": "The Product ID from the AppStore."
    },
    "canUpgrade": {
      "type": "string",
      "description": "When **true,** specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response."
    },
    "isDowngrade": {
      "type": "string",
      "description": "When **true,** the account has been downgraded from a premium account type. Otherwise **false.**"
    },
    "renewalDate": {
      "type": "string",
      "description": ""
    },
    "taxExemptId": {
      "type": "string",
      "description": ""
    },
    "currencyCode": {
      "type": "string",
      "description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code to use for the account."
    },
    "paymentCycle": {
      "type": "string",
      "description": "The payment cycle associated with the plan. Valid values: \n\n- `Monthly`\n- `Annually` "
    },
    "perSeatPrice": {
      "type": "string",
      "description": "The per-seat price associated with the plan.\n\nExample: `\"456.0000\"`"
    },
    "enableSupport": {
      "type": "string",
      "description": "When **true,** customer support is provided as part of the account plan."
    },
    "includedSeats": {
      "type": "string",
      "description": "The number of seats (users) included in the plan."
    },
    "paymentMethod": {
      "type": "string",
      "description": " The payment method used with the plan. Valid values: CreditCard, PurchaseOrder, Premium, or Freemium. "
    },
    "planStartDate": {
      "type": "string",
      "description": "The date that the Account started using the current plan."
    },
    "renewalStatus": {
      "type": "string",
      "description": "The renewal status for the account. Valid values are:\n\n* `auto`: The account automatically renews.\n* `queued_for_close`: The account will be closed at the `billingPeriodEndDate`.\n* `queued_for_downgrade`: The account will be downgraded at the `billingPeriodEndDate`.\n\n**Note:** For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response."
    },
    "seatDiscounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/seatDiscount"
      },
      "description": " A complex type that contains any seat discount information. Valid values:\n \n - `BeginSeatCount` \n - `EndSeatCount`\n - `SeatDiscountPercent`\n \n"
    },
    "supportPlanFee": {
      "type": "string",
      "description": "The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`"
    },
    "planFeatureSets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/featureSet"
      },
      "description": "A complex type that sets the feature sets for the account. It contains the following information (all string content):\n\n* currencyFeatureSetPrices - Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set.\n* envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true).\n* featureSetId - A unique ID for the feature set.\n* fixedFee - A one-time fee associated with the plan (when isEnabled=true).\n* isActive - Specifies whether the feature set is actively set as part of the plan.\n* isEnabled - Specifies whether the feature set is actively enabled as part of the plan.\n* name - The name of the feature set.\n* seatFee - An incremental seat cost for seat-based plans (when isEnabled=true).\n"
    },
    "canCancelRenewal": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "incrementalSeats": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "notificationType": {
      "type": "string",
      "description": ""
    },
    "planClassification": {
      "type": "string",
      "description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`"
    },
    "supportIncidentFee": {
      "type": "string",
      "description": "The support incident fee charged for each support incident.\n\nExample: `\"$0.00\"`"
    },
    "otherDiscountPercent": {
      "type": "string",
      "description": " Any other percentage discount for the plan. "
    },
    "subscriptionStartDate": {
      "type": "string",
      "description": ""
    },
    "downgradePlanInformation": {
      "$ref": "#/components/schemas/downgradePlanUpdateResponse"
    },
    "appStoreReceiptPurchaseDate": {
      "type": "string",
      "description": ""
    },
    "appStoreReceiptExpirationDate": {
      "type": "string",
      "description": ""
    }
  },
  "description": "Contains information about an account billing plan.",
  "x-ms-summary": "Contains information about an account billing plan.",
  "x-ds-definition-name": "accountBillingPlan"
}

{
  "type": "object",
  "properties": {
    "billingPlan": {
      "$ref": "#/components/schemas/accountBillingPlan"
    },
    "taxExemptId": {
      "type": "string",
      "description": ""
    },
    "paymentMethod": {
      "type": "string",
      "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
    },
    "billingAddress": {
      "$ref": "#/components/schemas/accountAddress"
    },
    "successorPlans": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingPlan"
      },
      "description": "A list of billing plans that the current billing plan can be rolled into."
    },
    "entityInformation": {
      "$ref": "#/components/schemas/billingEntityInformationResponse"
    },
    "referralInformation": {
      "$ref": "#/components/schemas/referralInformation"
    },
    "creditCardInformation": {
      "$ref": "#/components/schemas/creditCardInformation"
    },
    "downgradePlanInformation": {
      "$ref": "#/components/schemas/downgradePlanUpdateResponse"
    },
    "downgradeRequestInformation": {
      "$ref": "#/components/schemas/downgradeRequestInformation"
    },
    "paymentProcessorInformation": {
      "$ref": "#/components/schemas/paymentProcessorInformation"
    },
    "directDebitProcessorInformation": {
      "$ref": "#/components/schemas/directDebitProcessorInformation"
    },
    "billingAddressIsCreditCardAddress": {
      "type": "string",
      "description": "When **true,** the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different."
    }
  },
  "description": "Defines an account billing plan response object.",
  "x-ms-summary": "Defines an account billing plan response object.",
  "x-ds-definition-name": "accountBillingPlanResponse"
}

{
  "type": "object",
  "properties": {
    "valueType": {
      "type": "string",
      "description": ""
    },
    "isRequired": {
      "type": "boolean",
      "description": ""
    },
    "optionName": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "accountIdentityInputOption"
}

{
  "type": "object",
  "properties": {
    "identityVerification": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/accountIdentityVerificationWorkflow"
      },
      "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](https://raw.githubusercontent.com) method in the [IdentityVerifications](https://raw.githubusercontent.com) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "accountIdentityVerificationResponse"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the Identity Verification workflow step."
    },
    "type": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Information about a specific step in an Identity Verification workflow.",
  "x-ms-summary": "Information about a specific step in an Identity Verification workflow.",
  "x-ds-definition-name": "accountIdentityVerificationStep"
}

{
  "type": "object",
  "properties": {
    "ownerType": {
      "type": "string",
      "description": ""
    },
    "isDisabled": {
      "type": "string",
      "description": "When **true,** the workflow is disabled."
    },
    "workflowId": {
      "type": "string",
      "description": "Workflow unique ID</br>This is the ID you must specify when setting ID Verification in an envelope using the `identityVerification`\n[core recipient parameter](/docs/esign-rest-api/reference/envelopes/enveloperecipients/#core-recipient-parameters)"
    },
    "defaultName": {
      "type": "string",
      "description": "The name of the Identity Verification workflow."
    },
    "inputOptions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/accountIdentityInputOption"
      },
      "description": ""
    },
    "workflowLabel": {
      "type": "string",
      "description": ""
    },
    "signatureProvider": {
      "$ref": "#/components/schemas/accountSignatureProvider"
    },
    "defaultDescription": {
      "type": "string",
      "description": "Text describing the purpose of the Identity Verification workflow."
    },
    "workflowResourceKey": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Specifies an Identity Verification workflow.",
  "x-ms-summary": "Specifies an Identity Verification workflow.",
  "x-ds-definition-name": "accountIdentityVerificationWorkflow"
}

{
  "type": "object",
  "properties": {
    "brands": {
      "$ref": "#/components/schemas/AccountBrands"
    },
    "planName": {
      "type": "string",
      "description": "The name of the Billing Plan."
    },
    "dssValues": {
      "type": "object",
      "description": "",
      "additionalProperties": {
        "type": "string"
      }
    },
    "canUpgrade": {
      "type": "string",
      "description": "When **true,** specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response."
    },
    "seatsInUse": {
      "type": "string",
      "description": "The number of users currently active on the account."
    },
    "accountName": {
      "type": "string",
      "description": "The name of the current account."
    },
    "createdDate": {
      "type": "string",
      "description": "The creation date of the account in UTC timedate format."
    },
    "isDowngrade": {
      "type": "string",
      "description": "When **true,** the account has been downgraded from a premium account type. Otherwise **false.**"
    },
    "planEndDate": {
      "type": "string",
      "description": "The date that the current plan will end."
    },
    "currencyCode": {
      "type": "string",
      "description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account."
    },
    "seatsAllowed": {
      "type": "string",
      "description": "The number of active users the account can have at one time."
    },
    "accountIdGuid": {
      "type": "string",
      "description": "The GUID associated with the account ID."
    },
    "currentPlanId": {
      "type": "string",
      "description": "ID of the plan used to create this account."
    },
    "paymentMethod": {
      "type": "string",
      "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
    },
    "planStartDate": {
      "type": "string",
      "description": "The date that the Account started using the current plan."
    },
    "billingProfile": {
      "type": "string",
      "description": "Reserved for DocuSign.\n"
    },
    "suspensionDate": {
      "type": "string",
      "description": "The date on which the account was suspended."
    },
    "accountSettings": {
      "$ref": "#/components/schemas/accountSettingsInformation"
    },
    "distributorCode": {
      "type": "string",
      "description": "The code that identifies the billing plan groups and plans for the new account."
    },
    "recipientDomains": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientDomain"
      },
      "description": ""
    },
    "suspensionStatus": {
      "type": "string",
      "description": "Indicates whether the account is currently suspended."
    },
    "connectPermission": {
      "type": "string",
      "description": ""
    },
    "envelopeUnitPrice": {
      "type": "string",
      "description": "The price of sending an envelope, represented in the account's local currency."
    },
    "externalAccountId": {
      "type": "string",
      "description": "The Account ID displayed on the user's Account page."
    },
    "status21CFRPart11": {
      "type": "string",
      "description": "The status of the account content per (Title 21 CFR Part 11)[https://www.fda.gov/regulatory-information/search-fda-guidance-documents/part-11-electronic-records-electronic-signatures-scope-and-application]. This regulation defines the criteria under which electronic records and electronic signatures are considered trustworthy."
    },
    "docuSignLandingUrl": {
      "type": "string",
      "description": "URL of the landing page used to create the account."
    },
    "planClassification": {
      "type": "string",
      "description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`"
    },
    "displayApplianceUrl": {
      "type": "string",
      "description": ""
    },
    "useDisplayAppliance": {
      "type": "boolean",
      "description": ""
    },
    "billingPeriodEndDate": {
      "type": "string",
      "description": "The billing period end date in UTC timedate format."
    },
    "allowTransactionRooms": {
      "type": "string",
      "description": "When **true,** the transaction rooms feature exposed through the Workspaces API is enabled."
    },
    "billingPeriodStartDate": {
      "type": "string",
      "description": "The billing period start date in UTC timedate format."
    },
    "envelopeSendingBlocked": {
      "type": "string",
      "description": "When **true,** the ability to send envelopes is blocked. When **false,** envelopes can be sent."
    },
    "displayApplianceStartUrl": {
      "type": "string",
      "description": ""
    },
    "billingPeriodDaysRemaining": {
      "type": "string",
      "description": "Number of days remaining in the current billing period."
    },
    "billingPeriodEnvelopesSent": {
      "type": "string",
      "description": "The number of envelopes that have been sent in the current billing period."
    },
    "billingPeriodEnvelopesAllowed": {
      "type": "string",
      "description": "The number of envelopes that can be sent in the current billing period (can be unlimited)."
    },
    "forgottenPasswordQuestionsCount": {
      "type": "string",
      "description": " A complex element that contains up to four Question/Answer pairs for forgotten password information for a user."
    }
  },
  "description": "Contains account Information.",
  "x-ms-summary": "Contains account Information.",
  "x-ds-definition-name": "accountInformation"
}

{
  "type": "object",
  "properties": {
    "maximumLength": {
      "type": "string",
      "description": "The maximum number of entry characters supported by the custom tab."
    },
    "minimumLength": {
      "type": "string",
      "description": "Minimum length of the access code string."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "accountMinimumPasswordLength"
}

{
  "type": "object",
  "properties": {
    "reminders": {
      "$ref": "#/components/schemas/reminders"
    },
    "expirations": {
      "$ref": "#/components/schemas/expirations"
    },
    "userOverrideEnabled": {
      "type": "string",
      "description": "When **true,** the user can override envelope expirations."
    }
  },
  "description": "A complex element that specifies notifications (expirations and reminders) for the envelope.",
  "x-ms-summary": "A complex element that specifies notifications (expirations and reminders) for the envelope.",
  "x-ds-definition-name": "accountNotification"
}

{
  "type": "object",
  "properties": {
    "maximumDays": {
      "type": "string",
      "description": ""
    },
    "minimumDays": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "accountPasswordExpirePasswordDays"
}

{
  "type": "object",
  "properties": {
    "maximumMinutes": {
      "type": "string",
      "description": ""
    },
    "minimumMinutes": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "accountPasswordLockoutDurationMinutes"
}

{
  "type": "object",
  "properties": {
    "options": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of option strings supported by this setting."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "accountPasswordLockoutDurationType"
}

{
  "type": "object",
  "properties": {
    "maximumAge": {
      "type": "string",
      "description": ""
    },
    "minimumAge": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "accountPasswordMinimumPasswordAgeDays"
}

{
  "type": "object",
  "properties": {
    "maximumQuestions": {
      "type": "string",
      "description": "The maximum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or greater than `minimumQuestions`."
    },
    "minimumQuestions": {
      "type": "string",
      "description": "The minimum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or less than `maximumQuestions`."
    }
  },
  "description": "Information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password.",
  "x-ms-summary": "Information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password.",
  "x-ds-definition-name": "accountPasswordQuestionsRequired"
}

{
  "type": "object",
  "properties": {
    "expirePassword": {
      "type": "string",
      "description": "When **true,** passwords expire. The default value is `false`."
    },
    "questionsRequired": {
      "type": "string",
      "description": "The number of security questions required to confirm the user’s identity before the user can reset their password. The default value is `0`."
    },
    "expirePasswordDays": {
      "type": "string",
      "description": "The number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true.**"
    },
    "lockoutDurationType": {
      "type": "string",
      "description": "The interval associated with the user lockout after a failed login attempt.\n\nPossible values are:\n\n- `minutes` (default)\n- `hours`\n- `days`"
    },
    "passwordIncludeDigit": {
      "type": "string",
      "description": "When **true,** passwords must include a digit. The default value is `false`."
    },
    "passwordStrengthType": {
      "type": "string",
      "description": "The type of password strength. Possible values are:\n\n- `basic`: The minimum password length is 6 characters with no other password requirements.\n- `medium`: The minimum password length is 7 characters. Passwords must also have one uppercase letter, one lowercase letter, and one number or special character.\n- `strong`: The minimum password length is 9 characters. Passwords must also have one uppercase letter, one lowercase letter, one number, and one special character.\n- `custom`: This option enables you to customize password requirements, including the following properties:\n\n   - `minimumPasswordLength`\n   - `minimumPasswordAgeDays`\n   - `passwordIncludeDigit`\n   - `passwordIncludeDigitOrSpecialCharacter`\n   - `passwordIncludeLowerCase`\n   - `passwordIncludeSpecialCharacter`\n   - `passwordIncludeUpperCase`\n   - `questionsRequired`"
    },
    "minimumPasswordLength": {
      "type": "string",
      "description": "The minimum number of characters in the password. This value must be a number between `6` and `15`. The default value is `6`."
    },
    "lockoutDurationMinutes": {
      "type": "string",
      "description": "The number of minutes a user is locked out of the system after three failed login attempts. The default value is `2`."
    },
    "minimumPasswordAgeDays": {
      "type": "string",
      "description": "The minimum number of days after a password is set before it can be changed. This value can be `0` or more days. The default value is `0`."
    },
    "passwordIncludeLowerCase": {
      "type": "string",
      "description": "When **true,** passwords must include a lowercase letter. The default value is `false`."
    },
    "passwordIncludeUpperCase": {
      "type": "string",
      "description": "When **true,** passwords must include an uppercase letter. The default value is `false`."
    },
    "questionsRequiredMetadata": {
      "$ref": "#/components/schemas/accountPasswordQuestionsRequired"
    },
    "expirePasswordDaysMetadata": {
      "$ref": "#/components/schemas/accountPasswordExpirePasswordDays"
    },
    "lockoutDurationTypeMetadata": {
      "$ref": "#/components/schemas/accountPasswordLockoutDurationType"
    },
    "passwordStrengthTypeMetadata": {
      "$ref": "#/components/schemas/accountPasswordStrengthType"
    },
    "minimumPasswordLengthMetadata": {
      "$ref": "#/components/schemas/accountMinimumPasswordLength"
    },
    "lockoutDurationMinutesMetadata": {
      "$ref": "#/components/schemas/accountPasswordLockoutDurationMinutes"
    },
    "minimumPasswordAgeDaysMetadata": {
      "$ref": "#/components/schemas/accountPasswordMinimumPasswordAgeDays"
    },
    "passwordIncludeSpecialCharacter": {
      "type": "string",
      "description": "When **true,** passwords must include a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."
    },
    "passwordIncludeDigitOrSpecialCharacter": {
      "type": "string",
      "description": "When **true,** passwords must include either a digit or a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "accountPasswordRules"
}

{
  "type": "object",
  "properties": {
    "options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/accountPasswordStrengthTypeOption"
      },
      "description": "An array of option strings supported by this setting."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "accountPasswordStrengthType"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": ""
    },
    "minimumLength": {
      "type": "string",
      "description": "Minimum length of the access code string."
    },
    "passwordIncludeDigit": {
      "type": "string",
      "description": "When **true,** passwords must include a digit. The default value is `false`."
    },
    "passwordIncludeLowerCase": {
      "type": "string",
      "description": "When **true,** passwords must include a lowercase letter. The default value is `false`."
    },
    "passwordIncludeUpperCase": {
      "type": "string",
      "description": "When **true,** passwords must include an uppercase letter. The default value is `false`."
    },
    "passwordIncludeSpecialCharacter": {
      "type": "string",
      "description": "When **true,** passwords must include a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."
    },
    "passwordIncludeDigitOrSpecialCharacter": {
      "type": "string",
      "description": "When **true,** passwords must include either a digit or a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "accountPasswordStrengthTypeOption"
}

{
  "type": "object",
  "properties": {
    "webForms": {
      "type": "string",
      "description": ""
    },
    "vaultingMode": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "allowVaulting": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "powerFormRole": {
      "type": "string",
      "description": "The PowerForms rights associated with the account permission profile. Valid values are:\n\n- `none` \n- `user` \n- `admin`\n"
    },
    "allowApiAccess": {
      "type": "string",
      "description": "When **true,** users can manage documents by using the API."
    },
    "allowAutoTagging": {
      "type": "string",
      "description": " When **true,** auto-tagging is enabled for the account."
    },
    "allowBulkSending": {
      "type": "string",
      "description": "When **true,** bulk sending is enabled for users."
    },
    "webFormsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowTransactions": {
      "type": "string",
      "description": ""
    },
    "canCreateWorkspaces": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "disableOtherActions": {
      "type": "string",
      "description": "When **true,** users can access the **Other Actions** menu."
    },
    "allowESealRecipients": {
      "type": "string",
      "description": "When **true,** users can add electronic seal ([eSeal](https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html)) recipients."
    },
    "allowEnvelopeSending": {
      "type": "string",
      "description": "When **true,** users can send envelopes."
    },
    "canCreateTransaction": {
      "type": "string",
      "description": ""
    },
    "canDeleteTransaction": {
      "type": "string",
      "description": ""
    },
    "vaultingModeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowVaultingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowedTemplateAccess": {
      "type": "string",
      "description": "Specifies the level of access that users have to account templates. Valid values are: \n\n- `none` \n- `use`\n- `create`\n- `share`"
    },
    "disableDocumentUpload": {
      "type": "string",
      "description": "When **true,** users cannot upload documents."
    },
    "powerFormRoleMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowAccountManagement": {
      "type": "string",
      "description": "When **true,** users have full administrative access to the account."
    },
    "allowApiAccessMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSignerAttachments": {
      "type": "string",
      "description": "When **true,** users can add requests for attachments from signers."
    },
    "canSendEnvelopesViaSMS": {
      "type": "string",
      "description": ""
    },
    "useNewSendingInterface": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "allowApiAccessToAccount": {
      "type": "string",
      "description": "When **true,** users can access the account by using the eSignature API."
    },
    "allowWetSigningOverride": {
      "type": "string",
      "description": "When **true,** users can override the default account setting that controls whether recipients can sign documents on paper. The option to overrride this setting occurs during the sending process on a per-envelope basis."
    },
    "allowedClickwrapsAccess": {
      "type": "string",
      "description": ""
    },
    "enableApiRequestLogging": {
      "type": "string",
      "description": "When **true,** API request logging is enabled.\n\n**Note:** Logging limits apply."
    },
    "allowAutoTaggingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowBulkSendingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowedAddressBookAccess": {
      "type": "string",
      "description": "Specifies the level of access that users have to the account's address book. Valid values are:\n\n- `personal`\n- `useShared`\n- `usePersonalAndShared`\n- `personalAndShared`\n"
    },
    "signingUiVersionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowApiSequentialSigning": {
      "type": "string",
      "description": "When **true,** users may specify sequential signing recipients when they send documents by using the API."
    },
    "allowTransactionsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowDocuSignDesktopClient": {
      "type": "string",
      "description": "When **true,** the DocuSign Desktop Client is enabled for users.\n"
    },
    "allowSupplementalDocuments": {
      "type": "string",
      "description": "When **true,** senders can include supplemental documents."
    },
    "allowedOrchestrationAccess": {
      "type": "string",
      "description": ""
    },
    "canCreateWorkspacesMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableOtherActionsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowESealRecipientsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowEnvelopeSendingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowTaggingInSendAndCorrect": {
      "type": "string",
      "description": "When **true,** the tagger palette is visible during the sending and correct flows and users can add tabs to documents."
    },
    "canCreateTransactionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canDeleteTransactionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowedTemplateAccessMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableDocumentUploadMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "supplementalDocumentsMustRead": {
      "type": "string",
      "description": "When **true,** senders can require recipients to read supplemental documents."
    },
    "supplementalDocumentsMustView": {
      "type": "string",
      "description": "When **true,** users can require recipients to view supplemental documents."
    },
    "allowAccountManagementMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSignerAttachmentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canSendEnvelopesViaSMSMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "useNewSendingInterfaceMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowApiAccessToAccountMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowApiSendingOnBehalfOfOthers": {
      "type": "string",
      "description": "When **true,** users can send envelopes on behalf of others."
    },
    "allowWetSigningOverrideMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowedClickwrapsAccessMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canDeleteDocumentsInTransaction": {
      "type": "string",
      "description": ""
    },
    "enableApiRequestLoggingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "supplementalDocumentsMustAccept": {
      "type": "string",
      "description": "When **true,** senders can require recipients to accept supplemental documents."
    },
    "allowedAddressBookAccessMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSequentialSigningInterface": {
      "type": "string",
      "description": "When **true,** the sequential signing user interface is enabled."
    },
    "allowApiSequentialSigningMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableTransactionPointIntegration": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "useNewDocuSignExperienceInterface": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "allowDocuSignDesktopClientMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSupplementalDocumentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowedOrchestrationAccessMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableRecipientViewingNotifications": {
      "type": "string",
      "description": "When **true,** senders are notified when recipients view the documents that they send."
    },
    "allowTaggingInSendAndCorrectMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowedToBeEnvelopeTransferRecipient": {
      "type": "string",
      "description": "When **true,** users can be recipients of envelopes transferred to them by administrators of other accounts. "
    },
    "supplementalDocumentsMustReadMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "supplementalDocumentsMustViewMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowApiSendingOnBehalfOfOthersMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSendersToSetRecipientEmailLanguage": {
      "type": "string",
      "description": "When **true,** senders can set the language of the email that is sent to recipients."
    },
    "canDeleteDocumentsInTransactionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableKeyTermsSuggestionsByDocumentType": {
      "type": "string",
      "description": ""
    },
    "supplementalDocumentsMustAcceptMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSequentialSigningInterfaceMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableTransactionPointIntegrationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "useNewDocuSignExperienceInterfaceMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableRecipientViewingNotificationsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowedToBeEnvelopeTransferRecipientMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSendersToSetRecipientEmailLanguageMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableKeyTermsSuggestionsByDocumentTypeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "receiveCompletedSelfSignedDocumentsAsEmailLinks": {
      "type": "string",
      "description": "When **true,** senders receive emails about completed, self-signed documents that contain links to the completed documents instead of PDF attachments."
    },
    "allowPowerFormsAdminToAccessAllPowerFormEnvelopes": {
      "type": "string",
      "description": "When **true,** PowerForm Administrators can access all of the PowerForm envelopes associated with the account."
    },
    "receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "description": "This object defines account permissions for users who are associated with the account permission profile. ",
  "x-ms-summary": "This object defines account permissions for users who are associated with the account permission profile. ",
  "x-ds-definition-name": "accountRoleSettings"
}

{
  "type": "object",
  "properties": {
    "seals": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/sealIdentifier"
      },
      "description": "A list of electronic seals to apply to documents."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "accountSeals"
}

{
  "type": "object",
  "properties": {
    "usesAPI": {
      "type": "string",
      "description": "When **true,**\nthe account can use the API.\n\n**Note:** Only SysAdmin users can change this setting.\n"
    },
    "allowACE": {
      "type": "string",
      "description": ""
    },
    "bulkSend": {
      "type": "string",
      "description": "When **true,** this user can use the bulk send feature for the account."
    },
    "exitPrompt": {
      "type": "string",
      "description": ""
    },
    "accountName": {
      "type": "string",
      "description": "The name on the account."
    },
    "allowMarkup": {
      "type": "string",
      "description": "When **true,** the Document Markup feature is enabled.\n\n**Note:**  To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.\n"
    },
    "autoNavRule": {
      "type": "string",
      "description": "Specifies how auto-navigation works.\nValid values are:\n\n- `off`\n- `required_fields`\n- `required_and_blank_fields`\n- `all_fields`\n- `page_then_required_fields`\n- `page_then_required_and_blank_fields`\n- `page_then_all_fields`\n"
    },
    "enableDSPro": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "expressSend": {
      "type": "string",
      "description": "Boolean that specifies whether a member of an account can express send (without tags) or must send with tags on documents."
    },
    "hidePricing": {
      "type": "string",
      "description": "Boolean that specifies whether to hide the pricing functionality for an account."
    },
    "allowSignNow": {
      "type": "string",
      "description": "When **true,**\nthe account administrator can enable\nthe Sign Now feature.\n"
    },
    "enableSearch": {
      "type": "string",
      "description": ""
    },
    "readOnlyMode": {
      "type": "string",
      "description": ""
    },
    "allowBulkSend": {
      "type": "string",
      "description": "When **true,** bulk send functionality is enabled for the account.\n\n**Note:** Only Admin users can change this setting."
    },
    "allowInPerson": {
      "type": "string",
      "description": "When **true,** the account administrator can enable in-person signing.\n\n**Note:** Only SysAdmin users can change this setting.\n\n"
    },
    "allowWebForms": {
      "type": "string",
      "description": ""
    },
    "enableAutoNav": {
      "type": "string",
      "description": "When **true,** enables the account to set the AutoNav rule setting, which enables a sender to override the auto-navigation setting per envelope.\n\n**Note:** To change this setting, you must be a SysAdmin user or `EnableAutoNavByDSAdmin must be set."
    },
    "faxOutEnabled": {
      "type": "string",
      "description": "When **true,** fax delivery to recipients is allowed for the account.\n\n**Note:** Only Admin users can change this setting."
    },
    "idCheckExpire": {
      "type": "string",
      "description": "Determines when a user's authentication with the account expires. Valid values are:\n\n- `always`: Users are required to authenticate each time.\n- `variable`: If the authentication for a user is valid and falls within the value for the `idCheckExpireDays` property, the user is not required to authenticate again.\n\n**Note:** Only Admin users can change this setting."
    },
    "showTutorials": {
      "type": "string",
      "description": "When **true,**\nshow tutorials.\n"
    },
    "adoptSigConfig": {
      "type": "string",
      "description": "When **true,** [Signature Adoption Configuration](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=dsz1583277358168.html) is enabled. \n\n**Note:** Only Admin users can change this setting."
    },
    "allowIDVLevel1": {
      "type": "string",
      "description": "When **true,** IDV Level 1 is allowed. The default value is **false.**"
    },
    "allowIDVLevel2": {
      "type": "string",
      "description": ""
    },
    "allowIDVLevel3": {
      "type": "string",
      "description": ""
    },
    "allowReminders": {
      "type": "string",
      "description": "When **true,**\nan account administrator can to turn on reminders\nand expiration defaults for the account.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "billingAddress": {
      "$ref": "#/components/schemas/addressInformation"
    },
    "enableSearchUI": {
      "type": "string",
      "description": ""
    },
    "enableVaulting": {
      "type": "string",
      "description": "When **true,** Vaulting is enabled for the account."
    },
    "finishReminder": {
      "type": "string",
      "description": ""
    },
    "rsaVeridUserId": {
      "type": "string",
      "description": "The user ID for the RSA account.\n\n**Note:**\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it.\n"
    },
    "sessionTimeout": {
      "type": "string",
      "description": "The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes.\n"
    },
    "signDateFormat": {
      "type": "string",
      "description": "The format for the signature date. Valid values are:\n\n- `d/M/yyyy`\n- `dd-MM-yy`\n- `dd-MMM-yy`\n- `dd-MM-yyyy`\n- `dd.MM.yyyy`\n- `dd-MMM-yyyy`\n- `dd MMMM yyyy`\n- `M/d/yyyy`\n- `MM-dd-yyyy`\n- `MM/dd/yyyy`\n- `MM/dd/yy`\n- `MMM-dd-yyyy`\n- `MMM d, yyyy`\n- `MMMM d, yyyy`\n- `yyyy-MM-dd`\n- `yyyy-MMM-dd`\n- `yyyy/MM/dd`\n- `yyyy MMMM d`\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "signTimeFormat": {
      "type": "string",
      "description": "The format for the signature time. Valid values are:\n\n- `none`\n- `HH:mm`\n- `h:mm`\n- `HH:mm:ss`\n- `h:mm:ss`\n"
    },
    "useDerivedKeys": {
      "type": "string",
      "description": "Reserved for DocuSign.\n"
    },
    "advancedCorrect": {
      "type": "string",
      "description": "When **true,** the Advanced Correction feature is enabled for this account."
    },
    "allowCDWithdraw": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false.**\n**Note:** Only Admin users can change this setting."
    },
    "allowExpression": {
      "type": "string",
      "description": "If the account plan does not include calculated fields, this setting allows an account to use them.\n\n"
    },
    "allowSharedTabs": {
      "type": "string",
      "description": "When **true,**\nshared tabs are enabled for the account.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "bccEmailArchive": {
      "type": "string",
      "description": "Boolean that specifies whether BCC for Email Archive is enabled for the account. BCC for Email Archive allows you to set up an archive email address so that a BCC copy of an envelope is sent only to that address."
    },
    "cfrUseWideImage": {
      "type": "string",
      "description": "Boolean that specifies whether to use a shorter/wider format when generating the CFR Part 11 signature image."
    },
    "enableClickPlus": {
      "type": "string",
      "description": ""
    },
    "enablePowerForm": {
      "type": "string",
      "description": "When **true,** enables PowerForms for the account.\n\n**Note:** Only SysAdmin users can change this setting."
    },
    "idCheckRequired": {
      "type": "string",
      "description": "Indicates if authentication is configured for the account. Valid values are:\n\n- `always`: Authentication checks are performed on every envelope.\n- `never`: Authentication checks are not performed on any envelopes.\n- `optional`: Authentication is configurable per envelope.\n\n**Note:** Only Admin users can change this setting."
    },
    "rsaVeridRuleset": {
      "type": "string",
      "description": "The RSA rule set used with the account.\n\n**Note:**\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it.\n"
    },
    "usesAPIMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "accessCodeFormat": {
      "$ref": "#/components/schemas/accessCodeFormat"
    },
    "allowACEMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowAutoTagging": {
      "type": "string",
      "description": " When **true,** auto-tagging is enabled for the account."
    },
    "allowIDVPlatform": {
      "type": "string",
      "description": ""
    },
    "allowMergeFields": {
      "type": "string",
      "description": "When **true,** the account can use\n[merge fields](https://support.docusign.com/s/document-item?bundleId=evk1581360654067&topicId=ipy1581360621906.html)\nwith DocuSign for Salesforce.\n"
    },
    "allowSMSDelivery": {
      "type": "string",
      "description": ""
    },
    "bulkSendMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canSelfBrandSend": {
      "type": "string",
      "description": "When **true,** account administrators can self-brand their sending console through the DocuSign console."
    },
    "canSelfBrandSign": {
      "type": "string",
      "description": "When **true,** account administrators can self-brand their signing console through the DocuSign console."
    },
    "convertPdfFields": {
      "type": "string",
      "description": "Boolean that specifies whether to enable PDF form fields to get converted to DocuSign secure fields when the document is added or uploaded to an envelope."
    },
    "disableMobileApp": {
      "type": "string",
      "description": "When **true,** the mobile app distributor key is prevented from connecting for account users."
    },
    "enableClickwraps": {
      "type": "string",
      "description": "Boolean that specifies whether clickwraps are enabled in your app. A [clickwrap](https://raw.githubusercontent.com) is an iframe that you embed in your own website or app."
    },
    "enableWitnessing": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "enforceTlsEmails": {
      "type": "string",
      "description": ""
    },
    "inSessionEnabled": {
      "type": "string",
      "description": "When **true,** the account can send in-session (embedded) envelopes.\n\n**Note:** Only Admin users can change this setting."
    },
    "rsaVeridPassword": {
      "type": "string",
      "description": "The password for the RSA account.\n\n\n**Note:**\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it.\n"
    },
    "setRecipSignLang": {
      "type": "string",
      "description": "When **true,**\nsetting a unique language for a recipient\nnot only affects the email language, but also the signing\nlanguage they are presented with. When **false,** only the email will\nbe affected when the sender specifies a unique language for a\nrecipient.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "signTimeShowAmPm": {
      "type": "string",
      "description": "When **true,**\nthe time shows the AM or PM indicator.\n"
    },
    "signingUiVersion": {
      "type": "string",
      "description": "Reserved for DocuSign.\n"
    },
    "timezoneOffsetUI": {
      "type": "string",
      "description": "Specifies the time zone\nto use in the UI.\n\nValid values are:\n\n- `TZ_01_AfghanistanStandardTime`\n- `TZ_02_AlaskanStandardTime`\n- `TZ_03_ArabStandardTime`\n- `TZ_04_ArabianStandardTime`\n- `TZ_05_ArabicStandardTime`\n- `TZ_06_ArgentinaStandardTime`\n- `TZ_07_AtlanticStandardTime`\n- `TZ_08_AUS_CentralStandardTime`\n- `TZ_09_AUS_EasternStandardTime`\n- `TZ_10_AzerbaijanStandardTime`\n- `TZ_11_AzoresStandardTime`\n- `TZ_12_BangladeshStandardTime`\n- `TZ_13_CanadaCentralStandardTime`\n- `TZ_14_CapeVerdeStandardTime`\n- `TZ_15_CaucasusStandardTime`\n- `TZ_16_CentralAustraliaStandardTime`\n- `TZ_17_CentralAmericaStandardTime`\n- `TZ_18_CentralAsiaStandardTime`\n- `TZ_19_CentralBrazilianStandardTime`\n- `TZ_20_CentralEuropeStandardTime`\n- `TZ_21_CentralEuropeanStandardTime`\n- `TZ_22_CentralPacificStandardTime`\n- `TZ_23_CentralStandardTime`\n- `TZ_24_CentralStandardTimeMexico`\n- `TZ_25_ChinaStandardTime`\n- `TZ_26_DatelineStandardTime`\n- `TZ_27_E_AfricaStandardTime`\n- `TZ_28_E_AustraliaStandardTime`\n- `TZ_29_E_EuropeStandardTime`\n- `TZ_30_E_SouthAmericaStandardTime`\n- `TZ_31_EasternStandardTime`\n- `TZ_32_EgyptStandardTime`\n- `TZ_33_EkaterinburgStandardTime`\n- `TZ_34_FijiStandardTime`\n- `TZ_35_FLE_StandardTime`\n- `TZ_36_GeorgianStandardTime`\n- `TZ_37_GMT_StandardTime`\n- `TZ_38_GreenlandStandardTime`\n- `TZ_39_GreenwichStandardTime`\n- `TZ_40_GTB_StandardTime`\n- `TZ_41_HawaiianStandardTime`\n- `TZ_42_IndiaStandardTime`\n- `TZ_43_IranStandardTime`\n- `TZ_44_IsraelStandardTime`\n- `TZ_45_JordanStandardTime`\n- `TZ_46_KaliningradStandardTime`\n- `TZ_47_KamchatkaStandardTime`\n- `TZ_48_KoreaStandardTime`\n- `TZ_49_MagadanStandardTime`\n- `TZ_50_MauritiusStandardTime`\n- `TZ_51_MidAtlanticStandardTime`\n- `TZ_52_MiddleEastStandardTime`\n- `TZ_53_MontevideoStandardTime`\n- `TZ_54_MoroccoStandardTime`\n- `TZ_55_MountainStandardTime`\n- `TZ_56_MountainStandardTimeMMexico`\n- `TZ_57_MyanmarStandardTime`\n- `TZ_58_N_CentralAsiaStandardTime`\n- `TZ_59_NamibiaStandardTime`\n- `TZ_60_NepalStandardTime`\n- `TZ_61_NewZealandStandardTime`\n- `TZ_62_NewfoundlandStandardTime`\n- `TZ_63_NorthAsiaEastStandardTime`\n- `TZ_64_NorthAsiaStandardTime`\n- `TZ_65_PacificSAStandardTime`\n- `TZ_66_PacificStandardTime`\n- `TZ_67_PacificStandardTimeMexico`\n- `TZ_68_PakistanStandardTime`\n- `TZ_69_ParaguayStandardTime`\n- `TZ_70_RomanceStandardTime`\n- `TZ_71_RussianStandardTime`\n- `TZ_72_SAEasternStandardTime`\n- `TZ_73_SAPacificStandardTime`\n- `TZ_74_SAWesternStandardTime`\n- `TZ_75_SamoaStandardTime`\n- `TZ_76_SE_AsiaStandardTime`\n- `TZ_77_SingaporeStandardTime`\n- `TZ_78_SouthAfricaStandardTime`\n- `TZ_79_SriLankaStandardTime`\n- `TZ_80_SyriaStandardTime`\n- `TZ_81_TaipeiStandardTime`\n- `TZ_82_TasmaniaStandardTime`\n- `TZ_83_TokyoStandardTime`\n- `TZ_84_TongaStandardTime`\n- `TZ_85_TurkeyStandardTime`\n- `TZ_86_UlaanbaatarStandardTime`\n- `TZ_87_US_EasternStandardTime`\n- `TZ_88_USMountainStandardTime`\n- `TZ_89_VenezuelaStandardTime`\n- `TZ_90_VladivostokStandardTime`\n- `TZ_91_W_AustraliaStandardTime`\n- `TZ_92_W_CentralAfricaStandardTime`\n- `TZ_93_W_EuropeStandardTime`\n- `TZ_94_WestAsiaStandardTime`\n- `TZ_95_WestPacificStandardTime`\n- `TZ_96_YakutskStandardTime`\n"
    },
    "useNewBlobForPdf": {
      "type": "string",
      "description": "Reserved for DocuSign.\n"
    },
    "validationsBrand": {
      "type": "string",
      "description": "Valid values are:\n\n- `docusign`\n- `account`\n"
    },
    "waterMarkEnabled": {
      "type": "string",
      "description": "When **true,**\nthe\n[watermark feature](https://support.docusign.com/s/articles/How-do-I-manage-the-watermark-for-In-Process-envelopes-sent-from-my-account)\nis enabled for the account.\n"
    },
    "accountUISettings": {
      "$ref": "#/components/schemas/accountUISettings"
    },
    "allowDataDownload": {
      "type": "string",
      "description": "When **true,** senders can download form data from the envelopes that they send.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "allowEHankoStamps": {
      "type": "string",
      "description": "When **true,**\n[eHanko stamps](https://support.docusign.com/s/document-item?bundleId=jux1643235969954&topicId=dys1578456666697.html)\nare enabled.\n"
    },
    "allowRemoteNotary": {
      "type": "string",
      "description": ""
    },
    "displayBetaSwitch": {
      "type": "string",
      "description": "Boolean that specifies whether to display a Beta switch for your app."
    },
    "documentRetention": {
      "type": "string",
      "description": "Sets a document retention period, which controls the number of days that DocuSign retains documents after they have reached a completed,declined, or voided state. When document retention is enabled for the account, the default value is `356` days."
    },
    "enableReportLinks": {
      "type": "string",
      "description": "Enables direct links to envelopes in reports for administrators in the following scopes:\n- `NoEnvelopes`\n- `AllEnvelopes`\n- `OnlyOwnEnvelopes`"
    },
    "enableSendToAgent": {
      "type": "string",
      "description": "When **true,** this account can use the Agent recipient type.\n\n**Note:** Only SysAdmin users can change this setting.\n"
    },
    "enableSignOnPaper": {
      "type": "string",
      "description": "When **true,** a sender can allow signers to use the sign on paper option.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "idCheckExpireDays": {
      "type": "string",
      "description": "The number of days before user authentication credentials expire. A value of `0` specifies that users must re-authenticate for each new session.\n\n**Note:** Only Admin users can change this setting."
    },
    "setRecipEmailLang": {
      "type": "string",
      "description": "When **true,** senders can set the email language to use for\neach recipient.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "socialIdRecipAuth": {
      "type": "string",
      "description": "When **true,**\nrecipients can use\n[social ids](https://support.docusign.com/guides/signer-authentication)\nwhen signing\n"
    },
    "timezoneOffsetAPI": {
      "type": "string",
      "description": "Specifies the time zone\nto use with the API.\n\nValid values are:\n\n- `TZ_01_AfghanistanStandardTime`\n- `TZ_02_AlaskanStandardTime`\n- `TZ_03_ArabStandardTime`\n- `TZ_04_ArabianStandardTime`\n- `TZ_05_ArabicStandardTime`\n- `TZ_06_ArgentinaStandardTime`\n- `TZ_07_AtlanticStandardTime`\n- `TZ_08_AUS_CentralStandardTime`\n- `TZ_09_AUS_EasternStandardTime`\n- `TZ_10_AzerbaijanStandardTime`\n- `TZ_11_AzoresStandardTime`\n- `TZ_12_BangladeshStandardTime`\n- `TZ_13_CanadaCentralStandardTime`\n- `TZ_14_CapeVerdeStandardTime`\n- `TZ_15_CaucasusStandardTime`\n- `TZ_16_CentralAustraliaStandardTime`\n- `TZ_17_CentralAmericaStandardTime`\n- `TZ_18_CentralAsiaStandardTime`\n- `TZ_19_CentralBrazilianStandardTime`\n- `TZ_20_CentralEuropeStandardTime`\n- `TZ_21_CentralEuropeanStandardTime`\n- `TZ_22_CentralPacificStandardTime`\n- `TZ_23_CentralStandardTime`\n- `TZ_24_CentralStandardTimeMexico`\n- `TZ_25_ChinaStandardTime`\n- `TZ_26_DatelineStandardTime`\n- `TZ_27_E_AfricaStandardTime`\n- `TZ_28_E_AustraliaStandardTime`\n- `TZ_29_E_EuropeStandardTime`\n- `TZ_30_E_SouthAmericaStandardTime`\n- `TZ_31_EasternStandardTime`\n- `TZ_32_EgyptStandardTime`\n- `TZ_33_EkaterinburgStandardTime`\n- `TZ_34_FijiStandardTime`\n- `TZ_35_FLE_StandardTime`\n- `TZ_36_GeorgianStandardTime`\n- `TZ_37_GMT_StandardTime`\n- `TZ_38_GreenlandStandardTime`\n- `TZ_39_GreenwichStandardTime`\n- `TZ_40_GTB_StandardTime`\n- `TZ_41_HawaiianStandardTime`\n- `TZ_42_IndiaStandardTime`\n- `TZ_43_IranStandardTime`\n- `TZ_44_IsraelStandardTime`\n- `TZ_45_JordanStandardTime`\n- `TZ_46_KaliningradStandardTime`\n- `TZ_47_KamchatkaStandardTime`\n- `TZ_48_KoreaStandardTime`\n- `TZ_49_MagadanStandardTime`\n- `TZ_50_MauritiusStandardTime`\n- `TZ_51_MidAtlanticStandardTime`\n- `TZ_52_MiddleEastStandardTime`\n- `TZ_53_MontevideoStandardTime`\n- `TZ_54_MoroccoStandardTime`\n- `TZ_55_MountainStandardTime`\n- `TZ_56_MountainStandardTimeMMexico`\n- `TZ_57_MyanmarStandardTime`\n- `TZ_58_N_CentralAsiaStandardTime`\n- `TZ_59_NamibiaStandardTime`\n- `TZ_60_NepalStandardTime`\n- `TZ_61_NewZealandStandardTime`\n- `TZ_62_NewfoundlandStandardTime`\n- `TZ_63_NorthAsiaEastStandardTime`\n- `TZ_64_NorthAsiaStandardTime`\n- `TZ_65_PacificSAStandardTime`\n- `TZ_66_PacificStandardTime`\n- `TZ_67_PacificStandardTimeMexico`\n- `TZ_68_PakistanStandardTime`\n- `TZ_69_ParaguayStandardTime`\n- `TZ_70_RomanceStandardTime`\n- `TZ_71_RussianStandardTime`\n- `TZ_72_SAEasternStandardTime`\n- `TZ_73_SAPacificStandardTime`\n- `TZ_74_SAWesternStandardTime`\n- `TZ_75_SamoaStandardTime`\n- `TZ_76_SE_AsiaStandardTime`\n- `TZ_77_SingaporeStandardTime`\n- `TZ_78_SouthAfricaStandardTime`\n- `TZ_79_SriLankaStandardTime`\n- `TZ_80_SyriaStandardTime`\n- `TZ_81_TaipeiStandardTime`\n- `TZ_82_TasmaniaStandardTime`\n- `TZ_83_TokyoStandardTime`\n- `TZ_84_TongaStandardTime`\n- `TZ_85_TurkeyStandardTime`\n- `TZ_86_UlaanbaatarStandardTime`\n- `TZ_87_US_EasternStandardTime`\n- `TZ_88_USMountainStandardTime`\n- `TZ_89_VenezuelaStandardTime`\n- `TZ_90_VladivostokStandardTime`\n- `TZ_91_W_AustraliaStandardTime`\n- `TZ_92_W_CentralAfricaStandardTime`\n- `TZ_93_W_EuropeStandardTime`\n- `TZ_94_WestAsiaStandardTime`\n- `TZ_95_WestPacificStandardTime`\n- `TZ_96_YakutskStandardTime`\n"
    },
    "validationsReport": {
      "type": "string",
      "description": "Valid values are:\n\n- `none`\n- `life_sciences_part11`\n"
    },
    "allowManagedStamps": {
      "type": "string",
      "description": "When **true,** [Managed Stamps](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=cex1583277417267.html) are enabled."
    },
    "allowOrganizations": {
      "type": "string",
      "description": "Boolean that specifies whether [DocuSign Admin](https://raw.githubusercontent.com) is enabled for the account."
    },
    "allowSigningGroups": {
      "type": "string",
      "description": "When **true,** the account allows signing groups. This setting is only shown in responses that list account settings. This property is read-only."
    },
    "allowSocialIdLogin": {
      "type": "string",
      "description": "Deprecated."
    },
    "allowValueInsights": {
      "type": "string",
      "description": ""
    },
    "disableUserSharing": {
      "type": "string",
      "description": "When **true,** the User Sharing feature is disabled for the account."
    },
    "documentVisibility": {
      "type": "string",
      "description": "Configures the Document Visibility feature for the account. Valid values are:\n\n- `Off`: Document Visibility is not active for the account.\n- `MustSignToViewUnlessSenderAccount`: Document Visibility is enabled for all envelopes sent from the account. Any member of the sending account can view all of the documents in an envelope.\n- `MustSignToViewUnlessSender`: Document Visibility is enabled for all envelopes sent from the account. Only the sender can view all of the documents in an envelope.\n- `SenderCanSetMustSignToViewUnlessSenderAccount`: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents within it are still visible to any member of the sending account.\nVd- `SenderCanSetMustSignToViewUnlessSender`: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents in the envelope are visible only to the sender.\n\n**Note:** For this configuration to take effect, `allowDocumentVisibility` must be set to **true.**"
    },
    "enableBccDummyLink": {
      "type": "string",
      "description": ""
    },
    "enableSendToManage": {
      "type": "string",
      "description": "When **true,** this account can use the Editor recipient type.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "envelopeSearchMode": {
      "type": "string",
      "description": ""
    },
    "exitPromptMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signatureProviders": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Names of electronic or digital signature providers that can be used."
    },
    "signerAttachConcat": {
      "type": "string",
      "description": "When **true,** signer attachments are added to the parent document\nthat contains the attachment.\nThe default behavior creates\na new document in the envelope for every signer attachment.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "tabAccountSettings": {
      "$ref": "#/components/schemas/tabAccountSettings"
    },
    "validationsAllowed": {
      "type": "string",
      "description": "Boolean that specifies whether validations on recipient email domains are allowed."
    },
    "validationsCadence": {
      "type": "string",
      "description": "Valid values are:\n\n- `none`\n- `monthly`\n"
    },
    "validationsEnabled": {
      "type": "string",
      "description": "When **true,**\nenables validations.\n"
    },
    "accountNameMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "accountNotification": {
      "$ref": "#/components/schemas/accountNotification"
    },
    "allowConnectOAuthUI": {
      "type": "string",
      "description": ""
    },
    "allowDelayedRouting": {
      "type": "string",
      "description": "\"true\" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, \"false\" otherwise."
    },
    "allowENoteEOriginal": {
      "type": "string",
      "description": "Specifies whether eNote eOriginal integration is enabled.\n"
    },
    "allowIDVLevel1Trial": {
      "type": "string",
      "description": ""
    },
    "allowMarkupMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowMemberTimeZone": {
      "type": "string",
      "description": "When **true,** account users can set their own\n[time zone settings](https://support.docusign.com/s/articles/How-do-I-modify-time-zone-settings-for-my-account).\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "allowNonUSPhoneAuth": {
      "type": "string",
      "description": "Specifies whether users can use\ninternational numbers\nfor phone authentication.\n"
    },
    "allowOfflineSigning": {
      "type": "string",
      "description": "When **true,**\n[offline signing](https://support.docusign.com/articles/Offline-access-with-the-DocuSign-Mobile-App-for-iOS-iPad-iPhone-iPod-Touch)\nis enabled for the account.\n\n**Note:** Only Admin users can change this setting."
    },
    "allowSignerReassign": {
      "type": "string",
      "description": "When **true,** the recipient of an envelope sent from this account can reassign it to another person.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "authenticationCheck": {
      "type": "string",
      "description": "Sets when authentication checks are applied for recipient envelope access. This setting only applies to the following ID checks: \n\n- Phone Authentication\n- SMS Authentication\n- Knowledge-Based ID\n\nThis setting takes one of the following options: \n\n- `initial_access`: The authentication check always applies the first time a recipient accesses the documents. Recipients are not asked to authenticate again when they access the documents from the same browser on the same device. If the recipient attempts to access the documents from a different browser or a different device, the recipient must pass authentication again. Once authenticated, that recipient is not challenged again on the new device or browser. The ability for a recipient to skip authentication for documents is limited to documents sent from the same sending account.\n- `each_access`: Authentication checks apply every time a recipient attempts to access the envelope. However, you can configure the Authentication Expiration setting to allow recipients to skip authentication when they have recently passed authentication by setting a variable time frame.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "autoNavRuleMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dataPopulationScope": {
      "type": "string",
      "description": "Specifies how data is shared for tabs with the same tabLabel. Valid values are:\n\n- `document`: Tabs in a document with the same label populate with the same data.\n- `envelope`: Tabs in all documents in the envelope with the same label populate with the same data.\n- `notset`:   Use the global account setting.\n\nThis setting applies to the following tab types:\n\n- Check box\n- Company\n- Data field\n- Drop-down list\n- Full name\n- Formula\n- Note\n- Title\n\n**Note:** Only Admin users can change this setting. Changing this setting affects envelopes that have been sent but not completed."
    },
    "enableAdmHealthcare": {
      "type": "string",
      "description": "Account Level Flag that determines the availability to use ADM Healthcare fields"
    },
    "enableDSProMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableIDFxIntuitKBA": {
      "type": "string",
      "description": ""
    },
    "enableSocialIdLogin": {
      "type": "string",
      "description": "Deprecated."
    },
    "enableStrikeThrough": {
      "type": "string",
      "description": "When **true,** enables strikethrough formatting in documents."
    },
    "expressSendMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "hidePricingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "rsaVeridAccountName": {
      "type": "string",
      "description": "The RSA account name.\n\n**Note:**\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it.\n"
    },
    "sbsTransactionLevel": {
      "type": "string",
      "description": ""
    },
    "sendingTagsFontName": {
      "type": "string",
      "description": "The account-wide default 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`"
    },
    "sendingTagsFontSize": {
      "type": "string",
      "description": "The account-wide default font size used for the information in the tab:\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`"
    },
    "singleSignOnEnabled": {
      "type": "string",
      "description": "When **true,**\nsingle sign-on (SSO) is enabled.\n"
    },
    "useSmartContractsV1": {
      "type": "string",
      "description": ""
    },
    "allowAutoNavSettings": {
      "type": "string",
      "description": "  When **true,** auto-navigation can be enabled for this account.\n"
    },
    "allowDocGenDocuments": {
      "type": "string",
      "description": ""
    },
    "allowEnvelopeCorrect": {
      "type": "string",
      "description": "When **true,** the envelope correction feature is enabled.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "allowServerTemplates": {
      "type": "string",
      "description": "When **true,**\nthe account can use templates.\n"
    },
    "allowSignNowMetadata": {
      "type": "string",
      "description": "Metadata that indicates whether the `allowSignNow` property is editable.\n"
    },
    "allowSignatureStamps": {
      "type": "string",
      "description": "When **true,** Signature Stamps are enabled.\n\n**Note:** Only Admin users can change this setting."
    },
    "allowSigningInsights": {
      "type": "string",
      "description": ""
    },
    "disableMobileSending": {
      "type": "string",
      "description": "When **true,** sending from a mobile application is disabled.\n\n**Note:** Only Admin users can change this setting."
    },
    "emailTemplateVersion": {
      "type": "string",
      "description": "Specifies the version of the email templates used in an account. If new signing is selected in a member's Admin page, the user is updated to the newest version (1.1), the minimum version of email supported for the account."
    },
    "enablePDFAConversion": {
      "type": "string",
      "description": ""
    },
    "enableReservedDomain": {
      "type": "string",
      "description": "When **true,** account administrators can reserve a web domain and users. Domains are organization-specific reserved internet domains, such as `@exampledomain.com`. You can define policy settings for users of each reserved domain within your organization, export lists of domain users for audit purposes, and manage domain users.\n\n- Domains may be claimed by an organization.\n- When a domain is claimed by an organization, all users within that domain are added to the organization, even if they have trial or free accounts.\n- You can set domain controls for all users of the domain.\n- You can export information about your organization’s users that are associated with your reserved domains.\n\n**Note:** Only SysAdmin users can change this setting."
    },
    "enableSearchMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSignWithNotary": {
      "type": "string",
      "description": "When **true,** Sign with Notary functionality is enabled for the account.\n\n**Note:** Only Admin users can change this setting."
    },
    "enableSmartContracts": {
      "type": "string",
      "description": "When **true,** blockchain-based [Smart Contracts](https://www.docusign.com/products/blockchain) are enabled. The default value is **false.**"
    },
    "expressSendAllowTabs": {
      "type": "string",
      "description": "Boolean that specifies whether a member of an account can send templates without the tags being stripped out, even when the account is configured to let its users express send only (they cannot use the tagger)."
    },
    "idCheckExpireMinutes": {
      "type": "string",
      "description": "The number of minutes before user authentication credentials expire."
    },
    "identityVerification": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/accountIdentityVerificationWorkflow"
      },
      "description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](https://raw.githubusercontent.com) method in the [IdentityVerifications](https://raw.githubusercontent.com) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)."
    },
    "maximumSigningGroups": {
      "type": "string",
      "description": "The maximum number of signing groups allowed on the account. The default value is `50`. This setting is only shown in responses that list account settings.\n\n**Note:** Only SysAdmin users can change this setting."
    },
    "mobileSessionTimeout": {
      "type": "string",
      "description": "The number of minutes of inactivity before a mobile user is automatically logged out of the system. Valid values are `1` to `120` minutes. The default value is `20` minutes.\n\n**Note:** Only Admin users can change this setting."
    },
    "readOnlyModeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "requireDeclineReason": {
      "type": "string",
      "description": "When **true,** signers who decline to sign an envelope sent from this account\nare required to provide a reason for declining.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "sendingTagsFontColor": {
      "type": "string",
      "description": "The account-wide default font color to use for the content of the tab.\n\nValid values are:\n\n- `Black`\n- `BrightBlue`\n- `BrightRed`\n- `DarkGreen`\n- `DarkRed`\n- `Gold`\n- `Green`\n- `NavyBlue`\n- `Purple`\n- `White`\n"
    },
    "useAccountLevelEmail": {
      "type": "string",
      "description": "Reserved for DocuSign.\n"
    },
    "useNewEnvelopeSearch": {
      "type": "string",
      "description": ""
    },
    "accountDateTimeFormat": {
      "type": "string",
      "description": "UTC date/time format for the account."
    },
    "allowAccessCodeFormat": {
      "type": "string",
      "description": "When **true,** the configured [Access Code Format](/docs/esign-rest-api/reference/accounts/accounts/get/#accessCodeFormat) page is enabled for account administrators.\n\n**Note:** Only Admin users can change this setting."
    },
    "allowAgreementActions": {
      "type": "string",
      "description": ""
    },
    "allowBulkSendMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowDelegatedSigning": {
      "type": "string",
      "description": ""
    },
    "allowInPersonMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowRecipientConnect": {
      "type": "string",
      "description": ""
    },
    "allowScheduledSending": {
      "type": "string",
      "description": "\"true\" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, \"false\" otherwise."
    },
    "allowWebFormsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowWhatsAppDelivery": {
      "type": "string",
      "description": ""
    },
    "anchorPopulationScope": {
      "type": "string",
      "description": "This property determines how template anchor tabs are applied.\n\nValid values are:\n\n- `document`: Anchor tabs are applied only to the document that you specify. \n- `envelope`: Anchor tabs are applied to all of the documents in the envelope associated with the template.\n\n**Note:** When you are using the `anchorPopulationScope` property with a Composite Template, the value `document` is supported only with a single server template and a single inline template.\n\n"
    },
    "canUseSalesforceOAuth": {
      "type": "string",
      "description": ""
    },
    "captureVoiceRecording": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "disableSignerCertView": {
      "type": "string",
      "description": "When **true,** signers cannot view certificates of completion."
    },
    "disableStyleSignature": {
      "type": "string",
      "description": "When **true,** the **Select Style** option is hidden from signers and they must draw their signature instead. "
    },
    "enableAutoNavMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableDSigExpressPens": {
      "type": "string",
      "description": ""
    },
    "enableInBrowserEditor": {
      "type": "string",
      "description": ""
    },
    "enablePowerFormDirect": {
      "type": "string",
      "description": "When **true,** enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms.\n\n**Note:** Only Admin users can change this setting."
    },
    "faxOutEnabledMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "idCheckConfigurations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/idCheckConfiguration"
      },
      "description": "A list of ID check configuration objects."
    },
    "idCheckExpireMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "mergeMixedModeResults": {
      "type": "string",
      "description": ""
    },
    "optInMobileSigningV02": {
      "type": "string",
      "description": "Boolean that specifies whether to opt in for Signing v02 on Mobile Devices functionality."
    },
    "optOutNewPlatformSeal": {
      "type": "string",
      "description": "Boolean that specifies whether to allow envelope senders to opt out of using the new platform seal."
    },
    "sharedTemplateFolders": {
      "type": "string",
      "description": "Boolean that specifies whether an account can use Shared Template Folders."
    },
    "showTutorialsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signerCanSignOnMobile": {
      "type": "string",
      "description": "When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "signerMustHaveAccount": {
      "type": "string",
      "description": "When **true,** senders can only send an envelope to a recipient\nthat has a DocuSign account.\n\n**Note:** Only Account Administrators can change this setting.\n"
    },
    "signerMustLoginToSign": {
      "type": "string",
      "description": "When **true,**\nsigners must log in to the DocuSign platform to sign an envelope.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "signingSessionTimeout": {
      "type": "string",
      "description": "The number of minutes\nthat a signing session stays\nalive without any activity.\n"
    },
    "useConsumerDisclosure": {
      "type": "string",
      "description": "When **true,** the account uses an Electronic Record and\nSignature Disclosure Statement.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "useMultiAppGroupsData": {
      "type": "string",
      "description": ""
    },
    "accountDefaultLanguage": {
      "type": "string",
      "description": ""
    },
    "adoptSigConfigMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowEnvelopeReporting": {
      "type": "string",
      "description": "Specifies whether the account has access to reports.\n"
    },
    "allowIDVLevel1Metadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowIDVLevel2Metadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowIDVLevel3Metadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowPaymentProcessing": {
      "type": "string",
      "description": "When **true,** payment processing is enabled for the account.\n\n**Note:** Only Admin users can change this setting."
    },
    "allowPhoneAuthOverride": {
      "type": "string",
      "description": "Boolean that specifies whether users can override phone authentication."
    },
    "allowRemindersMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSecurityAppliance": {
      "type": "string",
      "description": "Boolean that specifies whether a DocuSign Signature Appliance can be used with the account."
    },
    "allowSigningExtensions": {
      "type": "string",
      "description": "Boolean that specifies whether Signing and App Extensions are allowed."
    },
    "billingAddressMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "chromeSignatureEnabled": {
      "type": "string",
      "description": "Boolean that specifies whether the signers of the envelopes from this account use a signature with a DocuSign chrome around it or not."
    },
    "disableUploadSignature": {
      "type": "string",
      "description": "When **true,** signers cannot upload custom image files of their signature and initials.\n\n**Note:** Only Admin users can change this setting."
    },
    "draftEnvelopeRetention": {
      "type": "string",
      "description": ""
    },
    "enableAdvancedPayments": {
      "type": "string",
      "description": "When **true,** enables Advanced Payments for the account."
    },
    "enableCalculatedFields": {
      "type": "string",
      "description": "When **true,** calculated fields are enabled for the account. \n\n**Note:** This setting can be changed only by Admin users, and only if the account-level setting `allowExpression` is set to **true.**"
    },
    "enableEsignCommunities": {
      "type": "string",
      "description": ""
    },
    "enableLargeFileSupport": {
      "type": "string",
      "description": ""
    },
    "enableScheduledRelease": {
      "type": "string",
      "description": "When **true,** scheduled releases are enabled. The default value is **false.**"
    },
    "enableSearchUIMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableTransactionPoint": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "enableVaultingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "finishReminderMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "guidedFormsHtmlAllowed": {
      "type": "string",
      "description": "When **true,** HTML used to implement [Guided Forms](https://www.docusign.com/products/guided-forms) is enabled for the account."
    },
    "inPersonSigningEnabled": {
      "type": "string",
      "description": "When **true,** in-person signing is enabled for the account."
    },
    "sessionTimeoutMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signDateFormatMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signTimeFormatMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signerCanCreateAccount": {
      "type": "string",
      "description": "When **true,**\na signer can create a DocuSign account\nafter signing.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "startInAdvancedCorrect": {
      "type": "string",
      "description": "When **true,**\nwhen initiating correction of an in-flight envelope\nthe sender starts in advanced correct mode.\n"
    },
    "useDerivedKeysMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "advancedCorrectMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowAgentNameEmailEdit": {
      "type": "string",
      "description": "  When **true,** an agent recipient can change the email addresses of recipients later in the signing order.\n"
    },
    "allowCDWithdrawMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowDocumentVisibility": {
      "type": "string",
      "description": "When **true,** the [Document Visibility](https://support.docusign.com/guides/ndse-user-guide-document-visibility) feature is enabled for the account.\n"
    },
    "allowExpressionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSendToIntermediary": {
      "type": "string",
      "description": "When **true,**\nthe account admin can enable the Send to Intermediary\nfeature on the account.\n"
    },
    "allowSharedTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "attachCompletedEnvelope": {
      "type": "string",
      "description": "When **true,** envelope documents are included as a PDF file attachment to \"signing completed\" emails.\n\n**Note:** Only SysAdmin users can change this setting."
    },
    "bccEmailArchiveMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "betaSwitchConfiguration": {
      "type": "string",
      "description": "Reserved for DocuSign.\n"
    },
    "cfrUseWideImageMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableMultipleSessions": {
      "type": "string",
      "description": "When **true,** account users cannot be logged into multiple sessions at the same time.\n\n**Note:** Only Admin users can change this setting."
    },
    "enableAccountWideSearch": {
      "type": "string",
      "description": ""
    },
    "enableClickPlusMetaData": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enablePaymentProcessing": {
      "type": "string",
      "description": "When **true,** payment processing is enabled for this account.\n\n**Note:** This setting can be changed only by Admin users, and only if the account-level setting `allowPaymentProcessing` is set."
    },
    "enablePowerFormMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableResponsiveSigning": {
      "type": "string",
      "description": "When **true,** enables responsive signing."
    },
    "enableSMSAuthentication": {
      "type": "string",
      "description": "When **true,** the account can use SMS authentication.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "enableSignerAttachments": {
      "type": "string",
      "description": "When **true,** users can use the signing attachments feature to request attachments from signers.\n\n**Note:** Only Admin users can change this setting."
    },
    "externalDocumentSources": {
      "$ref": "#/components/schemas/externalDocumentSources"
    },
    "hideAccountAddressInCoC": {
      "type": "string",
      "description": "Boolean that specifies whether to hide the account address in the Certificate of Completion."
    },
    "idCheckRequiredMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "inPersonIDCheckQuestion": {
      "type": "string",
      "description": "A text field containing the question that an in-person signing host uses to collect personal information from the recipient. The recipient's response to this question is saved and can be viewed in the certificate associated with the envelope.\n\n**Note:** Only Admin users can change this setting."
    },
    "inSessionSuppressEmails": {
      "type": "string",
      "description": "When **true,** emails are not sent to the in-session (embedded) recipients on an envelope.\n\n**Note:** Only Admin users can change this setting."
    },
    "maxNumberOfCustomStamps": {
      "type": "string",
      "description": "The maximum number of custom stamps."
    },
    "showLocalizedWatermarks": {
      "type": "string",
      "description": "Boolean that specifies whether localized watermarks are displayed."
    },
    "signerLoginRequirements": {
      "type": "string",
      "description": "Sets the login requirements for signers. Valid values are:\n\n- `login_not_required`: Signers are not required to log in.\n- `login_required_if_account_holder`: If the signer has a DocuSign account,\n  they must log in to sign the document.\n- `login_required_per_session`: The sender cannot send an envelope to anyone\n  who does not have a DocuSign account.\n- `login_required_per_envelope`: The sender cannot send an envelope to anyone\n  who does not have a DocuSign account, and the signer must also log in for\n  each envelope they will sign.\n\n\n**Note:** Only Admin users can change this setting. If you use Direct PowerForms\nor captive (embedded signers), the \"Account required\" settings are bypassed for\nthose signers. If your workflow requires that the signer have an account,\nyou should not use those methods.\n"
    },
    "universalSignatureOptIn": {
      "type": "string",
      "description": "Reserved for DocuSign.\n"
    },
    "allowAutoTaggingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowDocumentDisclosures": {
      "type": "string",
      "description": "Boolean that specifies whether disclosure documents can be included in envelopes."
    },
    "allowIDVPlatformMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowMergeFieldsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowPhoneAuthentication": {
      "type": "string",
      "description": "Boolean that specifies whether phone authentication is enabled for the account."
    },
    "allowSMSDeliveryMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "bulkSendMaxCopiesInBatch": {
      "type": "string",
      "description": ""
    },
    "canSelfBrandSendMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canSelfBrandSignMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "conditionalFieldsEnabled": {
      "type": "string",
      "description": "When **true,** conditional fields can be used in documents.\n\n**Note:** Only Admin users can change this setting."
    },
    "convertPdfFieldsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableMobileAppMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableSignerHistoryView": {
      "type": "string",
      "description": "When **true,** signers cannot view envelope history."
    },
    "enableAdvancedPowerForms": {
      "type": "string",
      "description": "When **true,** enables advanced PowerForms for the account."
    },
    "enableClickwrapsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableContactSuggestions": {
      "type": "string",
      "description": ""
    },
    "enableDSigEUAdvancedPens": {
      "type": "string",
      "description": ""
    },
    "enableInboxRelevanceSort": {
      "type": "string",
      "description": ""
    },
    "enableRequireSignOnPaper": {
      "type": "string",
      "description": "When **true,** the account can use the `requireSignOnPaper` option.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "enableSMSDeliveryPrimary": {
      "type": "string",
      "description": ""
    },
    "enableSendToIntermediary": {
      "type": "string",
      "description": "When **true,** this account can use the Intermediary recipient type.\n\n**Note:** Only Admin users can change this setting, and only if `allowSendToIntermediary` is set.\n"
    },
    "enableWitnessingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enforceTlsEmailsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "externalSignaturePadType": {
      "type": "string",
      "description": "Specifies the signature pad type.\nValid values are:\n\n- `none`\n- `topaz`\n- `e_padv9`\n- `e_pad_integrisign`\n- `topaz_sigplusextlite`\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "inSessionEnabledMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "optInUniversalSignatures": {
      "type": "string",
      "description": ""
    },
    "pkiSignDownloadedPDFDocs": {
      "type": "string",
      "description": "The policy for adding a digital certificate to downloaded, printed, and emailed documents. \n\nPossible values are: \n\n- `no_sign`\n- `no_sign_allow_user_override`\n- `yes_sign` (Specifies that PDF files downloaded from the platform are signed.)\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "recipientsCanSignOffline": {
      "type": "string",
      "description": "When **true,**\nrecipients receiving envelopes from this account\ncan sign offline.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "setRecipSignLangMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signTimeShowAmPmMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signingUiVersionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "simplifiedSendingEnabled": {
      "type": "string",
      "description": "When **true,** simplified sending is enabled for the account. The default value is **false.**"
    },
    "timezoneOffsetUIMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "useNewBlobForPdfMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "validationsBrandMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "waterMarkEnabledMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowDataDownloadMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowEHankoStampsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowEnvelopeCustomFields": {
      "type": "string",
      "description": "Specifies whether\n[envelope custom fields](https://support.docusign.com/s/document-item?bundleId=jux1643235969954&topicId=mns1578456285568.html)\nare enabled.\n"
    },
    "allowExternalSignaturePad": {
      "type": "string",
      "description": "When **true,** the account can\nconfigure and use signature pads for their recipients.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "allowPerformanceAnalytics": {
      "type": "string",
      "description": ""
    },
    "allowPrivateSigningGroups": {
      "type": "string",
      "description": "Reserved for DocuSign. This property returns the value **false** when listing account settings. This property is read-only."
    },
    "allowRemoteNotaryMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowResourceFileBranding": {
      "type": "string",
      "description": "When **true,**\nresource files can be uploaded in branding.\n"
    },
    "allowSigningRadioDeselect": {
      "type": "string",
      "description": "Boolean that specifies whether the account supports radio buttons on tabs [Radio CustomTabType](https://raw.githubusercontent.com)."
    },
    "bulkSendActionResendLimit": {
      "type": "string",
      "description": ""
    },
    "displayBetaSwitchMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "documentRetentionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableAccessCodeGenerator": {
      "type": "string",
      "description": "When **true,** enables Access Code Generator on the account."
    },
    "enableReportLinksMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSendToAgentMetadata": {
      "$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"
    },
    "enableSignOnPaperMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "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."
    },
    "idCheckExpireDaysMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "setRecipEmailLangMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "socialIdRecipAuthMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "specifyDocumentVisibility": {
      "type": "string",
      "description": "When **true,** senders can specify the visibility of the documents in an envelope at the recipient level.\n"
    },
    "timezoneOffsetAPIMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "useSAFESignerCertificates": {
      "type": "string",
      "description": "When **true,**\nsigners are\nrequired to use SAFE digital signatures.\n"
    },
    "validationsReportMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowManagedStampsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowMultipleBrandProfiles": {
      "type": "string",
      "description": "Specifies whether the account supports multiple brands.\n"
    },
    "allowOrganizationsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSigningGroupsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSocialIdLoginMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSupplementalDocuments": {
      "type": "string",
      "description": "When **true,** this user can include supplemental documents."
    },
    "allowTransactionsWorkspace": {
      "type": "string",
      "description": ""
    },
    "allowValueInsightsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "autoProvisionSignerAccount": {
      "type": "string",
      "description": "Boolean that specifies whether to automatically provision a user membership in the account for accountless recipients. (Also known as Just-in-Time provisioning.)"
    },
    "disableUserSharingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "documentRetentionPurgeTabs": {
      "type": "string",
      "description": "When **true** and `documentRetention` is set, document fields and metadata are also purged after the document retention period ends. The default value is **false.**\n\n**Note:** Only Admins can change this setting."
    },
    "documentVisibilityMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableBccDummyLinkMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableClickPlusCustomStyle": {
      "type": "string",
      "description": ""
    },
    "enableSendToManageMetadata": {
      "$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."
    },
    "envelopeIntegrationAllowed": {
      "type": "string",
      "description": "Shows the envelope integration rule for the account, which indicates whether custom admins can enable Connect for their accounts. Enumeration values are: \n\n- `not_allowed`\n- `full` \n\n**Note:** Only SysAdmin users can change this setting.                                                                                 "
    },
    "envelopeIntegrationEnabled": {
      "type": "string",
      "description": "When **true,** enables Connect for an account. Note that Connect integration requires additional configuration that must be set up for it to take effect; this switch is only the on/off control for the account.\n\n**Note:** Only Admin users can change this setting, and only when `envelopeIntegrationAllowed` is set."
    },
    "envelopeSearchModeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "numberOfActiveCustomStamps": {
      "type": "string",
      "description": "The number of active custom stamps associated with the account. DocuSign calculates this number automatically. This property is only visible to the DocuSign account manager."
    },
    "pdfMaxIndividualUploadSize": {
      "type": "string",
      "description": ""
    },
    "require21CFRpt11Compliance": {
      "type": "string",
      "description": "When **true,**\nrecipients are required\nto use a 21 CFR part 11-compliant signing experience.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "signatureProvidersMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signerAttachConcatMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "skipAuthCompletedEnvelopes": {
      "type": "string",
      "description": "When **true,**\ndo not require authentication prompt for viewing completed envelopes\n"
    },
    "useEnvelopeSearchMixedMode": {
      "type": "string",
      "description": ""
    },
    "validationsAllowedMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "validationsCadenceMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "validationsEnabledMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowConnectSendFinishLater": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "allowDelayedRoutingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowENoteEOriginalMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowExternalLinkedAccounts": {
      "type": "string",
      "description": ""
    },
    "allowIDVLevel1TrialMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowMemberTimeZoneMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowNonUSPhoneAuthMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowOcrOfEnvelopeDocuments": {
      "type": "string",
      "description": ""
    },
    "allowOfflineSigningMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSignerReassignMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSignerReassignOverride": {
      "type": "string",
      "description": "When **true,** an account administrator can override the ability of an envelope recipient to reassign it to another person.\n\n**Note:** Only Admin users can change this setting."
    },
    "allowUsersToAccessDirectory": {
      "type": "string",
      "description": ""
    },
    "authenticationCheckMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "commentEmailShowMessageText": {
      "type": "string",
      "description": "When **true,** the text of comments is included in email notifications when a comment is posted.\n\n**Note:**  If the envelope requires additional recipient authentication, comment text is not included."
    },
    "consumerDisclosureFrequency": {
      "type": "string",
      "description": "Speficies how often to display the consumer disclosure.\n\nValid values are:\n\n- `once`: Per account, the supplemental document is displayed once only per `userId`. \n- `always`: Per envelope, the supplemental document is displayed once only per `userId`. \n- `each_access`: Per envelope, the supplemental document is displayed once only per `recipientId`.\n"
    },
    "dataPopulationScopeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableAutoTemplateMatching": {
      "type": "string",
      "description": ""
    },
    "enableAdmHealthcareMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableClickPlusCustomFields": {
      "type": "string",
      "description": ""
    },
    "enableDSigIDCheckForAESPens": {
      "type": "string",
      "description": ""
    },
    "enableIDFxIntuitKBAMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSearchServiceAzureUri": {
      "type": "string",
      "description": ""
    },
    "enableSearchSiteSpecificApi": {
      "type": "string",
      "description": ""
    },
    "enableSocialIdLoginMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableStrikeThroughMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "maximumUsersPerSigningGroup": {
      "type": "string",
      "description": "The maximum number of users per signing group. The default value is `50`. This setting is only shown in responses that list account settings.\n\n**Note:** Only SysAdmin users can change this setting."
    },
    "pdfMaxChunkedUploadPartSize": {
      "type": "string",
      "description": ""
    },
    "senderCanSignInEachLocation": {
      "type": "string",
      "description": "When **true,** a signer can draw their signature in each\nlocation where a sign or initial tab exists. This functionality\nis typically used for mobile signing.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "sendingTagsFontNameMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "sendingTagsFontSizeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "singleSignOnEnabledMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "wurflMinAllowableScreenSize": {
      "type": "string",
      "description": "The smallest screen allowed."
    },
    "advancedSearchEnableTabField": {
      "type": "string",
      "description": ""
    },
    "allowAccountMemberNameChange": {
      "type": "string",
      "description": "Boolean that specifies whether member names can be changed in the account."
    },
    "allowAgreementOrchestrations": {
      "type": "string",
      "description": ""
    },
    "allowAutoNavSettingsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowConnectUnifiedPayloadUI": {
      "type": "string",
      "description": ""
    },
    "allowDocGenDocumentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowEnvelopeCorrectMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowEnvelopeCustodyTransfer": {
      "type": "string",
      "description": "Specifies whether the account is able to\nmanage rules that [transfer ownership](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=xqx1583277378404.html)\nof envelopes within the same account.\n\n\n\n"
    },
    "allowSendToCertifiedDelivery": {
      "type": "string",
      "description": "When **true,**\nthe account admin can enable the\nSend to Certified Delivery\nfeature on the account.\n"
    },
    "allowServerTemplatesMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSignatureStampsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSigningInsightsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableMobileSendingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "emailTemplateVersionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableAgreementActionsForCLM": {
      "type": "string",
      "description": ""
    },
    "enableDSigIDVerificationPens": {
      "type": "string",
      "description": ""
    },
    "enablePDFAConversionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableReservedDomainMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSignWithNotaryMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSmartContractsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "envelopeStampingDefaultValue": {
      "type": "string",
      "description": "When **true,** envelopes sent by this account automatically have the envelope ID stamped in the document margins, unless the sender selects not to have the documents stamped."
    },
    "expressSendAllowTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "idCheckExpireMinutesMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "identityVerificationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "maximumSigningGroupsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "mobileSessionTimeoutMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "pdfMaxChunkedUploadTotalSize": {
      "type": "string",
      "description": ""
    },
    "requireDeclineReasonMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "requireSignerCertificateType": {
      "type": "string",
      "description": "Sets the Digital Signature certificate requirements for sending envelopes.\nValid values are:\n\n- `none`: A Digital Signature certificate is not required.\n- `docusign_express`: Signers must use a DocuSign Express certificate.\n- `docusign_personal`: Signers must use a DocuSign personal certificate.\n- `safe`\n- `open_trust`: Signers must use an OpenTrust certificate.\n"
    },
    "sendingTagsFontColorMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "showConditionalRoutingOnSend": {
      "type": "string",
      "description": "When **true,** Conditional Routing options display to senders during the sending experience."
    },
    "showInitialConditionalFields": {
      "type": "string",
      "description": "Boolean that specifies whether conditional field options are initially displayed (before a user makes entries)."
    },
    "useAccountLevelEmailMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "useNewEnvelopeSearchMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "useSignatureProviderPlatform": {
      "type": "string",
      "description": "Boolean that specifies whether the account uses the digital signature provider platform to eSign."
    },
    "accountDateTimeFormatMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowAccessCodeFormatMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowAgreementActionsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowDelegatedSigningMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowEnvelopePublishReporting": {
      "type": "string",
      "description": "When **true,** envelope publishing reporting is enabled.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "allowExpressSignerCertificate": {
      "type": "string",
      "description": "When **true,** signers are required to use Express Digital Signatures.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "allowInPersonElectronicNotary": {
      "type": "string",
      "description": "Account-level flag that determines the ability to perform In-Person Electronic Notary (IPEN) actions.\n"
    },
    "allowParticipantRecipientType": {
      "type": "string",
      "description": ""
    },
    "allowRecipientConnectMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowScheduledSendingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSignDocumentFromHomePage": {
      "type": "string",
      "description": "When **true,** recipients can sign documents from the home page.\n\n**Note:** Only Admin users can change this setting."
    },
    "allowWhatsAppDeliveryMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "anchorPopulationScopeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "canUseSalesforceOAuthMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "captureVoiceRecordingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "cfr21SimplifiedSigningEnabled": {
      "type": "string",
      "description": ""
    },
    "commentsAllowEnvelopeOverride": {
      "type": "string",
      "description": "When **true** and comments are enabled for the account, senders can disable comments for an envelope through the **Advanced Options** menu that appears during the sending process."
    },
    "disableSignerCertViewMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableStyleSignatureMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableAdvancedEnvelopesSearch": {
      "type": "string",
      "description": ""
    },
    "enableClickPlusDynamicContent": {
      "type": "string",
      "description": ""
    },
    "enableDSigExpressPensMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableIDFxPhoneAuthentication": {
      "type": "string",
      "description": ""
    },
    "enableInBrowserEditorMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enablePowerFormDirectMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSendingTagsFontSettings": {
      "type": "string",
      "description": "When **true,** enables fonts to be set on tags for the account."
    },
    "enforceTemplateNameUniqueness": {
      "type": "string",
      "description": "When **true,** the template name must be unique."
    },
    "idfxKBAAuthenticationOverride": {
      "type": "string",
      "description": ""
    },
    "linkedExternalPrimaryAccounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/linkedExternalPrimaryAccount"
      },
      "description": ""
    },
    "mergeMixedModeResultsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "optInMobileSigningV02Metadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "requireExternalUserManagement": {
      "type": "string",
      "description": "When **true,** the account requires external management of users.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "senderMustAuthenticateSigning": {
      "type": "string",
      "description": "When **true,** a sender who is also a recipient of an envelope\nmust follow the authentication requirements for the envelope.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "sharedTemplateFoldersMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signerCanSignOnMobileMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signerMustHaveAccountMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signerMustLoginToSignMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signingSessionTimeoutMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "supplementalDocumentsMustRead": {
      "type": "string",
      "description": "When **true,** account users must both view and accept supplemental documents when signing."
    },
    "supplementalDocumentsMustView": {
      "type": "string",
      "description": "When **true,** account users must view supplemental documents when signing."
    },
    "useConsumerDisclosureMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "useMultiAppGroupsDataMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "accountDefaultLanguageMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowAccountManagementGranular": {
      "type": "string",
      "description": "When **true,** the account can be managed on a per-user basis.\n\n**Note:** Only Admin users can change this setting."
    },
    "allowEnvelopeReportingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowMultipleSignerAttachments": {
      "type": "string",
      "description": "When **true,** recipients can\nupload multiple signer attachments with a single attachment.\n\n**Note:** Only Admin users can change this setting."
    },
    "allowOrganizationSsoManagement": {
      "type": "string",
      "description": ""
    },
    "allowPaymentProcessingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowPhoneAuthOverrideMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSecurityApplianceMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSigningExtensionsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "chromeSignatureEnabledMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableMobilePushNotifications": {
      "type": "string",
      "description": "When **true,** push notifications are disabled for the account.\n\n**Note:** Only Admin users can change this setting."
    },
    "disableUploadSignatureMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "documentConversionRestrictions": {
      "type": "string",
      "description": "Sets the account document upload restriction for non-account administrators. Valid values are:\n\n- `no_restrictions`: There are no restrictions on the type of documents that can be uploaded.\n- `allow_pdf_only`: Non-administrators can only upload PDF files.\n- `no_upload`: Non-administrators cannot upload files.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "draftEnvelopeRetentionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableAdvancedPaymentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableAgreementActionsForESign": {
      "type": "string",
      "description": ""
    },
    "enableCalculatedFieldsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableEsignCommunitiesMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableLargeFileSupportMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableScheduledReleaseMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSigningExtensionComments": {
      "type": "string",
      "description": "When **true,** enables comments for the account so that signers and recipients can make and respond to comments in documents belonging to the envelopes that they are sent."
    },
    "enableTransactionPointMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "guidedFormsHtmlAllowedMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "ignoreErrorIfAnchorTabNotFound": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "inPersonSigningEnabledMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "isConnectDocumentFieldsEnabled": {
      "type": "string",
      "description": ""
    },
    "sendToCertifiedDeliveryEnabled": {
      "type": "string",
      "description": "When true,\nthe account can use the\ncertified deliveries recipient type.\n"
    },
    "signerCanCreateAccountMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "startInAdvancedCorrectMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "suppressCertificateEnforcement": {
      "type": "string",
      "description": "Boolean that specifies whether or not API calls require a x509 cert in the header of the call."
    },
    "writeReminderToEnvelopeHistory": {
      "type": "string",
      "description": "When **true,**\nsent reminders are included in the envelope history."
    },
    "allowAgentNameEmailEditMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowConnectHttpListenerConfigs": {
      "type": "string",
      "description": "Boolean that specifies whether a Connect configuration can use HTTP listeners."
    },
    "allowConsumerDisclosureOverride": {
      "type": "string",
      "description": "When **true,**\nthe account has the ability to change the\n[Consumer Disclosure](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=aqg1583277336549.html)\nsetting.\n"
    },
    "allowDocumentVisibilityMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowDocumentsOnSignedEnvelopes": {
      "type": "string",
      "description": "Boolean that specifies whether notifications can include the envelope's signed document."
    },
    "allowOpenTrustSignerCertificate": {
      "type": "string",
      "description": "When **true,** senders can use OpenTrust signer certificates.\n\n**Note:** Only Admin users can change this setting."
    },
    "allowSendToIntermediaryMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowThirdPartyElectronicNotary": {
      "type": "string",
      "description": "Account level flag that determines the availability to perform Third Party Notary (3PN) actions."
    },
    "attachCompletedEnvelopeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "betaSwitchConfigurationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "checkForMultipleAdminsOnAccount": {
      "type": "string",
      "description": ""
    },
    "disableMultipleSessionsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableAccountWideSearchMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableCombinedPDFDownloadForSBS": {
      "type": "string",
      "description": ""
    },
    "enableEnvelopeStampingByDSAdmin": {
      "type": "string",
      "description": "When **true,** enables the DocuSign administrator to control envelope stamping for an account (placement of the `envelopeId`)."
    },
    "enablePaymentProcessingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableRecipientDomainValidation": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "enableResponsiveSigningMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSMSAuthenticationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSignerAttachmentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "guidedFormsHtmlConversionPolicy": {
      "type": "string",
      "description": ""
    },
    "hideAccountAddressInCoCMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "idfxPhoneAuthenticationOverride": {
      "type": "string",
      "description": ""
    },
    "inPersonIDCheckQuestionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "inSessionSuppressEmailsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "showLocalizedWatermarksMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signerLoginRequirementsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "supplementalDocumentsMustAccept": {
      "type": "string",
      "description": "When **true,** account users must accept supplemental documents when signing."
    },
    "allowDocumentDisclosuresMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowExtendedSendingResourceFile": {
      "type": "string",
      "description": "Boolean that specifies whether resource files can be used for extended sending."
    },
    "allowIDVForEUQualifiedSignatures": {
      "type": "string",
      "description": ""
    },
    "allowOrganizationDocusignMonitor": {
      "type": "string",
      "description": ""
    },
    "allowPhoneAuthenticationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "conditionalFieldsEnabledMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableSignerHistoryViewMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableAdvancedPowerFormsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableContactSuggestionsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableDSigEUAdvancedPensMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableInboxRelevanceSortMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableRequireSignOnPaperMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSendToIntermediaryMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "externalSignaturePadTypeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "hasRecipientConnectClaimedDomain": {
      "type": "string",
      "description": ""
    },
    "pkiSignDownloadedPDFDocsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "recipientsCanSignOfflineMetadata": {
      "$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"
    },
    "sendLockoutRecipientNotification": {
      "type": "string",
      "description": ""
    },
    "simplifiedSendingEnabledMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowEnvelopeCustomFieldsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowExternalSignaturePadMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowPerformanceAnalyticsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowPrivateSigningGroupsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowResourceFileBrandingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSetEmbeddedRecipientStartURL": {
      "type": "string",
      "description": ""
    },
    "allowSigningRadioDeselectMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableAccessCodeGeneratorMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableClickPlusConditionalContent": {
      "type": "string",
      "description": ""
    },
    "enableDSigIDCheckRemoteForQESPens": {
      "type": "string",
      "description": ""
    },
    "enableSequentialSigningUIMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSignOnPaperOverrideMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "specifyDocumentVisibilityMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "useSAFESignerCertificatesMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "AllowConnectIdentityVerificationUI": {
      "type": "string",
      "description": ""
    },
    "allowMultipleBrandProfilesMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowOrganizationToUseRemoteNotary": {
      "type": "string",
      "description": ""
    },
    "allowSupplementalDocumentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowTransactionsWorkspaceMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowTransactionsWorkspaceOriginal": {
      "type": "string",
      "description": ""
    },
    "anchorTagVersionedPlacementEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign.\n"
    },
    "autoProvisionSignerAccountMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableClickPlusCustomStyleMetaData": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSequentialSigningAPIMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "envelopeIntegrationAllowedMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "envelopeIntegrationEnabledMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "pdfMaxIndividualUploadSizeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "require21CFRpt11ComplianceMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signerShowSecureFieldInitialValues": {
      "type": "string",
      "description": "When **true,** the initial values of all SecureFields are written\nto the document when it is sent.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "skipAuthCompletedEnvelopesMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "useConsumerDisclosureWithinAccount": {
      "type": "string",
      "description": "When **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement."
    },
    "useEnvelopeSearchMixedModeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "advancedSearchEnableTemplateIdField": {
      "type": "string",
      "description": ""
    },
    "allowConnectSendFinishLaterMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowExternalLinkedAccountsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowOcrOfEnvelopeDocumentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSafeBioPharmaSignerCertificate": {
      "type": "string",
      "description": "When **true,**\naccount administrators can\nspecify that signers are\nrequired to use SAFE-BioPharma digital signatures.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "allowSignerReassignOverrideMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowUsersToAccessDirectoryMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "commentEmailShowMessageTextMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "consumerDisclosureFrequencyMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableAutoTemplateMatchingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableClickPlusCustomFieldsMetaData": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableDSigIDCheckForAESPensMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableDSigIDCheckInPersonForQESPens": {
      "type": "string",
      "description": ""
    },
    "enableDSigIDVerificationPremierPens": {
      "type": "string",
      "description": ""
    },
    "enableESignAPIHourlyLimitManagement": {
      "type": "string",
      "description": ""
    },
    "enableSearchServiceAzureUriMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSearchSiteSpecificApiMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSigningExtensionConversations": {
      "type": "string",
      "description": "When **true,** enables conversation functionality."
    },
    "maximumUsersPerSigningGroupMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "optOutAutoNavTextAndTabColorUpdates": {
      "type": "string",
      "description": "Boolean that allows envelope senders to opt out of the recipient signing auto-navigation feature and opt out of updating tab font color."
    },
    "pdfMaxChunkedUploadPartSizeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "senderCanSignInEachLocationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "showCompleteDialogInEmbeddedSession": {
      "type": "string",
      "description": "Boolean that specifies whether complete dialogs are displayed directly within an application in embedded signing sessions."
    },
    "signDateTimeAccountLanguageOverride": {
      "type": "string",
      "description": ""
    },
    "signDateTimeAccountTimezoneOverride": {
      "type": "string",
      "description": ""
    },
    "useDocuSignExpressSignerCertificate": {
      "type": "string",
      "description": "When **true,**\nsigners\nare required to use Express Digital Signatures.\n"
    },
    "wurflMinAllowableScreenSizeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "advancedSearchEnableTabFieldMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowAccountMemberNameChangeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowAgreementOrchestrationsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowEnvelopeCustodyTransferMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowOrganizationDocusignMonitorFree": {
      "type": "string",
      "description": ""
    },
    "allowSendToCertifiedDeliveryMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "bulkSendMaxUnprocessedEnvelopesCount": {
      "type": "string",
      "description": ""
    },
    "defaultToAdvancedEnvelopesFilterForm": {
      "type": "string",
      "description": ""
    },
    "enableAgreementActionsForCLMMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableDSigIDVerificationPensMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableEnvelopeStampingByAccountAdmin": {
      "type": "string",
      "description": "When **true,** enables the account administrator\nto control envelope stamping for an account\n(stamping the `envelopeId` in the document margins).\n\n**Note:** This setting can be changed only\nby Admin users, and only if the account-level\nsetting `enableEnvelopeStampingByDSAdmin` is set to **true.**"
    },
    "enableRecipientMayProvidePhoneNumber": {
      "type": "string",
      "description": ""
    },
    "enableSigningOrderSettingsForAccount": {
      "type": "string",
      "description": "When **true,** switches Signing Order to On by default for new envelopes."
    },
    "envelopeStampingDefaultValueMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "pdfMaxChunkedUploadTotalSizeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "requireSignerCertificateTypeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "showConditionalRoutingOnSendMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "showInitialConditionalFieldsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signerAttachCertificateToEnvelopePDF": {
      "type": "string",
      "description": "When **true,**\nthe Certificate of Completion is included in the PDF of the envelope documents\nwhen it is downloaded.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "useSignatureProviderPlatformMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "advancedSearchEnableTemplateNameField": {
      "type": "string",
      "description": ""
    },
    "allowEditingEnvelopesOnBehalfOfOthers": {
      "type": "string",
      "description": ""
    },
    "allowEnvelopePublishReportingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowExpressSignerCertificateMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowInPersonElectronicNotaryMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowOrganizationDomainUserManagement": {
      "type": "string",
      "description": ""
    },
    "allowParticipantRecipientTypeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSendingEnvelopesOnBehalfOfOthers": {
      "type": "string",
      "description": ""
    },
    "allowSignDocumentFromHomePageMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "cfr21SimplifiedSigningEnabledMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "commentsAllowEnvelopeOverrideMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableAdvancedEnvelopesSearchMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableClickPlusDynamicContentMetaData": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableEnforceTlsEmailsSettingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableIDFxAccountlessSMSAuthForPart11": {
      "type": "string",
      "description": ""
    },
    "enableIDFxPhoneAuthenticationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSendingTagsFontSettingsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableWebFormsSeparateUserPermissions": {
      "type": "string",
      "description": ""
    },
    "enforceTemplateNameUniquenessMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "idfxKBAAuthenticationOverrideMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "optOutNewPlatformSealPlatformMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "recipientSigningAutoNavigationControl": {
      "type": "string",
      "description": "When **true,** recipients receiving envelopes from this account can override auto-navigation functionality.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "requireExternalUserManagementMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "senderMustAuthenticateSigningMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "supplementalDocumentsMustReadMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "supplementalDocumentsMustViewMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowAccountManagementGranularMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowManagingEnvelopesOnBehalfOfOthers": {
      "type": "string",
      "description": ""
    },
    "allowMultipleSignerAttachmentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowOrganizationSsoManagementMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disableMobilePushNotificationsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "documentConversionRestrictionsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dss_SIGN_29182_SlideUpBar_RadminOption": {
      "type": "string",
      "description": ""
    },
    "enableAgreementActionsForESignMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableCommentsHistoryDownloadInSigning": {
      "type": "string",
      "description": ""
    },
    "enableIdfxPhoneAuthSignatureAuthStatus": {
      "type": "string",
      "description": ""
    },
    "enableSigningExtensionCommentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "sendToCertifiedDeliveryEnabledMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "suppressCertificateEnforcementMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "useNewEnvelopeSearchOnlyWithSearchTerm": {
      "type": "string",
      "description": ""
    },
    "writeReminderToEnvelopeHistoryMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowConsumerDisclosureOverrideMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowDocumentsOnSignedEnvelopesMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowOpenTrustSignerCertificateMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowThirdPartyElectronicNotaryMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "checkForMultipleAdminsOnAccountMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableEnvelopeStampingByDSAdminMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableKeyTermsSuggestionsByDocumentType": {
      "type": "string",
      "description": ""
    },
    "enableRecipientDomainValidationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSMSDeliveryAdditionalNotification": {
      "type": "string",
      "description": ""
    },
    "guidedFormsHtmlConversionPolicyMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "idfxPhoneAuthenticationOverrideMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "phoneAuthRecipientMayProvidePhoneNumber": {
      "type": "string",
      "description": "When **true,** senders can allow recipients to provide a phone number for the Phone Authentication process.\n\n**Note:** Only Admin users can change this setting."
    },
    "signerInSessionUseEnvelopeCompleteEmail": {
      "type": "string",
      "description": "When **true,** an \"envelope complete\" email is sent to an in-session\n(embedded) or offline signer after DocuSign processes the envelope\nif in-session emails are not suppressed.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "supplementalDocumentsMustAcceptMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowAdvancedRecipientRoutingConditional": {
      "type": "string",
      "description": "When **true,** [Conditional Routing](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=aqm1578456487908.html) is enabled for the account as part of DocuSign's Advanced Recipient Routing feature."
    },
    "allowExtendedSendingResourceFileMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowIDVForEUQualifiedSignaturesMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowOrganizationDocusignMonitorMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableCustomerSatisfactionMetricTracking": {
      "type": "string",
      "description": "When **true,** enables customer satisfaction metric tracking for the account."
    },
    "selfSignedRecipientEmailDocumentMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "sendLockoutRecipientNotificationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSetEmbeddedRecipientStartURLMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableClickPlusConditionalContentMetaData": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableDSigIDCheckRemoteForQESPensMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableInboxRelevanceSortForRecentAccounts": {
      "type": "string",
      "description": ""
    },
    "enableParticipantRecipientSettingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "EnvelopeLimitsTotalDocumentSizeAllowedInMB": {
      "type": "string",
      "description": ""
    },
    "allowOrganizationToUseRemoteNotaryMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowTransactionsWorkspaceOriginalMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "anchorTagVersionedPlacementMetadataEnabled": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "disablePurgeNotificationsForSenderMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signerShowSecureFieldInitialValuesMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "useConsumerDisclosureWithinAccountMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "advancedSearchEnableTemplateIdFieldMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSafeBioPharmaSignerCertificateMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableDSigIDCheckInPersonForQESPensMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableDSigIDVerificationPremierPensMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableESignAPIHourlyLimitManagementMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSigningExtensionConversationsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "optOutAutoNavTextAndTabColorUpdatesMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "showCompleteDialogInEmbeddedSessionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signDateTimeAccountLanguageOverrideMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signDateTimeAccountTimezoneOverrideMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "useDocuSignExpressSignerCertificateMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowOrganizationDocusignMonitorFreeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "defaultToAdvancedEnvelopesFilterFormMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableEnvelopeStampingByAccountAdminMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableInboxBrowseViewsPoweredByElasticSearch": {
      "type": "string",
      "description": ""
    },
    "enableRecipientMayProvidePhoneNumberMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSigningOrderSettingsForAccountMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "selfSignedRecipientEmailDocumentUserOverride": {
      "type": "string",
      "description": "When **true,** the `selfSignedRecipientEmailDocument` user setting\ncan be set for an individual user.\nThe user setting overrides the account setting.\n\n**Note:** Only Admin users can change this account setting.\n"
    },
    "signerAttachCertificateToEnvelopePDFMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "advancedSearchEnableTemplateNameFieldMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowEditingEnvelopesOnBehalfOfOthersMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowOrganizationDomainUserManagementMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowSendingEnvelopesOnBehalfOfOthersMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableIDFxAccountlessSMSAuthForPart11Metadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableWebFormsSeparateUserPermissionsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "ignoreErrorIfAnchorTabNotFoundMetadataEnabled": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "recipientSigningAutoNavigationControlMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowManagingEnvelopesOnBehalfOfOthersMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowOrganizationToUseInPersonElectronicNotary": {
      "type": "string",
      "description": "Organization-level flag that determines the ability to perform In-Person Electronic Notary (IPEN) actions.\n"
    },
    "enableCommentsHistoryDownloadInSigningMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableIdfxPhoneAuthSignatureAuthStatusMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "useNewEnvelopeSearchOnlyWhenSearchingAfterDate": {
      "type": "string",
      "description": ""
    },
    "useNewEnvelopeSearchOnlyWithSearchTermMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableKeyTermsSuggestionsByDocumentTypeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableSMSDeliveryAdditionalNotificationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "phoneAuthRecipientMayProvidePhoneNumberMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "showMaskedFieldsWhenDownloadingDocumentAsSender": {
      "type": "string",
      "description": ""
    },
    "signerInSessionUseEnvelopeCompleteEmailMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowAdvancedRecipientRoutingConditionalMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowOrganizationToUseThirdPartyElectronicNotary": {
      "type": "string",
      "description": "Org level flag that determines the availability to perform Third Party Notary (3PN) actions."
    },
    "enableCustomerSatisfactionMetricTrackingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabled": {
      "type": "string",
      "description": ""
    },
    "dss_SIGN_28411_EnableLeavePagePrompt_RadminOption": {
      "type": "string",
      "description": ""
    },
    "enableInboxRelevanceSortForRecentAccountsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "EnvelopeLimitsTotalDocumentSizeAllowedInMBMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dss_EnableProvisioningPenConfiguration_RadminOption": {
      "type": "string",
      "description": ""
    },
    "dss_EnableSignatureTypeCustomTagRadmin_RadminOption": {
      "type": "string",
      "description": ""
    },
    "enableInboxBrowseViewsPoweredByElasticSearchMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "selfSignedRecipientEmailDocumentUserOverrideMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowOrganizationToUseInPersonElectronicNotaryMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "useNewEnvelopeSearchOnlyWhenSearchingAfterDateMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "showMaskedFieldsWhenDownloadingDocumentAsSenderMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowOrganizationToUseThirdPartyElectronicNotaryMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabledMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "description": "Contains account settings information. Used in requests to set property values. Used in responses to report property values.",
  "x-ms-summary": "Contains account settings information. Used in requests to set property values. Used in responses to report property values.",
  "x-ds-definition-name": "accountSettingsInformation"
}

{
  "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. "
    },
    "accountId": {
      "type": "string",
      "description": "The account ID associated with the envelope."
    },
    "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. "
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "sharedAccess": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/memberSharedItems"
      },
      "description": "A list of shared access information of envelope and templates for the users specified in the request."
    },
    "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 shared access information.",
  "x-ms-summary": "Contains shared access information.",
  "x-ds-definition-name": "accountSharedAccess"
}

{
  "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": ""
    },
    "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 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."
    },
    "stampImageUri": {
      "type": "string",
      "description": "The URI for retrieving the image of the user's stamp."
    },
    "signatureUsers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signatureUser"
      },
      "description": ""
    },
    "adoptedDateTime": {
      "type": "string",
      "description": "The UTC date and time when the user adopted the signature."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the item was created."
    },
    "signatureGroups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signatureGroup"
      },
      "description": ""
    },
    "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": "Specifies the user's signature in initials format."
    },
    "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": "accountSignature"
}

{
  "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."
    },
    "signatureUsers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signatureUserDef"
      },
      "description": ""
    },
    "signatureGroups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signatureGroupDef"
      },
      "description": ""
    },
    "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": "accountSignatureDefinition"
}

{
  "type": "object",
  "properties": {
    "priority": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "isRequired": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "signatureProviderId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "signatureProviderName": {
      "type": "string",
      "description": "The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](https://raw.githubusercontent.com). You can also retrieve the list by using the [AccountSignatureProviders: List](https://raw.githubusercontent.com) method.\n\nExample: `universalsignaturepen_default`\n\n"
    },
    "signatureProviderDisplayName": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "signatureProviderOptionsMetadata": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/accountSignatureProviderOption"
      },
      "description": "Reserved for DocuSign."
    },
    "signatureProviderRequiredOptions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signatureProviderRequiredOption"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Contains information about the signature provider associated with the Identity Verification workflow.\nIf empty, then this specific workflow is not intended for signers.\n",
  "x-ms-summary": "Contains information about the signature provider associated with the Identity Verification workflow.\nIf empty, then this specific workflow is not intended for signers.\n",
  "x-ds-definition-name": "accountSignatureProvider"
}

{
  "type": "object",
  "properties": {
    "signatureProviderOptionId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "signatureProviderOptionName": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "signatureProviderOptionDisplayName": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Reserved for DocuSign.",
  "x-ms-summary": "Reserved for DocuSign.",
  "x-ds-definition-name": "accountSignatureProviderOption"
}

{
  "type": "object",
  "properties": {
    "signatureProviders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/accountSignatureProvider"
      },
      "description": "Names of electronic or digital signature providers that can be used."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "accountSignatureProviders"
}

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

{
  "type": "object",
  "properties": {
    "askAnAdmin": {
      "$ref": "#/components/schemas/askAnAdmin"
    },
    "adminMessage": {
      "$ref": "#/components/schemas/adminMessage"
    },
    "hideUseATemplate": {
      "type": "string",
      "description": "When **true,** the **Templates** menu is hidden from account users who are not Admins. The default value is **false.**"
    },
    "enableAdminMessage": {
      "type": "string",
      "description": ""
    },
    "hideSendAnEnvelope": {
      "type": "string",
      "description": ""
    },
    "clickwrapSchemaVersion": {
      "type": "string",
      "description": ""
    },
    "shouldRedactAccessCode": {
      "type": "string",
      "description": ""
    },
    "enableLegacySendflowLink": {
      "type": "string",
      "description": ""
    },
    "hideUseATemplateMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "removeEnvelopeForwarding": {
      "type": "string",
      "description": ""
    },
    "hasExternalLinkedAccounts": {
      "type": "string",
      "description": ""
    },
    "hideUseATemplateInPrepare": {
      "type": "string",
      "description": ""
    },
    "enableAdminMessageMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableEnvelopeCopyWithData": {
      "type": "string",
      "description": ""
    },
    "hideSendAnEnvelopeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowUsersToEditSharedAccess": {
      "type": "string",
      "description": ""
    },
    "enableEasySignTemplateUpload": {
      "type": "string",
      "description": ""
    },
    "uploadNewImageToSignOrInitial": {
      "type": "string",
      "description": ""
    },
    "clickwrapSchemaVersionMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "shouldRedactAccessCodeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "orderBasedRecipientIdGeneration": {
      "type": "string",
      "description": ""
    },
    "enableLegacySendflowLinkMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "removeEnvelopeForwardingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "hasExternalLinkedAccountsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "hideUseATemplateInPrepareMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableEnvelopeCopyWithDataMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowUsersToEditSharedAccessMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableEasySignTemplateUploadMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "uploadNewImageToSignOrInitialMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableEasySignCanUseMultiTemplateApply": {
      "type": "string",
      "description": ""
    },
    "orderBasedRecipientIdGenerationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "enableEasySignCanUseMultiTemplateApplyMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "description": "An object that defines the options that are available to non-administrators in the UI.",
  "x-ms-summary": "An object that defines the options that are available to non-administrators in the UI.",
  "x-ds-definition-name": "accountUISettings"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique ID for the Salesforce object."
    },
    "name": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "active": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "addOnId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Contains information about add ons.",
  "x-ms-summary": "Contains information about add ons.",
  "x-ds-definition-name": "addOn"
}

{
  "type": "object",
  "properties": {
    "fax": {
      "type": "string",
      "description": "A fax number associated with the address, if one is available."
    },
    "city": {
      "type": "string",
      "description": "The user's city. Maximum length: 40 characters."
    },
    "phone": {
      "type": "string",
      "description": "A phone number associated with the address."
    },
    "country": {
      "type": "string",
      "description": "The user's country. Maximum length: 50 characters."
    },
    "address1": {
      "type": "string",
      "description": "The first line of the user's address.\nMaximum length: 100 characters."
    },
    "address2": {
      "type": "string",
      "description": "The second line of the user's address.\nMaximum length: 100 characters."
    },
    "zipPlus4": {
      "type": "string",
      "description": ""
    },
    "postalCode": {
      "type": "string",
      "description": "The user's postal code. Maximum length: 20 characters."
    },
    "stateOrProvince": {
      "type": "string",
      "description": "The user's state or province. Maximum length: 40 characters."
    }
  },
  "description": "Contains address information.",
  "x-ms-summary": "Contains address information.",
  "x-ds-definition-name": "addressInformation"
}

{
  "type": "object",
  "properties": {
    "displayLevelCode": {
      "type": "string",
      "description": "Specifies the display level for the recipient. Valid values are:\n* `ReadOnly`\n* `Editable`\n* `DoNotDisplay`"
    },
    "receiveInResponse": {
      "type": "string",
      "description": "A Boolean value that specifies whether the information must be returned in the response."
    },
    "addressInformation": {
      "$ref": "#/components/schemas/addressInformation"
    }
  },
  "description": "Contains address input information.",
  "x-ms-summary": "Contains address input information.",
  "x-ds-definition-name": "addressInformationInput"
}

{
  "type": "object",
  "properties": {
    "baseMessage": {
      "type": "string",
      "description": ""
    },
    "moreInformation": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "adminMessage"
}

{
  "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"
    },
    "email": {
      "type": "string",
      "description": "The email ID of the agent. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. "
    },
    "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."
    },
    "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."
    },
    "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."
    },
    "phoneNumber": {
      "$ref": "#/components/schemas/recipientPhoneNumber"
    },
    "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`."
    },
    "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."
    },
    "totalTabCount": {
      "type": "string",
      "description": "The total number of tabs in the documents. This property is read-only."
    },
    "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."
    },
    "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. "
    },
    "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. "
    },
    "declinedDateTime": {
      "type": "string",
      "description": "The date and time the recipient declined the document. This property is read-only."
    },
    "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."
    },
    "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"
    },
    "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.**"
    },
    "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"
    },
    "recipientTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "socialAuthentications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/socialAuthentication"
      },
      "description": "Deprecated."
    },
    "deliveryMethodMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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"
    },
    "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."
    },
    "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."
    },
    "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": "Contains information about an agent recipient. An agent is a recipient who can add name and email information for recipients that appear after the agent in routing order.",
  "x-ms-summary": "Contains information about an agent recipient. An agent is a recipient who can add name and email information for recipients that appear after the agent in routing order.",
  "x-ds-definition-name": "agent"
}

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The status of the API request."
    },
    "description": {
      "type": "string",
      "description": "The API endpoint that was called."
    },
    "requestLogId": {
      "type": "string",
      "description": "The ID of the log entry."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the item was created."
    }
  },
  "description": "Contains API request log information.",
  "x-ms-summary": "Contains API request log information.",
  "x-ds-definition-name": "apiRequestLog"
}

{
  "type": "object",
  "properties": {
    "apiRequestLogs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/apiRequestLog"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Contains information about multiple API request logs.",
  "x-ms-summary": "Contains information about multiple API request logs.",
  "x-ds-definition-name": "apiRequestLogsResult"
}

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "description": "The Product ID from the AppStore."
    },
    "marketPlace": {
      "type": "string",
      "description": ""
    }
  },
  "description": "Contains information about an APP store product.",
  "x-ms-summary": "Contains information about an APP store product.",
  "x-ds-definition-name": "appStoreProduct"
}

{
  "type": "object",
  "properties": {
    "productId": {
      "type": "string",
      "description": "The Product ID from the AppStore."
    },
    "receiptData": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "downgradeProductId": {
      "type": "string",
      "description": ""
    },
    "isDowngradeCancellation": {
      "type": "string",
      "description": ""
    }
  },
  "description": "Contains information about an APP store receipt.",
  "x-ms-summary": "Contains information about an APP store receipt.",
  "x-ds-definition-name": "appStoreReceipt"
}

{
  "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": "**Note:** Approve tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient.\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"
    },
    "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\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"
    },
    "buttonText": {
      "type": "string",
      "description": " Specifies the approval text that displays in the tab. "
    },
    "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": "Specifies the page number on which the tab is located. For supplemental documents, this value must be `1`.\n"
    },
    "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. You can only use this when adding new tabs for a recipient. When used, the new tab inherits all of the properties of the custom tab."
    },
    "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"
    },
    "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"
    },
    "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": "A tab that allows the recipient to approve documents\nwithout placing a signature or initials on the\ndocument.\n",
  "x-ms-summary": "A tab that allows the recipient to approve documents\nwithout placing a signature or initials on the\ndocument.\n",
  "x-ds-definition-name": "approve"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": ""
    },
    "email": {
      "type": "string",
      "description": ""
    },
    "phone": {
      "type": "string",
      "description": ""
    },
    "message": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "askAnAdmin"
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "string",
      "description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size."
    },
    "name": {
      "type": "string",
      "description": "The name of the attachment."
    },
    "label": {
      "type": "string",
      "description": "A label for the attachment. Potential values include: \n\n- `guidedForm`: [Guided forms](https://www.docusign.com/products/guided-forms) provide a step-by-step, mobile-ready experience to help signers easily complete long or complex forms.\n- `eventNotifications`: A list of envelope-level event statuses that trigger Connect to send updates to the endpoint specified in the `url` property. \n"
    },
    "remoteUrl": {
      "type": "string",
      "description": "The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads."
    },
    "attachmentId": {
      "type": "string",
      "description": "The unique identifier for the attachment."
    },
    "accessControl": {
      "type": "string",
      "description": "Valid values are `sender` and `senderAndAllRecipients`."
    },
    "attachmentType": {
      "type": "string",
      "description": "Specifies the type of the attachment for the recipient."
    }
  },
  "description": "Contains information about an attachment.",
  "x-ms-summary": "Contains information about an attachment.",
  "x-ds-definition-name": "attachment"
}

{
  "type": "object",
  "properties": {
    "totalCount": {
      "type": "string",
      "description": "The number of times the authentication method was used. "
    },
    "lastProvider": {
      "type": "string",
      "description": "The last provider that authenticated the user. "
    },
    "lastTimestamp": {
      "type": "string",
      "description": " The data and time the user last used the authentication method. "
    },
    "authenticationType": {
      "type": "string",
      "description": "Indicates the type of authentication. Valid values are: PhoneAuth, STAN, ISCheck, OFAC, AccessCode, AgeVerify, or SSOAuth. "
    }
  },
  "description": "Contains information about the method used for authentication.",
  "x-ms-summary": "Contains information about the method used for authentication.",
  "x-ds-definition-name": "authenticationMethod"
}

{
  "type": "object",
  "properties": {
    "ofacResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "yahooResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "googleResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "liveIDResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "openIDResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "sTANPinResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "smsAuthResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "twitterResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "facebookResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "idLookupResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "linkedinResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "ageVerifyResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "phoneAuthResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "accessCodeResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "salesforceResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "anySocialIDResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "idQuestionsResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "signatureProviderResult": {
      "$ref": "#/components/schemas/eventResult"
    },
    "identityVerificationResult": {
      "$ref": "#/components/schemas/eventResult"
    }
  },
  "description": "A complex element that contains information about a user's authentication status.",
  "x-ms-summary": "A complex element that contains information about a user's authentication status.",
  "x-ds-definition-name": "authenticationStatus"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the authorization user."
    },
    "email": {
      "type": "string",
      "description": "The email address of the authorization user."
    },
    "userId": {
      "type": "string",
      "description": "The ID of the authorization user."
    },
    "accountId": {
      "type": "string",
      "description": "The account ID."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "authorizationUser"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "Specifies the BCC email address. DocuSign verifies that the email format is correct, but does not verify that the email is active.Using this overrides the BCC for Email Archive information setting for this envelope.\n\nMaximum of length: 100 characters. "
    },
    "bccEmailAddressId": {
      "type": "string",
      "description": "Only users with canManageAccount setting can use this option. An array of up to 5 email addresses the envelope is sent to as a BCC email. \n \nExample: If your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address."
    }
  },
  "description": "Contains information about the BCC email address.",
  "x-ms-summary": "Contains information about the BCC email address.",
  "x-ds-definition-name": "bccEmailAddress"
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "The helper URI for retrieving the BCC email archive."
    },
    "email": {
      "type": "string",
      "description": "The BCC email address to use for archiving DocuSign messages.\n\nExample: customer_bcc@example.com"
    },
    "status": {
      "type": "string",
      "description": "The status of the BCC email address. Possible values are:\n\n- `activation_sent`: An activation link has been sent to the BCC email address.\n- `active`: The BCC email address is actively used for archiving.\n- `closed`: The BCC email address is no longer used for archiving."
    },
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the BCC email archive configuration was created."
    },
    "modified": {
      "type": "string",
      "description": "The UTC DateTime when the BCC email archive configuration was last modified."
    },
    "accountId": {
      "type": "string",
      "description": "The ID of the account that owns the BCC email archive configuration."
    },
    "createdBy": {
      "$ref": "#/components/schemas/userInfo"
    },
    "modifiedBy": {
      "$ref": "#/components/schemas/userInfo"
    },
    "bccEmailArchiveId": {
      "type": "string",
      "description": "The ID of the BCC email archive configuration."
    },
    "emailNotificationId": {
      "type": "string",
      "description": "The GUID of the activation email message sent to the BCC email address."
    }
  },
  "description": "This object contains information abut a BCC email archive configuration (a BCC email address used to archive DocuSign-generated emails).",
  "x-ms-summary": "This object contains information abut a BCC email archive configuration (a BCC email address used to archive DocuSign-generated emails).",
  "x-ds-definition-name": "bccEmailArchive"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The BCC email address used to archive the emails that DocuSign generates. \n\nExample: customer_bcc@example.com"
    },
    "action": {
      "type": "string",
      "description": "The action taken on the BCC email archive configuration.\n\nExamples: \n\n- `CREATED`: The BCC email archive configuration has been created.\n- `UPDATED`: The BCC email address has been activated by clicking on the activation link in the activation email message.\n- `CLOSED`: The BCC email address has been marked as closed is no longer used for archiving."
    },
    "status": {
      "type": "string",
      "description": "The status of the BCC email address. Possible values are:\n\n- `activation_sent`: An activation link has been sent to the BCC email address.\n- `active`: The BCC email address is actively used for archiving.\n- `closed`: The BCC email address is no longer used for archiving."
    },
    "modified": {
      "type": "string",
      "description": "The UTC DateTime when the BCC email address was last modified."
    },
    "accountId": {
      "type": "string",
      "description": "The ID of the account that owns the BCC email archive configuration."
    },
    "modifiedBy": {
      "$ref": "#/components/schemas/userInfo"
    }
  },
  "description": "Contains details about the history of the BCC email archive configuration.",
  "x-ms-summary": "Contains details about the history of the BCC email archive configuration.",
  "x-ds-definition-name": "bccEmailArchiveHistory"
}

{
  "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."
    },
    "bccEmailArchiveHistory": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bccEmailArchiveHistory"
      },
      "description": "A list of changes to the BCC email archive configuration."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bccEmailArchiveHistoryList"
}

{
  "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."
    },
    "bccEmailArchives": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bccEmailArchive"
      },
      "description": "A list of  BCC email archive configurations."
    }
  },
  "description": "Contains a list of BCC email archive configurations.",
  "x-ms-summary": "Contains a list of BCC email archive configurations.",
  "x-ds-definition-name": "bccEmailArchiveList"
}

{
  "type": "object",
  "properties": {
    "prices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingPrice"
      },
      "description": ""
    },
    "blocked": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "discounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingDiscount"
      },
      "description": ""
    },
    "unitPrice": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "chargeName": {
      "type": "string",
      "description": "Provides information on what services the charge item is for.\n\nThe following table provides a description of the different chargeName values available at this time.\n\n| chargeName | Description |\n| --- | --- |\n| id_check | ID Check Charge |\n| in_person_signing | In Person Signing charge |\n| envelopes Included | Sent Envelopes for the account |\n| age_verify | Age verification check |\n| ofac | OFAC Check |\n| id_confirm | ID confirmation check |\n| student_authentication | STAN PIN authentication check |\n| wet_sign_fax | Pages for returning signed documents by fax |\n| attachment_fax | Pages for returning attachments by fax |\n| phone_authentication | Phone authentication charge |\n| powerforms | PowerForm envelopes sent |\n| signer_payments | Payment processing charge |\n| outbound_fax | Send by fax charge |\n| bulk_recipient_envelopes | Bulk Recipient Envelopes sent |\n| sms_authentications | SMS authentication charge |\n| saml_authentications | SAML authentication charge |\n| express_signer_certificate | DocuSign Express Certificate charge |\n| personal_signer_certificate | Personal Signer Certificate charge |\n| safe_certificate | SAFE BioPharma Signer Certificate charge |\n| seats | Included active seats charge |\n| open_trust_certificate | OpenTrust Signer Certificate charge |"
    },
    "chargeType": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "usedQuantity": {
      "type": "string",
      "description": ""
    },
    "allowedQuantity": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "includedQuantity": {
      "type": "string",
      "description": ""
    },
    "lastEffectiveDate": {
      "type": "string",
      "description": ""
    },
    "firstEffectiveDate": {
      "type": "string",
      "description": ""
    },
    "chargeUnitOfMeasure": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "incrementalQuantity": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Contains information about a billing charge.",
  "x-ms-summary": "Contains information about a billing charge.",
  "x-ds-definition-name": "billingCharge"
}

{
  "type": "object",
  "properties": {
    "billingChargeItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingCharge"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Defines a billing charge response object.",
  "x-ms-summary": "Defines a billing charge response object.",
  "x-ds-definition-name": "billingChargeResponse"
}

{
  "type": "object",
  "properties": {
    "discount": {
      "type": "string",
      "description": ""
    },
    "endQuantity": {
      "type": "string",
      "description": ""
    },
    "beginQuantity": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "billingDiscount"
}

{
  "type": "object",
  "properties": {
    "entityName": {
      "type": "string",
      "description": ""
    },
    "billingProfile": {
      "type": "string",
      "description": "The type of billing method on the account. Valid values are: \n\n- `direct`\n- `web`"
    },
    "externalEntityId": {
      "type": "string",
      "description": ""
    },
    "isExternallyBilled": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "billingEntityInformationResponse"
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "string",
      "description": "The total amount of the purchase."
    },
    "balance": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "dueDate": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "invoiceId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "invoiceUri": {
      "type": "string",
      "description": "Contains a URI for an endpoint that you can use to retrieve invoice information."
    },
    "invoiceItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingInvoiceItem"
      },
      "description": "Reserved for DocuSign."
    },
    "pdfAvailable": {
      "type": "string",
      "description": ""
    },
    "invoiceNumber": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "taxableAmount": {
      "type": "string",
      "description": ""
    },
    "nonTaxableAmount": {
      "type": "string",
      "description": ""
    }
  },
  "description": "Contains information about a billing invoice.",
  "x-ms-summary": "Contains information about a billing invoice.",
  "x-ds-definition-name": "billingInvoice"
}

{
  "type": "object",
  "properties": {
    "quantity": {
      "type": "string",
      "description": "The quantity of envelopes to add to the account."
    },
    "taxAmount": {
      "type": "string",
      "description": ""
    },
    "unitPrice": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "chargeName": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "chargeAmount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "invoiceItemId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "taxExemptAmount": {
      "type": "string",
      "description": ""
    }
  },
  "description": "Contains information about an item on a billing invoice.",
  "x-ms-summary": "Contains information about an item on a billing invoice.",
  "x-ds-definition-name": "billingInvoiceItem"
}

{
  "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. "
    },
    "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. "
    },
    "billingInvoices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingInvoice"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Defines a billing invoice response object.",
  "x-ms-summary": "Defines a billing invoice response object.",
  "x-ds-definition-name": "billingInvoicesResponse"
}

{
  "type": "object",
  "properties": {
    "currencyCode": {
      "type": "string",
      "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.\n"
    },
    "accountBalance": {
      "type": "string",
      "description": ""
    },
    "pastDueBalance": {
      "type": "string",
      "description": ""
    },
    "paymentAllowed": {
      "type": "string",
      "description": ""
    },
    "billingInvoices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingInvoice"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "billingInvoicesSummary"
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "invoiceId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "paymentId": {
      "type": "string",
      "description": "The ID of the payment."
    }
  },
  "description": "Contains information on a billing plan.",
  "x-ms-summary": "Contains information on a billing plan.",
  "x-ds-definition-name": "billingPayment"
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "string",
      "description": "The total amount of the purchase."
    },
    "paymentId": {
      "type": "string",
      "description": "The ID of the payment."
    },
    "description": {
      "type": "string",
      "description": "A sender-defined description of the line item.\n"
    },
    "paymentDate": {
      "type": "string",
      "description": ""
    },
    "paymentNumber": {
      "type": "string",
      "description": "When **true,** a PDF version of the invoice is available. \n\nTo get the PDF, make the call again and change \"Accept:\" in the header to \"Accept: application/pdf\"."
    }
  },
  "description": "Defines a billing payment request object.",
  "x-ms-summary": "Defines a billing payment request object.",
  "x-ds-definition-name": "billingPaymentItem"
}

{
  "type": "object",
  "properties": {
    "paymentAmount": {
      "type": "string",
      "description": "The payment amount for the past due invoices. This value must match the pastDueBalance value retrieved using Get Past Due Invoices."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "billingPaymentRequest"
}

{
  "type": "object",
  "properties": {
    "billingPayments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingPayment"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Defines an billing payment response object.",
  "x-ms-summary": "Defines an billing payment response object.",
  "x-ds-definition-name": "billingPaymentResponse"
}

{
  "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. "
    },
    "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. "
    },
    "billingPayments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingPaymentItem"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Defines a billing payments response object.",
  "x-ms-summary": "Defines a billing payments response object.",
  "x-ds-definition-name": "billingPaymentsResponse"
}

{
  "type": "object",
  "properties": {
    "planId": {
      "type": "string",
      "description": "DocuSign's ID for the account plan."
    },
    "planName": {
      "type": "string",
      "description": "The name of the billing plan.\n"
    },
    "paymentCycle": {
      "type": "string",
      "description": " The payment cycle associated with the plan. Valid values: Monthly or Annually. "
    },
    "perSeatPrice": {
      "type": "string",
      "description": "The per seat price for the plan."
    },
    "enableSupport": {
      "type": "string",
      "description": "When **true,** customer support is provided as part of the account plan."
    },
    "includedSeats": {
      "type": "string",
      "description": "The number of seats (users) included in the plan."
    },
    "paymentMethod": {
      "type": "string",
      "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
    },
    "seatDiscounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/seatDiscount"
      },
      "description": "A complex type that returns information about any seat discounts. It contains the information `BeginSeatCount`, `EndSeatCount` and `SeatDiscountPercent`."
    },
    "supportPlanFee": {
      "type": "string",
      "description": "The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`"
    },
    "planFeatureSets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/featureSet"
      },
      "description": "Reserved for DocuSign."
    },
    "appStoreProducts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/appStoreProduct"
      },
      "description": "Reserved for DocuSign."
    },
    "currencyPlanPrices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/currencyPlanPrice"
      },
      "description": "Contains the `currencyCode` and `currencySymbol` for the alternate currency values for `envelopeFee`, `fixedFee`, and `seatFee` that are configured for this plan feature set."
    },
    "planClassification": {
      "type": "string",
      "description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`"
    },
    "supportIncidentFee": {
      "type": "string",
      "description": "The support incident fee charged for each support incident.\n\nExample: `\"$0.00\"`"
    },
    "otherDiscountPercent": {
      "type": "string",
      "description": "Any other percentage discount for the plan.\n\nExample: `\"0.00\"`"
    }
  },
  "description": "Contains information about a billing plan.",
  "x-ms-summary": "Contains information about a billing plan.",
  "x-ds-definition-name": "billingPlan"
}

{
  "type": "object",
  "properties": {
    "taxExemptId": {
      "type": "string",
      "description": ""
    },
    "enablePreAuth": {
      "type": "string",
      "description": ""
    },
    "enableSupport": {
      "type": "string",
      "description": "When **true,** customer support is provided as part of the account plan."
    },
    "includedSeats": {
      "type": "string",
      "description": "The number of seats (users) included in the plan."
    },
    "paymentMethod": {
      "type": "string",
      "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
    },
    "renewalStatus": {
      "type": "string",
      "description": "The renewal status of the account. Possible values are:\n\n- `auto`: The account automatically renews. \n- `queued_for_close`: The account will be closed at the billingPeriodEndDate. \n- queued_for_downgrade`: The account will be downgraded at the `billingPeriodEndDate`."
    },
    "billingAddress": {
      "$ref": "#/components/schemas/accountAddress"
    },
    "processPayment": {
      "type": "string",
      "description": ""
    },
    "appStoreReceipt": {
      "$ref": "#/components/schemas/appStoreReceipt"
    },
    "downgradeReason": {
      "type": "string",
      "description": "(Optional) The user's reason for downgrading their billing plan."
    },
    "planInformation": {
      "$ref": "#/components/schemas/planInformation"
    },
    "incrementalSeats": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "paymentProcessor": {
      "type": "string",
      "description": ""
    },
    "saleDiscountAmount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "referralInformation": {
      "$ref": "#/components/schemas/referralInformation"
    },
    "saleDiscountPercent": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "saleDiscountPeriods": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "creditCardInformation": {
      "$ref": "#/components/schemas/creditCardInformation"
    },
    "saleDiscountFixedAmount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "paymentProcessorInformation": {
      "$ref": "#/components/schemas/paymentProcessorInformation"
    },
    "saleDiscountSeatPriceOverride": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "directDebitProcessorInformation": {
      "$ref": "#/components/schemas/directDebitProcessorInformation"
    }
  },
  "description": "This object contains details about a billing plan.",
  "x-ms-summary": "This object contains details about a billing plan.",
  "x-ds-definition-name": "billingPlanInformation"
}

{
  "type": "object",
  "properties": {
    "invoice": {
      "$ref": "#/components/schemas/billingInvoice"
    },
    "taxAmount": {
      "type": "string",
      "description": ""
    },
    "isProrated": {
      "type": "string",
      "description": "When **true,** the billing plan is prorated."
    },
    "totalAmount": {
      "type": "string",
      "description": ""
    },
    "currencyCode": {
      "type": "string",
      "description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account."
    },
    "subtotalAmount": {
      "type": "string",
      "description": ""
    }
  },
  "description": "Information used to provide a preview of a billing plan.",
  "x-ms-summary": "Information used to provide a preview of a billing plan.",
  "x-ds-definition-name": "billingPlanPreview"
}

{
  "type": "object",
  "properties": {
    "billingPlan": {
      "$ref": "#/components/schemas/billingPlan"
    },
    "successorPlans": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingPlan"
      },
      "description": "A list of billing plans that the current billing plan can be rolled into."
    }
  },
  "description": "Defines a billing plan response object.",
  "x-ms-summary": "Defines a billing plan response object.",
  "x-ds-definition-name": "billingPlanResponse"
}

{
  "type": "object",
  "properties": {
    "planId": {
      "type": "string",
      "description": "DocuSign's ID for the account plan."
    },
    "planName": {
      "type": "string",
      "description": "The name of the billing plan used for the account.\n\nExamples: \n\n- `Personal - Annual`\n- `Unlimited Envelope Subscription - Annual Billing`"
    },
    "currencyCode": {
      "type": "string",
      "description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account."
    },
    "paymentCycle": {
      "type": "string",
      "description": "The payment cycle associated with the plan. Valid values: \n\n- `Monthly`\n- `Annually` "
    },
    "includedSeats": {
      "type": "string",
      "description": "The number of seats (users) included in the plan."
    },
    "paymentMethod": {
      "type": "string",
      "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
    },
    "billingPlanPreview": {
      "$ref": "#/components/schemas/billingPlanPreview"
    },
    "accountPaymentMethod": {
      "type": "string",
      "description": "The type of payment method used for the account. Valid values are:\n\n- `credit_card`\n- "
    }
  },
  "description": "Defines a billing plan update response object.",
  "x-ms-summary": "Defines a billing plan update response object.",
  "x-ds-definition-name": "billingPlanUpdateResponse"
}

{
  "type": "object",
  "properties": {
    "billingPlans": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billingPlan"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Defines a billing plans response object.",
  "x-ms-summary": "Defines a billing plans response object.",
  "x-ds-definition-name": "billingPlansResponse"
}

{
  "type": "object",
  "properties": {
    "unitPrice": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "endQuantity": {
      "type": "string",
      "description": ""
    },
    "beginQuantity": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "billingPrice"
}

{
  "type": "object",
  "properties": {
    "links": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/brandLink"
      },
      "description": "An array of `brandLink` objects that contain information about the links that the brand uses."
    },
    "logos": {
      "$ref": "#/components/schemas/brandLogos"
    },
    "colors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "An array of name-value pairs specifying the colors that the brand uses for the following elements:\n\n- Button background\n- Button text\n- Header background\n- Header text"
    },
    "brandId": {
      "type": "string",
      "description": "The ID used to identify a specific brand in API calls."
    },
    "brandName": {
      "type": "string",
      "description": "The name of the brand."
    },
    "resources": {
      "$ref": "#/components/schemas/brandResourceUrls"
    },
    "brandCompany": {
      "type": "string",
      "description": "The name of the company associated with the brand."
    },
    "emailContent": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/brandEmailContent"
      },
      "description": "Deprecated."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "landingPages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "An array of name/value pairs specifying the pages to which the user is redirected after the following events occur:\n\n- Signing Completed\n- Viewed Exit\n- Finish Later\n- Decline\n- Session Timeout\n- Authentication Failure\n\nIf you do not specify landing pages, the DocuSign default pages are used."
    },
    "brandLanguages": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of two-letter codes for the languages that you want to use with the brand. The supported languages are:\n\n- Arabic (`ar`)\n- Armenian (`hy`)\n- Bahasa Indonesia (`id`)\n- Bahasa Malay (`ms`)\n- Bulgarian (`bg`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Czech (`cs`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English UK (`en_GB`)\n- English US (`en`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canada (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brasil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukranian (`uk`)\n- Vietnamese (`vi`)"
    },
    "isSendingDefault": {
      "type": "boolean",
      "description": "When **true,** the sending brand is the default brand for sending new envelopes."
    },
    "isSigningDefault": {
      "type": "boolean",
      "description": "When **true,** the siging brand is the default brand for the signing experience."
    },
    "isOrganizationBrand": {
      "type": "string",
      "description": ""
    },
    "defaultBrandLanguage": {
      "type": "string",
      "description": "The two-letter code for the language that you want to use as the brand default. The supported languages are:\n\n- Arabic (`ar`)\n- Armenian (`hy`)\n- Bahasa Indonesia (`id`)\n- Bahasa Malay (`ms`)\n- Bulgarian (`bg`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Czech (`cs`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English UK (`en_GB`)\n- English US (`en`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canada (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brasil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukranian (`uk`)\n- Vietnamese (`vi`)"
    },
    "organizationBrandLogo": {
      "type": "string",
      "description": ""
    },
    "isOverridingCompanyName": {
      "type": "boolean",
      "description": "When **true,** the `brandCompany` property is overriding the name of the company in the account settings."
    }
  },
  "description": "Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.",
  "x-ms-summary": "Information about a brand that is associated with an account. A brand applies custom styles and text to an envelope.",
  "x-ds-definition-name": "brand"
}

{
  "type": "object",
  "properties": {
    "content": {
      "type": "string",
      "description": "Deprecated."
    },
    "linkText": {
      "type": "string",
      "description": "Deprecated."
    },
    "emailToLink": {
      "type": "string",
      "description": "Deprecated."
    },
    "emailContentType": {
      "type": "string",
      "description": "Deprecated."
    }
  },
  "description": "Deprecated.",
  "x-ms-summary": "Deprecated.",
  "x-ds-definition-name": "brandEmailContent"
}

{
  "type": "object",
  "properties": {
    "linkText": {
      "type": "string",
      "description": "The text used for the link."
    },
    "linkType": {
      "type": "string",
      "description": "The type of link. Valid values include:\n\n- `aboutDocusign`\n- `closeButton`"
    },
    "showLink": {
      "type": "string",
      "description": "When **true,** the link displays to the recipient."
    },
    "urlOrMailTo": {
      "type": "string",
      "description": "The URL or mailto address of the link."
    }
  },
  "description": "Information about a link that a brand uses.",
  "x-ms-summary": "Information about a link that a brand uses.",
  "x-ds-definition-name": "brandLink"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The URI for the brand's secondary logo.\n\nThis is a read-only property that provides a URI to the logo in use.\nTo update a logo use\n[AccountBrands: updateLogo](https://raw.githubusercontent.com).\n"
    },
    "primary": {
      "type": "string",
      "description": "The URI for the brand's secondary logo.\n\nThis is a read-only property that provides a URI to the logo in use.\nTo update a logo use\n[AccountBrands: updateLogo](https://raw.githubusercontent.com).\n"
    },
    "secondary": {
      "type": "string",
      "description": "The URI for the brand's secondary logo.\n\nThis is a read-only property that provides a URI to the logo in use.\nTo update a logo use\n[AccountBrands: updateLogo](https://raw.githubusercontent.com).\n"
    }
  },
  "description": "The URIs for retrieving the logos that are associated with the brand.\n\nThese are read-only properties that provide a URI to logos in use.\nTo update a logo use\n[AccountBrands: updateLogo](https://raw.githubusercontent.com).\n",
  "x-ms-summary": "The URIs for retrieving the logos that are associated with the brand.\n\nThese are read-only properties that provide a URI to logos in use.\nTo update a logo use\n[AccountBrands: updateLogo](https://raw.githubusercontent.com).\n",
  "x-ds-definition-name": "brandLogos"
}

{
  "type": "object",
  "properties": {
    "brandId": {
      "type": "string",
      "description": "The ID of the brand used in API calls"
    }
  },
  "description": "This request object contains information about a specific brand.",
  "x-ms-summary": "This request object contains information about a specific brand.",
  "x-ds-definition-name": "brandRequest"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The URI for the email resource file that the brand uses."
    },
    "sending": {
      "type": "string",
      "description": "The URI for the sending resource file that the brand uses."
    },
    "signing": {
      "type": "string",
      "description": "The URI for the signing resource file that the brand uses."
    },
    "signingCaptive": {
      "type": "string",
      "description": "The URI for the captive (embedded) signing resource file that the brand uses."
    }
  },
  "description": "Brands use resource files to style the following experiences: \n\n- Email\n- Sending\n- Signing\n- Captive (embedded) signing \n\nYou can modify these resource files to customize these experiences.",
  "x-ms-summary": "Brands use resource files to style the following experiences: \n\n- Email\n- Sending\n- Signing\n- Captive (embedded) signing \n\nYou can modify these resource files to customize these experiences.",
  "x-ds-definition-name": "brandResourceUrls"
}

{
  "type": "object",
  "properties": {
    "createdDate": {
      "type": "string",
      "description": "The date and time that the brand resource was created."
    },
    "modifiedDate": {
      "type": "string",
      "description": "The date on which this user record was last modified."
    },
    "createdByUserInfo": {
      "$ref": "#/components/schemas/userInfo"
    },
    "modifiedTemplates": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "This property is returned in the response to the [AccountBrands::listResources][listResources] request. It contains a list of any email templates that have been modified to differ from the master resource files.\n\n[listResources]: /docs/esign-rest-api/reference/accounts/accountbrands/listresources/"
    },
    "modifiedByUserInfo": {
      "$ref": "#/components/schemas/userInfo"
    },
    "resourcesContentUri": {
      "type": "string",
      "description": "The URI for the brand resource file."
    },
    "resourcesContentType": {
      "type": "string",
      "description": "The type of brand resource file. A brand uses a different resource file to control each of the following experiences:\n\n- Sending (`sending`)\n- Signing (`signing`)\n- Email messages (`email`)\n- Captive (embedded) signing (`signing_captive`)\n\nYou can modify the default email messages and formats in these files and upload them to your brand to customize the user experience."
    },
    "dataNotSavedNotInMaster": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Deprecated."
    }
  },
  "description": "Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences.",
  "x-ms-summary": "Information about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences.",
  "x-ds-definition-name": "brandResources"
}

{
  "type": "object",
  "properties": {
    "resourcesContentTypes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/brandResources"
      },
      "description": "A list of resources that the brand uses."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "brandResourcesList"
}

{
  "type": "object",
  "properties": {
    "brands": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/brandRequest"
      },
      "description": "A list of brands."
    }
  },
  "description": "Details about one or more brands.",
  "x-ms-summary": "Details about one or more brands.",
  "x-ds-definition-name": "brandsRequest"
}

{
  "type": "object",
  "properties": {
    "brands": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/brand"
      },
      "description": "A list of brands."
    },
    "senderBrandIdDefault": {
      "type": "string",
      "description": "The brand that envelope senders see when a brand is not explicitly set."
    },
    "recipientBrandIdDefault": {
      "type": "string",
      "description": "The brand that envelope recipients see when a brand is not explicitly set."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "brandsResponse"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the recipient assigned to this envelope transaction."
    },
    "email": {
      "type": "string",
      "description": "The email address of the recipient assigned to this envelope transaction."
    },
    "bulkStatus": {
      "type": "string",
      "description": "Indicates the status of the bulk send operation. Returned values can be:\n- `queued`\n- `processing`\n- `sent`\n- `failed`"
    },
    "envelopeId": {
      "type": "string",
      "description": "GUID of the bulk envelope."
    },
    "envelopeUri": {
      "type": "string",
      "description": "The URI for retrieving the envelope or envelopes."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "transactionId": {
      "type": "string",
      "description": "Identifier for the envelope transaction. The ID is a sender-generated value and is valid in the DocuSign system for 7 days. DocuSign recommends that you use a transaction ID for offline signing to ensure that an envelope is not sent multiple times. You can use the transaction ID to determine an envelope's status (queued, processing, sent, or failed) in cases where the Internet connection is lost before envelope status is returned."
    },
    "bulkRecipientRow": {
      "type": "string",
      "description": "The row of the recipient in the CSV file used to create the bulk recipient list."
    },
    "submittedDateTime": {
      "type": "string",
      "description": "The date and time on which the bulk envelope was created."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkEnvelope"
}

{
  "type": "object",
  "properties": {
    "sent": {
      "type": "string",
      "description": "The number of entries with a status of sent."
    },
    "failed": {
      "type": "string",
      "description": "The number of entries with a status of failed. "
    },
    "queued": {
      "type": "string",
      "description": "The number of entries with a status of queued. "
    },
    "batchId": {
      "type": "string",
      "description": "Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches."
    },
    "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. "
    },
    "batchSize": {
      "type": "string",
      "description": "The number of items returned in this response."
    },
    "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`."
    },
    "bulkEnvelopes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkEnvelope"
      },
      "description": "A list of bulk envelope objects."
    },
    "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."
    },
    "submittedDate": {
      "type": "string",
      "description": "The date on which the bulk envelope was created."
    },
    "bulkEnvelopesBatchUri": {
      "type": "string",
      "description": "URI at which you can retrieve the batch envelopes."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkEnvelopeStatus"
}

{
  "type": "object",
  "properties": {
    "batchName": {
      "type": "string",
      "description": ""
    },
    "envelopeOrTemplateId": {
      "type": "string",
      "description": "The GUID of the envelope or template."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkProcessRequest"
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "batchId": {
      "type": "string",
      "description": "Identifier used to query the status of an individual bulk recipient batch."
    },
    "batchName": {
      "type": "string",
      "description": ""
    },
    "batchSize": {
      "type": "string",
      "description": "The total number of items in the batch being queried."
    },
    "queueLimit": {
      "type": "string",
      "description": ""
    },
    "totalQueued": {
      "type": "string",
      "description": ""
    },
    "errorDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Error details.\n"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkProcessResponse"
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkSendBatchError"
      },
      "description": ""
    },
    "listId": {
      "type": "string",
      "description": "The GUID of the bulk send list."
    },
    "success": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkProcessResult"
}

{
  "type": "object",
  "properties": {
    "bulkListSummaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkProcessingListSummary"
      },
      "description": "An array of `bulkSendingListSummary` objects where each summary provides basic information about a bulk send list that belongs to the current user."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkProcessingListSummaries"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": ""
    },
    "createdDate": {
      "type": "string",
      "description": "The creation date of the account in UTC timedate format."
    },
    "createdByUser": {
      "type": "string",
      "description": ""
    },
    "bulkProcessListId": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkProcessingListSummary"
}

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

{
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "The action to apply. Valid values:\n\n* `Resend`\n* `Correct`\n* `Void`\n\nThis property is required and case-sensitive. The value must correspond to the `bulkAction` query parameter.\n"
    },
    "voidReason": {
      "type": "string",
      "description": "A string explaining why the envelope is voided. This value is shown in a message to the recipients.\n\nThis property is required if `action` is `Void`.\n"
    },
    "notification": {
      "$ref": "#/components/schemas/notification"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkSendBatchActionRequest"
}

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "The server error associated with the Connect post failure."
    },
    "errorDetail": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkSendBatchError"
}

{
  "type": "object",
  "properties": {
    "batchName": {
      "type": "string",
      "description": "The new name of the bulk send batch.\n\nThis property is required. The maximum length of the string is 500 characters."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkSendBatchRequest"
}

{
  "type": "object",
  "properties": {
    "sent": {
      "type": "string",
      "description": "The number of envelopes sent successfully."
    },
    "action": {
      "type": "string",
      "description": ""
    },
    "failed": {
      "type": "string",
      "description": "The number of envelopes that failed to process or send.\n"
    },
    "queued": {
      "type": "string",
      "description": "The number of envelopes waiting in pending queue\n"
    },
    "batchId": {
      "type": "string",
      "description": "The batch ID."
    },
    "batchName": {
      "type": "string",
      "description": "The batch name."
    },
    "batchSize": {
      "type": "string",
      "description": "The number of of bulk envelopes submitted in the current batch\n"
    },
    "bulkErrors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkSendErrorStatus"
      },
      "description": "An array of error statuses."
    },
    "ownerUserId": {
      "type": "string",
      "description": ""
    },
    "actionStatus": {
      "type": "string",
      "description": ""
    },
    "envelopesUri": {
      "type": "string",
      "description": "The URI to get all envelopes sent in the batch.\n"
    },
    "senderUserId": {
      "type": "string",
      "description": "The ID of the sender."
    },
    "envelopesInfo": {
      "$ref": "#/components/schemas/bulkSendEnvelopesInfo"
    },
    "mailingListId": {
      "type": "string",
      "description": "The ID of the mailing list used to create the batch."
    },
    "submittedDate": {
      "type": "string",
      "description": "The timestamp of  when the batch was submitted in ISO 8601 format.\n\n"
    },
    "mailingListName": {
      "type": "string",
      "description": ""
    },
    "resendsRemaining": {
      "type": "string",
      "description": ""
    },
    "envelopeIdOrTemplateId": {
      "type": "string",
      "description": "The ID of the draft envelope or template that was used to create the batch.\n"
    }
  },
  "description": "Result of `getBulkSendBatchStatus`",
  "x-ms-summary": "Result of `getBulkSendBatchStatus`",
  "x-ds-definition-name": "bulkSendBatchStatus"
}

{
  "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. "
    },
    "queueLimit": {
      "type": "string",
      "description": "Maximum number of envelopes an account is permitted to have in the queue at any one time."
    },
    "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. "
    },
    "totalQueued": {
      "type": "string",
      "description": "The number of envelopes currently pending processing for the entire account."
    },
    "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."
    },
    "batchSizeLimit": {
      "type": "string",
      "description": "The maximum number of envelopes the account is permitted to submit in a given batch."
    },
    "bulkBatchSummaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkSendBatchSummary"
      },
      "description": "An array of batch summaries."
    },
    "bulkProcessQueueLimit": {
      "type": "string",
      "description": ""
    },
    "bulkProcessTotalQueued": {
      "type": "string",
      "description": ""
    }
  },
  "description": "A list of bulk send batch summaries. ",
  "x-ms-summary": "A list of bulk send batch summaries. ",
  "x-ds-definition-name": "bulkSendBatchSummaries"
}

{
  "type": "object",
  "properties": {
    "sent": {
      "type": "string",
      "description": "Number of envelopes that have been sent."
    },
    "action": {
      "type": "string",
      "description": ""
    },
    "failed": {
      "type": "string",
      "description": "Number of envelopes that failed to send."
    },
    "queued": {
      "type": "string",
      "description": "Number of envelopes peding processing.\n"
    },
    "batchId": {
      "type": "string",
      "description": "The batch ID."
    },
    "batchUri": {
      "type": "string",
      "description": "The batch details URI."
    },
    "batchName": {
      "type": "string",
      "description": "The name of the batch."
    },
    "batchSize": {
      "type": "string",
      "description": "The number of envelopes in the batch."
    },
    "actionStatus": {
      "type": "string",
      "description": ""
    },
    "submittedDate": {
      "type": "string",
      "description": "The time stamp of when the batch was created in ISO 8601 format."
    }
  },
  "description": "Summary status of a single batch.",
  "x-ms-summary": "Summary status of a single batch.",
  "x-ds-definition-name": "bulkSendBatchSummary"
}

{
  "type": "object",
  "properties": {
    "sent": {
      "type": "string",
      "description": "The number of entries with a status of `sent`."
    },
    "signed": {
      "type": "string",
      "description": ""
    },
    "voided": {
      "type": "string",
      "description": ""
    },
    "correct": {
      "type": "string",
      "description": ""
    },
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the workspace user authorization was created."
    },
    "deleted": {
      "type": "string",
      "description": ""
    },
    "declined": {
      "type": "string",
      "description": ""
    },
    "timedOut": {
      "type": "string",
      "description": ""
    },
    "completed": {
      "type": "string",
      "description": ""
    },
    "delivered": {
      "type": "string",
      "description": ""
    },
    "authoritativeCopy": {
      "type": "string",
      "description": "When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"
    },
    "transferCompleted": {
      "type": "string",
      "description": ""
    },
    "digitalSignaturesPending": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulkSendEnvelopesInfo"
}

{
  "type": "object",
  "properties": {
    "created": {
      "type": "string",
      "description": "The timestamp of when the error occurred in ISO 8601 format."
    },
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "errorMessage": {
      "type": "string",
      "description": "The error message generated during processing, if any.\n"
    },
    "recipientEmails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of email addresses for the failed bulk envelope.\n\nRecipient email/info of the failed bulk envelope.\n"
    }
  },
  "description": "A single bulk send error report.",
  "x-ms-summary": "A single bulk send error report.",
  "x-ds-definition-name": "bulkSendErrorStatus"
}

{
  "type": "object",
  "properties": {
    "batchName": {
      "type": "string",
      "description": "The human-readable name of the batch. If you do not set this value, it defaults to the `name` property of the `bulkSendingList` object.\n"
    },
    "envelopeOrTemplateId": {
      "type": "string",
      "description": "The GUID of the envelope or template that you want to send in bulk."
    }
  },
  "description": "This object contains information about the envelope or template that you want to send in bulk.",
  "x-ms-summary": "This object contains information about the envelope or template that you want to send in bulk.",
  "x-ds-definition-name": "bulkSendRequest"
}

{
  "type": "object",
  "properties": {
    "errors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of errors that occurred. This information is intended to be parsed by machine."
    },
    "batchId": {
      "type": "string",
      "description": "A batch identifier that you can use to get the status of the batch."
    },
    "batchName": {
      "type": "string",
      "description": ""
    },
    "batchSize": {
      "type": "string",
      "description": "The total number of items in the batch being queried."
    },
    "queueLimit": {
      "type": "string",
      "description": ""
    },
    "totalQueued": {
      "type": "string",
      "description": ""
    },
    "errorDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A human-readable object that describes errors that occur. It is only valid for responses and ignored in requests."
    },
    "envelopeOrTemplateId": {
      "type": "string",
      "description": "The GUID of the envelope or template that was sent."
    }
  },
  "description": "The object contains the response to a bulk send request.",
  "x-ms-summary": "The object contains the response to a bulk send request.",
  "x-ds-definition-name": "bulkSendResponse"
}

{
  "type": "object",
  "properties": {
    "canBeSent": {
      "type": "boolean",
      "description": "When **true,** the envelope or template is compatible with the bulk send list and can be sent by using the [BulkSend: createBulkSendRequest][BulkSendRequest] method.\n\n**Note:** This property is only returned in responses and ignored in requests.\n\n[BulkSendRequest]:  /docs/esign-rest-api/reference/bulkenvelopes/bulksend/createbulksendrequest/\n"
    },
    "validationErrors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of validation errors that were encountered during the bulk send test.\n\n**Note:** This information is intended to be parsed by machine."
    },
    "validationErrorDetails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Human-readable details about any validation errors that occurred."
    }
  },
  "description": "This object contains the results of a bulk send test.",
  "x-ms-summary": "This object contains the results of a bulk send test.",
  "x-ds-definition-name": "bulkSendTestResponse"
}

{
  "type": "object",
  "properties": {
    "emailBlurb": {
      "type": "string",
      "description": "The email body for this copy of the envelope."
    },
    "recipients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkSendingCopyRecipient"
      },
      "description": "Information about the recipients associated with this copy of the envelope."
    },
    "customFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkSendingCopyCustomField"
      },
      "description": "The custom fields for this copy of the envelope.\n\n**Note:** These custom fields must also be included in the original envelope or template that you want to send."
    },
    "emailSubject": {
      "type": "string",
      "description": "The email subject line for this copy of the envelope.\n\nFor information about adding merge field information to the email subject,\nsee [Template Email Subject Merge Fields](https://raw.githubusercontent.com).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters."
    },
    "docGenFormFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulksendingCopyDocGenFormField"
      },
      "description": ""
    }
  },
  "description": "This object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance.",
  "x-ms-summary": "This object contains the details to use for a specific copy, or instance, of the envelope. When you send an envelope by using a bulk send list, you can customize these properties for each instance.",
  "x-ds-definition-name": "bulkSendingCopy"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the custom field."
    },
    "value": {
      "type": "string",
      "description": "The value of the custom field."
    }
  },
  "description": "This object contains details about a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send.",
  "x-ms-summary": "This object contains details about a custom field for a bulk send copy. In a bulk send request, each custom field in the bulk send list must match a custom field in the envelope or template that you want to send.",
  "x-ds-definition-name": "bulkSendingCopyCustomField"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": ""
    },
    "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": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkSendingCopyTab"
      },
      "description": "A list of tabs associated with the recipient. In a bulk send request, each of these recipient tabs must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nFor example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information.\n\n You can use the following types of tabs to match bulk send recipients to an envelope:\n\n- Text tabs\n- Radio group tabs (where the name of the `radioGroup` on the envelope is used as the `tabLabel` in the bulk send list)\n- List tabs"
    },
    "email": {
      "type": "string",
      "description": "The recipient's email address."
    },
    "hostName": {
      "type": "string",
      "description": "The name of the signing host.\nThis is the DocuSign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n"
    },
    "roleName": {
      "type": "string",
      "description": "The name of the role associated with the recipient.\n\n**Note:** Every recipient must be assigned either a `recipientId` or a `roleName` but not both. You cannot use `roleName` and `recipientId` in the same list."
    },
    "faxNumber": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "hostEmail": {
      "type": "string",
      "description": "The email address of the signing host.\nThis is the DocuSign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `email` instead.\n\nMaximum Length: 100 characters.\n"
    },
    "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."
    },
    "signerName": {
      "type": "string",
      "description": "The in-person signer's full legal name.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n"
    },
    "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"
    },
    "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."
    },
    "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/"
    },
    "signingGroupId": {
      "type": "string",
      "description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
    },
    "emailNotification": {
      "$ref": "#/components/schemas/recipientEmailNotification"
    },
    "smsAuthentication": {
      "$ref": "#/components/schemas/recipientSMSAuthentication"
    },
    "phoneAuthentication": {
      "$ref": "#/components/schemas/recipientPhoneAuthentication"
    },
    "identificationMethod": {
      "type": "string",
      "description": ""
    },
    "identityVerification": {
      "$ref": "#/components/schemas/recipientIdentityVerification"
    },
    "socialAuthentications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/socialAuthentication"
      },
      "description": "Deprecated."
    },
    "idCheckInformationInput": {
      "$ref": "#/components/schemas/idCheckInformationInput"
    },
    "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."
    },
    "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]]` "
    },
    "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)"
    }
  },
  "description": "This object contains details about a bulk send recipient.",
  "x-ms-summary": "This object contains details about a bulk send recipient.",
  "x-ds-definition-name": "bulkSendingCopyRecipient"
}

{
  "type": "object",
  "properties": {
    "tabLabel": {
      "type": "string",
      "description": "The label associated with the recipient tab. In a bulk send request, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nMaximum Length: 500 characters."
    },
    "initialValue": {
      "type": "string",
      "description": "The initial value that you want to assign to the tab."
    }
  },
  "description": "A tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nFor example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information.",
  "x-ms-summary": "A tab associated with the bulk send recipient. In a bulk send request, each recipient tab must match a recipient tab on the envelope or template that you want to send. To match up, the `tabLabel` for this tab and the `tabLabel` for the corresponding tab on the envelope or template must be the same.\n\nFor example, if the envelope has a placeholder text tab with the `tabLabel` `childName`, you must assign the same `tabLabel` `childName` to the tab here that you are populating with that information.",
  "x-ds-definition-name": "bulkSendingCopyTab"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the bulk send list."
    },
    "listId": {
      "type": "string",
      "description": "The GUID of the bulk send list."
    },
    "bulkCopies": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkSendingCopy"
      },
      "description": "An array of `bulkCopy` objects. Each object represents an instance or copy of an envelope and contains details such as the recipient, custom fields, tabs, and other information."
    }
  },
  "description": "This object contains the details for the bulk send list.",
  "x-ms-summary": "This object contains the details for the bulk send list.",
  "x-ds-definition-name": "bulkSendingList"
}

{
  "type": "object",
  "properties": {
    "bulkListSummaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bulkSendingListSummary"
      },
      "description": "An array of `bulkSendingListSummary` objects where each summary provides basic information about a bulk send list that belongs to the current user."
    }
  },
  "description": "This complex type contains summaries that provide basic information about the bulk send lists that belong to the current user.",
  "x-ms-summary": "This complex type contains summaries that provide basic information about the bulk send lists that belong to the current user.",
  "x-ds-definition-name": "bulkSendingListSummaries"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the bulk send list."
    },
    "createdDate": {
      "type": "string",
      "description": "The UTC DateTime that the bulk send list was created."
    },
    "createdByUser": {
      "type": "string",
      "description": "The GUID of the user who created the bulk send list."
    },
    "bulkSendListId": {
      "type": "string",
      "description": "The GUID of the bulk send list. This property is created after you post a new bulk send list."
    }
  },
  "description": "This object contains basic information about a bulk send list.",
  "x-ms-summary": "This object contains basic information about a bulk send list.",
  "x-ds-definition-name": "bulkSendingListSummary"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": ""
    },
    "value": {
      "type": "string",
      "description": "Specifies the value of the tab. "
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "bulksendingCopyDocGenFormField"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The email address associated with the captive recipient."
    },
    "userName": {
      "type": "string",
      "description": "The username associated with the captive recipient."
    },
    "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"
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    }
  },
  "description": "This object contains details about a captive (embedded) recipient.",
  "x-ms-summary": "This object contains details about a captive (embedded) recipient.",
  "x-ds-definition-name": "captiveRecipient"
}

{
  "type": "object",
  "properties": {
    "captiveRecipients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/captiveRecipient"
      },
      "description": "A complex type containing information about one or more captive recipients."
    }
  },
  "description": "Contains information about captive (embedded) recipients.",
  "x-ms-summary": "Contains information about captive (embedded) recipients.",
  "x-ds-definition-name": "captiveRecipientInformation"
}

{
  "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. Notification of the document to sign is sent to this email address. \n\nMaximum length: 100 characters. "
    },
    "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."
    },
    "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."
    },
    "phoneNumber": {
      "$ref": "#/components/schemas/recipientPhoneNumber"
    },
    "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"
    },
    "clientUserId": {
      "type": "string",
      "description": "Not applicable for Carbon Copy recipients."
    },
    "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."
    },
    "totalTabCount": {
      "type": "string",
      "description": "The total number of tabs in the documents. This property is read-only."
    },
    "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."
    },
    "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. "
    },
    "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."
    },
    "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."
    },
    "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"
    },
    "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.**"
    },
    "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"
    },
    "recipientTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "socialAuthentications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/socialAuthentication"
      },
      "description": "Deprecated."
    },
    "deliveryMethodMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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"
    },
    "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."
    },
    "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."
    },
    "emailRecipientPostSigningURL": {
      "type": "string",
      "description": ""
    },
    "linkedAccountConfigurationId": {
      "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": "Contains information about a carbon copy recipient. 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. ",
  "x-ms-summary": "Contains information about a carbon copy recipient. 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. ",
  "x-ds-definition-name": "carbonCopy"
}

{
  "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"
    },
    "email": {
      "type": "string",
      "description": "The recipient's email address."
    },
    "status": {
      "type": "string",
      "description": "The status of the recipient. 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."
    },
    "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."
    },
    "phoneNumber": {
      "$ref": "#/components/schemas/recipientPhoneNumber"
    },
    "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"
    },
    "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."
    },
    "totalTabCount": {
      "type": "string",
      "description": "The total number of tabs in the documents. This property is read-only."
    },
    "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."
    },
    "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. "
    },
    "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."
    },
    "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."
    },
    "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"
    },
    "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.**"
    },
    "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"
    },
    "recipientTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "socialAuthentications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/socialAuthentication"
      },
      "description": "Deprecated."
    },
    "deliveryMethodMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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"
    },
    "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."
    },
    "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."
    },
    "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": "Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.",
  "x-ms-summary": "Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.",
  "x-ds-definition-name": "certifiedDelivery"
}

{
  "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."
    },
    "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 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": ""
    },
    "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": "This property does not apply to `checkbox` tabs.\n\nTo require users to check\nat least one, or at most some number\nof checkboxes,\nassociate the checkbox tabs\nwith a [`tabGroup`][tabGroup].\nThen set the following `tabGroup` properties:\n\n- [`maximumAllowed`][maximumAllowed]\n- [`minimumRequired`][minimumRequired]\n- [`groupRule`][groupRule] specifies how the other two properties are interpreted.\n\nYou can find an example\nat [Stack Overflow][so].\n\n[so]:               https://stackoverflow.com/questions/58209376/checkbox-validation-using-docusign-rest-api/58210277#58210277\n[tabGroup]:         /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups\n[groupRule]:        /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_grouprule\n[maximumAllowed]:   /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_maximumallowed\n[minimumRequired]:  /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_minimumrequired\n"
    },
    "selected": {
      "type": "string",
      "description": "When **true,** the checkbox is selected."
    },
    "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\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-7, -6)\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 (-7, -6)\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.\nFor 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 apply. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all 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"
    },
    "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."
    },
    "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"
    },
    "lockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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"
    },
    "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"
    },
    "selectedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "selectedOriginal": {
      "type": "string",
      "description": ""
    },
    "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"
    },
    "shareToRecipients": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "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"
    },
    "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."
    },
    "selectedOriginalMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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"
    },
    "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."
    },
    "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 select a yes/no (on/off) option.\n",
  "x-ms-summary": "A tab that allows the recipient to select a yes/no (on/off) option.\n",
  "x-ds-definition-name": "checkbox"
}

{
  "type": "object",
  "properties": {
    "size": {
      "type": "string",
      "description": "The size of the part in bytes. \n\nDocuSign recommends that a chunked upload part is no larger than a few MB in size."
    },
    "sequence": {
      "type": "string",
      "description": "The order of the part in the chunked upload."
    }
  },
  "description": "An object that contains information about the chunked upload part.",
  "x-ms-summary": "An object that contains information about the chunked upload part.",
  "x-ds-definition-name": "chunkedUploadPart"
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "string",
      "description": "A base64-encoded representation of the content that is used to upload the file. \n\nMaximum size: 50 MB. However, data is also subject to REST API limits regarding request sizes, and Internet Information Systems (IIS) might place further constraints on file size."
    },
    "chunkedUploadId": {
      "type": "string",
      "description": "The ID of the chunked upload.\n\n**Note:** This property is ignored in requests, and overridden with an auto-generated value in responses."
    }
  },
  "description": "This is the request object for uploading a chunked upload.",
  "x-ms-summary": "This is the request object for uploading a chunked upload.",
  "x-ds-definition-name": "chunkedUploadRequest"
}

{
  "type": "object",
  "properties": {
    "checksum": {
      "type": "string",
      "description": "A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content that has been uploaded to the chunked upload. 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 commit action is refused."
    },
    "committed": {
      "type": "string",
      "description": "When **true,** the chunked upload has been committed. A committed chunked upload can no longer receive any additional parts and is ready for use within other API requests. "
    },
    "totalSize": {
      "type": "string",
      "description": "The total size of the parts of the chunked upload.\n\n**Note:** When a chunked upload is used as an envelope document, it is subject to the PDF size limit (25 MB) and page count limit that apply to all envelope documents."
    },
    "maxTotalSize": {
      "type": "string",
      "description": "The maximum total size allowed for a chunked upload. This value is configured per DocuSign environment, account, or integrator. The default value is 50 MB."
    },
    "chunkedUploadId": {
      "type": "string",
      "description": "The ID of the chunked upload. "
    },
    "chunkedUploadUri": {
      "type": "string",
      "description": "The URI that you use to reference the chunked upload in other API requests, such as envelope document and envelope attachment requests. "
    },
    "chunkedUploadParts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/chunkedUploadPart"
      },
      "description": "A list of the parts that compose the chunked upload, including their byte sizes. The list must be contiguous before you can commit the chunked upload."
    },
    "expirationDateTime": {
      "type": "string",
      "description": "The UTC time at which the chunked upload expires and is no longer addressable. \n\n**Note:** You must fully upload and use a chunked upload within 20 minutes of initializing it.\n"
    },
    "maxChunkedUploadParts": {
      "type": "string",
      "description": "The maximum number of parts allowed for a chunked upload. This value is configurable per DocuSign environment, account, or integrator. The default value is 128. The maximum possible value is 256.  "
    }
  },
  "description": "This response object is returned after you upload a chunked upload.",
  "x-ms-summary": "This response object is returned after you upload a chunked upload.",
  "x-ds-definition-name": "chunkedUploadResponse"
}

{
  "type": "object",
  "properties": {
    "service": {
      "type": "string",
      "description": "The service name for the cloud storage provider."
    },
    "serviceId": {
      "type": "string",
      "description": "The DocuSign-generated ID for the cloud storage provider."
    },
    "redirectUrl": {
      "type": "string",
      "description": "The URL the user is redirected to after the cloud storage provider authenticates the user. Using this will append the redirectUrl to the authenticationUrl.\n\nThe redirectUrl is restricted to URLs in the docusign.com or docusign.net domains."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "authenticationUrl": {
      "type": "string",
      "description": "The authentication URL used for the cloud storage provider. This information is only included in the response if the user has not passed authentication for the cloud storage provider. If the redirectUrl query string is provided, the returnUrl is appended to the authenticationUrl. "
    }
  },
  "description": "Contains details about a specific cloud storage provider.",
  "x-ms-summary": "Contains details about a specific cloud storage provider.",
  "x-ds-definition-name": "cloudStorageProvider"
}

{
  "type": "object",
  "properties": {
    "storageProviders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/cloudStorageProvider"
      },
      "description": "An Array containing the storage providers associated with the user."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "cloudStorageProviders"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the comment."
    },
    "hmac": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "read": {
      "type": "boolean",
      "description": "When **true,** indicates that the comment was read."
    },
    "text": {
      "type": "string",
      "description": "The content of the comment, as UTF-8 text. \n\nMaximum Length: 500 characters.\n\n**Note:** The maximum size allowed for the entire message body is 32 KB. "
    },
    "tabId": {
      "type": "string",
      "description": "The unique identifier for the tab that represents the comment thread."
    },
    "subject": {
      "type": "string",
      "description": "The subject of the envelope."
    },
    "mentions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of userIds that are mentioned directly in the body of a comment."
    },
    "threadId": {
      "type": "string",
      "description": "The unique identifier for the comment thread."
    },
    "timestamp": {
      "type": "string",
      "description": "The time the comment was created."
    },
    "visibleTo": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The user IDs of the users that the comment is visible to."
    },
    "envelopeId": {
      "type": "string",
      "description": "The Guid of the envelope the comment thread belongs to."
    },
    "sentByEmail": {
      "type": "string",
      "description": "The email address of the user who created the comment."
    },
    "sentByUserId": {
      "type": "string",
      "description": "The user ID of the user who created the comment."
    },
    "sentByImageId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "sentByFullName": {
      "type": "string",
      "description": "The full name of the user who created the comment."
    },
    "sentByInitials": {
      "type": "string",
      "description": "The initials of the user who created the comment."
    },
    "signingGroupId": {
      "type": "string",
      "description": "The ID of the signing group that can view the comment or that created the comment."
    },
    "signingGroupName": {
      "type": "string",
      "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. "
    },
    "sentByRecipientId": {
      "type": "string",
      "description": "The recipient ID of the user who created the comment."
    },
    "threadOriginatorId": {
      "type": "string",
      "description": "The userId of the user who created the thread."
    },
    "timeStampFormatted": {
      "type": "string",
      "description": "The time the comment was created, formatted according to the format of the user who created the comment."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "comment"
}

{
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "format": "int32",
      "description": "The maximum number of results to return."
    },
    "comments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/comment"
      },
      "description": "An array of comment tabs that contain information about users' comments on documents."
    },
    "endTimetoken": {
      "type": "string",
      "description": ""
    },
    "startTimetoken": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "commentHistoryResult"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique ID for the Salesforce object."
    },
    "text": {
      "type": "string",
      "description": "Specifies the text that is shown in the dropdown list. "
    },
    "mentions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of userIds that are mentioned directly in the body of a comment."
    },
    "threadId": {
      "type": "string",
      "description": "The unique identifier for the comment thread."
    },
    "visibleTo": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "threadAnchorKeys": {
      "type": "object",
      "description": "",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "commentPublish"
}

{
  "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"
    },
    "comments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/comment"
      },
      "description": "An array of comment tabs that contain information about users' comments on documents."
    },
    "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"
    },
    "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."
    },
    "threadId": {
      "type": "string",
      "description": "The unique identifier for the comment thread."
    },
    "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"
    },
    "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"
    },
    "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": "Specifies the page number on which the tab is located."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "commentThread"
}

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

{
  "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": ""
    },
    "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": "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."
    },
    "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"
    },
    "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"
    },
    "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": "Specifies the page number on which the tab is located."
    },
    "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 Commission County tab displays the county of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](https://raw.githubusercontent.com).\n",
  "x-ms-summary": "A Commission County tab displays the county of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](https://raw.githubusercontent.com).\n",
  "x-ds-definition-name": "commissionCounty"
}

{
  "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": ""
    },
    "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": "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."
    },
    "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"
    },
    "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"
    },
    "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": "Specifies the page number on which the tab is located."
    },
    "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 Commission Expiration tab displays the expiration date of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](https://raw.githubusercontent.com).\n",
  "x-ms-summary": "A Commission Expiration tab displays the expiration date of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](https://raw.githubusercontent.com).\n",
  "x-ds-definition-name": "commissionExpiration"
}

{
  "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": ""
    },
    "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": "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."
    },
    "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"
    },
    "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"
    },
    "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": "Specifies the page number on which the tab is located."
    },
    "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 Commission Number tab displays a notary's commission number. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/\n",
  "x-ms-summary": "A Commission Number tab displays a notary's commission number. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/\n",
  "x-ds-definition-name": "commissionNumber"
}

{
  "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": ""
    },
    "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": "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."
    },
    "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"
    },
    "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"
    },
    "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": "Specifies the page number on which the tab is located."
    },
    "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 Commission State tab displays the state in which a notary's commission was granted. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/\n",
  "x-ms-summary": "A Commission State tab displays the state in which a notary's commission was granted. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/\n",
  "x-ds-definition-name": "commissionState"
}

{
  "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.\nFor 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 company name.\n",
  "x-ms-summary": "A tab that displays the recipient's company name.\n",
  "x-ds-definition-name": "company"
}

{
  "type": "object",
  "properties": {
    "document": {
      "$ref": "#/components/schemas/document"
    },
    "inlineTemplates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/inlineTemplate"
      },
      "description": " Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value."
    },
    "serverTemplates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/serverTemplate"
      },
      "description": "Zero or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value."
    },
    "compositeTemplateId": {
      "type": "string",
      "description": "The ID of this composite template. This ID is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document."
    },
    "pdfMetaDataTemplateSequence": {
      "type": "string",
      "description": "A number representing the sequence in which to apply the template that contains the PDF metadata.\n\nExample: `4`"
    }
  },
  "description": "This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources.\n\n[composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/",
  "x-ms-summary": "This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources.\n\n[composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/",
  "x-ds-definition-name": "compositeTemplate"
}

{
  "type": "object",
  "properties": {
    "order": {
      "type": "string",
      "description": "An integer that specifies the order in which rules are processed.\nLower values are processed before higher values."
    },
    "conditions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/conditionalRecipientRuleCondition"
      },
      "description": "An array of conditions that define when the recipients will be used."
    },
    "recipientId": {
      "type": "string",
      "description": "The ID of the recipient to whom the condition will be applied. This value should match the `recipientId` defined in the recipient object.\n"
    },
    "recipientGroup": {
      "$ref": "#/components/schemas/recipientGroup"
    }
  },
  "description": "A rule that defines a set of recipients and the conditions under which they will be used for the envelope.",
  "x-ms-summary": "A rule that defines a set of recipients and the conditions under which they will be used for the envelope.",
  "x-ds-definition-name": "conditionalRecipientRule"
}

{
  "type": "object",
  "properties": {
    "order": {
      "type": "string",
      "description": "An integer that specifies the order in which rules are processed.\nLower values are processed before higher values."
    },
    "filters": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/conditionalRecipientRuleFilter"
      },
      "description": ""
    },
    "recipientLabel": {
      "type": "string",
      "description": "An identifier for the recipient. After assigning this value in a `recipient` object, you can reference it in the `conditions` object to set the recipient as a conditional recipient. For an example, see [How to use conditional recipients](https://raw.githubusercontent.com).\n"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "conditionalRecipientRuleCondition"
}

{
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "description": "The scope under which the condition is evaluated. Valid values:\n\n* `tabs`"
    },
    "tabId": {
      "type": "string",
      "description": "The unique identifier for the tab."
    },
    "value": {
      "type": "string",
      "description": "A set value to which the tab's actual value is compared."
    },
    "tabType": {
      "type": "string",
      "description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
    },
    "operator": {
      "type": "string",
      "description": "How the tab value is compared to the `value` property. Valid values:\n\n* `equals`\n* `greaterThan`\n* `greaterThanEquals`\n* `lessThan`\n* `lessThanEquals`\n* `filled`\n* `selected`"
    },
    "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"
    },
    "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"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "conditionalRecipientRuleFilter"
}

{
  "type": "object",
  "properties": {
    "totalRecords": {
      "type": "string",
      "description": "The number of results."
    },
    "configurations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectCustomConfiguration"
      },
      "description": "An array of DocuSign Connect configurations."
    }
  },
  "description": "This object contains the results of a ConnectConfigurations::GET method.",
  "x-ms-summary": "This object contains the results of a ConnectConfigurations::GET method.",
  "x-ds-definition-name": "connectConfigResults"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the Connect configuration.\n\nThis property is required."
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `urlToPublishTo` property.\n\nSet this property when you are using the [JSON SIM event model](https://raw.githubusercontent.com). If you are instead using any of [the legacy event message formats](https://raw.githubusercontent.com), set either the `envelopeEvents` property or the `recipientEvents` property.\n\nThe [possible event statuses](/platform/webhooks/connect/improved-json-sim-event-model/#eventreference) are:\n\n* `envelope-created`\n* `envelope-sent`\n* `envelope-resent`\n* `envelope-delivered`\n* `envelope-completed`\n* `envelope-declined`\n* `envelope-voided`\n* `recipient-authenticationfailed`\n* `recipient-autoresponded`\n* `recipient-declined`\n* `recipient-delivered`\n* `recipient-completed`\n* `recipient-sent`\n* `recipient-resent`\n* `template-created`\n* `template-modified`\n* `template-deleted`\n* `envelope-corrected`\n* `envelope-purge`\n* `envelope-deleted`\n* `envelope-discard`\n* `recipient-reassign`\n* `recipient-delegate`\n* `recipient-finish-later`\n* `click-agreed`\n* `click-declined`\n"
    },
    "userIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A comma-separated list of user IDs. This sets the users associated with the tracked envelope and recipient events. When a tracked event occurs for a set user, the a notification message is sent to your Connect listener.\n\nBy default, the users will be included in the configuration. If you want to exclude the users, set the `allUsersExcept` property to **true.**\n\n**Note:** If `allUsers` is set to `false`, then you must provide a list of user IDs."
    },
    "allUsers": {
      "type": "string",
      "description": "When **true,** the tracked envelope and recipient events for all users, including users that are added a later time, are sent through Connect. The default value is **false.**\n\n**Note:** If this property is **false,** make sure you set the `userIds` property to a non-empty array of user IDs."
    },
    "groupIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "password": {
      "type": "string",
      "description": "The password for the Connect configuration.\n\nThis property is not used for the `createHistoricalEnvelopePublishTransaction` endpoint.\n"
    },
    "userName": {
      "type": "string",
      "description": "The name of the user."
    },
    "connectId": {
      "type": "string",
      "description": "The DocuSign-generated ID for the Connect configuration.\n\nThis property is read-only."
    },
    "enableLog": {
      "type": "string",
      "description": "When **true,** Connect logging is turned on. DocuSign recommends that you enable this functionality to help troubleshoot any issues. \n\nYou can have a maximum of 100 active logs in your account. You can view the entries in active logs in the **Logs** tab in the Connect console."
    },
    "eventData": {
      "$ref": "#/components/schemas/connectEventData"
    },
    "sfObjects": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectSalesforceObject"
      },
      "description": "An array of Salesforce objects."
    },
    "disabledBy": {
      "type": "string",
      "description": ""
    },
    "includeHMAC": {
      "type": "string",
      "description": ""
    },
    "deliveryMode": {
      "type": "string",
      "description": "The delivery mode of the configuration. Valid values:\n\n* `SIM`\n* `Aggregate`"
    },
    "includeOAuth": {
      "type": "string",
      "description": ""
    },
    "soapNamespace": {
      "type": "string",
      "description": "The namespace of the SOAP interface.\n\n**Note:** If `useSoapInterface` is set to **true,** you must set this value."
    },
    "allUsersExcept": {
      "type": "string",
      "description": "This flag allows you to toggle between including and excluding specified users from the configuration. When **false,** the users corresponding to the IDs in `userIds` will be included in the configuration. Conversely, when **true,** the users will be excluded from the configuration. The default value is **false.**"
    },
    "envelopeEvents": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property.\n\nWhen using any of [the legacy event message formats](https://raw.githubusercontent.com), you must include either the `envelopeEvents` property or the `recipientEvents` property. If you are instead using the [JSON SIM event model](]/platform/webhooks/connect/improved-json-sim-event-model/), use the `events` property.\n\nThe [possible event statuses](https://raw.githubusercontent.com) are:\n\n* `Sent`\n* `Delivered`\n* `Completed`\n* `Declined`\n* `Voided`\n\n**Note:** These values are case-sensitive."
    },
    "senderOverride": {
      "type": "string",
      "description": ""
    },
    "urlToPublishTo": {
      "type": "string",
      "description": "The web address of the listener or retrieving service endpoint. It must be an HTTPS URL."
    },
    "recipientEvents": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of recipient event statuses that will trigger Connect to send notifications to your webhook listener at the URL endpoint specified in the `url` property. \n\nWhen using any of [the legacy event message formats](https://raw.githubusercontent.com), you must include either the `envelopeEvents` property or the `recipientEvents` property. If you are instead using the [JSON SIM event model](https://raw.githubusercontent.com), use the `events` property.\n\nThe [possible event statuses](https://raw.githubusercontent.com) are:\n\n* `Sent`\n* `AutoResponded`\n* `Delivered`\n* `Completed`\n* `Declined`\n* `AuthenticationFailed`\n\n**Note:** These values are case-sensitive."
    },
    "externalFolderId": {
      "type": "string",
      "description": "The ID of an external folder."
    },
    "includeDocuments": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "requireMutualTls": {
      "type": "string",
      "description": "When **true,** [Mutual TLS](https://raw.githubusercontent.com) authentication is enabled."
    },
    "useSoapInterface": {
      "type": "string",
      "description": "When **true,** the notifications are sent to your endpoint as SOAP requests. "
    },
    "configurationType": {
      "type": "string",
      "description": "The type of the configuration. Valid values:\n\n* `custom`: Creates an account-level configuration\n* `customrecipient`: Creates a Recipient Connect configuration\n* `salesforce`\n* `eOriginal`\n\nThis property is required."
    },
    "integratorManaged": {
      "type": "string",
      "description": ""
    },
    "salesforceAuthcode": {
      "type": "string",
      "description": ""
    },
    "externalFolderLabel": {
      "type": "string",
      "description": "The label for an external folder."
    },
    "allowEnvelopePublish": {
      "type": "string",
      "description": "Set this value to **true** to enable the webhook. The default property is **false.**"
    },
    "salesforceApiVersion": {
      "type": "string",
      "description": "The version of the Salesforce API that you are using."
    },
    "includeCertSoapHeader": {
      "type": "string",
      "description": ""
    },
    "includeDocumentFields": {
      "type": "string",
      "description": "When **true,** the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. "
    },
    "salesforceCallBackUrl": {
      "type": "string",
      "description": ""
    },
    "senderSelectableItems": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "This property sets the items that are available for selection when adding or editing Connect objects. "
    },
    "allowSalesforcePublish": {
      "type": "string",
      "description": "When **true,** DocuSign sends data to the designated Salesforce account through Connect. The default value is **true.**"
    },
    "requiresAcknowledgement": {
      "type": "string",
      "description": "When **true,** event delivery acknowledgements are enabled for your Connect configuration.\n\nDocuSign Connect awaits a valid 200 response from your application acknowledging that it received a message. If you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and places it into a failure queue. It is imperative that you acknowledge successful receipt of Connect events as they occur by sending a 200 event back.\n\n#### When **true** and Send Individual Messages (SIM) mode is activated\n\nIf the HTTP status response to a notification message is not in the range of 200-299,\nthen the message delivery failed, and the configuration is marked as down.\n\nThe message will be queued and retried once per day.\nWhile a Connect configuration is marked down, subsequent notifications will not be tried. Instead they will be immediately queued with the reason `Pending`.\nWhen a message succeeds, all queued messages for the configuration will be tried immediately, in order.\n\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When **true** and SIM mode is not activated\n\nIf the HTTP Status response to a notification message is not in the range of 200-299,  then the message delivery failed, and the message is queued.\n\nThe message will be retried after at least a day the next time a subsequent message is successfully sent to this configuration (subscription).  Subsequent notifications will be tried when they occur.\nThere is a maximum of ten retries. Alternately, you can use **Republish Connect Information** to manually republish the notification.\n\n#### When **false**\n\nWhen `requiresAcknowledgement` is set to **false** and you do not acknowledge receiving an event notification message within 100 seconds, DocuSign treats the message as a failure and determines that the server is unavailable. It does not retry to send the notification message, and you must handle the failure manually.\n\n"
    },
    "includeEnvelopeVoidReason": {
      "type": "string",
      "description": "When **true,** if the envelope is voided, the Connect Service notification will include the void reason, as entered by the person that voided the envelope. "
    },
    "includeTimeZoneInformation": {
      "type": "string",
      "description": "When **true,** Connect will include the envelope time zone information."
    },
    "includeCertificateOfCompletion": {
      "type": "string",
      "description": "When **true,** the Connect Service includes the Certificate of Completion with completed envelopes. "
    },
    "signMessageWithX509Certificate": {
      "type": "string",
      "description": "When **true,** Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. "
    },
    "includeSenderAccountasCustomField": {
      "type": "string",
      "description": "When **true,** Connect will include the sender account as Custom Field in the data."
    },
    "salesforceDocumentsAsContentFiles": {
      "type": "string",
      "description": "When **true,** DocuSign can use documents in your Salesforce account for sending and signing."
    }
  },
  "description": "The `connectCustomConfiguration` object describes a Connect configuration for your account.",
  "x-ms-summary": "The `connectCustomConfiguration` object describes a Connect configuration for your account.",
  "x-ds-definition-name": "connectCustomConfiguration"
}

{
  "type": "object",
  "properties": {
    "payload": {
      "type": "string",
      "description": "Log output."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "connectConfig": {
      "type": "string",
      "description": "The name of the Connect configuration."
    },
    "eventDateTime": {
      "type": "string",
      "description": "The UTC date and time of the event."
    },
    "eventDescription": {
      "type": "string",
      "description": "A description of the event."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "connectDebugLog"
}

{
  "type": "object",
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "connectDeleteFailureResult"
}

{
  "type": "object",
  "properties": {
    "format": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "version": {
      "type": "string",
      "description": "Set this property to `restv2.1` to return event data in JSON. If the property is not set, the event data will be returned in XML by default."
    },
    "includeData": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A string array of the data to be included.\nThe default is the empty array `[]`.\n\n- `attachments`: Include attachments associated with the envelope.\n- `custom_fields`: Include the custom fields associated with the envelope.\n- `documents`: Include the documents associated with the envelope.\n- `extensions`: Include information about the email settings associated with the envelope.\n- `folders`: Include the folder where the envelope exists.\n- `payment_tabs`: Include the payment tabs associated with the envelope.\n- `powerform`: Include the PowerForms associated with the envelope.\n- `prefill_tabs`: Include the [pre-filled tabs](https://raw.githubusercontent.com) associated with the envelope.\n- `recipients`: Include the recipients associated with the envelope.\n- `tabs`: Include the tabs associated with the envelope.\n"
    }
  },
  "description": "This object lets you choose the data format of your Connect response.",
  "x-ms-summary": "This object lets you choose the data format of your Connect response.",
  "x-ds-definition-name": "connectEventData"
}

{
  "type": "object",
  "properties": {
    "envelopeIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of envelope GUIDs.\n\nExample: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec`\n"
    },
    "synchronous": {
      "type": "string",
      "description": "Must be **false.** Setting this property to any other value will result in errors."
    }
  },
  "description": "A list of failed envelope IDs to retry.",
  "x-ms-summary": "A list of failed envelope IDs to retry.",
  "x-ds-definition-name": "connectFailureFilter"
}

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The connection status."
    },
    "configId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "configUrl": {
      "type": "string",
      "description": "Reserved for DocuSign.\n"
    },
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "statusMessage": {
      "type": "string",
      "description": "A human-readable message describing the connection status."
    }
  },
  "description": "This object contains details about a Connect failure result.",
  "x-ms-summary": "This object contains details about a Connect failure result.",
  "x-ds-definition-name": "connectFailureResult"
}

{
  "type": "object",
  "properties": {
    "retryQueue": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectFailureResult"
      },
      "description": "Details about a Connect failure result."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "connectFailureResults"
}

{
  "type": "object",
  "properties": {
    "config": {
      "$ref": "#/components/schemas/connectCustomConfiguration"
    },
    "envelopes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of envelope IDs as comma-separated strings. This property is required.\n\nFor example: `[\"4280f274-xxxx-xxxx-xxxx-b218b7eeda08\",\"9586h293-xxxx-xxxx-xxxx-m923b8opre71\",\"2347w948-xxxx-xxxx-xxxx-t096b8krno89\"]`"
    }
  },
  "description": "The request body for the `createHistoricalEnvelopePublishTransaction` endpoint.",
  "x-ms-summary": "The request body for the `createHistoricalEnvelopePublishTransaction` endpoint.",
  "x-ds-definition-name": "connectHistoricalEnvelopeRepublish"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The email address of the envelope sender."
    },
    "error": {
      "type": "string",
      "description": "The error that caused the Connect post to fail."
    },
    "logId": {
      "type": "string",
      "description": "The Connect log ID for the entry."
    },
    "logUri": {
      "type": "string",
      "description": "The URI for the Connect log entry."
    },
    "status": {
      "type": "string",
      "description": "The envelope status for the Connect post. Possible values are:\n- `Any`\n- `Voided`\n- `Created`\n- `Deleted`\n- `Sent`\n- `Delivered`\n- `Signed`\n- `Completed`\n- `Declined`\n- `TimedOut`\n- `Template`\n- `Processing`\n\nFor details about these statuses, see [Envelope Status Code Descriptions](https://raw.githubusercontent.com)."
    },
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the Connect post was created."
    },
    "lastTry": {
      "type": "string",
      "description": "The UTC DateTime of the last attempt to post."
    },
    "subject": {
      "type": "string",
      "description": "The subject of the envelope."
    },
    "retryUri": {
      "type": "string",
      "description": "A URI that you can use to retry to publish the Connect post."
    },
    "userName": {
      "type": "string",
      "description": "The name of the sender of the envelope."
    },
    "accountId": {
      "type": "string",
      "description": "The account ID associated with the envelope."
    },
    "configUrl": {
      "type": "string",
      "description": "The web address of the listener or retrieving service endpoint for Connect."
    },
    "connectId": {
      "type": "string",
      "description": "The ID of the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post."
    },
    "failureId": {
      "type": "string",
      "description": "The failure log ID for the failure."
    },
    "envelopeId": {
      "type": "string",
      "description": "The ID of the envelope that failed to post."
    },
    "failureUri": {
      "type": "string",
      "description": "The URI for the Connect post failure."
    },
    "retryCount": {
      "type": "string",
      "description": "The number of times the Connect post has been retried."
    },
    "connectDebugLog": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectDebugLog"
      },
      "description": "A complex element containing information about the Connect configuration, error details, date/time, description and payload.\nThis information is included in the response only when the `additional_info` query is set to **true.**\nThis additional information is only available when retrieving general logs with [ConnectEvents:get](https://raw.githubusercontent.com), but not when retrieving failure logs with [ConnectEvents:listFailures](https://raw.githubusercontent.com)."
    }
  },
  "description": "Contains information about a Connect log entry.",
  "x-ms-summary": "Contains information about a Connect log entry.",
  "x-ds-definition-name": "connectLog"
}

{
  "type": "object",
  "properties": {
    "logs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectLog"
      },
      "description": "A list of Connect general logs."
    },
    "type": {
      "type": "string",
      "description": "The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`\n"
    },
    "failures": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectLog"
      },
      "description": "An array of containing failure information from the Connect failure log."
    },
    "totalRecords": {
      "type": "string",
      "description": "The count of records in the log list."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "connectLogs"
}

{
  "type": "object",
  "properties": {
    "scope": {
      "type": "string",
      "description": "The scopes that your app will request from the authorization server.\n\nThis property is optional.\n\n**Note:** If you are using Azure, this value is the application ID URI of the secified resource affixed with the `.default`. For example: `api://{{clientId}}/.default`"
    },
    "clientId": {
      "type": "string",
      "description": "The client ID assigned to your app by your authorization server or OAuth service.\n\nThis property is required."
    },
    "clientSecret": {
      "type": "string",
      "description": "The secret value provided by your authorization server.\n\nThis property is required."
    },
    "customParameters": {
      "type": "string",
      "description": "",
      "additionalProperties": {
        "type": "string"
      }
    },
    "authorizationServerUrl": {
      "type": "string",
      "description": "The token URL for your authorization server or OAuth service.\n\nThis property is required."
    }
  },
  "description": "A complex object describing a Connect OAuth configuration.",
  "x-ms-summary": "A complex object describing a Connect OAuth configuration.",
  "x-ds-definition-name": "connectOAuthConfig"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique ID for the Salesforce object."
    },
    "dsLink": {
      "type": "string",
      "description": "A URL that links to the information in the DocuSign field."
    },
    "dsNode": {
      "type": "string",
      "description": ""
    },
    "sfField": {
      "type": "string",
      "description": ""
    },
    "sfFolder": {
      "type": "string",
      "description": "The name of the Salesforce folder."
    },
    "dsAttribute": {
      "type": "string",
      "description": ""
    },
    "sfFieldName": {
      "type": "string",
      "description": "The name of the Salesforce field."
    },
    "sfLockedValue": {
      "type": "string",
      "description": ""
    }
  },
  "description": "This object is used to match a DocuSign field to a Salesforce field so that DocuSign can send information to your Salesforce account.",
  "x-ms-summary": "This object is used to match a DocuSign field to a Salesforce field so that DocuSign can send information to your Salesforce account.",
  "x-ds-definition-name": "connectSalesforceField"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the `connectSalesforceObject`."
    },
    "active": {
      "type": "string",
      "description": "When **true,** the `connectSalesforceObject` is active."
    },
    "insert": {
      "type": "string",
      "description": ""
    },
    "sfObject": {
      "type": "string",
      "description": "The Salesforce.com object type, such as `case`, `contact`, or `opportunity`."
    },
    "description": {
      "type": "string",
      "description": "A description of the `connectSalesforceObject`."
    },
    "selectFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectSalesforceField"
      },
      "description": "The DocuSign and Salesforce fields that you want to use to match a Salesforce object with DocuSign information. This information tells Connect when to send updates to Salesforce."
    },
    "sfObjectName": {
      "type": "string",
      "description": "A name for the Salesforce object.\n\n**Note:** You can enter any name for the object. It does not have to match the `sfObject` property."
    },
    "updateFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectSalesforceField"
      },
      "description": "The DocuSign and Salesforce fields that you want to update. \n\n**Note:** You can choose to update SalesForce (with information from DocuSign) only, update DocuSign only, or both."
    },
    "onCompleteOnly": {
      "type": "string",
      "description": "When **true,** Salesforce is updated only when the envelope is complete."
    }
  },
  "description": "A `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account.\n\nWhen you install DocuSign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize DocuSign Connect for Salesforce by associating DocuSign objects with Salesforce objects so that DocuSign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see \n[DocuSign for Salesforce - Adding Completed Documents to the Notes and Attachments](https://support.docusign.com/s/articles/DocuSign-for-Salesforce-Adding-Completed-Documents-to-the-Notes-and-Attachments-New).",
  "x-ms-summary": "A `connectSalesforceObject` is an object that updates envelope and document status or recipient status in your Salesforce account.\n\nWhen you install DocuSign Connect for Salesforce, the service automatically sets up two Connect objects: one that updates envelope status and documents and one that updates recipient status. You can also customize DocuSign Connect for Salesforce by associating DocuSign objects with Salesforce objects so that DocuSign Connect for Salesforce updates or inserts the information into the Salesforce object. For more information, see \n[DocuSign for Salesforce - Adding Completed Documents to the Notes and Attachments](https://support.docusign.com/s/articles/DocuSign-for-Salesforce-Adding-Completed-Documents-to-the-Notes-and-Attachments-New).",
  "x-ds-definition-name": "connectSalesforceObject"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": ""
    },
    "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."
    },
    "userName": {
      "type": "string",
      "description": "The name of the user."
    },
    "isIncluded": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "connectUserInfo"
}

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "string",
      "description": "Boolean value that indicates whether the custom Connect configuration is enabled or not."
    },
    "connectId": {
      "type": "string",
      "description": "The ID of the custom Connect configuration being accessed."
    },
    "hasAccess": {
      "type": "string",
      "description": ""
    },
    "configurationtype": {
      "type": "string",
      "description": "The type of custom Connect configuration being accessed."
    },
    "senderSearchableItems": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "connectUserObject"
}

{
  "type": "object",
  "properties": {
    "consentKey": {
      "type": "string",
      "description": ""
    },
    "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/"
    },
    "signerConsentStatus": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "consentDetails"
}

{
  "type": "object",
  "properties": {
    "returnUrl": {
      "type": "string",
      "description": "The URL to which the user should be redirected. This is only used when the `envelopeId` is specified as a draft envelope. In this case, the endpoint returns a URL for the sender view. When the user exits the sender view, they will be redirected to the `returnUrl` value. If no value is provided, there is no option to leave the sender view.\n\nIn other cases, the user is not redirected out of the console view."
    },
    "envelopeId": {
      "type": "string",
      "description": "The ID of an envelope. If the envelope has been sent, the endpoint returns a URL for a view of the documents. If the envelope has not yet been sent, the endpoint returns a URL for the sender view.\n\nThis property is optional. If no value is provided, the endpoint returns a URL for the front page of the demo UI."
    }
  },
  "description": "The request object for the [EnvelopeViews: createConsole](https://raw.githubusercontent.com) method.",
  "x-ms-summary": "The request object for the [EnvelopeViews: createConsole](https://raw.githubusercontent.com) method.",
  "x-ds-definition-name": "consoleViewRequest"
}

{
  "type": "object",
  "properties": {
    "pdfId": {
      "type": "string",
      "description": "**Deprecated.** \n\nThe `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. "
    },
    "custom": {
      "type": "string",
      "description": "When **true,** indicates that the consumer disclosure is a custom disclosure. The default is **false.**"
    },
    "useBrand": {
      "type": "string",
      "description": "When **true,** specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience.  \n\nWhen **false** (default), or if the signing brand does not specify a company name, the account name is used instead.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. "
    },
    "esignText": {
      "type": "string",
      "description": "The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting.\n\n**Note:** If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting."
    },
    "changeEmail": {
      "type": "string",
      "description": "If the customer needs to change their email address, this is the email address to which they should the change request.\n\nMaximum length: 100 characters."
    },
    "companyName": {
      "type": "string",
      "description": "Specifies the company name used in the disclosure. The default value is the account name.\n\nHowever, if your account uses signing brands that specify a company name, you can substitute the brand's company name by setting the `useBrand` property to **true.** Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience.\n\n**Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true.**"
    },
    "enableEsign": {
      "type": "string",
      "description": "When **true** (default), indicates that eSign is enabled."
    },
    "companyPhone": {
      "type": "string",
      "description": "The phone number of the company associated with the consumer disclosure, as a free-formatted string."
    },
    "languageCode": {
      "type": "string",
      "description": "The code for the language version of the disclosure. The following languages are supported:\n\n- Arabic (`ar`)\n- Bulgarian (`bg`)\n- Czech (`cs`)\n- Chinese Simplified (`zh_CN`)\n- Chinese Traditional (`zh_TW`)\n- Croatian (`hr`)\n- Danish (`da`)\n- Dutch (`nl`)\n- English US (`en`)\n- English UK (`en_GB`)\n- Estonian (`et`)\n- Farsi (`fa`)\n- Finnish (`fi`)\n- French (`fr`)\n- French Canadian (`fr_CA`)\n- German (`de`)\n- Greek (`el`)\n- Hebrew (`he`)\n- Hindi (`hi`)\n- Hungarian (`hu`)\n- Bahasa Indonesian (`id`)\n- Italian (`it`)\n- Japanese (`ja`)\n- Korean (`ko`)\n- Latvian (`lv`)\n- Lithuanian (`lt`)\n- Bahasa Melayu (`ms`)\n- Norwegian (`no`)\n- Polish (`pl`)\n- Portuguese (`pt`)\n- Portuguese Brazil (`pt_BR`)\n- Romanian (`ro`)\n- Russian (`ru`)\n- Serbian (`sr`)\n- Slovak (`sk`)\n- Slovenian (`sl`)\n- Spanish (`es`)\n- Spanish Latin America (`es_MX`)\n- Swedish (`sv`)\n- Thai (`th`)\n- Turkish (`tr`)\n- Ukrainian (`uk`) \n- Vietnamese (`vi`)\n\nAdditionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`."
    },
    "withdrawCity": {
      "type": "string",
      "description": "Contains the city of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 50 characters. "
    },
    "withdrawEmail": {
      "type": "string",
      "description": "Contains the email address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawOther": {
      "type": "string",
      "description": "Contains any other information needed to withdraw consent.\n\nMaximum length: 255 characters.\n\nExample:\n\n`We do not need any other information from you to withdraw consent.`"
    },
    "withdrawPhone": {
      "type": "string",
      "description": "Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string.\n\nMaximum length: 20 characters. "
    },
    "withdrawState": {
      "type": "string",
      "description": "Contains the state of the postal address to which a customer can send a consent withdrawal notification.\n\nExample: `PA`"
    },
    "accountEsignId": {
      "type": "string",
      "description": "The GUID of the account associated with the consumer disclosure."
    },
    "esignAgreement": {
      "type": "string",
      "description": "The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting."
    },
    "withdrawByMail": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw consent by postal mail. The default is **false.**"
    },
    "allowCDWithdraw": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false.**\n**Note:** Only Admin users can change this setting."
    },
    "copyCostPerPage": {
      "type": "string",
      "description": "The cost per page if the customer requests paper copies.\n\nExample: \n\n`0.0000`"
    },
    "withdrawByEmail": {
      "type": "string",
      "description": "When **true** (default), indicates that the customer can withdraw consent by email."
    },
    "withdrawByPhone": {
      "type": "string",
      "description": "When **true,** indicates that the customer can withdraw consent by phone. The default is **false.**"
    },
    "changeEmailOther": {
      "type": "string",
      "description": "Other information about the requirements for the user to change their email address.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We do not require any other information from you to change your email address.`"
    },
    "copyRequestEmail": {
      "type": "string",
      "description": "The email address to which the customer should send a request for copies of a document.\n\nMaximum length: 100 characters."
    },
    "mustAgreeToEsign": {
      "type": "string",
      "description": "When **true,** the  recipient must agree to the consumer disclosure. The value of this property is read-only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions."
    },
    "withdrawPostalCode": {
      "type": "string",
      "description": "Contains the postal code of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 20 characters. "
    },
    "withdrawAddressLine1": {
      "type": "string",
      "description": "Contains the first address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawAddressLine2": {
      "type": "string",
      "description": "Contains the second address line of the postal address to which a customer can send a consent withdrawal notification.\n\nMaximum length: 100 characters. "
    },
    "withdrawConsequences": {
      "type": "string",
      "description": "Text indicating the consequences of withdrawing consent.\n\nMaximum length: 255 characters."
    },
    "allowCDWithdrawMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "copyFeeCollectionMethod": {
      "type": "string",
      "description": "Specifies the fee collection method for cases in which the customer requires paper copies of the document.\n\nMaximum length: 255 characters.\n\nExample: \n\n`We will bill you for any fees at that time, if any.`"
    },
    "useConsumerDisclosureWithinAccount": {
      "type": "string",
      "description": "When **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement."
    },
    "useConsumerDisclosureWithinAccountMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "description": "Details about consumer disclosures.",
  "x-ms-summary": "Details about consumer disclosures.",
  "x-ds-definition-name": "consumerDisclosure"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the contact."
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of email addresses."
    },
    "shared": {
      "type": "string",
      "description": "When **true,** this contact is shared."
    },
    "isOwner": {
      "type": "boolean",
      "description": ""
    },
    "contactId": {
      "type": "string",
      "description": "The ID of a contact person in the account's address book."
    },
    "contactUri": {
      "type": "string",
      "description": "The URI for retrieving information about the contact."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "organization": {
      "type": "string",
      "description": ""
    },
    "signingGroup": {
      "type": "string",
      "description": "The ID of the signing group."
    },
    "cloudProvider": {
      "type": "string",
      "description": "The cloud service that provided the contact. Valid values are:\n\n- `rooms`\n- `docusignCore` (default)\n\n<!-- Future:\n\n- `Box`\n- `GoogleDrive`\n- `Dropbox`\n- `SalesForce`\n- `SkyDrive`\n\n-->"
    },
    "roomContactType": {
      "type": "string",
      "description": ""
    },
    "signingGroupName": {
      "type": "string",
      "description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. "
    },
    "contactPhoneNumbers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contactPhoneNumber"
      },
      "description": "A list of the contact's phone numbers.\n\n**Note:** The phone numbers associated with shared contacts do not display to users other than the user who added the contact. Additionally, in the following scenarios, the phone number of a shared contact does not populate automatically for anyone other than the user who added the contact:\n\n- Sending an envelope by using SMS\n- Using phone authentication\n\nYou must ask the user who added the contact for the phone number and then manually enter it into the authentication box."
    },
    "notaryContactDetails": {
      "$ref": "#/components/schemas/notaryContactDetails"
    },
    "cloudProviderContainerId": {
      "type": "string",
      "description": "The ID of the container at the cloud provider. For example, this might be the room ID for a DocuSign Transaction Room."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "contact"
}

{
  "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. "
    },
    "contacts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contact"
      },
      "description": "A list of contacts."
    },
    "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": "This response object contains information about the contacts associated with an account.",
  "x-ms-summary": "This response object contains information about the contacts associated with an account.",
  "x-ds-definition-name": "contactGetResponse"
}

{
  "type": "object",
  "properties": {
    "contactList": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contact"
      },
      "description": "A list of contacts."
    }
  },
  "description": "The request object containing the new information for the contacts.",
  "x-ms-summary": "The request object containing the new information for the contacts.",
  "x-ds-definition-name": "contactModRequest"
}

{
  "type": "object",
  "properties": {
    "phoneType": {
      "type": "string",
      "description": "The type of phone number. Valid values are:\n\n- `home`\n- `mobile`\n- `work`\n- `other`\n- `fax`"
    },
    "phoneNumber": {
      "type": "string",
      "description": "The contact's phone number.\n\nExample: `+12223334444`"
    }
  },
  "description": "Details about the phone numbers associated with a specific contact.",
  "x-ms-summary": "Details about the phone numbers associated with a specific contact.",
  "x-ds-definition-name": "contactPhoneNumber"
}

{
  "type": "object",
  "properties": {
    "contacts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/contact"
      },
      "description": "A list of contacts."
    }
  },
  "description": "This response objects shows the updated details for the contacts.",
  "x-ms-summary": "This response objects shows the updated details for the contacts.",
  "x-ds-definition-name": "contactUpdateResponse"
}

{
  "type": "object",
  "properties": {
    "viewUrl": {
      "type": "string",
      "description": ""
    },
    "returnUrl": {
      "type": "string",
      "description": "(Required) The URL to which the user should be redirected after\nthe view session has ended.\n\nMaximum Length: 470 characters. If the `returnUrl` exceeds this\nlimit, the user is redirected to a truncated URL\nBe sure to include `https://` in the URL\nor redirecting might fail on some browsers.\n\nWhen DocuSign redirects to\nthis URL, it will include an `event` query parameter that your app can use:\n\n* `send`: User corrected and sent the envelope.\n* `save`: User saved the envelope.\n* `cancel`: User canceled the transaction.\n* `error`: There was an error when performing the correct or send.\n* `sessionEnd`: The session ended before the user completed a different action.\n"
    },
    "beginOnTagger": {
      "type": "string",
      "description": ""
    },
    "suppressNavigation": {
      "type": "string",
      "description": "Specifies whether the window is displayed with or without dressing."
    }
  },
  "description": "The request body for the [EnvelopeViews: createCorrect](https://raw.githubusercontent.com) method.",
  "x-ms-summary": "The request body for the [EnvelopeViews: createCorrect](https://raw.githubusercontent.com) method.",
  "x-ds-definition-name": "correctViewRequest"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": ""
    },
    "isoCode": {
      "type": "string",
      "description": ""
    },
    "provinces": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/province"
      },
      "description": ""
    },
    "provinceValidated": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "country"
}

{
  "type": "object",
  "properties": {
    "address": {
      "$ref": "#/components/schemas/addressInformation"
    },
    "cardType": {
      "type": "string",
      "description": "The type of credit card. Valid values are: \n\n- `visa` \n- `mastercard` \n- `amex`"
    },
    "cvNumber": {
      "type": "string",
      "description": "The 3 or 4-digit card verification value (CVV) number associated with the credit card. CVV numbers are also referred to as card security codes (CSCs)."
    },
    "cardNumber": {
      "type": "string",
      "description": "The credit card number."
    },
    "nameOnCard": {
      "type": "string",
      "description": "The exact name as it appears on the credit card."
    },
    "tokenizedCard": {
      "type": "string",
      "description": ""
    },
    "cardLastDigits": {
      "type": "string",
      "description": ""
    },
    "expirationYear": {
      "type": "string",
      "description": "The year in which the credit card expires, in 4-digit format."
    },
    "expirationMonth": {
      "type": "string",
      "description": "The month that the credit card expires, expressed as a number from 1 to 12."
    }
  },
  "description": "This object contains information about a credit card that is associated with an account.",
  "x-ms-summary": "This object contains information about a credit card that is associated with an account.",
  "x-ds-definition-name": "creditCardInformation"
}

{
  "type": "object",
  "properties": {
    "cardTypes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array containing supported credit card types."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "creditCardTypes"
}

{
  "type": "object",
  "properties": {
    "seatFee": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "fixedFee": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "envelopeFee": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "currencyCode": {
      "type": "string",
      "description": "Specifies the alternate ISO currency code for the account. "
    },
    "currencySymbol": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Information about the price and currency associated with the feature set. Reserved for internal DocuSign use only.",
  "x-ms-summary": "Information about the price and currency associated with the feature set. Reserved for internal DocuSign use only.",
  "x-ds-definition-name": "currencyFeatureSetPrice"
}

{
  "type": "object",
  "properties": {
    "currencyCode": {
      "type": "string",
      "description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account."
    },
    "perSeatPrice": {
      "type": "string",
      "description": "The per-seat price associated with the plan.\n\nExample: `\"456.0000\"`"
    },
    "currencySymbol": {
      "type": "string",
      "description": "Specifies the currency symbol.\nValid values:\n\n- `AED` <br>  \"د.إ\"\n- `AFN` <br>  \"؋\"\n- `ALL` <br>  \"L\"\n- `AMD` <br>  \"֏\"\n- `ANG` <br>  \"ƒ\"\n- `AOA` <br>  \"Kz\"\n- `ARS` <br>  \"$\"\n- `AUD` <br>  \"$\"\n- `AWG` <br>  \"ƒ\"\n- `AZN` <br>  \"₼\"\n- `BAM` <br>  \"KM\"\n- `BBD` <br>  \"$\"\n- `BDT` <br>  \"৳\"\n- `BGN` <br>  \"лв\"\n- `BHD` <br>  \".د.ب\"\n- `BIF` <br>  \"FBu\"\n- `BMD` <br>  \"$\"\n- `BND` <br>  \"$\"\n- `BOB` <br>  \"$b\"\n- `BOV` <br>  \"BOV\"\n- `BRL` <br>  \"R$\"\n- `BSD` <br>  \"$\"\n- `BTN` <br>  \"Nu.\"\n- `BWP` <br>  \"P\"\n- `BYN` <br>  \"Br\"\n- `BYR` <br>  \"Br\"\n- `BZD` <br>  \"BZ$\"\n- `CAD` <br>  \"$\"\n- `CDF` <br>  \"FC\"\n- `CHE` <br>  \"CHE\"\n- `CHF` <br>  \"CHF\"\n- `CHW` <br>  \"CHW\"\n- `CLF` <br>  \"CLF\"\n- `CLP` <br>  \"$\"\n- `CNY` <br>  \"¥\"\n- `COP` <br>  \"$\"\n- `COU` <br>  \"COU\"\n- `CRC` <br>  \"₡\"\n- `CUC` <br>  \"$\"\n- `CUP` <br>  \"₱\"\n- `CVE` <br>  \"$\"\n- `CZK` <br>  \"Kč\"\n- `DJF` <br>  \"Fdj\"\n- `DKK` <br>  \"kr\"\n- `DOP` <br>  \"RD$\"\n- `DZD` <br>  \"دج\"\n- `EGP` <br>  \"£\"\n- `ERN` <br>  \"Nfk\"\n- `ETB` <br>  \"Br\"\n- `EUR` <br>  \"€\"\n- `FJD` <br>  \"$\"\n- `FKP` <br>  \"£\"\n- `GBP` <br>  \"£\"\n- `GEL` <br>  \"₾\"\n- `GHS` <br>  \"GH₵\"\n- `GIP` <br>  \"£\"\n- `GMD` <br>  \"D\"\n- `GNF` <br>  \"FG\"\n- `GTQ` <br>  \"Q\"\n- `GYD` <br>  \"$\"\n- `HKD` <br>  \"$\"\n- `HNL` <br>  \"L\"\n- `HRK` <br>  \"kn\"\n- `HTG` <br>  \"G\"\n- `HUF` <br>  \"Ft\"\n- `IDR` <br>  \"Rp\"\n- `ILS` <br>  \"₪\"\n- `INR` <br>  \"₹\"\n- `IQD` <br>  \"ع.د\"\n- `IRR` <br>  \"﷼\"\n- `ISK` <br>  \"kr\"\n- `JMD` <br>  \"J$\"\n- `JOD` <br>  \"JD\"\n- `JPY` <br>  \"¥\"\n- `KES` <br>  \"KSh\"\n- `KGS` <br>  \"лв\"\n- `KHR` <br>  \"៛\"\n- `KMF` <br>  \"CF\"\n- `KPW` <br>  \"₩\"\n- `KRW` <br>  \"₩\"\n- `KWD` <br>  \"KD\"\n- `KYD` <br>  \"$\"\n- `KZT` <br>  \"₸\"\n- `LAK` <br>  \"₭\"\n- `LBP` <br>  \"£\"\n- `LKR` <br>  \"₨\"\n- `LRD` <br>  \"$\"\n- `LSL` <br>  \"M\"\n- `LYD` <br>  \"LD\"\n- `MAD` <br>  \"MAD\"\n- `MDL` <br>  \"lei\"\n- `MGA` <br>  \"Ar\"\n- `MKD` <br>  \"ден\"\n- `MMK` <br>  \"K\"\n- `MNT` <br>  \"₮\"\n- `MOP` <br>  \"MOP$\"\n- `MRO` <br>  \"UM\"\n- `MUR` <br>  \"₨\"\n- `MVR` <br>  \"Rf\"\n- `MWK` <br>  \"MK\"\n- `MXN` <br>  \"$\"\n- `MXV` <br>  \"MXV\"\n- `MYR` <br>  \"RM\"\n- `MZN` <br>  \"MT\"\n- `NAD` <br>  \"$\"\n- `NGN` <br>  \"₦\"\n- `NIO` <br>  \"C$\"\n- `NOK` <br>  \"kr\"\n- `NPR` <br>  \"₨\"\n- `NZD` <br>  \"$\"\n- `OMR` <br>  \"﷼\"\n- `PAB` <br>  \"B/.\"\n- `PEN` <br>  \"S/.\"\n- `PGK` <br>  \"K\"\n- `PHP` <br>  \"₱\"\n- `PKR` <br>  \"₨\"\n- `PLN` <br>  \"zł\"\n- `PYG` <br>  \"Gs\"\n- `QAR` <br>  \"﷼\"\n- `RON` <br>  \"lei\"\n- `RSD` <br>  \"Дин.\"\n- `RUB` <br>  \"₽\"\n- `RWF` <br>  \"R₣\"\n- `SAR` <br>  \"﷼\"\n- `SBD` <br>  \"$\"\n- `SCR` <br>  \"₨\"\n- `SDG` <br>  \"ج.س.\"\n- `SEK` <br>  \"kr\"\n- `SGD` <br>  \"S$\"\n- `SHP` <br>  \"£\"\n- `SLL` <br>  \"Le\"\n- `SOS` <br>  \"S\"\n- `SRD` <br>  \"$\"\n- `SSP` <br>  \"£\"\n- `STD` <br>  \"Db\"\n- `SVC` <br>  \"$\"\n- `SYP` <br>  \"£\"\n- `SZL` <br>  \"E\"\n- `THB` <br>  \"฿\"\n- `TJS` <br>  \"SM\"\n- `TMT` <br>  \"T\"\n- `TND` <br>  \"د.ت\"\n- `TOP` <br>  \"T$\"\n- `TRY` <br>  \"₺\"\n- `TTD` <br>  \"TT$\"\n- `TWD` <br>  \"NT$\"\n- `TZS` <br>  \"TSh\"\n- `UAH` <br>  \"₴\"\n- `UGX` <br>  \"USh\"\n- `USD` <br>  \"$\"\n- `USN` <br>  \"$\"\n- `UYI` <br>  \"UYI\"\n- `UYU` <br>  \"$U\"\n- `UZS` <br>  \"лв\"\n- `VEF` <br>  \"Bs\"\n- `VND` <br>  \"₫\"\n- `VUV` <br>  \"VT\"\n- `WST` <br>  \"WS$\"\n- `XAF` <br>  \"FCFA\"\n- `XAG` <br>  \"XAG\"  Silver\n- `XAU` <br>  \"XAU\"  Gold\n- `XBA` <br>  \"XBA\"  Bond Markets Units European Composite Unit (EURCO)\n- `XBB` <br>  \"XBB\"  European Monetary Unit (E.M.U.-6)\n- `XBC` <br>  \"XBC\"  European Unit of Account 9(E.U.A.-9)\n- `XBD` <br>  \"XBD\"  European Unit of Account 17(E.U.A.-17)\n- `XCD` <br>  \"$\"\n- `XDR` <br>  \"XDR\" }` <br>  // Special Drawing Rights (SDRs)` <br>  units of account for IMF\n- `XOF` <br>  \"CFA\"\n- `XPD` <br>  \"XPD\"  Palladium\n- `XPF` <br>  \"₣\"\n- `XPT` <br>  \"XPT\"  Platinum\n- `XSU` <br>  \"Sucre\"\n- `XTS` <br>  \"XTS\" Reserved for testing purposes\n- `XUA` <br>  \"XUA\"\n- `XXX` <br>  \"XXX\" Denotes transaction involving no currency\n- `YER` <br>  \"﷼\"\n- `ZAR` <br>  \"R\"\n- `ZMW` <br>  \"ZK\"\n- `ZWL` <br>  \"$\"\n"
    },
    "supportPlanFee": {
      "type": "string",
      "description": "The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`"
    },
    "supportIncidentFee": {
      "type": "string",
      "description": "The support incident fee charged for each support incident.\n\nExample: `\"$0.00\"`"
    },
    "supportedCardTypes": {
      "$ref": "#/components/schemas/creditCardTypes"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "currencyPlanPrice"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the custom field."
    },
    "show": {
      "type": "string",
      "description": "When **true,** the custom field displays at the top of the Certificate of Completion."
    },
    "value": {
      "type": "string",
      "description": "Specifies the value of the custom field. \n\nMaximum Length: 2,000 characters."
    },
    "fieldId": {
      "type": "string",
      "description": "The ID of the custom field."
    },
    "required": {
      "type": "string",
      "description": "When **true,** the signer must complete the custom field."
    },
    "listItems": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "For a list custom field, this is an array of strings that represent the items in a list. \n\nMaximum Length: 2,000 characters."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "customFieldType": {
      "type": "string",
      "description": "The type of custom field. Valid values are:\n\n- `text` (default)\n- `list`"
    }
  },
  "description": "This object provides details about a custom field.",
  "x-ms-summary": "This object provides details about a custom field.",
  "x-ds-definition-name": "customField"
}

{
  "type": "object",
  "properties": {
    "listCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/listCustomField"
      },
      "description": "An array of list custom fields."
    },
    "textCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/textCustomField"
      },
      "description": "An array of text custom fields."
    }
  },
  "description": "Contains information about custom fields.",
  "x-ms-summary": "Contains information about custom fields.",
  "x-ds-definition-name": "customFields"
}

{
  "type": "object",
  "properties": {
    "listCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/listCustomField"
      },
      "description": "An array of list custom fields."
    },
    "textCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/textCustomField"
      },
      "description": "An array of text custom fields."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "customFieldsEnvelope"
}

{
  "type": "object",
  "properties": {
    "customSettings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "The name/value pair information for the user custom setting."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "customSettingsInformation"
}

{
  "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."
    },
    "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.\nFor 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."
    },
    "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 a date. Date tabs\nare one-line fields that allow date information to be\nentered in any format. The tooltip for this tab recommends\nentering the date as MM/DD/YYYY, but this is not enforced.\nThe format entered by the signer is retained. If you need a\nparticular date format enforced, DocuSign recommends using a\nText tab with a validation pattern and a validation message\nto enforce the format.\n",
  "x-ms-summary": "A tab that allows the recipient to enter a date. Date tabs\nare one-line fields that allow date information to be\nentered in any format. The tooltip for this tab recommends\nentering the date as MM/DD/YYYY, but this is not enforced.\nThe format entered by the signer is retained. If you need a\nparticular date format enforced, DocuSign recommends using a\nText tab with a validation pattern and a validation message\nto enforce the format.\n",
  "x-ds-definition-name": "date"
}

{
  "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."
    },
    "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": "**Note:** Date Signed tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient.\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"
    },
    "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\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.\nFor 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."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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": "A tab that displays the date that the recipient signed the\ndocument.\n",
  "x-ms-summary": "A tab that displays the date that the recipient signed the\ndocument.\n",
  "x-ds-definition-name": "dateSigned"
}

{
  "type": "object",
  "properties": {
    "dateAreaX": {
      "type": "string",
      "description": "The X axis position of the top-left corner."
    },
    "dateAreaY": {
      "type": "string",
      "description": "The Y axis position of the top-left corner."
    },
    "dateAreaWidth": {
      "type": "string",
      "description": "The width of the rectangle."
    },
    "dateAreaHeight": {
      "type": "string",
      "description": "The height of the rectangle."
    }
  },
  "description": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle.",
  "x-ms-summary": "Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area.\n\nThis property contains the following information about the central rectangle:\n\n- `DateAreaX`: The X axis position of the top-left corner.\n- `DateAreaY`: The Y axis position of the top-left corner.\n- `DateAreaWidth`: The width of the rectangle.\n- `DateAreaHeight`: The height of the rectangle.",
  "x-ds-definition-name": "dateStampProperties"
}

{
  "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": "**Note:** Decline tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient.\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"
    },
    "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\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"
    },
    "buttonText": {
      "type": "string",
      "description": " Specifies the decline text displayed in the tab."
    },
    "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.\nFor 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"
    },
    "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"
    },
    "declineReason": {
      "type": "string",
      "description": "The reason the recipient declined the document."
    },
    "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"
    },
    "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"
    },
    "declineReasonMetadata": {
      "$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": "A tab that allows the recipient the option of declining an\nenvelope. If the recipient clicks the tab during the signing\nprocess, the envelope is voided.\n",
  "x-ms-summary": "A tab that allows the recipient the option of declining an\nenvelope. If the recipient clicks the tab during the signing\nprocess, the envelope is voided.\n",
  "x-ds-definition-name": "decline"
}

{
  "type": "object",
  "properties": {
    "rules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeDelayRule"
      },
      "description": "User-specified rules indicating how and when the envelope should sent for the workflow step and its associated recipients. Only one rule may be specified."
    },
    "status": {
      "type": "string",
      "description": "Status of the delayed routing step. Valid values:\n\n* `pending`: The workflow step has not been reached and the delay has not been initiated.\n* `started`: The workflow step has begun and the delay is in progress. The envelope has not yet been sent to the workflow step's recipients.\n* `completed`: The delay has elapsed and the envelope has been sent to the workflow step's recipients.\n\nThis property is read-only."
    },
    "resumeDate": {
      "type": "string",
      "description": "The ISO 8601 timestamp of when the envelope is scheduled to be sent to the recipients associated with the workflow step. This property is `null` if the workflow step has not been initiated.\n\nThis property is read-only.\n"
    }
  },
  "description": "A complex element that specifies the delayed routing settings for the workflow step.",
  "x-ms-summary": "A complex element that specifies the delayed routing settings for the workflow step.",
  "x-ds-definition-name": "delayedRouting"
}

{
  "type": "object",
  "properties": {
    "Name": {
      "type": "string",
      "description": ""
    },
    "Email": {
      "type": "string",
      "description": ""
    },
    "UserId": {
      "type": "string",
      "description": ""
    },
    "UserAuthorizationId": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "delegationInfo"
}

{
  "type": "object",
  "properties": {
    "apiRequestLogging": {
      "type": "string",
      "description": " When **true,** enables API request logging for the user. "
    },
    "apiRequestLogMaxEntries": {
      "type": "string",
      "description": "Specifies the maximum number of API requests to log."
    },
    "apiRequestLogRemainingEntries": {
      "type": "string",
      "description": "Indicates the remaining number of API requests that can be logged."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "diagnosticsSettingsInformation"
}

{
  "type": "object",
  "properties": {
    "iBAN": {
      "type": "string",
      "description": "The International Bank Account Number (IBAN). \n\nExample: `DE89370400440532013000`\n\nFor more information, see [PeopleSoft's guide to Setting Up Banks](https://docs.oracle.com/cd/E16365_01/fscm91pbr0/eng/psbooks/fsbk/chapter.htm?File=fsbk/htm/fsbk03.htm).\n\n**Note:** This number will be obfuscated."
    },
    "email": {
      "type": "string",
      "description": "The email address of the user who is associated with the payment method. This field is required for POST and PUT requests.\n\nMaximum Length: 80 characters."
    },
    "country": {
      "type": "string",
      "description": "The user's country. The system populates this value automatically.\n\n"
    },
    "bankCode": {
      "type": "string",
      "description": "The code or number that identifies the bank. This is also known as the sort code.\n\nExample: `200000`\n\nMaximum Length: 18 characters."
    },
    "bankName": {
      "type": "string",
      "description": "The name of the direct debit bank.\n\nMaximum Length: 80 characters."
    },
    "lastName": {
      "type": "string",
      "description": "The user's last name. This field is required for POST and PUT requests.\n\nMaximum Length: 70 characters."
    },
    "firstName": {
      "type": "string",
      "description": "The user's first name. This field is required for POST and PUT requests.\n\nMaximum Length: 30 characters."
    },
    "bankBranchCode": {
      "type": "string",
      "description": "The branch code of the bank used for direct debit.\n\nMaximum Length: 10 characters."
    },
    "bankCheckDigit": {
      "type": "string",
      "description": "The check digit or digits in the international bank account number. These digits are used to confirm the validity of the account.\n\nMaximum Length: 4 characters."
    },
    "bankTransferType": {
      "type": "string",
      "description": "Specifies the type of direct debit transfer. The value of this field is dependent on the user's country. This field is required for POST and PUT requests. Possible values are:\n\n- `DirectDebitUK`\n- `DirectEntryAU`\n- `SEPA`"
    },
    "bankTransferAccountName": {
      "type": "string",
      "description": "The name on the direct debit bank account. This field is required for POST and PUT requests.\n\nMaximum Length: 60 characters."
    },
    "bankTransferAccountNumber": {
      "type": "string",
      "description": "The customer's bank account number. This value will be obfuscated. This field is required for POST and PUT requests.\n\nMaximum Length: 30 characters."
    }
  },
  "description": "Contains information about a bank that processes a customer's direct debit payments.",
  "x-ms-summary": "Contains information about a bank that processes a customer's direct debit payments.",
  "x-ds-definition-name": "directDebitProcessorInformation"
}

{
  "type": "object",
  "properties": {
    "dateOfBirth": {
      "type": "string",
      "description": "Specifies the recipient's date, month, and year of birth."
    },
    "displayLevelCode": {
      "type": "string",
      "description": "Specifies the display level for the recipient. Valid values are:\n* `ReadOnly`\n* `Editable`\n* `DoNotDisplay`"
    },
    "receiveInResponse": {
      "type": "string",
      "description": "A Boolean value that specifies whether the information must be returned in the response."
    }
  },
  "description": "Complex type containing:\n\n* dateOfBirth\n* displayLevelCode\n* receiveInResponse",
  "x-ms-summary": "Complex type containing:\n\n* dateOfBirth\n* displayLevelCode\n* receiveInResponse",
  "x-ds-definition-name": "dobInformationInput"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the form field. The name must be unique to the document.\n\nRequired for PUT requests."
    },
    "type": {
      "type": "string",
      "description": "Always `TextBox`.  You do not need to provide this value."
    },
    "label": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "value": {
      "type": "string",
      "description": "The value of the form field.\n\nRequired for PUT requests."
    },
    "options": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/docGenFormFieldOption"
      },
      "description": "An array of option strings supported by this setting."
    },
    "required": {
      "type": "string",
      "description": "When **true,** the field is required. This value comes from the the document."
    },
    "validation": {
      "$ref": "#/components/schemas/docGenFormFieldValidation"
    },
    "description": {
      "type": "string",
      "description": "A sender-defined description of the line item.\n"
    },
    "predefinedValidation": {
      "type": "string",
      "description": ""
    }
  },
  "description": "The document fields available for document generation.\n\nThis object is used in reponses (GET) and requests (PUT).\nWhen used with [DocumentGeneration: updateEnvelopeDocGenFormFields](https://raw.githubusercontent.com)\n(PUT) the `name` and `value` properties are required,\nand any other values are ignored.",
  "x-ms-summary": "The document fields available for document generation.\n\nThis object is used in reponses (GET) and requests (PUT).\nWhen used with [DocumentGeneration: updateEnvelopeDocGenFormFields](https://raw.githubusercontent.com)\n(PUT) the `name` and `value` properties are required,\nand any other values are ignored.",
  "x-ds-definition-name": "docGenFormField"
}

{
  "type": "object",
  "properties": {
    "label": {
      "type": "string",
      "description": ""
    },
    "value": {
      "type": "string",
      "description": "Specifies the value of the tab. "
    },
    "selected": {
      "type": "string",
      "description": "When **true,** the radio button is selected."
    },
    "description": {
      "type": "string",
      "description": "A sender-defined description of the line item.\n"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "docGenFormFieldOption"
}

{
  "type": "object",
  "properties": {
    "docGenFormFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/docGenFormFields"
      },
      "description": "A list of `docGenFormFields` objects."
    }
  },
  "description": "This object maps the document generation fields to their values.",
  "x-ms-summary": "This object maps the document generation fields to their values.",
  "x-ds-definition-name": "docGenFormFieldRequest"
}

{
  "type": "object",
  "properties": {
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "docGenFormFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/docGenFormFields"
      },
      "description": "A list of `docGenFormFields` objects."
    }
  },
  "description": "An object for document generation responses.",
  "x-ms-summary": "An object for document generation responses.",
  "x-ds-definition-name": "docGenFormFieldResponse"
}

{
  "type": "object",
  "properties": {
    "expression": {
      "type": "string",
      "description": ""
    },
    "errorMessage": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "docGenFormFieldValidation"
}

{
  "type": "object",
  "properties": {
    "documentId": {
      "type": "string",
      "description": "The GUID of the document."
    },
    "docGenErrors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/docGenSyntaxError"
      },
      "description": "A list of `docGenSyntaxError` objects."
    },
    "docGenFormFieldList": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/docGenFormField"
      },
      "description": "A list of `docGenFormField` objects."
    },
    "docGenDocumentStatus": {
      "type": "string",
      "description": "The status of the document. This is a read-only property.\nValid values:\n\n- `mergesuceeded`\n- `created`\n- `hassyntaxerror`\n"
    }
  },
  "description": "A collection of document generation fields.",
  "x-ms-summary": "A collection of document generation fields.",
  "x-ds-definition-name": "docGenFormFields"
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "The error message."
    },
    "errorCode": {
      "type": "string",
      "description": "A code associated with the error condition."
    },
    "tagIdentifier": {
      "type": "string",
      "description": "The tag that caused the syntax error.\nSee [Document Generation Syntax](https://support.docusign.com/s/document-item?bundleId=als1679428547895&topicId=ftc1679700030026.html)\nto learn more about document generation syntax rules."
    }
  },
  "description": "Describes document generation errors.",
  "x-ms-summary": "Describes document generation errors.",
  "x-ds-definition-name": "docGenSyntaxError"
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "A URI containing the user ID."
    },
    "name": {
      "type": "string",
      "description": "The name of the document."
    },
    "tabs": {
      "$ref": "#/components/schemas/EnvelopeRecipientTabs"
    },
    "order": {
      "type": "string",
      "description": "The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. "
    },
    "pages": {
      "type": "string",
      "description": "The number of pages in the document. This property is read-only."
    },
    "display": {
      "type": "string",
      "description": "This string sets the display and behavior properties of\nthe document during signing. Valid values:\n\n* `modal`<br>\n  The document is shown as a supplement action strip\n  and can be viewed, downloaded, or printed in a modal window.\n  This is the recommended value for supplemental documents. \n\n* `inline`<br>\n  The document is shown in the normal signing window.\n  This value is not used with supplemental documents,\n  but is the default value for all other documents.\n"
    },
    "password": {
      "type": "string",
      "description": "The user's encrypted password hash."
    },
    "remoteUrl": {
      "type": "string",
      "description": "The file ID from the cloud storage service where\nthe document is located. This information is\nreturned using\n[CloudStorage: listFolders](https://raw.githubusercontent.com) or\n[CloudStorage: list](https://raw.githubusercontent.com).\n"
    },
    "documentId": {
      "type": "string",
      "description": "Specifies the document ID of this document. This value is used by tabs to determine which document they appear in."
    },
    "matchBoxes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/matchBox"
      },
      "description": "Matchboxes define areas in a document for document matching when you are creating envelopes.\nThey are only used when you upload and edit a template.\n\n"
    },
    "fileExtension": {
      "type": "string",
      "description": "The file extension type of the document. Non-PDF documents are converted to PDF.\n\nIf the document is not a PDF, `fileExtension` is required.\n\nIf you try to upload a non-PDF document without a `fileExtension`, you will receive an \"unable to load document\" error message.  \n "
    },
    "documentBase64": {
      "type": "string",
      "description": "The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding."
    },
    "documentFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements: \n\n* `name`: A string that can be a maximum of 50 characters. \n* `value`: A string that can be a maximum of 200 characters.\n\nIf you are using XML, the name/value pair is contained in a `nameValue` element. \n"
    },
    "fileFormatHint": {
      "type": "string",
      "description": ""
    },
    "htmlDefinition": {
      "$ref": "#/components/schemas/documentHtmlDefinition"
    },
    "templateLocked": {
      "type": "string",
      "description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
    },
    "applyAnchorTabs": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "docGenFormFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/docGenFormField"
      },
      "description": ""
    },
    "isDocGenDocument": {
      "type": "string",
      "description": ""
    },
    "templateRequired": {
      "type": "string",
      "description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
    },
    "authoritativeCopy": {
      "type": "boolean",
      "description": "When **true,** this document is considered an authoritative copy.\n\nIf this property is not set, it gets its value from the envelope's `authoritativeCopyDefault` property if it's set, or the envelope's `authoritativeCopy` property.\n\nWhen **false,** this document is not an authoritative copy regardless of the envelope's `authoritativeCopyDefault` or `authoritativeCopy` property."
    },
    "includeInDownload": {
      "type": "string",
      "description": "When **true,**\nthe document is included in the combined document download (`documentsCombinedUri`). \nThe default value is **true.**\n"
    },
    "pdfFormFieldOption": {
      "type": "string",
      "description": ""
    },
    "transformPdfFields": {
      "type": "string",
      "description": "When **true,** PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF.\n"
    },
    "signerMustAcknowledge": {
      "type": "string",
      "description": "Sets how the signer interacts with the supplemental document.\nValid values:\n\n* `no_interaction`<br>\n  No recipient action is required.\n\n* `view`<br>\n  The recipient is required to view the document.\n\n* `accept`<br>\n  The recipient is required to accept the document by selecting accept during signing, but is not required to view the document.\n\n* `view_accept`<br>\n  The recipient is required to view and accept the document.\n\n"
    },
    "assignTabsToRecipientId": {
      "type": "string",
      "description": ""
    },
    "encryptedWithKeyManager": {
      "type": "string",
      "description": "When **true,** the document has been encrypted by the sender for use with the DocuSign Key Manager Security Appliance.\n "
    },
    "signerMustAcknowledgeUseAccountDefault": {
      "type": "boolean",
      "description": "When **true,** the account default setting for the required recipient option is used. If this property is set, `signerMustAcknowledge` cannot be set (and vice versa)."
    }
  },
  "description": "A document object.",
  "x-ms-summary": "A document object.",
  "x-ds-definition-name": "document"
}

{
  "type": "object",
  "properties": {
    "documentFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "The array of name/value custom data strings to be added to a document. Custom document field information is returned in the status, but otherwise is not used by DocuSign. The array contains the elements: \n\n* `name`: A string that can be a maximum of 50 characters. \n* `value`: A string that can be a maximum of 200 characters.\n\nIf you are using XML, the name/value pair is contained in a `nameValue` element. \n"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "documentFieldsInformation"
}

{
  "type": "object",
  "properties": {
    "arrowOpen": {
      "type": "string",
      "description": "Indicates the direction of the disclosure arrow\nwhen the collapsible section is in the open state.\n\nOne of the following:\n\n- `up`: In the open state, the disclosure arrow points up.\n- `down`: In the open state, the disclosure arrow points down.\n- `left`: In the open state, the disclosure arrow points left.\n- `right`: In the open state, the disclosure arrow points right.\n"
    },
    "arrowSize": {
      "type": "string",
      "description": "Indicates the size of the collapsible arrows. Possible values are:\n\n- `small`\n- `large` (default)\n"
    },
    "arrowColor": {
      "type": "string",
      "description": "A CSS color value (such as `#DCF851`) that indicates the color of the arrow.\n"
    },
    "arrowStyle": {
      "type": "string",
      "description": "The name of the CSS style to be used on collapsible arrow section.\n"
    },
    "labelStyle": {
      "type": "string",
      "description": "The name of the CSS style to be used for the collapsible container's label."
    },
    "arrowClosed": {
      "type": "string",
      "description": "Indicates the direction of the disclosure arrow\nwhen the collapsible section is in the closed state.\n\nOne of the following:\n\n- `up`: In the closed state, the disclosure arrow points up.\n- `down`: In the closed state, the disclosure arrow points down.\n- `left`: In the closed state, the disclosure arrow points left.\n- `right`: In the closed state, the disclosure arrow points right.\n"
    },
    "arrowLocation": {
      "type": "string",
      "description": "The location of the arrow relative to the collapsible section's label. Possible values are:\n\n- `right` (default)\n- `left`\n"
    },
    "containerStyle": {
      "type": "string",
      "description": "The name of the CSS style to be used for the collapsible container.\n"
    },
    "onlyArrowIsClickable": {
      "type": "boolean",
      "description": "When **true,** only the arrow is clickable to expand or collapse the section.\nWhen **false** (the default), both the label and the arrow are clickable.\n\nIf no arrow is used, this setting is ignored.\n"
    },
    "outerLabelAndArrowStyle": {
      "type": "string",
      "description": "The name of the CSS style to be used for the collapsible container's outer label and arrow style."
    }
  },
  "description": "Display settings for collapsible section.",
  "x-ms-summary": "Display settings for collapsible section.",
  "x-ds-definition-name": "documentHtmlCollapsibleDisplaySettings"
}

{
  "type": "object",
  "properties": {
    "source": {
      "type": "string",
      "description": "Specifies the type of responsive signing that will be used with the document.\n\nIf the value of this property is valid HTML,\nand the [smart sections feature][] is enabled,\nthe HTML code is used to display the signing page:\n\n```\nsource: \"<html> ... <body><p>hello world</p></body></html>\"\n```\n\nIf the value of this property is the string `document`,\nthe HTML signing page is generated from the provided document.\n\n```\nsource: \"document\"\n```\n\n**Related topics**\n\n- [How to create a signable HTML document](https://raw.githubusercontent.com)\n- [How to convert a PDF file into a signable HTML document](https://raw.githubusercontent.com)\n- [Responsive signing](https://raw.githubusercontent.com)\n\n\n[smart sections feature]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=qlx1578456478178.html"
    },
    "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."
    },
    "headerLabel": {
      "type": "string",
      "description": "Header text or an HTML tag to place above the responsive HTML block."
    },
    "displayOrder": {
      "type": "string",
      "description": "The position on the page where the display section appears."
    },
    "documentGuid": {
      "type": "string",
      "description": "The GUID of the document."
    },
    "displayAnchors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentHtmlDisplayAnchor"
      },
      "description": "An object that defines how to handle a section of the HTML in signing. This property enables an incoming request to make a section of the HTML collapsible and expandable or hidden from view.\n\nA start anchor, end anchor, or both are required.\nIf the anchors are not found, the display anchor will be ignored.\n\nFor a list of the available types, see the\n[`display` property](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings_display)\nof the\n[`displaySettings` object.](/docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition_documents_htmldefinition_displayanchors_displaysettings)"
    },
    "maxScreenWidth": {
      "type": "string",
      "description": "If set, the responsive HTML version of the signing document will only display on screens with the specified pixel width or less. If the screen is larger than the value that you specify, the default PDF version of the content displays instead.\n\nThis setting can also be configured at the account level.\n"
    },
    "removeEmptyTags": {
      "type": "string",
      "description": "Holds a comma-separated list of HTML tags to remove if they have no text within their node (including child nodes)."
    },
    "displayPageNumber": {
      "type": "string",
      "description": "The number of the page on which the display section appears."
    },
    "displayAnchorPrefix": {
      "type": "string",
      "description": "Contains text that all display anchors must start with. Using at least four characters will improve anchor processing performance."
    },
    "showMobileOptimizedToggle": {
      "type": "string",
      "description": "When **true** (the default), the **Mobile-Friendly** toggle displays at the top of the screen on the user's mobile device. When **false,** the toggle will not be displayed.\n\nthe **Mobile-Friendly** toggle lets the user switch between the mobile-friendly and the PDF versions of a document. For example, the recipient can use this toggle to review the document using the PDF view before they finish signing.\n"
    }
  },
  "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document.\nSee [Responsive signing](https://raw.githubusercontent.com)\nin the [eSignature concepts guide](https://raw.githubusercontent.com).",
  "x-ms-summary": "Holds the properties that define how to generate the responsive-formatted HTML for the document.\nSee [Responsive signing](https://raw.githubusercontent.com)\nin the [eSignature concepts guide](https://raw.githubusercontent.com).",
  "x-ds-definition-name": "documentHtmlDefinition"
}

{
  "type": "object",
  "properties": {
    "documentId": {
      "type": "string",
      "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
    },
    "documentIdGuid": {
      "type": "string",
      "description": "The GUID of the document."
    },
    "htmlDefinition": {
      "$ref": "#/components/schemas/documentHtmlDefinition"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "documentHtmlDefinitionOriginal"
}

{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentHtmlDefinitionOriginal"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "documentHtmlDefinitionOriginals"
}

{
  "type": "object",
  "properties": {
    "htmlDefinitions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Holds the properties that define how to generate the responsive-formatted HTML for the document."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "documentHtmlDefinitions"
}

{
  "type": "object",
  "properties": {
    "endAnchor": {
      "type": "string",
      "description": "Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default.\n\n**Note:** A start anchor, an end anchor, or both are required."
    },
    "startAnchor": {
      "type": "string",
      "description": "Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.\n\n**Note:** A start anchor, an end anchor, or both are required."
    },
    "caseSensitive": {
      "type": "boolean",
      "description": "When **true,** the start or end anchor strings must match the strings specified by the start and end anchor settings in case as well as in content."
    },
    "displaySettings": {
      "$ref": "#/components/schemas/documentHtmlDisplaySettings"
    },
    "removeEndAnchor": {
      "type": "boolean",
      "description": "When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying."
    },
    "removeStartAnchor": {
      "type": "boolean",
      "description": "When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "documentHtmlDisplayAnchor"
}

{
  "type": "object",
  "properties": {
    "display": {
      "type": "string",
      "description": "Sets the display and behavior properties. Possible  values are:\n\n- `inline`:\n  Leaves the HTML where it is in the document.\n  This property lets you add a label or present on a separate page.\n\n- `collapsible`:\n  The HTML in this section may be expanded or collapsed.\n  Initially this section is expanded.\n\n- `collapsed`:\n  The HTML in this section may be expanded or collapsed.\n  Initially this section is collapsed.\n\n- `continue_button`:\n  Creates a stop point in the document to draw the reader's\n  attention before proceeding to the next section.\n\n- `responsive_table`:\n  Turns this section into a responsive table.\n  Note that this is only used on HTML tables that fall within the anchor start and end positions.\n\n- `responsive_table_single_column`:\n  Turns this section into a responsive single-column table.\n  Note this is only used on HTML tables that fall within the anchor start and end positions.\n  The table will be converted to one single column where each current column will become a row, then stacked.\n\n- `print_only`:\n  Do not show this portion of the HTML in the responsive signing view.\n\n\n"
    },
    "preLabel": {
      "type": "string",
      "description": "Enables you to add descriptive text that appears before a collapsed section or continue button."
    },
    "cellStyle": {
      "type": "string",
      "description": "Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types."
    },
    "tableStyle": {
      "type": "string",
      "description": "Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`."
    },
    "displayLabel": {
      "type": "string",
      "description": "The label to add to this display section in the signing page.\n"
    },
    "displayOrder": {
      "type": "integer",
      "format": "int32",
      "description": "The position on the page where the display section appears."
    },
    "labelWhenOpened": {
      "type": "string",
      "description": "The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`."
    },
    "inlineOuterStyle": {
      "type": "string",
      "description": "Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`."
    },
    "displayPageNumber": {
      "type": "integer",
      "format": "int32",
      "description": "The number of the page on which the display section appears."
    },
    "collapsibleSettings": {
      "$ref": "#/components/schemas/documentHtmlCollapsibleDisplaySettings"
    },
    "hideLabelWhenOpened": {
      "type": "boolean",
      "description": "When **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`."
    },
    "scrollToTopWhenOpened": {
      "type": "boolean",
      "description": "When **true** and the section is expanded,\nthe position of the section-close control\nscrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`.\n"
    }
  },
  "description": "This object defines how to display the HTML\nbetween the `startAnchor` and `endAnchor`.",
  "x-ms-summary": "This object defines how to display the HTML\nbetween the `startAnchor` and `endAnchor`.",
  "x-ds-definition-name": "documentHtmlDisplaySettings"
}

{
  "type": "object",
  "properties": {
    "documentId": {
      "type": "string",
      "description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
    },
    "templateId": {
      "type": "string",
      "description": "The unique identifier of the template. If this is not provided, DocuSign generates an error and the call fails."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "documentEndPage": {
      "type": "string",
      "description": ""
    },
    "documentStartPage": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "documentTemplate"
}

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

{
  "type": "object",
  "properties": {
    "rights": {
      "type": "string",
      "description": "Indicates whether the document is editable:\n\n- `editable`\n- `read_only`"
    },
    "visible": {
      "type": "string",
      "description": "When **true,** the document is visible to the recipient."
    },
    "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."
    },
    "recipientId": {
      "type": "string",
      "description": "The ID of the recipient to whom the document visibility setting is applied. This value should match the `recipientId` defined in the recipient object.\n"
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    }
  },
  "description": "This object configures a recipient's read/write access to a document.",
  "x-ms-summary": "This object configures a recipient's read/write access to a document.",
  "x-ds-definition-name": "documentVisibility"
}

{
  "type": "object",
  "properties": {
    "documentVisibility": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentVisibility"
      },
      "description": "An array of `documentVisibility` objects that specifies which documents are visible to which recipients."
    }
  },
  "description": "A list of `documentVisibility` objects that specify whether documents are visible to recipients.",
  "x-ms-summary": "A list of `documentVisibility` objects that specify whether documents are visible to recipients.",
  "x-ds-definition-name": "documentVisibilityList"
}

{
  "type": "object",
  "properties": {
    "paymentMethod": {
      "type": "string",
      "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
    },
    "downgradePlanInformation": {
      "$ref": "#/components/schemas/downgradePlanUpdateResponse"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "downgradRequestBillingInfoResponse"
}

{
  "type": "object",
  "properties": {
    "promoCode": {
      "type": "string",
      "description": ""
    },
    "saleDiscount": {
      "type": "string",
      "description": ""
    },
    "planInformation": {
      "$ref": "#/components/schemas/planInformation"
    },
    "saleDiscountType": {
      "type": "string",
      "description": ""
    },
    "downgradeEventType": {
      "type": "string",
      "description": ""
    },
    "saleDiscountPeriods": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "downgradeBillingPlanInformation"
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": ""
    },
    "productId": {
      "type": "string",
      "description": "The Product ID from the AppStore."
    },
    "promoCode": {
      "type": "string",
      "description": ""
    },
    "saleDiscount": {
      "type": "string",
      "description": ""
    },
    "discountApplied": {
      "type": "string",
      "description": ""
    },
    "downgradePlanId": {
      "type": "string",
      "description": ""
    },
    "saleDiscountType": {
      "type": "string",
      "description": ""
    },
    "downgradePlanName": {
      "type": "string",
      "description": ""
    },
    "saleDiscountPeriods": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "accountPaymentMethod": {
      "type": "string",
      "description": "The type of payment method used for the account. Valid values are:\n\n- `credit_card`\n- "
    },
    "downgradePaymentCycle": {
      "type": "string",
      "description": ""
    },
    "downgradeEffectiveDate": {
      "type": "string",
      "description": ""
    },
    "downgradeRequestStatus": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "downgradePlanUpdateResponse"
}

{
  "type": "object",
  "properties": {
    "downgradeRequestStatus": {
      "type": "string",
      "description": ""
    },
    "downgradeRequestCreation": {
      "type": "string",
      "description": ""
    },
    "downgradeRequestProductId": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "downgradeRequestInformation"
}

{
  "type": "object",
  "properties": {
    "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."
    },
    "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": "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."
    },
    "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"
    },
    "required": {
      "type": "string",
      "description": "When **true,** the signer is required to fill out this tab."
    },
    "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."
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "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": "Specifies the page number on which the tab is located."
    },
    "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."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "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"
    },
    "lockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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"
    },
    "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"
    },
    "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."
    },
    "allowSignerUpload": {
      "type": "string",
      "description": "When **true,** the recipient can upload an image to use as the background of the drawing field. The default value is **false.**"
    },
    "formOrderMetadata": {
      "$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"
    },
    "useBackgroundAsCanvas": {
      "type": "string",
      "description": ""
    },
    "conditionalParentLabel": {
      "type": "string",
      "description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
    },
    "conditionalParentValue": {
      "type": "string",
      "description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\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": "A tab that allows the recipient to add a free-form drawing to the document.",
  "x-ms-summary": "A tab that allows the recipient to add a free-form drawing to the document.",
  "x-ds-definition-name": "draw"
}

{
  "type": "object",
  "properties": {
    "apiKey": {
      "type": "string",
      "description": ""
    },
    "password": {
      "type": "string",
      "description": "The user's encrypted password hash."
    },
    "userName": {
      "type": "string",
      "description": "The user's username."
    },
    "organization": {
      "type": "string",
      "description": "The name of the organization."
    },
    "eNoteConfigured": {
      "type": "string",
      "description": "When **false,** the user must configure eNote for the feature to work.\n\n**Note:** In the account settings, `allowENoteEOriginal` must be **true**\nto make changes to the configuration."
    },
    "connectConfigured": {
      "type": "string",
      "description": "When **false,** the user must configure Connect and eOriginal for the integration to work."
    }
  },
  "description": "This object contains information used to\nconfigure [eNote][eNote] functionality.\nTo use eNote, the Allow eNote for eOriginal account plan item must be on,\nand the Connect configuration for eOriginal must be set correctly.\n\n[eNote]: https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=tsn1583277394951.html\n",
  "x-ms-summary": "This object contains information used to\nconfigure [eNote][eNote] functionality.\nTo use eNote, the Allow eNote for eOriginal account plan item must be on,\nand the Connect configuration for eOriginal must be set correctly.\n\n[eNote]: https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=tsn1583277394951.html\n",
  "x-ds-definition-name": "eNoteConfiguration"
}

{
  "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"
    },
    "email": {
      "type": "string",
      "description": "The recipient's email address. Notification of the document to sign is sent to this email address. \n\nMaximum length: 100 characters. "
    },
    "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`.\n"
    },
    "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."
    },
    "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. \n\nMaximum Length: 50 characters."
    },
    "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."
    },
    "phoneNumber": {
      "$ref": "#/components/schemas/recipientPhoneNumber"
    },
    "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"
    },
    "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."
    },
    "totalTabCount": {
      "type": "string",
      "description": "The total number of tabs in the documents. This property is read-only."
    },
    "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."
    },
    "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. "
    },
    "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. "
    },
    "declinedDateTime": {
      "type": "string",
      "description": "The date and time the recipient declined the document. This property is read-only."
    },
    "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."
    },
    "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"
    },
    "faxNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "firstNameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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.**"
    },
    "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"
    },
    "recipientTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "socialAuthentications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/socialAuthentication"
      },
      "description": "Deprecated."
    },
    "deliveryMethodMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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"
    },
    "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."
    },
    "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."
    },
    "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 defining the management and access rights of a recipient assigned as an editor on the envelope. Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and text tabs for the remaining recipients.",
  "x-ms-summary": "A complex type defining the management and access rights of a recipient assigned as an editor on the envelope. Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and text tabs for the remaining recipients.",
  "x-ds-definition-name": "editor"
}

{
  "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 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."
    },
    "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.\nFor 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."
    },
    "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 an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n",
  "x-ms-summary": "A tab that allows the recipient to enter an email address.\nThis is a one-line field that checks that a valid email\naddress is entered. It uses the same parameters as a Text\ntab, with the validation message and pattern set for email\ninformation.\n\nWhen getting information that includes\nthis tab type, the original value of the tab when the\nassociated envelope was sent is included in the response.\n",
  "x-ds-definition-name": "email"
}

{
  "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"
    },
    "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."
    },
    "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": "**Note:** Email Address tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient.\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"
    },
    "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\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.\nFor supplemental documents, this value must be `1`.\n"
    },
    "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 property 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."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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": "A tab that displays the recipient's email as entered in the\nrecipient information.\n",
  "x-ms-summary": "A tab that displays the recipient's email as entered in the\nrecipient information.\n",
  "x-ds-definition-name": "emailAddress"
}

{
  "type": "object",
  "properties": {
    "bccEmailAddresses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/bccEmailAddress"
      },
      "description": "An array containing the email address that should receive a copy of all email communications related to an envelope for archiving purposes. Maximum Length: 100 characters.\n\nWhile this property is an array, note that it takes only a single email address.\n\n**Note:** Only users with the `canManageAccount` setting set to **true** can use this option. \n\nDocuSign verifies that the email format is correct, but does not verify that the email address is active. You can use this for archiving purposes. However, using this property overrides the BCC for Email Archive information setting for this envelope. \n\n**Example:** if your account has BCC for Email Archive set up for the email address archive@mycompany.com and you send an envelope using the BCC Email Override to send a BCC email to salesarchive@mycompany.com, then a copy of the envelope is only sent to the salesarchive@mycompany.com email address."
    },
    "replyEmailNameOverride": {
      "type": "string",
      "description": "The name to associate with the Reply To email address, instead of the name that is configured at the account level. Maximum Length: 100 characters."
    },
    "replyEmailAddressOverride": {
      "type": "string",
      "description": "The Reply To email address to use for email replies, instead of the one that is configured at the account level. DocuSign verifies that the email address is in a correct format, but does not verify that it is active. Maximum Length: 100 characters."
    }
  },
  "description": "A complex element that allows  the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. \n\nWhen the emailSettings information is used for an envelope, it only applies to that envelope. \n\n**IMPORTANT:** The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. \n\nEmailSettings consists of: \n\n* replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters.\n* replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters.\n* bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. \nDocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters.\n*Example*: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.",
  "x-ms-summary": "A complex element that allows  the sender to override some envelope email setting information. This can be used to override the Reply To email address and name associated with the envelope and to override the BCC email addresses to which an envelope is sent. \n\nWhen the emailSettings information is used for an envelope, it only applies to that envelope. \n\n**IMPORTANT:** The emailSettings information is not returned in the GET for envelope status. Use GET /email_settings to return information about the emailSettings. \n\nEmailSettings consists of: \n\n* replyEmailAddressOverride - The Reply To email used for the envelope. DocuSign will verify that a correct email format is used, but does not verify that the email is active. Maximum Length: 100 characters.\n* replyEmailNameOverride - The name associated with the Reply To email address. Maximum Length: 100 characters.\n* bccEmailAddresses - An array of up to five email addresses to which the envelope is sent to as a BCC email. Only users with canManageAccount setting set to true can use this option. \nDocuSign verifies that the email format is correct, but does not verify that the email is active. Using this overrides the BCC for Email Archive information setting for this envelope. Maximum Length: 100 characters.\n*Example*: if your account has BCC for Email Archive set up for the email address 'archive@mycompany.com' and you send an envelope using the BCC Email Override to send a BCC email to 'salesarchive@mycompany.com', then a copy of the envelope is only sent to the 'salesarchive@mycompany.com' email address.",
  "x-ds-definition-name": "emailSettings"
}

{
  "type": "object",
  "properties": {
    "holder": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "sender": {
      "$ref": "#/components/schemas/userInfo"
    },
    "status": {
      "type": "string",
      "description": "Indicates the envelope status. Valid values are:\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n"
    },
    "brandId": {
      "type": "string",
      "description": "The ID of the brand."
    },
    "folders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folder"
      },
      "description": "A list of folder objects."
    },
    "location": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "workflow": {
      "$ref": "#/components/schemas/workflow"
    },
    "anySigner": {
      "type": "string",
      "description": "Deprecated. This feature has been replaced by signing groups."
    },
    "brandLock": {
      "type": "string",
      "description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope."
    },
    "powerForm": {
      "$ref": "#/components/schemas/powerForm"
    },
    "emailBlurb": {
      "type": "string",
      "description": "This is the same as the email body. If specified it is included in email body for all envelope recipients."
    },
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "hasWavFile": {
      "type": "string",
      "description": "When **true,** indicates that a .wav file used for voice authentication is included in the envelope. "
    },
    "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"
    },
    "recipients": {
      "$ref": "#/components/schemas/EnvelopeRecipients"
    },
    "allowMarkup": {
      "type": "string",
      "description": "When **true,** the Document Markup feature is enabled.\n\n**Note:**  To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.\n"
    },
    "envelopeUri": {
      "type": "string",
      "description": "The URI for retrieving the envelope or envelopes."
    },
    "expireAfter": {
      "type": "string",
      "description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
    },
    "hasComments": {
      "type": "string",
      "description": "When **true,** indicates that users have added comments to the envelope."
    },
    "messageLock": {
      "type": "string",
      "description": "When **true,** prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope."
    },
    "asynchronous": {
      "type": "string",
      "description": "When **true,** the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n\n**Note:** A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](https://raw.githubusercontent.com) or by checking the\nConnect notification."
    },
    "customFields": {
      "$ref": "#/components/schemas/AccountCustomFields"
    },
    "documentsUri": {
      "type": "string",
      "description": "The URI for retrieving all of the documents associated with the envelope as separate files."
    },
    "emailSubject": {
      "type": "string",
      "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.\n"
    },
    "notification": {
      "$ref": "#/components/schemas/notification"
    },
    "sentDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the envelope was sent. This property is read-only."
    },
    "templatesUri": {
      "type": "string",
      "description": "The URI for retrieving the templates."
    },
    "voidedReason": {
      "type": "string",
      "description": "The reason the envelope or template was voided.\n\n**Note:** The string is truncated to the first 200 characters.\n"
    },
    "allowComments": {
      "type": "string",
      "description": "When **true,** users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document."
    },
    "allowReassign": {
      "type": "string",
      "description": "When **true,** the recipient can redirect an envelope to a more appropriate recipient."
    },
    "emailSettings": {
      "$ref": "#/components/schemas/emailSettings"
    },
    "enableWetSign": {
      "type": "string",
      "description": "When **true,** the signer is allowed to print the document and sign it on paper."
    },
    "expireEnabled": {
      "type": "string",
      "description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
    },
    "is21CFRPart11": {
      "type": "string",
      "description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."
    },
    "recipientsUri": {
      "type": "string",
      "description": "Contains a URI for an endpoint that you can use to retrieve the recipients."
    },
    "transactionId": {
      "type": "string",
      "description": " Used to identify an envelope.\n\n The ID is a sender-generated value and is valid in the DocuSign system for 7 days.\n It is recommended that a transaction ID is used for offline\n signing to ensure that an envelope is not sent multiple times.\n The `transactionId` property can be used determine an envelope's\n status (i.e. was it created or not) in cases where the internet c\n onnection was lost before the envelope status was returned."
    },
    "useDisclosure": {
      "type": "string",
      "description": "When **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **false,** the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information."
    },
    "attachmentsUri": {
      "type": "string",
      "description": "Contains a URL for retrieving the attachments that are associated with the envelope."
    },
    "autoNavigation": {
      "type": "string",
      "description": "When **true,** autonavigation is set for the recipient.\n"
    },
    "certificateUri": {
      "type": "string",
      "description": "The URI for retrieving certificate information."
    },
    "documentBase64": {
      "type": "string",
      "description": "The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding."
    },
    "expireDateTime": {
      "type": "string",
      "description": "The date and time that the envelope is set to expire. This value is determined by the `InitialSentDateTime` of the envelope and the `expireAfter` property of the `notification` object. (Note that the `expireAfter` property of the envelope itself is not used.)\n"
    },
    "recipientsLock": {
      "type": "string",
      "description": "When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope."
    },
    "statusDateTime": {
      "type": "string",
      "description": "The DateTime that the envelope changed status (i.e. was created or sent.)"
    },
    "voidedDateTime": {
      "type": "string",
      "description": "The date and time the envelope or template was voided."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the item was created."
    },
    "customFieldsUri": {
      "type": "string",
      "description": "The URI for retrieving custom fields."
    },
    "deletedDateTime": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "lockInformation": {
      "$ref": "#/components/schemas/EnvelopeLocks"
    },
    "notificationUri": {
      "type": "string",
      "description": "The URI for retrieving notifications."
    },
    "signingLocation": {
      "type": "string",
      "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`."
    },
    "allowViewHistory": {
      "type": "string",
      "description": "When **true,** recipients can view the history of the envelope."
    },
    "declinedDateTime": {
      "type": "string",
      "description": "The date and time the recipient declined the document. This property is read-only."
    },
    "envelopeLocation": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "envelopeMetadata": {
      "$ref": "#/components/schemas/envelopeMetadata"
    },
    "purgeRequestDate": {
      "type": "string",
      "description": "The date that a purge was requested."
    },
    "authoritativeCopy": {
      "type": "string",
      "description": "When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"
    },
    "completedDateTime": {
      "type": "string",
      "description": "Specifies the date and time this item was completed."
    },
    "copyRecipientData": {
      "type": "string",
      "description": ""
    },
    "deliveredDateTime": {
      "type": "string",
      "description": "The date and time that the envelope was delivered to the recipient. This property is read-only."
    },
    "envelopeDocuments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeDocument"
      },
      "description": "An array containing information about the documents that are included in the envelope."
    },
    "isDynamicEnvelope": {
      "type": "string",
      "description": "When **true,** indicates that the envelope is a dynamic envelope."
    },
    "burnDefaultTabData": {
      "type": "string",
      "description": ""
    },
    "envelopeIdStamping": {
      "type": "string",
      "description": "When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed."
    },
    "externalEnvelopeId": {
      "type": "string",
      "description": "May contain an external identifier for the envelope."
    },
    "hasFormDataChanged": {
      "type": "string",
      "description": "When **true,** indicates that the data collected through form fields on a document has changed."
    },
    "purgeCompletedDate": {
      "type": "string",
      "description": "The date that a purge was completed."
    },
    "envelopeAttachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/attachment"
      },
      "description": "An array of attachment objects that provide information about the attachments that are associated with the envelope."
    },
    "initialSentDateTime": {
      "type": "string",
      "description": "The date and time the envelope was initially sent."
    },
    "documentsCombinedUri": {
      "type": "string",
      "description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file."
    },
    "lastModifiedDateTime": {
      "type": "string",
      "description": "The date and time that the item was last modified."
    },
    "signerCanSignOnMobile": {
      "type": "string",
      "description": "When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "statusChangedDateTime": {
      "type": "string",
      "description": "The data and time that the status changed."
    },
    "envelopeCustomMetadata": {
      "$ref": "#/components/schemas/envelopeCustomMetadata"
    },
    "accessControlListBase64": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "enforceSignerVisibility": {
      "type": "string",
      "description": "When **true,** signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by 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 by using this setting when an envelope is sent.\n\n**Note:** To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true.**\n\n[docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/"
    },
    "authoritativeCopyDefault": {
      "type": "string",
      "description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`."
    },
    "disableResponsiveDocument": {
      "type": "string",
      "description": "When **true,** responsive documents are disabled for the envelope."
    },
    "isSignatureProviderEnvelope": {
      "type": "string",
      "description": "When **true,** indicates that the envelope is a signature-provided envelope."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "envelope"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": ""
    },
    "label": {
      "type": "string",
      "description": ""
    },
    "attachmentId": {
      "type": "string",
      "description": "The unique identifier for the attachment."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "accessControl": {
      "type": "string",
      "description": "Valid values are `sender` and `senderAndAllRecipients`."
    },
    "attachmentType": {
      "type": "string",
      "description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "envelopeAttachment"
}

{
  "type": "object",
  "properties": {
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/attachment"
      },
      "description": "An object that contains information about the attachment."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "envelopeAttachmentsRequest"
}

{
  "type": "object",
  "properties": {
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeAttachment"
      },
      "description": "An array of attachment objects that contain information about the attachments."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "envelopeAttachmentsResult"
}

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

{
  "type": "object",
  "properties": {
    "auditEvents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeAuditEvent"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "envelopeAuditEventResponse"
}

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

{
  "type": "object",
  "properties": {
    "holder": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "sender": {
      "$ref": "#/components/schemas/userInfo"
    },
    "status": {
      "type": "string",
      "description": "Indicates the envelope status. Valid values when creating an envelope are: \n\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n\nYou can query these additional statuses once the recipients have interacted with the envelope.\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n"
    },
    "brandId": {
      "type": "string",
      "description": "The ID of the brand, or text and formatting, to use for the envelope. To use brands, account branding must be enabled for the account.\n\n**Note:** When creating an envelope using a branded template, include this value to ensure that the brand is applied."
    },
    "folders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folder"
      },
      "description": "An array of folders that the envelope belongs to."
    },
    "location": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "password": {
      "type": "string",
      "description": "The user's encrypted password hash."
    },
    "workflow": {
      "$ref": "#/components/schemas/workflow"
    },
    "anySigner": {
      "type": "string",
      "description": "Deprecated. This feature has been replaced by signing groups."
    },
    "brandLock": {
      "type": "string",
      "description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope."
    },
    "documents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/document"
      },
      "description": "A complex element that contains details about the documents associated with the envelope."
    },
    "powerForm": {
      "$ref": "#/components/schemas/powerForm"
    },
    "emailBlurb": {
      "type": "string",
      "description": "This optional element holds the body of the email message that is sent to all envelope recipients. \n\nMaximum Length: 10000 characters."
    },
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID.\n\nWhen used as a request body in [Envelopes: create](https://raw.githubusercontent.com), this is the ID of the envelope to clone."
    },
    "hasWavFile": {
      "type": "string",
      "description": "When **true,** indicates that a wave file (voice recording) is part of the envelope."
    },
    "purgeState": {
      "type": "string",
      "description": "Initiates a purge request. Valid values are:\n\n- `documents_queued`: Places envelope documents in the purge queue.\n- `documents_and_metadata_queued`: Places envelope documents\n   and metadata in the purge queue.\n- `documents_and_metadata_and_redact_queued`: Places envelope documents\n   and metadata in the purge queue and redacts personal information.\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"
    },
    "recipients": {
      "$ref": "#/components/schemas/EnvelopeRecipients"
    },
    "templateId": {
      "type": "string",
      "description": "The ID of the template. If a value is not provided, DocuSign generates a value. "
    },
    "allowMarkup": {
      "type": "string",
      "description": "When **true,** the Document Markup feature is enabled.\n\n**Note:**  To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.\n"
    },
    "attachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/attachment"
      },
      "description": "An array of attachment objects containing details about any envelope attachments."
    },
    "envelopeUri": {
      "type": "string",
      "description": "The URI for retrieving the envelope or envelopes."
    },
    "expireAfter": {
      "type": "string",
      "description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
    },
    "hasComments": {
      "type": "string",
      "description": "When **true,** indicates that users have added comments to the envelope."
    },
    "messageLock": {
      "type": "string",
      "description": "When **true,** prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope."
    },
    "asynchronous": {
      "type": "string",
      "description": "When **true,** the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n\n**Note:** A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](https://raw.githubusercontent.com) or by checking the\nConnect notification."
    },
    "customFields": {
      "$ref": "#/components/schemas/AccountCustomFields"
    },
    "documentsUri": {
      "type": "string",
      "description": "The URI for retrieving all of the documents associated with the envelope as separate files."
    },
    "emailSubject": {
      "type": "string",
      "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.\n"
    },
    "notification": {
      "$ref": "#/components/schemas/notification"
    },
    "sentDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the envelope was sent. This property is read-only."
    },
    "templatesUri": {
      "type": "string",
      "description": "The URI for retrieving any templates associated with the envelope."
    },
    "voidedReason": {
      "type": "string",
      "description": "The reason the envelope or template was voided.\n\n**Note:** The string is truncated to the first 200 characters.\n"
    },
    "accessibility": {
      "type": "string",
      "description": "Sets the document reading zones for screen reader applications.  This element can only be used if Document Accessibility is enabled for the account.\n\n**Note:** This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here."
    },
    "allowComments": {
      "type": "string",
      "description": "When **true,** comments are allowed on the envelope."
    },
    "allowReassign": {
      "type": "string",
      "description": "When **true,** the recipient can redirect an envelope to a more appropriate recipient."
    },
    "emailSettings": {
      "$ref": "#/components/schemas/emailSettings"
    },
    "enableWetSign": {
      "type": "string",
      "description": "When **true,** the signer is allowed to print the document and sign it on paper."
    },
    "expireEnabled": {
      "type": "string",
      "description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
    },
    "is21CFRPart11": {
      "type": "string",
      "description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."
    },
    "recipientsUri": {
      "type": "string",
      "description": "Contains a URI for an endpoint that you can use to retrieve the recipients."
    },
    "templateRoles": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/templateRole"
      },
      "description": "This object specifies the template recipients. Each `roleName` in the template must have a recipient assigned to it. This object is comprised of the following elements:\n\n* `email`: The recipient's email address.\n* `name`: The recipient's name.\n* `roleName`: The template roleName associated with the recipient.\n* `clientUserId`: An optional property that specifies whether the recipient is embedded or remote. If the `clientUserId` is not null, then the recipient is embedded. Note that if a `clientUserId` is used and the account settings `signerMustHaveAccount` or `signerMustLoginToSign` are **true,** an error is generated on sending.\n* `defaultRecipient`: Optional, When **true,** this recipient is the default recipient and any tabs generated by the `transformPdfFields` option are mapped to this recipient.\n* `routingOrder`: This specifies the routing order of the recipient in the envelope.\n* `accessCode`: This optional element specifies the access code a recipient has to enter to validate the identity. Maximum Length: 50 characters.\n* `inPersonSignerName`: Optional. If the template role is an in-person signer, this is the full legal name of the signer. Maximum Length: 100 characters.\n* `emailNotification`: This is an optional complex element that has a role-specific `emailSubject`, `emailBody`, and `language`. It follows the same format as the `emailNotification` property for recipients.\n* `tabs`: This property enables the tab values to be specified for matching to tabs in the template.\n"
    },
    "transactionId": {
      "type": "string",
      "description": " Used to identify an envelope. The ID is a sender-generated value and is valid in the DocuSign system for 7 days. DocuSign recommends that you use a transaction ID for offline signing to ensure that an envelope is not sent multiple times. You can use the `transactionId` property to determine an envelope's status (i.e. was it created or not) in cases where the Internet connection was lost before the envelope status was returned."
    },
    "useDisclosure": {
      "type": "string",
      "description": "When **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **false,** the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information."
    },
    "attachmentsUri": {
      "type": "string",
      "description": "The URI for retrieving the envelope attachments."
    },
    "autoNavigation": {
      "type": "string",
      "description": "When **true,** autonavigation is set for the recipient.\n"
    },
    "certificateUri": {
      "type": "string",
      "description": "The URI for retrieving certificate information."
    },
    "documentBase64": {
      "type": "string",
      "description": "The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding."
    },
    "expireDateTime": {
      "type": "string",
      "description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
    },
    "recipientsLock": {
      "type": "string",
      "description": "When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope."
    },
    "statusDateTime": {
      "type": "string",
      "description": "The DateTime that the envelope changed status (i.e. was created or sent.)"
    },
    "voidedDateTime": {
      "type": "string",
      "description": "The date and time the envelope or template was voided."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The date and time that the envelope was created."
    },
    "customFieldsUri": {
      "type": "string",
      "description": "The URI for retrieving custom fields."
    },
    "deletedDateTime": {
      "type": "string",
      "description": "The date and time that the envelope was deleted."
    },
    "lockInformation": {
      "$ref": "#/components/schemas/EnvelopeLocks"
    },
    "notificationUri": {
      "type": "string",
      "description": "The URI for retrieving notifications."
    },
    "signingLocation": {
      "type": "string",
      "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`."
    },
    "allowViewHistory": {
      "type": "string",
      "description": "When **true,** users can view the history of the envelope."
    },
    "declinedDateTime": {
      "type": "string",
      "description": "The date and time that the recipient declined the envelope."
    },
    "envelopeLocation": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "envelopeMetadata": {
      "$ref": "#/components/schemas/envelopeMetadata"
    },
    "purgeRequestDate": {
      "type": "string",
      "description": "The date that a purge was requested."
    },
    "authoritativeCopy": {
      "type": "string",
      "description": "When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"
    },
    "completedDateTime": {
      "type": "string",
      "description": "The date and time that the envelope was completed."
    },
    "copyRecipientData": {
      "type": "string",
      "description": "This value is only applicable when copying an existing envelope. Provide the ID of the envelope to clone in `envelopeId`.\n\nWhen **true,** the recipient field values of the existing envelope are included. Only values from data entry fields, like checkboxes and radio buttons, will be copied. Fields that require an action, like signatures and initials, will not be included."
    },
    "deliveredDateTime": {
      "type": "string",
      "description": "The date and time that the envelope was delivered to the recipient. This property is read-only."
    },
    "envelopeDocuments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeDocument"
      },
      "description": "An array containing information about the documents that are included in the envelope."
    },
    "eventNotification": {
      "$ref": "#/components/schemas/eventNotification"
    },
    "isDynamicEnvelope": {
      "type": "string",
      "description": "When **true,** indicates that the envelope is a dynamic envelope."
    },
    "burnDefaultTabData": {
      "type": "string",
      "description": ""
    },
    "compositeTemplates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/compositeTemplate"
      },
      "description": "A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope."
    },
    "envelopeIdStamping": {
      "type": "string",
      "description": "When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed."
    },
    "externalEnvelopeId": {
      "type": "string",
      "description": "May contain an external identifier for the envelope."
    },
    "hasFormDataChanged": {
      "type": "string",
      "description": "When **true,** indicates that the form data associated with the envelope has changed since it was sent. When **false,** this property does not appear in the response."
    },
    "purgeCompletedDate": {
      "type": "string",
      "description": "The date that a purge was completed."
    },
    "envelopeAttachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/attachment"
      },
      "description": "An array of attachment objects that provide information about the attachments that are associated with the envelope."
    },
    "initialSentDateTime": {
      "type": "string",
      "description": "The date and time that the envelope was first sent."
    },
    "documentsCombinedUri": {
      "type": "string",
      "description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file."
    },
    "lastModifiedDateTime": {
      "type": "string",
      "description": "The date and time that the item was last modified."
    },
    "recipientViewRequest": {
      "$ref": "#/components/schemas/recipientViewRequest"
    },
    "signerCanSignOnMobile": {
      "type": "string",
      "description": "When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "statusChangedDateTime": {
      "type": "string",
      "description": "The data and time that the status changed."
    },
    "envelopeCustomMetadata": {
      "$ref": "#/components/schemas/envelopeCustomMetadata"
    },
    "accessControlListBase64": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "allowRecipientRecursion": {
      "type": "string",
      "description": "When **true,** this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order."
    },
    "enforceSignerVisibility": {
      "type": "string",
      "description": "When **true,** signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by 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 by using this setting when an envelope is sent.\n\n**Note:** To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true.**\n\n[docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/"
    },
    "authoritativeCopyDefault": {
      "type": "string",
      "description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`."
    },
    "disableResponsiveDocument": {
      "type": "string",
      "description": "When **true,** the responsive document feature is turned off for the envelope."
    },
    "isSignatureProviderEnvelope": {
      "type": "string",
      "description": "When **true,** indicates that the envelope is a signature-provided envelope."
    }
  },
  "description": "Envelope object definition.",
  "x-ms-summary": "Envelope object definition.",
  "x-ds-definition-name": "envelopeDefinition"
}

{
  "type": "object",
  "properties": {
    "delay": {
      "type": "string",
      "description": "A string timespan representing the duration of the sending delay. The timespan is in the format `d.hh:mm:ss` where `d` is the number of days, `hh` is the number of hours (measured on a 24-hour clock), `mm` is minutes, and `ss` is seconds. The maximum delay is 30 days."
    },
    "resumeDate": {
      "type": "string",
      "description": "An ISO 8601 formatted datetime string indicating the date and time that the envelope will be sent. The specified datetime must occur in the future. It must not exceed 30 days from the time that the request is made."
    }
  },
  "description": "A user-specified object that describes the envelope delay.\n\nTo indicate a relative delay, use `delay`. To indicate the exact datetime the envelope should be sent, use `resumeDate`. Only one of the two properties can be used.",
  "x-ms-summary": "A user-specified object that describes the envelope delay.\n\nTo indicate a relative delay, use `delay`. To indicate the exact datetime the envelope should be sent, use `resumeDate`. Only one of the two properties can be used.",
  "x-ds-definition-name": "envelopeDelayRule"
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "The URI for retrieving the document."
    },
    "name": {
      "type": "string",
      "description": "The document's file name. \n\nExample: `Q1-Report.docx`"
    },
    "type": {
      "type": "string",
      "description": "The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`\n"
    },
    "order": {
      "type": "string",
      "description": "The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. "
    },
    "pages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/page"
      },
      "description": "An array of page objects that contain information about the pages in the document."
    },
    "display": {
      "type": "string",
      "description": "This string sets the display and behavior properties of\nthe document during signing. Valid values:\n\n* `modal`<br>\n  The document is shown as a supplement action strip\n  and can be viewed, downloaded, or printed in a modal window.\n  This is the recommended value for supplemental documents. \n\n* `inline`<br>\n  The document is shown in the normal signing window.\n  This value is not used with supplemental documents,\n  but is the default value for all other documents.\n"
    },
    "sizeBytes": {
      "type": "string",
      "description": ""
    },
    "documentId": {
      "type": "string",
      "description": "The ID of the document that the tab is placed on. This value must refer to the ID of an existing document."
    },
    "docGenErrors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/docGenSyntaxError"
      },
      "description": ""
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "nameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "documentBase64": {
      "type": "string",
      "description": "The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding."
    },
    "documentFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "An object containing information about the custom fields on the document."
    },
    "documentIdGuid": {
      "type": "string",
      "description": "The GUID of the document."
    },
    "templateLocked": {
      "type": "string",
      "description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
    },
    "attachmentTabId": {
      "type": "string",
      "description": "If this document is an attachment to another document in the envelope, this is the ID of the attachment tab it is associated with on the other document."
    },
    "displayMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "docGenFormFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/docGenFormField"
      },
      "description": ""
    },
    "isAceGenDocument": {
      "type": "string",
      "description": ""
    },
    "isDocGenDocument": {
      "type": "string",
      "description": ""
    },
    "templateRequired": {
      "type": "string",
      "description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
    },
    "addedRecipientIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "If recipients were added by converting form fields into tabs, their IDs appear here. This property is read-only."
    },
    "authoritativeCopy": {
      "type": "string",
      "description": "When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"
    },
    "includeInDownload": {
      "type": "string",
      "description": "When **true,**\nthe document is included in the combined document download (`documentsCombinedUri`). \nThe default value is **true.**\n"
    },
    "docGenDocumentStatus": {
      "type": "string",
      "description": ""
    },
    "containsPdfFormFields": {
      "type": "string",
      "description": "When **true,** the document has editable form fields that are made available through a PDF format."
    },
    "signerMustAcknowledge": {
      "type": "string",
      "description": "Sets how the signer interacts with the supplemental document.\nValid values:\n\n* `no_interaction`<br>\n  No recipient action is required.\n\n* `view`<br>\n  The recipient is required to view the document.\n\n* `accept`<br>\n  The recipient is required to accept the document by selecting accept during signing, but is not required to view the document.\n\n* `view_accept`<br>\n  The recipient is required to view and accept the document.\n\n"
    },
    "availableDocumentTypes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signatureType"
      },
      "description": ""
    },
    "authoritativeCopyMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "includeInDownloadMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "signerMustAcknowledgeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "This object contains details about the envelope document.",
  "x-ms-summary": "This object contains details about the envelope document.",
  "x-ds-definition-name": "envelopeDocument"
}

{
  "type": "object",
  "properties": {
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID."
    },
    "envelopeDocuments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeDocument"
      },
      "description": "An array containing information about the documents that are included in the envelope."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "envelopeDocumentsResult"
}

{
  "type": "object",
  "properties": {
    "includeDocuments": {
      "type": "string",
      "description": "When **true,**\nthe Connect webhook messages\nwill include the envelope's PDF documents.\nIncluding the PDF documents\ngreatly increases the size of the notification messages.\nEnsure that your listener can handle\nincoming messages that are 25MB or larger."
    },
    "envelopeEventStatusCode": {
      "type": "string",
      "description": "An envelope status for which your webhook should be called. Valid values:\n\n* `Sent` \n* `Delivered`\n* `Completed`\n* `Declined`\n* `Voided`"
    }
  },
  "description": "For which envelope events should your webhook be called?",
  "x-ms-summary": "For which envelope events should your webhook be called?",
  "x-ds-definition-name": "envelopeEvent"
}

{
  "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."
    },
    "formData": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/formDataItem"
      },
      "description": "An array of `formDataItem` objects. \n"
    },
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "emailSubject": {
      "type": "string",
      "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.\n"
    },
    "sentDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the envelope was sent. This property is read-only."
    },
    "prefillFormData": {
      "$ref": "#/components/schemas/prefillFormData"
    },
    "recipientFormData": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientFormData"
      },
      "description": "An array of form data for each recipient of the envelope."
    }
  },
  "description": "Describes the form data of the envelope.",
  "x-ms-summary": "Describes the form data of the envelope.",
  "x-ds-definition-name": "envelopeFormData"
}

{
  "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."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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.\nFor 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."
    },
    "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"
    },
    "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"
    },
    "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": "A tab that displays the envelope ID.\n\n**Note:**  The eSignature API uses the name `envelopeId` two ways:\n\n- As a _property_ of type `string` used to identify an envelope  by its GUID.\n- As an _object_ used to represent an envelope tab that displays\n  the envelope's GUID.\n",
  "x-ms-summary": "A tab that displays the envelope ID.\n\n**Note:**  The eSignature API uses the name `envelopeId` two ways:\n\n- As a _property_ of type `string` used to identify an envelope  by its GUID.\n- As an _object_ used to represent an envelope tab that displays\n  the envelope's GUID.\n",
  "x-ds-definition-name": "envelopeId"
}

{
  "type": "object",
  "properties": {
    "envelopeIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A comma-separated list of envelope IDs to include in the results."
    },
    "transactionIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A comma-separated list of transaction IDs to include in the results. Note that transaction IDs are valid for seven days."
    }
  },
  "description": "Lists of envelope and transaction IDs to use in the results.\n\nIf you use this request body with Envelopes: listStatus,\nyou must set one or both of the following query parameters\nto the special value `request_body`:\n\n- `envelope_ids=request_body`\n- `transaction_ids=request_body`\n",
  "x-ms-summary": "Lists of envelope and transaction IDs to use in the results.\n\nIf you use this request body with Envelopes: listStatus,\nyou must set one or both of the following query parameters\nto the special value `request_body`:\n\n- `envelope_ids=request_body`\n- `transaction_ids=request_body`\n",
  "x-ds-definition-name": "envelopeIdsRequest"
}

{
  "type": "object",
  "properties": {
    "allowCorrect": {
      "type": "string",
      "description": "Specifies if the Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you, including the recipient, envelope, and document information."
    },
    "allowAdvancedCorrect": {
      "type": "string",
      "description": "Specifies if the Advanced Correct feature is enabled for the envelope. This feature enables you to correct the details of in process envelopes that you sent or are shared with you. It offers more functionality than the Correct feature."
    },
    "enableSignWithNotary": {
      "type": "string",
      "description": "Specifies if DocuSign eNotary service is enabled for the envelope."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "envelopeMetadata"
}

{
  "type": "object",
  "properties": {
    "reminders": {
      "$ref": "#/components/schemas/reminders"
    },
    "expirations": {
      "$ref": "#/components/schemas/expirations"
    },
    "useAccountDefaults": {
      "type": "string",
      "description": "When **true,** the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When **false,** the reminders and expirations settings specified in this request are used. The default value is **false.**"
    }
  },
  "description": "A complex element that specifies the notification settings for the envelope.",
  "x-ms-summary": "A complex element that specifies the notification settings for the envelope.",
  "x-ds-definition-name": "envelopeNotificationRequest"
}

{
  "type": "object",
  "properties": {
    "errorCount": {
      "type": "string",
      "description": ""
    },
    "resultsUri": {
      "type": "string",
      "description": ""
    },
    "envelopeCount": {
      "type": "string",
      "description": ""
    },
    "submissionDate": {
      "type": "string",
      "description": ""
    },
    "fileLevelErrors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "processingStatus": {
      "type": "string",
      "description": "The status of the transaction. Valid values:\n\n* `unprocessed`\n* `processing`\n* `complete`\n* `fatal_error`\n"
    },
    "submittedByUserInfo": {
      "$ref": "#/components/schemas/userInfo"
    },
    "applyConnectSettings": {
      "type": "string",
      "description": ""
    },
    "processedEnvelopeCount": {
      "type": "string",
      "description": ""
    },
    "envelopeLevelErrorRollups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopePublishTransactionErrorRollup"
      },
      "description": ""
    },
    "envelopePublishTransactionId": {
      "type": "string",
      "description": "The ID of the publish transaction."
    },
    "noActionRequiredEnvelopeCount": {
      "type": "string",
      "description": ""
    },
    "submittedForPublishingEnvelopeCount": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "envelopePublishTransaction"
}

{
  "type": "object",
  "properties": {
    "count": {
      "type": "string",
      "description": "The maximum number of results to return."
    },
    "errorType": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "envelopePublishTransactionErrorRollup"
}

{
  "type": "object",
  "properties": {
    "redactPII": {
      "type": "string",
      "description": "When **true,** the system also redacts personally identifiable information (PII).\n\n**Note:** To redact PII, you must also set the property `removeTabsAndEnvelopeAttachments` to **true.**"
    },
    "retentionDays": {
      "type": "string",
      "description": "The number of days to retain envelope documents before purging them. This value must be a number between `0` and `999`."
    },
    "purgeEnvelopes": {
      "type": "string",
      "description": "When **true,** purging is enabled."
    },
    "removeTabsAndEnvelopeAttachments": {
      "type": "string",
      "description": "When **true,** the system also purges the tabs and attachments associated with the envelopes. "
    }
  },
  "description": "Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`). ",
  "x-ms-summary": "Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`). ",
  "x-ds-definition-name": "envelopePurgeConfiguration"
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "A URI containing the user ID."
    },
    "status": {
      "type": "string",
      "description": "Indicates the envelope status. Valid values are: \n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n"
    },
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "statusDateTime": {
      "type": "string",
      "description": "The DateTime that the envelope changed status (i.e. was created or sent.)"
    },
    "bulkEnvelopeStatus": {
      "$ref": "#/components/schemas/bulkEnvelopeStatus"
    },
    "recipientSigningUri": {
      "type": "string",
      "description": ""
    },
    "recipientSigningUriError": {
      "type": "string",
      "description": ""
    }
  },
  "description": " This object describes an envelope.",
  "x-ms-summary": " This object describes an envelope.",
  "x-ds-definition-name": "envelopeSummary"
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "A URI containing the user ID."
    },
    "name": {
      "type": "string",
      "description": ""
    },
    "owner": {
      "$ref": "#/components/schemas/userInfo"
    },
    "holder": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "sender": {
      "$ref": "#/components/schemas/userInfo"
    },
    "shared": {
      "type": "string",
      "description": "When **true,** indicates the template is shared with the **Everyone** group,\nwhich includes all users on the account.\n\nWhen **false,** the template is shared only with the groups you specify.\n"
    },
    "status": {
      "type": "string",
      "description": "Indicates the envelope status. Valid values are:\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n"
    },
    "brandId": {
      "type": "string",
      "description": "The ID of the brand."
    },
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the workspace user authorization was created."
    },
    "folders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folder"
      },
      "description": "A list of folder objects."
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder."
    },
    "lastUsed": {
      "type": "string",
      "description": ""
    },
    "location": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "password": {
      "type": "string",
      "description": "The user's encrypted password hash."
    },
    "workflow": {
      "$ref": "#/components/schemas/workflow"
    },
    "anySigner": {
      "type": "string",
      "description": "Deprecated. This feature has been replaced by signing groups."
    },
    "autoMatch": {
      "type": "string",
      "description": "By default, templates that have been used within\nthe last 60 days are included in auto-matching.\n\nBy explicitly setting `autoMatch`,\nyou can permanently include or exclude the template\nin auto matching.\n\nWhen **true** the template is included in auto-matching\nregardless of when it was last used.\n\nWhen **false** the template is never included in auto-matching."
    },
    "brandLock": {
      "type": "string",
      "description": "When **true,** the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope."
    },
    "documents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/document"
      },
      "description": "A complex element that contains details about the documents associated with the envelope."
    },
    "folderIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "pageCount": {
      "type": "string",
      "description": "An integer value specifying the number of document pages in the template. "
    },
    "powerForm": {
      "$ref": "#/components/schemas/powerForm"
    },
    "emailBlurb": {
      "type": "string",
      "description": "This is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients."
    },
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of an envelope that you want to use as\nthe basis for the template. The state of the envelope\ncan be `draft`, `sent`, or `completed`.\n\n"
    },
    "folderName": {
      "type": "string",
      "description": ""
    },
    "hasWavFile": {
      "type": "string",
      "description": "When **true,** indicates that a .wav file used for voice authentication is included in the envelope. "
    },
    "powerForms": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/powerForm"
      },
      "description": "An array of PowerForm objects."
    },
    "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"
    },
    "recipients": {
      "$ref": "#/components/schemas/EnvelopeRecipients"
    },
    "templateId": {
      "type": "string",
      "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. "
    },
    "allowMarkup": {
      "type": "string",
      "description": "When **true,** the Document Markup feature is enabled.\n\n**Note:**  To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.\n"
    },
    "description": {
      "type": "string",
      "description": "A sender-defined description of the line item.\n"
    },
    "envelopeUri": {
      "type": "string",
      "description": "The URI for retrieving the envelope or envelopes."
    },
    "expireAfter": {
      "type": "string",
      "description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
    },
    "hasComments": {
      "type": "string",
      "description": "When **true,** indicates that users have added comments to the envelope."
    },
    "messageLock": {
      "type": "string",
      "description": "When **true,** prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. \n\nAdditionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. \n\nHowever, if the `messageLock` node is set to **true** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope."
    },
    "newPassword": {
      "type": "string",
      "description": "The user's new password."
    },
    "asynchronous": {
      "type": "string",
      "description": "When **true,** the envelope is queued for\nprocessing and the value of the `status` property\nis set to `Processing`. Additionally, GET status\ncalls return `Processing` until completed.\n\n\n**Note:** A `transactionId` is required for this\ncall to work correctly. When the envelope is\ncreated, the status is `Processing` and an\n`envelopeId` is not returned in the response. To\nget the `envelopeId`, use a GET envelope query by\nusing the\n[transactionId](https://raw.githubusercontent.com) or by checking the\nConnect notification."
    },
    "customFields": {
      "$ref": "#/components/schemas/AccountCustomFields"
    },
    "documentsUri": {
      "type": "string",
      "description": "The URI for retrieving all of the documents associated with the envelope as separate files."
    },
    "emailSubject": {
      "type": "string",
      "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.\n"
    },
    "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."
    },
    "notification": {
      "$ref": "#/components/schemas/notification"
    },
    "sentDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the envelope was sent. This property is read-only."
    },
    "templatesUri": {
      "type": "string",
      "description": "The URI for retrieving the templates."
    },
    "voidedReason": {
      "type": "string",
      "description": "The reason the envelope or template was voided.\n\n**Note:** The string is truncated to the first 200 characters.\n"
    },
    "allowComments": {
      "type": "string",
      "description": "When **true,** users can add comments to the documents in the envelope. For example, if a signer has a question about the text in the document, they can add a comment to the document."
    },
    "allowReassign": {
      "type": "string",
      "description": "When **true,** the recipient can redirect an envelope to a more appropriate recipient."
    },
    "emailSettings": {
      "$ref": "#/components/schemas/emailSettings"
    },
    "enableWetSign": {
      "type": "string",
      "description": "When **true,** the signer is allowed to print the document and sign it on paper."
    },
    "expireEnabled": {
      "type": "string",
      "description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
    },
    "favoritedByMe": {
      "type": "string",
      "description": ""
    },
    "is21CFRPart11": {
      "type": "string",
      "description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."
    },
    "recipientsUri": {
      "type": "string",
      "description": "Contains a URI for an endpoint that you can use to retrieve the recipients."
    },
    "transactionId": {
      "type": "string",
      "description": " Used to identify an envelope.\n\n The ID is a sender-generated value and is valid in the DocuSign system for 7 days.\n It is recommended that a transaction ID is used for offline\n signing to ensure that an envelope is not sent multiple times.\n The `transactionId` property can be used determine an envelope's\n status (i.e. was it created or not) in cases where the internet c\n onnection was lost before the envelope status was returned."
    },
    "useDisclosure": {
      "type": "string",
      "description": "When **true,** the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When **false,** the Electronic Record and Signature Disclosure is not shown to any envelope recipients. \n\nIf the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information."
    },
    "attachmentsUri": {
      "type": "string",
      "description": "Contains a URL for retrieving the attachments that are associated with the envelope."
    },
    "autoNavigation": {
      "type": "string",
      "description": "When **true,** autonavigation is set for the recipient.\n"
    },
    "certificateUri": {
      "type": "string",
      "description": "The URI for retrieving certificate information."
    },
    "documentBase64": {
      "type": "string",
      "description": "The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding."
    },
    "expireDateTime": {
      "type": "string",
      "description": "Not used. Use the\n[`expirations`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification_expirations)\nproperty in the [`notification`](/docs/esign-rest-api/reference/envelopes/envelopes/create/#definition__envelopedefinition_notification) object instead."
    },
    "lastModifiedBy": {
      "$ref": "#/components/schemas/userInfo"
    },
    "recipientsLock": {
      "type": "string",
      "description": "When **true,** prevents senders from changing, correcting, or deleting the recipient information for the envelope."
    },
    "statusDateTime": {
      "type": "string",
      "description": "The DateTime that the envelope changed status (i.e. was created or sent.)"
    },
    "voidedDateTime": {
      "type": "string",
      "description": "The date and time the envelope or template was voided."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the item was created."
    },
    "customFieldsUri": {
      "type": "string",
      "description": "The URI for retrieving custom fields."
    },
    "deletedDateTime": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "lockInformation": {
      "$ref": "#/components/schemas/EnvelopeLocks"
    },
    "notificationUri": {
      "type": "string",
      "description": "The URI for retrieving notifications."
    },
    "signingLocation": {
      "type": "string",
      "description": "Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`."
    },
    "allowViewHistory": {
      "type": "string",
      "description": "When **true,** recipients can view the history of the envelope."
    },
    "declinedDateTime": {
      "type": "string",
      "description": "The date and time the recipient declined the document. This property is read-only."
    },
    "envelopeLocation": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "envelopeMetadata": {
      "$ref": "#/components/schemas/envelopeMetadata"
    },
    "isAceGenTemplate": {
      "type": "string",
      "description": ""
    },
    "isDocGenTemplate": {
      "type": "string",
      "description": ""
    },
    "purgeRequestDate": {
      "type": "string",
      "description": "The date that a purge was requested."
    },
    "authoritativeCopy": {
      "type": "string",
      "description": "When **true,** marks all of the documents in the envelope as authoritative copies.\n\n**Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.**"
    },
    "completedDateTime": {
      "type": "string",
      "description": "Specifies the date and time this item was completed."
    },
    "copyRecipientData": {
      "type": "string",
      "description": ""
    },
    "deliveredDateTime": {
      "type": "string",
      "description": "The date and time that the envelope was delivered to the recipient. This property is read-only."
    },
    "envelopeDocuments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeDocument"
      },
      "description": "An array containing information about the documents that are included in the envelope."
    },
    "isDynamicEnvelope": {
      "type": "string",
      "description": "When **true,** indicates that the envelope is a dynamic envelope."
    },
    "passwordProtected": {
      "type": "string",
      "description": ""
    },
    "burnDefaultTabData": {
      "type": "string",
      "description": ""
    },
    "envelopeIdStamping": {
      "type": "string",
      "description": "When **true,** [Envelope ID Stamping](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=tfm1578456367923.html) is enabled.\nAfter a document or attachment is stamped with an Envelope ID,\nthe ID is seen by all recipients\nand becomes a permanent part of the document\nand cannot be removed."
    },
    "externalEnvelopeId": {
      "type": "string",
      "description": "May contain an external identifier for the envelope."
    },
    "hasFormDataChanged": {
      "type": "string",
      "description": "When **true,** indicates that the data collected through form fields on a document has changed."
    },
    "purgeCompletedDate": {
      "type": "string",
      "description": "The date that a purge was completed."
    },
    "envelopeAttachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/attachment"
      },
      "description": "An array of attachment objects that provide information about the attachments that are associated with the envelope."
    },
    "initialSentDateTime": {
      "type": "string",
      "description": "The date and time the envelope was initially sent."
    },
    "documentsCombinedUri": {
      "type": "string",
      "description": "The URI for retrieving all of the documents associated with the envelope as a single PDF file."
    },
    "lastModifiedDateTime": {
      "type": "string",
      "description": "The date and time that the item was last modified."
    },
    "signerCanSignOnMobile": {
      "type": "string",
      "description": "When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "statusChangedDateTime": {
      "type": "string",
      "description": "The data and time that the status changed."
    },
    "envelopeCustomMetadata": {
      "$ref": "#/components/schemas/envelopeCustomMetadata"
    },
    "accessControlListBase64": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "enforceSignerVisibility": {
      "type": "string",
      "description": "When **true,** signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by 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 by using this setting when an envelope is sent.\n\n**Note:** To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` **true.**\n\n[docviz]: /docs/esign-rest-api/reference/envelopes/envelopedocumentvisibility/"
    },
    "authoritativeCopyDefault": {
      "type": "string",
      "description": "The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set.\nIf this property is not set, each document defaults to the envelope's `authoritativeCopy`."
    },
    "autoMatchSpecifiedByUser": {
      "type": "string",
      "description": "When **true,** the template has been explicitly included in or excluded from auto-matching. The default is false.\nThis is a read-only property."
    },
    "disableResponsiveDocument": {
      "type": "string",
      "description": "When **true,** responsive documents are disabled for the envelope."
    },
    "isSignatureProviderEnvelope": {
      "type": "string",
      "description": "When **true,** indicates that the envelope is a signature-provided envelope."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "envelopeTemplate"
}

{
  "type": "object",
  "properties": {
    "folders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folder"
      },
      "description": "A list of folder objects."
    },
    "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."
    },
    "envelopeTemplates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeTemplate"
      },
      "description": "The list of requested templates."
    }
  },
  "description": "Information about templates.",
  "x-ms-summary": "Information about templates.",
  "x-ds-definition-name": "envelopeTemplateResults"
}

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Indicates the envelope status. Valid values are:\n\n* `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in.\n* `created`: The envelope is created as a draft. It can be modified and sent later.\n* `declined`: The envelope has been declined by the recipients.\n* `delivered`: The envelope has been delivered to the recipients.\n* `sent`: The envelope will be sent to the recipients after the envelope is created.\n* `signed`: The envelope has been signed by the recipients.\n* `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope.\n"
    },
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "transactionId": {
      "type": "string",
      "description": " Used to identify an envelope. The ID is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "envelopeTransactionStatus"
}

{
  "type": "object",
  "properties": {
    "toUser": {
      "$ref": "#/components/schemas/userInformation"
    },
    "enabled": {
      "type": "string",
      "description": "When **true,** the envelope transfer rule is active."
    },
    "fromUser": {
      "$ref": "#/components/schemas/userInformation"
    },
    "toFolder": {
      "$ref": "#/components/schemas/folder"
    },
    "eventType": {
      "type": "string",
      "description": "The type of envelope event that triggers the transfer. Valid values are:\n\n- `sent`\n- `before sent` \n- `completed`"
    },
    "fromGroup": {
      "$ref": "#/components/schemas/group"
    },
    "modifiedDate": {
      "type": "string",
      "description": "The UTC DateTime when the envelope transfer rule was last modified. This property is read-only."
    },
    "modifiedUser": {
      "$ref": "#/components/schemas/userInformation"
    },
    "envelopeTransferRuleId": {
      "type": "string",
      "description": "The ID of the envelope transfer rule. The system generates this ID when the rule is first created."
    },
    "carbonCopyOriginalOwner": {
      "type": "string",
      "description": "When **true,** the original owner is added as a carbon copy recipient after envelope transfer. The default value is **false.**"
    }
  },
  "description": "This object contains details about an envelope transfer rule.",
  "x-ms-summary": "This object contains details about an envelope transfer rule.",
  "x-ds-definition-name": "envelopeTransferRule"
}

{
  "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."
    },
    "envelopeTransferRules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeTransferRule"
      },
      "description": "Contains information about a specific envelope transfer rule."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "envelopeTransferRuleInformation"
}

{
  "type": "object",
  "properties": {
    "toUser": {
      "$ref": "#/components/schemas/userInformation"
    },
    "enabled": {
      "type": "string",
      "description": "When **true,** the envelope transfer rule is active."
    },
    "toFolder": {
      "$ref": "#/components/schemas/folder"
    },
    "eventType": {
      "type": "string",
      "description": "The type of envelope event that triggers the transfer. Valid values are:\n\n- `sent`\n- `before sent` \n- `completed`"
    },
    "fromUsers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userInformation"
      },
      "description": "Information about the user who triggers the transfer."
    },
    "fromGroups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/group"
      },
      "description": "Information about the group that triggers the transfer."
    },
    "modifiedDate": {
      "type": "string",
      "description": "The UTC DateTime when the envelope transfer rule was last modified. This property is read-only."
    },
    "modifiedUser": {
      "$ref": "#/components/schemas/userInformation"
    },
    "envelopeTransferRuleId": {
      "type": "string",
      "description": "The ID of the envelope transfer rule. The system generates this ID when the rule is first created."
    },
    "carbonCopyOriginalOwner": {
      "type": "string",
      "description": "When **true,** the original owner is added as a carbon copy recipient after envelope transfer. The default value is **false.**"
    }
  },
  "description": "This object contains details about the envelope transfer rule that you want to create.",
  "x-ms-summary": "This object contains details about the envelope transfer rule that you want to create.",
  "x-ds-definition-name": "envelopeTransferRuleRequest"
}

{
  "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": "envelopeUpdateSummary"
}

{
  "type": "object",
  "properties": {
    "folders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folder"
      },
      "description": "A list of folder objects."
    },
    "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. "
    },
    "envelopes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelope"
      },
      "description": "Array of envelope information."
    },
    "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."
    },
    "continuationToken": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "lastQueriedDateTime": {
      "type": "string",
      "description": "The last time that a query was performed."
    },
    "envelopeSearchSource": {
      "type": "string",
      "description": ""
    },
    "envelopeTransactionStatuses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeTransactionStatus"
      },
      "description": "Array of envelope statuses and transaction IDs in the result set."
    }
  },
  "description": "Result set for the Envelopes: listStatusChanges method",
  "x-ms-summary": "Result set for the Envelopes: listStatusChanges method",
  "x-ds-definition-name": "envelopesInformation"
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "A brief message describing the error condition."
    },
    "errorCode": {
      "type": "string",
      "description": "The code associated with the error condition."
    }
  },
  "description": "This object describes errors that occur. It is only valid for responses and ignored in requests.",
  "x-ms-summary": "This object describes errors that occur. It is only valid for responses and ignored in requests.",
  "x-ds-definition-name": "errorDetails"
}

{
  "type": "object",
  "properties": {
    "url": {
      "type": "string",
      "description": "The endpoint to which Connect should send webhook notification messages via an HTTPS POST request. The URL must start with `https`. The customer's web server must use an SSL/TLS certificate whose CA is in the Microsoft list of trusted CAs. Self-signed certificates are not acceptable, but you can use free certificates from Let's Encrypt.\n\nThe maximum length of this property is 4096 bytes.\n"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A comma-separated list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `urlToPublishTo` property.\n\nSet this property when you are using the [JSON SIM event model](https://raw.githubusercontent.com). If you are instead using any of [the legacy event message formats](https://raw.githubusercontent.com), set either the `envelopeEvents` property or the `recipientEvents` property.\n\nThe [possible event statuses](/platform/webhooks/connect/improved-json-sim-event-model/#eventreference) are:\n\n* `envelope-created`\n* `envelope-sent`\n* `envelope-resent`\n* `envelope-delivered`\n* `envelope-completed`\n* `envelope-declined`\n* `envelope-voided`\n* `recipient-authenticationfailed`\n* `recipient-autoresponded`\n* `recipient-declined`\n* `recipient-delivered`\n* `recipient-completed`\n* `recipient-sent`\n* `recipient-resent`\n* `template-created`\n* `template-modified`\n* `template-deleted`\n* `envelope-corrected`\n* `envelope-purge`\n* `envelope-deleted`\n* `envelope-discard`\n* `recipient-reassign`\n* `recipient-delegate`\n* `recipient-finish-later`\n* `click-agreed`\n* `click-declined`\n"
    },
    "eventData": {
      "$ref": "#/components/schemas/connectEventData"
    },
    "includeHMAC": {
      "type": "string",
      "description": "When **true,** HMAC headers will be included with the webhook notifications.\n\n**Note:** [HMAC must enabled](https://raw.githubusercontent.com) at the account level with [one or more HMAC secrets](https://raw.githubusercontent.com)."
    },
    "deliveryMode": {
      "type": "string",
      "description": ""
    },
    "includeOAuth": {
      "type": "string",
      "description": ""
    },
    "soapNameSpace": {
      "type": "string",
      "description": "The namespace of the SOAP interface.\n\nThe namespace value must be set if useSoapInterface is set to true."
    },
    "envelopeEvents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeEvent"
      },
      "description": "A list of envelope-level event statuses that will trigger Connect to send updates to the endpoint specified in the `url` property. \n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both."
    },
    "loggingEnabled": {
      "type": "string",
      "description": "When **true,** the webhook messages are logged. They can be viewed on the DocuSign Administration Web Tool in the Connect section. Logged messages can also be downloaded via the [ConnectEvents resource](https://raw.githubusercontent.com)."
    },
    "includeTimeZone": {
      "type": "string",
      "description": "When **true,** the envelope's time zone information is included in the webhook messages. "
    },
    "recipientEvents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientEvent"
      },
      "description": "A list of recipient event statuses that will trigger Connect to send updates to   the endpoint specified in the URL property.\n\nTo receive notifications, you must include either an `envelopeEvents` node or a `recipientEvents` node. You do not need to specify both."
    },
    "includeDocuments": {
      "type": "string",
      "description": "When **true,**\nthe Connect webhook messages\nwill include the envelope's PDF documents.\nIncluding the PDF documents\ngreatly increases the size of the notification messages.\nEnsure that your listener can handle\nincoming messages that are 25MB or larger."
    },
    "useSoapInterface": {
      "type": "string",
      "description": "When **true,** this tells the Connect service that the user's endpoint has implemented a SOAP interface. "
    },
    "integratorManaged": {
      "type": "string",
      "description": ""
    },
    "includeDocumentFields": {
      "type": "string",
      "description": "When **true,** the Document Fields associated with the envelope's documents are included in the notification messages. Document Fields are optional custom name-value pairs added to documents using the API. "
    },
    "requireAcknowledgment": {
      "type": "string",
      "description": "When **true,** the DocuSign Connect service checks that the message was received and retries on failures. "
    },
    "signMessageWithX509Cert": {
      "type": "string",
      "description": "When **true,** Mutual TLS will be enabled for notifications. Mutual TLS must be initiated by the listener (the customer's web server) during the TLS handshake protocol. "
    },
    "includeEnvelopeVoidReason": {
      "type": "string",
      "description": "When **true,** this tells the Connect Service to include the void reason, as entered by the person that voided the envelope, in the message. "
    },
    "includeCertificateWithSoap": {
      "type": "string",
      "description": "When **true,**\nthe Connect service will digitally sign\nthe data.\nThe signature will be included in the message."
    },
    "includeCertificateOfCompletion": {
      "type": "string",
      "description": "When **true,** the Connect Service includes the Certificate of Completion with completed envelopes. "
    },
    "includeSenderAccountAsCustomField": {
      "type": "string",
      "description": "When **true,** Connect will include the sender account as Custom Field in the data."
    }
  },
  "description": "Use this object to configure a [DocuSign Connect webhook](https://raw.githubusercontent.com).",
  "x-ms-summary": "Use this object to configure a [DocuSign Connect webhook](https://raw.githubusercontent.com).",
  "x-ds-definition-name": "eventNotification"
}

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Event status."
    },
    "eventTimestamp": {
      "type": "string",
      "description": "Date/time of the event."
    },
    "failureDescription": {
      "type": "string",
      "description": "Reason for failure, if the event failed."
    },
    "vendorFailureStatusCode": {
      "type": "string",
      "description": "Failure status code, if the event failed."
    }
  },
  "description": "Information about the result of an event.",
  "x-ms-summary": "Information about the result of an event.",
  "x-ds-definition-name": "eventResult"
}

{
  "type": "object",
  "properties": {
    "expireWarn": {
      "type": "string",
      "description": "An integer that specifying the number of days before the envelope expires that an expiration warning email is sent to the recipient. When 0 (zero), no warning email is sent."
    },
    "expireAfter": {
      "type": "string",
      "description": "An integer that sets the number of days the envelope is active. For this value to be used, `expireEnabled` must be explicitly set to **true.**"
    },
    "expireEnabled": {
      "type": "string",
      "description": "When **true,** the envelope expires in the number of days set by `expireAfter`. When **false** or not set, the envelope expires in the number of days specified by the [default expiration account setting](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=rra1583277381176.html)."
    }
  },
  "description": "A complex element that specifies the expiration settings for the envelope. When an envelope expires, it is voided and no longer available for signing. **Note:** there is a short delay between when the envelope expires and when it is voided.\n",
  "x-ms-summary": "A complex element that specifies the expiration settings for the envelope. When an envelope expires, it is voided and no longer available for signing. **Note:** there is a short delay between when the envelope expires and when it is voided.\n",
  "x-ds-definition-name": "expirations"
}

{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": ""
    },
    "errorCode": {
      "type": "string",
      "description": "A code associated with the error condition."
    },
    "authenticationUrl": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "externalDocServiceErrorDetails"
}

{
  "type": "object",
  "properties": {
    "boxnetEnabled": {
      "type": "string",
      "description": "The account is enabled to allow external documents to be attached from BoxNet."
    },
    "boxnetMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dropboxEnabled": {
      "type": "string",
      "description": "The account is enabled to allow external documents to be attached from DropBox."
    },
    "dropboxMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "oneDriveEnabled": {
      "type": "string",
      "description": "The account is enabled to allow external documents to be attached from OneDrive."
    },
    "oneDriveMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "salesforceEnabled": {
      "type": "string",
      "description": "The account is enabled to allow external documents to be attached from Salesforce."
    },
    "googleDriveEnabled": {
      "type": "string",
      "description": "The account is enabled to allow external documents to be attached from Google Drive."
    },
    "salesforceMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "googleDriveMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "description": "A complex object specifying the external document sources.",
  "x-ms-summary": "A complex object specifying the external document sources.",
  "x-ds-definition-name": "externalDocumentSources"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The storage provider's ID for the file or folder."
    },
    "img": {
      "type": "string",
      "description": "The file extension for a file.\n\n**Note:** If the item is a folder, this value is null."
    },
    "uri": {
      "type": "string",
      "description": "The URI for the file or folder."
    },
    "date": {
      "type": "string",
      "description": "The UTC date and time that the file or folder was last modified."
    },
    "name": {
      "type": "string",
      "description": "The full name of a file."
    },
    "size": {
      "type": "string",
      "description": "The size of the file. The file size limit varies based on the cloud storage provider."
    },
    "type": {
      "type": "string",
      "description": "The type of cloud storage item. Valid values are:\n\n- `file`\n- `folder`"
    },
    "ownerName": {
      "type": "string",
      "description": ""
    },
    "supported": {
      "type": "string",
      "description": "When **true,** DocuSign supports the file type for upload."
    },
    "hasCompositeTemplate": {
      "type": "string",
      "description": ""
    }
  },
  "description": "This object contains information about a file or folder in cloud storage.",
  "x-ms-summary": "This object contains information about a file or folder in cloud storage.",
  "x-ds-definition-name": "externalFile"
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique ID for the Salesforce object."
    },
    "name": {
      "type": "string",
      "description": ""
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/externalFile"
      },
      "description": "If the tab is a list, this represents the values that are possible for the tab."
    },
    "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. "
    },
    "errorDetails": {
      "$ref": "#/components/schemas/externalDocServiceErrorDetails"
    },
    "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": "externalFolder"
}

{
  "type": "object",
  "properties": {
    "kba": {
      "type": "string",
      "description": ""
    },
    "phone": {
      "type": "string",
      "description": ""
    },
    "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."
    },
    "idVerification": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "externalPrimaryAccountRecipientAuthRequirements"
}

{
  "type": "object",
  "properties": {
    "templateId": {
      "type": "string",
      "description": "The ID of the template."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "favoritedDate": {
      "type": "string",
      "description": "Time at which the template was marked as favorite."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "favoriteTemplatesContentItem"
}

{
  "type": "object",
  "properties": {
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "favoriteTemplates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/favoriteTemplatesContentItem"
      },
      "description": "The favorite templates acted upon by the call."
    },
    "templatesUpdatedCount": {
      "type": "integer",
      "format": "int32",
      "description": "The number of templates successfully updated by the call. This property is read-only."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "favoriteTemplatesInfo"
}

{
  "type": "object",
  "properties": {
    "availabilty": {
      "type": "string",
      "description": ""
    },
    "featureName": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "featureAvailableMetadata"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "seatFee": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "fixedFee": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "isActive": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "isEnabled": {
      "type": "string",
      "description": "When **true,** the feature set is actively enabled as part of the plan."
    },
    "envelopeFee": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "featureSetId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "is21CFRPart11": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "currencyFeatureSetPrices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/currencyFeatureSetPrice"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "This object provides details about a feature set, or add-on product that is associated with an account. It is reserved for DocuSign internal use only.",
  "x-ms-summary": "This object provides details about a feature set, or add-on product that is associated with an account. It is reserved for DocuSign internal use only.",
  "x-ds-definition-name": "featureSet"
}

{
  "type": "object",
  "properties": {
    "mimeType": {
      "type": "string",
      "description": "The mime-type of a file type listed in a fileTypes collection."
    },
    "fileExtension": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "fileType"
}

{
  "type": "object",
  "properties": {
    "fileTypes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/fileType"
      },
      "description": "A collection of file types."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "fileTypeList"
}

{
  "type": "object",
  "properties": {
    "order": {
      "type": "string",
      "description": "The order in which to sort the results.\n\nValid values are: \n\n\n* `asc`: Ascending order.\n* `desc`: Descending order. "
    },
    "status": {
      "type": "string",
      "description": "The status of the envelope. By default, all statuses are returned.\n\nFor details, see [Envelope Status Code Descriptions](https://raw.githubusercontent.com)."
    },
    "expires": {
      "type": "string",
      "description": "The number of days a sent envelope remains active before it expires."
    },
    "orderBy": {
      "type": "string",
      "description": "The field used to sort the results.\n\nExample: `Created`"
    },
    "folderIds": {
      "type": "string",
      "description": "Filters for any combination of folder IDs and folder types. The possible folder types are:\n\n- `awaiting_my_signature`\n- `completed`\n- `draft`\n- `drafts`\n- `expiring_soon`\n- `inbox`\n- `out_for_signature`\n- `recyclebin`\n- `sentitems`\n- `waiting_for_others`"
    },
    "isTemplate": {
      "type": "string",
      "description": "When **true,** the item is a template."
    },
    "searchText": {
      "type": "string",
      "description": "A free text search field for searching across the items in a folder. The search looks for the text that you enter in the recipient names and emails, envelope custom fields, sender name, and subject."
    },
    "toDateTime": {
      "type": "string",
      "description": "The UTC DateTime of the end of a date range. If no value is provided, the default search is to the current date."
    },
    "fromDateTime": {
      "type": "string",
      "description": "The UTC DateTime of the beginning of a date range. If no value is provided, the default search is the previous 30 days."
    },
    "searchTarget": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "actionRequired": {
      "type": "string",
      "description": "When **true,** the current user needs to take action on the item."
    }
  },
  "description": "Use this object to create a filtered view of the items in a folder.",
  "x-ms-summary": "Use this object to create a filtered view of the items in a folder.",
  "x-ds-definition-name": "filter"
}

{
  "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."
    },
    "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"
    },
    "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\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`.\n"
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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": "A tab that displays the recipient's first name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the first section as the first name.\n",
  "x-ms-summary": "A tab that displays the recipient's first name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the first section as the first name.\n",
  "x-ds-definition-name": "firstName"
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "The URI for the folder."
    },
    "name": {
      "type": "string",
      "description": "The name of the folder."
    },
    "type": {
      "type": "string",
      "description": "The type of folder. Possible values include:\n\n- `draft`\n- `inbox`\n- `normal` (a system-generated folder)\n- `recyclebin`\n- `sentitems`\n- `custom` (a custom folder created by a user)"
    },
    "owner": {
      "$ref": "#/components/schemas/userInfo"
    },
    "filter": {
      "$ref": "#/components/schemas/filter"
    },
    "folders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folder"
      },
      "description": "A collection of folder objects returned in a response."
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder."
    },
    "hasAccess": {
      "type": "string",
      "description": "When **true,** the current user has access to the folder."
    },
    "itemCount": {
      "type": "string",
      "description": "The number of items in the folder."
    },
    "folderItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folderItem_v2"
      },
      "description": "A list of envelopes and templates that the folder contains."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "hasSubFolders": {
      "type": "string",
      "description": "When **true,** the folder has subfolders."
    },
    "parentFolderId": {
      "type": "string",
      "description": "The ID of the parent folder, or the special value `root` for the root folder."
    },
    "subFolderCount": {
      "type": "string",
      "description": "The number of subfolders."
    },
    "parentFolderUri": {
      "type": "string",
      "description": "The URI of the parent folder."
    }
  },
  "description": "This object contains details about a folder.",
  "x-ms-summary": "This object contains details about a folder.",
  "x-ds-definition-name": "folder"
}

{
  "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. "
    },
    "totalRows": {
      "type": "string",
      "description": "The total number of items in the result."
    },
    "endPosition": {
      "type": "string",
      "description": "The last index position in the result set. "
    },
    "folderItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folderItem_v2"
      },
      "description": "A list of the envelopes in the specified folder or folders. "
    },
    "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. "
    },
    "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": "Results from a folder item request.",
  "x-ms-summary": "Results from a folder item request.",
  "x-ds-definition-name": "folderItemResponse"
}

{
  "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."
    },
    "subject": {
      "type": "string",
      "description": "The subject of the envelope."
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder."
    },
    "folderUri": {
      "type": "string",
      "description": "If the item is a subfolder, this is the URI for retrieving it."
    },
    "ownerName": {
      "type": "string",
      "description": "The name of the user who owns the folder."
    },
    "envelopeId": {
      "type": "string",
      "description": "If the item is an envelope, this is the ID of the envelope."
    },
    "recipients": {
      "$ref": "#/components/schemas/EnvelopeRecipients"
    },
    "senderName": {
      "type": "string",
      "description": "The sender's name."
    },
    "templateId": {
      "type": "string",
      "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. "
    },
    "envelopeUri": {
      "type": "string",
      "description": "If the item is an envelope, this is the URI for retrieving it."
    },
    "senderEmail": {
      "type": "string",
      "description": "The sender's email address."
    },
    "templateUri": {
      "type": "string",
      "description": "The URI for retrieving the template."
    },
    "senderUserId": {
      "type": "string",
      "description": "The sender's id."
    },
    "sentDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the envelope was sent. This property is read-only."
    },
    "is21CFRPart11": {
      "type": "string",
      "description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."
    },
    "recipientsUri": {
      "type": "string",
      "description": "Contains a URI for an endpoint that you can use to retrieve the recipients."
    },
    "senderCompany": {
      "type": "string",
      "description": "The name of the sender's company."
    },
    "expireDateTime": {
      "type": "string",
      "description": "The date and time the envelope is set to expire."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the item was created."
    },
    "completedDateTime": {
      "type": "string",
      "description": "If the item is an envelope, this is the UTC DateTime when the envelope was completed."
    },
    "lastModifiedDateTime": {
      "type": "string",
      "description": "The date and time that the item was last modified."
    }
  },
  "description": "Information about folder item results.",
  "x-ms-summary": "Information about folder item results.",
  "x-ds-definition-name": "folderItem_v2"
}

{
  "type": "object",
  "properties": {
    "folders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folder"
      },
      "description": "A list of folder objects."
    },
    "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. "
    },
    "envelopes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeSummary"
      },
      "description": ""
    },
    "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": "folderItemsResponse"
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "A URI containing the user ID."
    },
    "name": {
      "type": "string",
      "description": "The name of the folder."
    },
    "user": {
      "$ref": "#/components/schemas/userInfo"
    },
    "owner": {
      "$ref": "#/components/schemas/userInfo"
    },
    "shared": {
      "type": "string",
      "description": "Indicates how the folder is shared. Valid values are:\n\n- `not_shared`\n- `shared_to`"
    },
    "folderId": {
      "type": "string",
      "description": "The ID of the folder."
    },
    "sharedUsers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userSharedItem"
      },
      "description": "A list of users that share the folder."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "sharedGroups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/memberGroupSharedItem"
      },
      "description": "A list of groups that share the folder."
    },
    "parentFolderId": {
      "type": "string",
      "description": "The ID of the parent folder."
    },
    "parentFolderUri": {
      "type": "string",
      "description": "The URI for the parent folder."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "folderSharedItem"
}

{
  "type": "object",
  "properties": {
    "folders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folder"
      },
      "description": "Not used."
    },
    "envelopeIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of envelope ID GUIDs."
    },
    "fromFolderId": {
      "type": "string",
      "description": " The ID of the folder that the envelope is being moved from."
    }
  },
  "description": "Information for a folder request.",
  "x-ms-summary": "Information for a folder request.",
  "x-ds-definition-name": "foldersRequest"
}

{
  "type": "object",
  "properties": {
    "folders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folder"
      },
      "description": "A list of folder objects."
    },
    "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. "
    },
    "envelopes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeSummary"
      },
      "description": ""
    },
    "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": "foldersResponse"
}

{
  "type": "object",
  "properties": {
    "forgottenPasswordAnswer1": {
      "type": "string",
      "description": "The answer to the first forgotten password challenge question."
    },
    "forgottenPasswordAnswer2": {
      "type": "string",
      "description": "The answer to the second forgotten password challenge question."
    },
    "forgottenPasswordAnswer3": {
      "type": "string",
      "description": "The answer to the third forgotten password challenge question."
    },
    "forgottenPasswordAnswer4": {
      "type": "string",
      "description": "The answer to the fourth forgotten password challenge question."
    },
    "forgottenPasswordQuestion1": {
      "type": "string",
      "description": "The first challenge question presented to a user who has forgotten their password."
    },
    "forgottenPasswordQuestion2": {
      "type": "string",
      "description": "The second challenge question presented to a user who has forgotten their password."
    },
    "forgottenPasswordQuestion3": {
      "type": "string",
      "description": "The third challenge question presented to a user who has forgotten their password."
    },
    "forgottenPasswordQuestion4": {
      "type": "string",
      "description": "The fourth challenge question presented to a user who has forgotten their password."
    }
  },
  "description": "A complex element that has up to four Question/Answer pairs for forgotten password information.",
  "x-ms-summary": "A complex element that has up to four Question/Answer pairs for forgotten password information.",
  "x-ds-definition-name": "forgottenPasswordInformation"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the form field."
    },
    "value": {
      "type": "string",
      "description": "The current value associated with the form field."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "originalValue": {
      "type": "string",
      "description": "The initial value associated with the form field."
    },
    "numericalValue": {
      "type": "string",
      "description": ""
    },
    "listSelectedValue": {
      "type": "string",
      "description": "The selected value in a list."
    },
    "originalNumericalValue": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "formDataItem"
}

{
  "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."
    },
    "hidden": {
      "type": "string",
      "description": "If this is a regular formula (no `paymentDetails` property is present):\n\n* **true:** The tab is hidden.\n* **false:** The tab is shown.\n\nIf the formula is payment item (a `paymentDetails` property is present):\n\n* **true:** The tab is displayed as a payment.\n* **false:** The tab is displayed as a regular formula.\n"
    },
    "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 (+35, -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 (+35, -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`.\n"
    },
    "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"
    },
    "hiddenMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "italicMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "lockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "paymentDetails": {
      "$ref": "#/components/schemas/paymentDetails"
    },
    "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"
    },
    "roundDecimalPlaces": {
      "type": "string",
      "description": "The number of decimal places to round to."
    },
    "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"
    },
    "isPaymentAmountMetadata": {
      "$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"
    },
    "roundDecimalPlacesMetadata": {
      "$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": "The value of a formula tab is calculated\nfrom the values of other\nnumber or date tabs in the document.\nWhen the recipient completes the underlying fields,\nthe formula tab calculates and displays the result.\n\nThe `formula` property of the tab\ncontains the references\nto the underlying tabs.\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nIf a formula tab contains\na `paymentDetails` property,\nthe tab is considered a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html\n[paymentguide]:     https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html\n",
  "x-ms-summary": "The value of a formula tab is calculated\nfrom the values of other\nnumber or date tabs in the document.\nWhen the recipient completes the underlying fields,\nthe formula tab calculates and displays the result.\n\nThe `formula` property of the tab\ncontains the references\nto the underlying tabs.\nSee [Calculated Fields][calculatedfields]\nin the DocuSign Support Center\nto learn more about formulas.\n\nIf a formula tab contains\na `paymentDetails` property,\nthe tab is considered a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html\n[paymentguide]:     https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html\n",
  "x-ds-definition-name": "formulaTab"
}

{
  "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."
    },
    "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"
    },
    "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\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`.\n"
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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": "A tab that displays the recipient's full name.\n",
  "x-ms-summary": "A tab that displays the recipient's full name.\n",
  "x-ds-definition-name": "fullName"
}

{
  "type": "object",
  "properties": {
    "fillColor": {
      "type": "string",
      "description": "The fill color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value)."
    },
    "lineColor": {
      "type": "string",
      "description": "The line color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value)."
    },
    "lineWeight": {
      "type": "string",
      "description": "The line weight or thickness to use for the overlay."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "graphicsContext"
}

{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userInfo"
      },
      "description": "A list of the users in the group. This property is not used by [Groups: list](https://raw.githubusercontent.com). To get a list of users see [GroupUsers: list](https://raw.githubusercontent.com)\n"
    },
    "groupId": {
      "type": "string",
      "description": "The DocuSign group ID for the group.\nThis is a read-only property."
    },
    "dsGroupId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "groupName": {
      "type": "string",
      "description": "The name of the group."
    },
    "groupType": {
      "type": "string",
      "description": "The group type."
    },
    "usersCount": {
      "type": "string",
      "description": "The total number of users in the group."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "permissionProfileId": {
      "type": "string",
      "description": "The ID of the permission profile associated with the group.\n\nUse [AccountPermissionProfiles: list](https://raw.githubusercontent.com)\nto get a list of permission profiles and their IDs."
    }
  },
  "description": "This object contains information about a group.",
  "x-ms-summary": "This object contains information about a group.",
  "x-ds-definition-name": "group"
}

{
  "type": "object",
  "properties": {
    "groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/group"
      },
      "description": "A collection group objects containing information about the groups."
    },
    "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": "This object is used for both requests and responses. Some properties (such as `endPosition`) only apply to the response of [Groups: list](https://raw.githubusercontent.com).\n",
  "x-ms-summary": "This object is used for both requests and responses. Some properties (such as `endPosition`) only apply to the response of [Groups: list](https://raw.githubusercontent.com).\n",
  "x-ds-definition-name": "groupInformation"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the signature."
    },
    "authSteps": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/idCheckSecurityStep"
      },
      "description": "A list of ID check security steps, each specifying an authorization type."
    },
    "isDefault": {
      "type": "string",
      "description": "Boolean that specifies whether the signature is the default signature for the user."
    }
  },
  "description": "A complex object specifying ID check configuration.",
  "x-ms-summary": "A complex object specifying ID check configuration.",
  "x-ds-definition-name": "idCheckConfiguration"
}

{
  "type": "object",
  "properties": {
    "dobInformationInput": {
      "$ref": "#/components/schemas/dobInformationInput"
    },
    "ssn4InformationInput": {
      "$ref": "#/components/schemas/ssn4InformationInput"
    },
    "ssn9InformationInput": {
      "$ref": "#/components/schemas/ssn9InformationInput"
    },
    "addressInformationInput": {
      "$ref": "#/components/schemas/addressInformationInput"
    }
  },
  "description": "A complex element that contains input information related to a recipient ID check.",
  "x-ms-summary": "A complex element that contains input information related to a recipient ID check.",
  "x-ds-definition-name": "idCheckInformationInput"
}

{
  "type": "object",
  "properties": {
    "authType": {
      "type": "string",
      "description": "Type of authorization used for the security check."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "idCheckSecurityStep"
}

{
  "type": "object",
  "properties": {
    "proofBaseURI": {
      "type": "string",
      "description": ""
    },
    "resourceToken": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "idEvidenceResourceToken"
}

{
  "type": "object",
  "properties": {
    "viewLink": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "idEvidenceViewLink"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The signer's full legal name in an eNotary flow.\n\nRequired when `inPersonSigningType` is `notary`.\nFor a regular in-person-signer flow, use `signerName` instead.\n\nMaximum Length: 100 characters.\n"
    },
    "note": {
      "type": "string",
      "description": "A note sent to the in-person signer in the signing email.\nThis note is visible only to this recipient.\n\nMaximum Length: 1000 characters.\n"
    },
    "tabs": {
      "$ref": "#/components/schemas/EnvelopeRecipientTabs"
    },
    "email": {
      "type": "string",
      "description": "The signer's email address in an eNotary flow.\n\nUse only when `inPersonSigningType` is `notary`.\nFor regular in-person-signer flow, use `signerEmail` instead.\n"
    },
    "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."
    },
    "hostName": {
      "type": "string",
      "description": "The name of the signing host.\nThis is the DocuSign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n"
    },
    "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."
    },
    "hostEmail": {
      "type": "string",
      "description": "The email address of the signing host.\nThis is the DocuSign user that is hosting the in-person signing session.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `email` instead.\n\nMaximum Length: 100 characters.\n"
    },
    "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."
    },
    "notaryHost": {
      "$ref": "#/components/schemas/notaryHost"
    },
    "signerName": {
      "type": "string",
      "description": "Required. The full legal name of a signer for the envelope. \n\nMaximum Length: 100 characters.\n\n\n"
    },
    "statusCode": {
      "type": "string",
      "description": "The code associated with the recipient's status. This property is read-only."
    },
    "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"
    },
    "signerEmail": {
      "type": "string",
      "description": "The in-person signer's email address.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `email` instead.\n\nMaximum Length: 100 characters.\n\n"
    },
    "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. \n\nIf this number is greater than `0` for a signing group, only the user who previously completed may sign again."
    },
    "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."
    },
    "signerLastName": {
      "type": "string",
      "description": "The signer's last name."
    },
    "signingGroupId": {
      "type": "string",
      "description": "Not applicable. You cannot use a signing group for an in-person signer."
    },
    "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. "
    },
    "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. "
    },
    "signerFirstName": {
      "type": "string",
      "description": "The signer's first name."
    },
    "declinedDateTime": {
      "type": "string",
      "description": "The date and time the recipient declined the document. This property is read-only."
    },
    "defaultRecipient": {
      "type": "string",
      "description": "When **true,**\nthis is the default recipient for the envelope.\nThis option is used when creating an envelope from a template.\n"
    },
    "designatorIdGuid": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "hostNameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "signingGroupName": {
      "type": "string",
      "description": "Not applicable."
    },
    "templateRequired": {
      "type": "string",
      "description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
    },
    "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"
    },
    "hostEmailMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "offlineAttributes": {
      "$ref": "#/components/schemas/offlineAttributes"
    },
    "signingGroupUsers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userInfo"
      },
      "description": "Not applicable."
    },
    "smsAuthentication": {
      "$ref": "#/components/schemas/recipientSMSAuthentication"
    },
    "accessCodeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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)."
    },
    "signerNameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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": ""
    },
    "inPersonSigningType": {
      "type": "string",
      "description": "Specifies whether the envelope uses the eNotary feature.\nValid values:\n\n* `inPersonSigner`: The envelope uses the normal in-person signing flow.\n* `notary`: The envelope uses the eNotary in-person signing flow.\n"
    },
    "phoneAuthentication": {
      "$ref": "#/components/schemas/recipientPhoneAuthentication"
    },
    "signerEmailMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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"
    },
    "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."
    },
    "signerLastNameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "signingGroupIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "idCheckInformationInput": {
      "$ref": "#/components/schemas/idCheckInformationInput"
    },
    "requireIdLookupMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "signerFirstNameMetadata": {
      "$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"
    },
    "inPersonSigningTypeMetadata": {
      "$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)"
    },
    "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": "Contains information about an in-person recipient. This is a DocuSign user,\nacting as a Signing Host,\nwho is in the same physical location as the signer.\nTo learn about the fields used\nfor the eNotary feature,\nsee the [EnvelopeRecipients resource][resource].\n\n[resource]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#in-person-signer-recipient\n",
  "x-ms-summary": "Contains information about an in-person recipient. This is a DocuSign user,\nacting as a Signing Host,\nwho is in the same physical location as the signer.\nTo learn about the fields used\nfor the eNotary feature,\nsee the [EnvelopeRecipients resource][resource].\n\n[resource]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/#in-person-signer-recipient\n",
  "x-ds-definition-name": "inPersonSigner"
}

{
  "type": "object",
  "properties": {
    "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."
    },
    "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."
    },
    "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"
    },
    "optional": {
      "type": "string",
      "description": "When **true,** the recipient does not need to complete this tab to complete 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."
    },
    "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."
    },
    "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 (+2, -7)\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 (+2, -7)\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`."
    },
    "scaleValue": {
      "type": "string",
      "description": " Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size."
    },
    "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."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "handDrawRequired": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "optionalMetadata": {
      "$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."
    },
    "formOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "xPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "yPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "documentIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "pageNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "scaleValueMetadata": {
      "$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": "A tab that allows the recipient to initial the document. May\nbe optional.\n",
  "x-ms-summary": "A tab that allows the recipient to initial the document. May\nbe optional.\n",
  "x-ds-definition-name": "initialHere"
}

{
  "type": "object",
  "properties": {
    "envelope": {
      "$ref": "#/components/schemas/envelope"
    },
    "sequence": {
      "type": "string",
      "description": "Specifies the order in which templates are overlaid."
    },
    "documents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/document"
      },
      "description": "A complex element that contains details about the documents associated with the envelope."
    },
    "recipients": {
      "$ref": "#/components/schemas/EnvelopeRecipients"
    },
    "customFields": {
      "$ref": "#/components/schemas/AccountCustomFields"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "inlineTemplate"
}

{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/connectUserInfo"
      },
      "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": "integratedConnectUserInfoList"
}

{
  "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."
    },
    "allUsersSelected": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "integratedUserInfoList"
}

{
  "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"
    },
    "email": {
      "type": "string",
      "description": "The recipient's email address. Notification of the document to sign is sent to this email address. \n\nMaximum length: 100 characters. "
    },
    "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`.\n"
    },
    "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."
    },
    "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."
    },
    "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."
    },
    "phoneNumber": {
      "$ref": "#/components/schemas/recipientPhoneNumber"
    },
    "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"
    },
    "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."
    },
    "totalTabCount": {
      "type": "string",
      "description": "The total number of tabs in the documents. This property is read-only."
    },
    "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."
    },
    "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. "
    },
    "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. "
    },
    "declinedDateTime": {
      "type": "string",
      "description": "The date and time the recipient declined the document. This property is read-only."
    },
    "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."
    },
    "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"
    },
    "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.**"
    },
    "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"
    },
    "recipientTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "socialAuthentications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/socialAuthentication"
      },
      "description": "Deprecated."
    },
    "deliveryMethodMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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"
    },
    "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."
    },
    "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."
    },
    "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": "Contains information about an intermediary recipient. An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added.",
  "x-ms-summary": "Contains information about an intermediary recipient. An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added.",
  "x-ds-definition-name": "intermediary"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the jurisdiction. Typically the state name."
    },
    "county": {
      "type": "string",
      "description": "The county of the jurisdiction."
    },
    "enabled": {
      "type": "string",
      "description": "When **true,** this jurisdiction is enabled."
    },
    "countyInSeal": {
      "type": "string",
      "description": "When **true,** the county name appears in the seal."
    },
    "jurisdictionId": {
      "type": "string",
      "description": "The ID of the jurisdiction.\nThe following jurisdictions\nare supported:\n\n-  `5 - California`\n-  `6 - Colorado`\n-  `9 - Florida`\n-  `10 - Georgia`\n-  `12 - Idaho`\n-  `13 - Illinois`\n-  `14 - Indiana`\n-  `15 - Iowa`\n-  `17 - Kentucky`\n-  `23 - Minnesota`\n-  `25 - Missouri`\n-  `30 - New Jersey`\n-  `32 - New York`\n-  `33 - North Carolina`\n-  `35 - Ohio`\n-  `37 - Oregon`\n-  `38 - Pennsylvania`\n-  `40 - South Carolina`\n-  `43 - Texas`\n-  `44 - Utah`\n-  `47 - Washington`\n-  `48 - West Virginia`\n-  `49 - Wisconsin`\n-  `62 - Florida Commissioner of Deeds`\n"
    },
    "stateNameInSeal": {
      "type": "string",
      "description": "When **true,** the name of the state appears in the seal."
    },
    "commissionIdInSeal": {
      "type": "string",
      "description": "When **true,** the notary's `comissionId` appears in the seal."
    },
    "notaryPublicInSeal": {
      "type": "string",
      "description": "When **true,** the name of the notary appears in the seal."
    },
    "allowUserUploadedSeal": {
      "type": "string",
      "description": "When **true,** the seal can be uploaded by the user."
    },
    "allowSystemCreatedSeal": {
      "type": "string",
      "description": "When **true,** the seal can be generated by the platform."
    }
  },
  "description": "Describes the jurisdiction of a notary.\nThis is read-only object.",
  "x-ms-summary": "Describes the jurisdiction of a notary.\nThis is read-only object.",
  "x-ds-definition-name": "jurisdiction"
}

{
  "type": "object",
  "properties": {
    "jurisdictionId": {
      "type": "string",
      "description": "The ID of the jurisdiction.\nThe following jurisdictions\nare supported:\n\n-  `5 - California`\n-  `6 - Colorado`\n-  `9 - Florida`\n-  `10 - Georgia`\n-  `12 - Idaho`\n-  `13 - Illinois`\n-  `14 - Indiana`\n-  `15 - Iowa`\n-  `17 - Kentucky`\n-  `23 - Minnesota`\n-  `25 - Missouri`\n-  `30 - New Jersey`\n-  `32 - New York`\n-  `33 - North Carolina`\n-  `35 - Ohio`\n-  `37 - Oregon`\n-  `38 - Pennsylvania`\n-  `40 - South Carolina`\n-  `43 - Texas`\n-  `44 - Utah`\n-  `47 - Washington`\n-  `48 - West Virginia`\n-  `49 - Wisconsin`\n-  `62 - Florida Commissioner of Deeds`\n"
    },
    "authorizedForRon": {
      "type": "string",
      "description": ""
    },
    "jurisdictionName": {
      "type": "string",
      "description": ""
    },
    "authorizedForIPen": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "jurisdictionSummary"
}

{
  "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."
    },
    "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"
    },
    "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\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`.\n"
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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": "A tab that displays the recipient's last name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the last section as the last name.\n",
  "x-ms-summary": "A tab that displays the recipient's last name. This tab\ntakes the recipient's name as entered in the recipient\ninformation, splits it into sections based on spaces and\nuses the last section as the last name.\n",
  "x-ds-definition-name": "lastName"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": ""
    },
    "linkId": {
      "type": "string",
      "description": ""
    },
    "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 to be sent later."
    },
    "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."
    },
    "accountName": {
      "type": "string",
      "description": "The name on the account."
    },
    "configurationId": {
      "type": "string",
      "description": ""
    },
    "pdfFieldHandlingOption": {
      "type": "string",
      "description": ""
    },
    "recipientAuthRequirements": {
      "$ref": "#/components/schemas/externalPrimaryAccountRecipientAuthRequirements"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "linkedExternalPrimaryAccount"
}

{
  "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."
    },
    "value": {
      "type": "string",
      "description": "The value to use when the item is selected."
    },
    "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": ""
    },
    "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."
    },
    "listItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/listItem"
      },
      "description": "The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four]\n\nMaximum Length of listItems:  2048 characters.\nMaximum Length of items in the list: 100 characters. \n"
    },
    "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`.\n"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "listSelectedValue": {
      "type": "string",
      "description": "The value in the list that is selected by default."
    },
    "shareToRecipients": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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."
    },
    "listSelectedValueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "shareToRecipientsMetadata": {
      "$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."
    },
    "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": "This tab offers a list of options to choose from.\nThe `listItems`\nproperty contains a list of\n[`listItem`](https://raw.githubusercontent.com)\nobjects to specify the selectable options.\n",
  "x-ms-summary": "This tab offers a list of options to choose from.\nThe `listItems`\nproperty contains a list of\n[`listItem`](https://raw.githubusercontent.com)\nobjects to specify the selectable options.\n",
  "x-ds-definition-name": "list"
}

{
  "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. This is the value that the user who creates or sends the envelope selects from the list."
    },
    "fieldId": {
      "type": "string",
      "description": "The ID of the custom field."
    },
    "required": {
      "type": "string",
      "description": "When **true,** senders are required to select an option from the list before they can send the envelope."
    },
    "listItems": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of strings that represents the options in a list.\n\nMaximum length: 2048 characters, but each individual option string can only be a maximum of 100 characters."
    },
    "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 list custom field from which envelope creators and senders can select custom data.",
  "x-ms-summary": "This object represents a list custom field from which envelope creators and senders can select custom data.",
  "x-ds-definition-name": "listCustomField"
}

{
  "type": "object",
  "properties": {
    "text": {
      "type": "string",
      "description": "Specifies the text that is shown in the dropdown list. "
    },
    "value": {
      "type": "string",
      "description": "Specifies the value that is used when the list item is selected."
    },
    "selected": {
      "type": "string",
      "description": "When **true,** indicates that this item is the default selection shown to a signer. \n\nOnly one selection can be set as the default."
    },
    "textMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "valueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "selectedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "One of the selectable items\nin the `listItems` property\nof a [`list`](https://raw.githubusercontent.com) tab.",
  "x-ms-summary": "One of the selectable items\nin the `listItems` property\nof a [`list`](https://raw.githubusercontent.com) tab.",
  "x-ds-definition-name": "listItem"
}

{
  "type": "object",
  "properties": {
    "timeZone": {
      "type": "string",
      "description": "Specifies the time zone. Valid values:\n\n- `TZ_01_AfghanistanStandardTime`\n- `TZ_02_AlaskanStandardTime`\n- `TZ_03_ArabStandardTime`\n- `TZ_04_ArabianStandardTime`\n- `TZ_05_ArabicStandardTime`\n- `TZ_06_ArgentinaStandardTime`\n- `TZ_07_AtlanticStandardTime`\n- `TZ_08_AUS_CentralStandardTime`\n- `TZ_09_AUS_EasternStandardTime`\n- `TZ_10_AzerbaijanStandardTime`\n- `TZ_11_AzoresStandardTime`\n- `TZ_12_BangladeshStandardTime`\n- `TZ_13_CanadaCentralStandardTime`\n- `TZ_14_CapeVerdeStandardTime`\n- `TZ_15_CaucasusStandardTime`\n- `TZ_16_CentralAustraliaStandardTime`\n- `TZ_17_CentralAmericaStandardTime`\n- `TZ_18_CentralAsiaStandardTime`\n- `TZ_19_CentralBrazilianStandardTime`\n- `TZ_20_CentralEuropeStandardTime`\n- `TZ_21_CentralEuropeanStandardTime`\n- `TZ_22_CentralPacificStandardTime`\n- `TZ_23_CentralStandardTime`\n- `TZ_24_CentralStandardTimeMexico`\n- `TZ_25_ChinaStandardTime`\n- `TZ_26_DatelineStandardTime`\n- `TZ_27_E_AfricaStandardTime`\n- `TZ_28_E_AustraliaStandardTime`\n- `TZ_29_E_EuropeStandardTime`\n- `TZ_30_E_SouthAmericaStandardTime`\n- `TZ_31_EasternStandardTime`\n- `TZ_32_EgyptStandardTime`\n- `TZ_33_EkaterinburgStandardTime`\n- `TZ_34_FijiStandardTime`\n- `TZ_35_FLE_StandardTime`\n- `TZ_36_GeorgianStandardTime`\n- `TZ_37_GMT_StandardTime`\n- `TZ_38_GreenlandStandardTime`\n- `TZ_39_GreenwichStandardTime`\n- `TZ_40_GTB_StandardTime`\n- `TZ_41_HawaiianStandardTime`\n- `TZ_42_IndiaStandardTime`\n- `TZ_43_IranStandardTime`\n- `TZ_44_IsraelStandardTime`\n- `TZ_45_JordanStandardTime`\n- `TZ_46_KaliningradStandardTime`\n- `TZ_47_KamchatkaStandardTime`\n- `TZ_48_KoreaStandardTime`\n- `TZ_49_MagadanStandardTime`\n- `TZ_50_MauritiusStandardTime`\n- `TZ_51_MidAtlanticStandardTime`\n- `TZ_52_MiddleEastStandardTime`\n- `TZ_53_MontevideoStandardTime`\n- `TZ_54_MoroccoStandardTime`\n- `TZ_55_MountainStandardTime`\n- `TZ_56_MountainStandardTimeMMexico`\n- `TZ_57_MyanmarStandardTime`\n- `TZ_58_N_CentralAsiaStandardTime`\n- `TZ_59_NamibiaStandardTime`\n- `TZ_60_NepalStandardTime`\n- `TZ_61_NewZealandStandardTime`\n- `TZ_62_NewfoundlandStandardTime`\n- `TZ_63_NorthAsiaEastStandardTime`\n- `TZ_64_NorthAsiaStandardTime`\n- `TZ_65_PacificSAStandardTime`\n- `TZ_66_PacificStandardTime`\n- `TZ_67_PacificStandardTimeMexico`\n- `TZ_68_PakistanStandardTime`\n- `TZ_69_ParaguayStandardTime`\n- `TZ_70_RomanceStandardTime`\n- `TZ_71_RussianStandardTime`\n- `TZ_72_SAEasternStandardTime`\n- `TZ_73_SAPacificStandardTime`\n- `TZ_74_SAWesternStandardTime`\n- `TZ_75_SamoaStandardTime`\n- `TZ_76_SE_AsiaStandardTime`\n- `TZ_77_SingaporeStandardTime`\n- `TZ_78_SouthAfricaStandardTime`\n- `TZ_79_SriLankaStandardTime`\n- `TZ_80_SyriaStandardTime`\n- `TZ_81_TaipeiStandardTime`\n- `TZ_82_TasmaniaStandardTime`\n- `TZ_83_TokyoStandardTime`\n- `TZ_84_TongaStandardTime`\n- `TZ_85_TurkeyStandardTime`\n- `TZ_86_UlaanbaatarStandardTime`\n- `TZ_87_US_EasternStandardTime`\n- `TZ_88_USMountainStandardTime`\n- `TZ_89_VenezuelaStandardTime`\n- `TZ_90_VladivostokStandardTime`\n- `TZ_91_W_AustraliaStandardTime`\n- `TZ_92_W_CentralAfricaStandardTime`\n- `TZ_93_W_EuropeStandardTime`\n- `TZ_94_WestAsiaStandardTime`\n- `TZ_95_WestPacificStandardTime`\n- `TZ_96_YakutskStandardTime`\n"
    },
    "dateFormat": {
      "type": "string",
      "description": "Specifies the date format. Valid values:\n\n- `default` <br> used the UI's \n- `longformat` <br> use the UI's long format\n- `dd_mm_yy` <br> dd-MM-yy\n- `dd_mmm_yy` <br> dd-MMM-yy\n- `dd_mm_yyyy` <br> dd-MM-yyyy\n- `dd_mmm_yyyy` <br> dd-MMM-yyyy\n- `ddmmmmyyyy` <br> dd MMMM yyyy\n- `ddmmyyyy` <br> dd/MM/yyyy\n- `ddmmyyyy_de` <br> dd.MM.yyyy\n- `dmyyyy` <br> d/M/yyyy\n- `d_m_yyyy` <br> d-M-yyyy\n- `mmmd_yyyy` <br> MMM d, yyyy\n- `mmm_dd_yyyy` <br> MMM-dd-yyyy\n- `mmmmd_yyyy` <br> MMMM d, yyyy\n- `mm_dd_yyyy` <br> MM-dd-yyyy\n- `mdyyyy` <br> M/d/yyyy\n- `yyyy_mmm_dd` <br> yyyy-MMM-dd\n- `yyyy_mm_dd` <br> yyyy-MM-dd\n- `yyyymmdd` <br> yyyy/MM/dd\n- `yyyymd` <br> yyyy/M/d\n- `custom` <br> Customer set own value\n- `mmddyyyy` <br> MM/dd/yyyy\n- `mmddyy` <br> MM/dd/yy\n- `yyyy_mmmm_d` <br> yyyy MMMM d\n"
    },
    "nameFormat": {
      "type": "string",
      "description": "Describes how names are displayed. Valid values:\n\n- `first_middle_last`<br>William Henry Gates\n- `full`<br>Mr William Henry Gates III\n- `last_first`<br>Gates William\n- `lastfirst`<br>GatesWilliam\n- `last_first_cjk`<br>Gates William only with CJK characters\n- `lastfirst_cjk`<br>GatesWilliam only with CJK characters\n\n<!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->\n"
    },
    "timeFormat": {
      "type": "string",
      "description": "Specifies the time format. Valid values:\n\n- `none`      <br>None\n- `hh_mm`     <br>hh:mm \n- `hhmm`      <br>HH:mm\n- `hhmmss`    <br>HH:mm:ss\n- `hhmmsstt`  <br>HH:mm:ss tt\n- `hhmmtt`    <br> HH:mm tt\n- `hmm`       <br>h:mm\n- `hmmss`     <br>h:mm:ss\n- `hmmsstt`   <br>h:mm:ss tt\n- `hmmtt`     <br>h:mm tt\n- `custom`    <br>Customer-set format\n\n<!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->"
    },
    "allowRegion": {
      "type": "string",
      "description": ""
    },
    "cultureName": {
      "type": "string",
      "description": "The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code."
    },
    "calendarType": {
      "type": "string",
      "description": "Specifies the type of calendar. Valid values:\n\n- `gregorian`\n- `japanese`\n- `buddhist`\n"
    },
    "currencyCode": {
      "type": "string",
      "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.\n"
    },
    "addressFormat": {
      "type": "string",
      "description": "Specifies the address format. Valid values:\n\n- `en_us`\n- `ja_jp`\n- `zh_cn_tw`\n"
    },
    "initialFormat": {
      "type": "string",
      "description": "When a user is required to enter their initials,\nthis property\nspecifies how initials are rendered.\nThe examples show the\ninitials for \"William Henry Gates\".\n\n\n- `first1last1`<br> \"WG\"\n- `last2`<br> \"GA\"\n- `first2`<br> \"WI\"\n- `last2_cjk`<br> first two characters from last name in CJK characters.\n\n<!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->\n"
    },
    "signDateFormat": {
      "type": "string",
      "description": "The format for the signature date. Valid values are:\n\n- `d/M/yyyy`\n- `dd-MM-yy`\n- `dd-MMM-yy`\n- `dd-MM-yyyy`\n- `dd.MM.yyyy`\n- `dd-MMM-yyyy`\n- `dd MMMM yyyy`\n- `M/d/yyyy`\n- `MM-dd-yyyy`\n- `MM/dd/yyyy`\n- `MM/dd/yy`\n- `MMM-dd-yyyy`\n- `MMM d, yyyy`\n- `MMMM d, yyyy`\n- `yyyy-MM-dd`\n- `yyyy-MMM-dd`\n- `yyyy/MM/dd`\n- `yyyy MMMM d`\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "signTimeFormat": {
      "type": "string",
      "description": "The format for the signature time. Valid values are:\n\n- `none`\n- `HH:mm`\n- `h:mm`\n- `HH:mm:ss`\n- `h:mm:ss`\n"
    },
    "customDateFormat": {
      "type": "string",
      "description": ""
    },
    "customTimeFormat": {
      "type": "string",
      "description": ""
    },
    "timeZoneMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "effectiveTimeZone": {
      "type": "string",
      "description": ""
    },
    "dateFormatMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "nameFormatMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "timeFormatMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "cultureNameMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "effectiveDateFormat": {
      "type": "string",
      "description": ""
    },
    "effectiveNameFormat": {
      "type": "string",
      "description": ""
    },
    "effectiveTimeFormat": {
      "type": "string",
      "description": ""
    },
    "calendarTypeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "currencyCodeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "customSignDateFormat": {
      "type": "string",
      "description": ""
    },
    "customSignTimeFormat": {
      "type": "string",
      "description": ""
    },
    "addressFormatMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "effectiveCalendarType": {
      "type": "string",
      "description": ""
    },
    "effectiveCurrencyCode": {
      "type": "string",
      "description": ""
    },
    "initialFormatMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "currencyNegativeFormat": {
      "type": "string",
      "description": "Determines how negative currency values\nare displayed.\n\nIn most cases, you should not need to change\nthis value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting).\n\nValid values:\n\n- `Default`<br>\n  `0`\n- `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br>\n  `($1,234,567.89)`\n- `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br>\n  `-$1,234,567.89`\n- `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br>\n  `-$ 1.234.567,89`\n- `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br>\n  `$ -1.234.567,89`\n- `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br>\n  `-1.234.567,89 $`\n- `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br>\n  `(1 234 567,89 $)`\n- `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br>\n  `-1 234 567,89 $`\n- `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br>\n  `$-1'234'567.89`\n- `Minus_CSym_1_Period_234_Period_567_Comma_89`<br>\n  `-$1.234.567,89`\n- `Minus_CSym_1_Comma_234_Comma_567`<br>\n  `-$1,234,567`\n- `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br>\n  `-$12,34,567.89`\n- `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br>\n  `($ 1234,567.89)`\n- `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br>\n  `$ -12,34,567.89`\n- `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br>\n  `$-1,234,567.89`\n- `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br>\n  `$ -1 234 567,89`\n- `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br>\n  `$ -1 234 567.89`\n- `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br>\n  `-$ 1 234 567,89`\n- `Minus_1_Space_234_Space_567_Comma_89_CSym`<br>\n  `-1 234 567,89$`\n- `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br>\n  `-1 234 567.89 $`\n- `OPar_CSym_1_Period_234_Period_567_CPar`<br>\n  `(1.234.567)`\n- `OPar_CSym_1_Comma_234_Comma_567_CPar`<br>\n  `($1,234,567)`\n- `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br>\n  `-1,234,567.89 $`\n- `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br>\n  `-$ 1,234,567.89`\n- `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br>\n  `($ 1.234.567,89)`\n- `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br>\n  `($ 1'234'567.89)`\n- `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br>\n  `($ 1 234 567,89)`\n- `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br>\n  `($ 1 234 567.89)`\n- `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br>\n  `($12,34,567.89)`\n- `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br>\n  `($ 12,34,567.89)`\n- `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br>\n  `(1,234,567.89 $)`\n- `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br>\n  `(1.234.567,89 $)`\n- `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br>\n  `(1 234 567,89$)`\n- `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br>\n  `(1 234 567.89 $)`\n- `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br>\n  `($ 1,234,567.89)`\n- `Minus_CSym_1_Period_234_Period_567`<br>\n  `-$ 1.234.567`\n- `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br>\n  `-$ 1'234'567.89`\n- `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br>\n  `-$ 1 234 567.89`\n- `CSym_Minus_1_Comma_234_Comma_567`<br>\n  `$-1,234,567`\n- `CSym_Minus_1_Period_234_Period_567`<br>\n  `$-1.234.567`\n- `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br>\n  `$ -1'234'567.89`\n- `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br>\n  `$ -1,234,567.89`\n- `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br>\n  `-$ 12,34,567.89`\n- `Minus_1_Period_234_Period_567_Space_CSym`<br>\n  `-123.456.789 $`\n- `CSym_Minus_1_Space_234_Space_567_Comma_89`<br>\n  `$-123 456 789,00`\n- `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br>\n  `-123'456'789.00 $`\n- `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br>\n  `$123,456,789.00-`\n- `CSym_Minus_1_Period_234_Period_567_Comma_89`<br>\n  `$-123.456.789,00`\n- `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br>\n  `($123.456.789,00)`\n- `Minus_CSym_1234_Comma_567_Period_89`<br>\n  `-$123456,789.00`\n- `Minus_CSym_1_Space_234_Space_567_Comma_89`<br>\n  `-$123 456 789,00`\n"
    },
    "currencyPositiveFormat": {
      "type": "string",
      "description": "Determines how positive currency values\nare displayed.\n\nIn most cases, you should not need to change\nthis value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting).\n\nValid values:\n\n\n- `Default`<br>\n  Uses the current locale.\n- `CSym_1_Comma_234_Comma_567_Period_89`<br>\n  `$1,234,567.89`\n- `CSym_Space_1_Period_234_Period_567_Comma_89`<br>\n  `$ 1.234.567,89`\n- `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br>\n  `1.234.567,89 $`\n- `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br>\n  `1 234 567,89 $`\n- `CSym_Space_1_Quote_234_Quote_567_Period_89`<br>\n  `$ 1'234'567.89`\n- `CSym_1_Comma_234_Comma_567`<br>\n  `$1,234,567`\n- `CSym_Space_12_Comma_34_Comma_567_Period_89`<br>\n  `$ 12,34,567.89`\n- `CSym_12_Comma_34_Comma_567_Period_89`<br>\n  `$12,34,567.89`\n- `CSym_Space_1234_Comma_567_Period_89`<br>\n  `$ 1234,567.89`\n- `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br>\n  `1 234 567.89 $`\n- `CSym_Space_1_Space_234_Space_567_Comma_89`<br>\n  `$ 1 234 567,89`\n- `CSym_Space_1_Space_234_Space_567_Period_89`<br>\n  `$ 1 234 567.89`\n- `Leading_1_Space_234_Space_567_Comma_89_CSym`<br>\n  `1 234 567,89$`\n- `CSym_1_Period_234_Period_567`<br>\n  `$1.234.567`\n- `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br>\n  `1,234,567. $` (New Armenian)\n- `CSym_Space_1_Comma_234_Comma_567_Period_89`<br>\n  `$ 1,234,567.89` (Persian)\n- `CSym_1_Period_234_Period_567_Comma_89`<br>\n  `$123.456.789,00` (es-CO)\n- `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br>\n  `123'456'789.00 $` (fr-ch)\n- `CSym_1234_Comma_567_Period_89`<br>\n  `$123456,789.00` (es-PR)\n- `Leading_1_Period_234_Period_567_Space_CSym`<br>\n  `123.456.789 $`\n- `CSym_1_Space_234_Space_567_Comma_89`<br>\n  `$123 456 789,00` (en-ZA, es-CR)\n"
    },
    "effectiveAddressFormat": {
      "type": "string",
      "description": ""
    },
    "effectiveInitialFormat": {
      "type": "string",
      "description": ""
    },
    "signDateFormatMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "signTimeFormatMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "effectiveCustomDateFormat": {
      "type": "string",
      "description": ""
    },
    "effectiveCustomTimeFormat": {
      "type": "string",
      "description": ""
    },
    "currencyNegativeFormatMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "currencyPositiveFormatMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "effectiveCurrencyNegativeFormat": {
      "type": "string",
      "description": ""
    },
    "effectiveCurrencyPositiveFormat": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "localePolicy"
}

{
  "type": "object",
  "properties": {
    "timeZone": {
      "type": "string",
      "description": "Specifies the time zone. Valid values:\n\n- `TZ_01_AfghanistanStandardTime`\n- `TZ_02_AlaskanStandardTime`\n- `TZ_03_ArabStandardTime`\n- `TZ_04_ArabianStandardTime`\n- `TZ_05_ArabicStandardTime`\n- `TZ_06_ArgentinaStandardTime`\n- `TZ_07_AtlanticStandardTime`\n- `TZ_08_AUS_CentralStandardTime`\n- `TZ_09_AUS_EasternStandardTime`\n- `TZ_10_AzerbaijanStandardTime`\n- `TZ_11_AzoresStandardTime`\n- `TZ_12_BangladeshStandardTime`\n- `TZ_13_CanadaCentralStandardTime`\n- `TZ_14_CapeVerdeStandardTime`\n- `TZ_15_CaucasusStandardTime`\n- `TZ_16_CentralAustraliaStandardTime`\n- `TZ_17_CentralAmericaStandardTime`\n- `TZ_18_CentralAsiaStandardTime`\n- `TZ_19_CentralBrazilianStandardTime`\n- `TZ_20_CentralEuropeStandardTime`\n- `TZ_21_CentralEuropeanStandardTime`\n- `TZ_22_CentralPacificStandardTime`\n- `TZ_23_CentralStandardTime`\n- `TZ_24_CentralStandardTimeMexico`\n- `TZ_25_ChinaStandardTime`\n- `TZ_26_DatelineStandardTime`\n- `TZ_27_E_AfricaStandardTime`\n- `TZ_28_E_AustraliaStandardTime`\n- `TZ_29_E_EuropeStandardTime`\n- `TZ_30_E_SouthAmericaStandardTime`\n- `TZ_31_EasternStandardTime`\n- `TZ_32_EgyptStandardTime`\n- `TZ_33_EkaterinburgStandardTime`\n- `TZ_34_FijiStandardTime`\n- `TZ_35_FLE_StandardTime`\n- `TZ_36_GeorgianStandardTime`\n- `TZ_37_GMT_StandardTime`\n- `TZ_38_GreenlandStandardTime`\n- `TZ_39_GreenwichStandardTime`\n- `TZ_40_GTB_StandardTime`\n- `TZ_41_HawaiianStandardTime`\n- `TZ_42_IndiaStandardTime`\n- `TZ_43_IranStandardTime`\n- `TZ_44_IsraelStandardTime`\n- `TZ_45_JordanStandardTime`\n- `TZ_46_KaliningradStandardTime`\n- `TZ_47_KamchatkaStandardTime`\n- `TZ_48_KoreaStandardTime`\n- `TZ_49_MagadanStandardTime`\n- `TZ_50_MauritiusStandardTime`\n- `TZ_51_MidAtlanticStandardTime`\n- `TZ_52_MiddleEastStandardTime`\n- `TZ_53_MontevideoStandardTime`\n- `TZ_54_MoroccoStandardTime`\n- `TZ_55_MountainStandardTime`\n- `TZ_56_MountainStandardTimeMMexico`\n- `TZ_57_MyanmarStandardTime`\n- `TZ_58_N_CentralAsiaStandardTime`\n- `TZ_59_NamibiaStandardTime`\n- `TZ_60_NepalStandardTime`\n- `TZ_61_NewZealandStandardTime`\n- `TZ_62_NewfoundlandStandardTime`\n- `TZ_63_NorthAsiaEastStandardTime`\n- `TZ_64_NorthAsiaStandardTime`\n- `TZ_65_PacificSAStandardTime`\n- `TZ_66_PacificStandardTime`\n- `TZ_67_PacificStandardTimeMexico`\n- `TZ_68_PakistanStandardTime`\n- `TZ_69_ParaguayStandardTime`\n- `TZ_70_RomanceStandardTime`\n- `TZ_71_RussianStandardTime`\n- `TZ_72_SAEasternStandardTime`\n- `TZ_73_SAPacificStandardTime`\n- `TZ_74_SAWesternStandardTime`\n- `TZ_75_SamoaStandardTime`\n- `TZ_76_SE_AsiaStandardTime`\n- `TZ_77_SingaporeStandardTime`\n- `TZ_78_SouthAfricaStandardTime`\n- `TZ_79_SriLankaStandardTime`\n- `TZ_80_SyriaStandardTime`\n- `TZ_81_TaipeiStandardTime`\n- `TZ_82_TasmaniaStandardTime`\n- `TZ_83_TokyoStandardTime`\n- `TZ_84_TongaStandardTime`\n- `TZ_85_TurkeyStandardTime`\n- `TZ_86_UlaanbaatarStandardTime`\n- `TZ_87_US_EasternStandardTime`\n- `TZ_88_USMountainStandardTime`\n- `TZ_89_VenezuelaStandardTime`\n- `TZ_90_VladivostokStandardTime`\n- `TZ_91_W_AustraliaStandardTime`\n- `TZ_92_W_CentralAfricaStandardTime`\n- `TZ_93_W_EuropeStandardTime`\n- `TZ_94_WestAsiaStandardTime`\n- `TZ_95_WestPacificStandardTime`\n- `TZ_96_YakutskStandardTime`\n"
    },
    "dateFormat": {
      "type": "string",
      "description": "Specifies the date format. Valid values:\n\n- `default` <br> used the UI's \n- `longformat` <br> use the UI's long format\n- `dd_mm_yy` <br> dd-MM-yy\n- `dd_mmm_yy` <br> dd-MMM-yy\n- `dd_mm_yyyy` <br> dd-MM-yyyy\n- `dd_mmm_yyyy` <br> dd-MMM-yyyy\n- `ddmmmmyyyy` <br> dd MMMM yyyy\n- `ddmmyyyy` <br> dd/MM/yyyy\n- `ddmmyyyy_de` <br> dd.MM.yyyy\n- `dmyyyy` <br> d/M/yyyy\n- `d_m_yyyy` <br> d-M-yyyy\n- `mmmd_yyyy` <br> MMM d, yyyy\n- `mmm_dd_yyyy` <br> MMM-dd-yyyy\n- `mmmmd_yyyy` <br> MMMM d, yyyy\n- `mm_dd_yyyy` <br> MM-dd-yyyy\n- `mdyyyy` <br> M/d/yyyy\n- `yyyy_mmm_dd` <br> yyyy-MMM-dd\n- `yyyy_mm_dd` <br> yyyy-MM-dd\n- `yyyymmdd` <br> yyyy/MM/dd\n- `yyyymd` <br> yyyy/M/d\n- `custom` <br> Customer set own value\n- `mmddyyyy` <br> MM/dd/yyyy\n- `mmddyy` <br> MM/dd/yy\n- `yyyy_mmmm_d` <br> yyyy MMMM d\n"
    },
    "nameFormat": {
      "type": "string",
      "description": "Describes how names are displayed. Valid values:\n\n- `first_middle_last`<br>William Henry Gates\n- `full`<br>Mr William Henry Gates III\n- `last_first`<br>Gates William\n- `lastfirst`<br>GatesWilliam\n- `last_first_cjk`<br>Gates William only with CJK characters\n- `lastfirst_cjk`<br>GatesWilliam only with CJK characters\n\n<!-- Web/RestApi/Models/v2_1/localePolicy.cs#L341-L366 -->\n"
    },
    "timeFormat": {
      "type": "string",
      "description": "Specifies the time format. Valid values:\n\n- `none`      <br>None\n- `hh_mm`     <br>hh:mm \n- `hhmm`      <br>HH:mm\n- `hhmmss`    <br>HH:mm:ss\n- `hhmmsstt`  <br>HH:mm:ss tt\n- `hhmmtt`    <br> HH:mm tt\n- `hmm`       <br>h:mm\n- `hmmss`     <br>h:mm:ss\n- `hmmsstt`   <br>h:mm:ss tt\n- `hmmtt`     <br>h:mm tt\n- `custom`    <br>Customer-set format\n\n<!-- Web/RestApi/Models/v2_1/localePolicy.cs#L501-L546 -->"
    },
    "cultureName": {
      "type": "string",
      "description": "The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code."
    },
    "calendarType": {
      "type": "string",
      "description": "Specifies the type of calendar. Valid values:\n\n- `gregorian`\n- `japanese`\n- `buddhist`\n"
    },
    "currencyCode": {
      "type": "string",
      "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.\n\nSupported formats:\n\n- `AED`\n- `AFN`\n- `ALL`\n- `AMD`\n- `ANG`\n- `AOA`\n- `ARS`\n- `AUD`\n- `AWG`\n- `AZN`\n- `BAM`\n- `BBD`\n- `BDT`\n- `BGN`\n- `BHD`\n- `BIF`\n- `BMD`\n- `BND`\n- `BOB`\n- `BOV`\n- `BRL`\n- `BSD`\n- `BTN`\n- `BWP`\n- `BYN`\n- `BYR`\n- `BZD`\n- `CAD`\n- `CDF`\n- `CHE`\n- `CHF`\n- `CHW`\n- `CLF`\n- `CLP`\n- `CNY`\n- `COP`\n- `COU`\n- `CRC`\n- `CUC`\n- `CUP`\n- `CVE`\n- `CZK`\n- `DJF`\n- `DKK`\n- `DOP`\n- `DZD`\n- `EGP`\n- `ERN`\n- `ETB`\n- `EUR`\n- `FJD`\n- `FKP`\n- `GBP`\n- `GEL`\n- `GHS`\n- `GIP`\n- `GMD`\n- `GNF`\n- `GTQ`\n- `GYD`\n- `HKD`\n- `HNL`\n- `HRK`\n- `HTG`\n- `HUF`\n- `IDR`\n- `ILS`\n- `INR`\n- `IQD`\n- `IRR`\n- `ISK`\n- `JMD`\n- `JOD`\n- `JPY`\n- `KES`\n- `KGS`\n- `KHR`\n- `KMF`\n- `KPW`\n- `KRW`\n- `KWD`\n- `KYD`\n- `KZT`\n- `LAK`\n- `LBP`\n- `LKR`\n- `LRD`\n- `LSL`\n- `LYD`\n- `MAD`\n- `MDL`\n- `MGA`\n- `MKD`\n- `MMK`\n- `MNT`\n- `MOP`\n- `MRO`\n- `MUR`\n- `MVR`\n- `MWK`\n- `MXN`\n- `MXV`\n- `MYR`\n- `MZN`\n- `NAD`\n- `NGN`\n- `NIO`\n- `NOK`\n- `NPR`\n- `NZD`\n- `OMR`\n- `PAB`\n- `PEN`\n- `PGK`\n- `PHP`\n- `PKR`\n- `PLN`\n- `PYG`\n- `QAR`\n- `RON`\n- `RSD`\n- `RUB`\n- `RWF`\n- `SAR`\n- `SBD`\n- `SCR`\n- `SDG`\n- `SEK`\n- `SGD`\n- `SHP`\n- `SLL`\n- `SOS`\n- `SRD`\n- `SSP`\n- `STD`\n- `SVC`\n- `SYP`\n- `SZL`\n- `THB`\n- `TJS`\n- `TMT`\n- `TND`\n- `TOP`\n- `TRY`\n- `TTD`\n- `TWD`\n- `TZS`\n- `UAH`\n- `UGX`\n- `USD`\n- `USN`\n- `UYI`\n- `UYU`\n- `UZS`\n- `VEF`\n- `VND`\n- `VUV`\n- `WST`\n- `XAF`\n- `XAG`\n- `XAU`\n- `XBA`\n- `XBB`\n- `XBC`\n- `XBD`\n- `XCD`\n- `XDR`\n- `XOF`\n- `XPD`\n- `XPF`\n- `XPT`\n- `XSU`\n- `XTS`\n- `XUA`\n- `XXX`\n- `YER`\n- `ZAR`\n- `ZMW`\n- `ZWL`\n"
    },
    "addressFormat": {
      "type": "string",
      "description": "Specifies the address format. Valid values:\n\n- `en_us`\n- `ja_jp`\n- `zh_cn_tw`\n"
    },
    "initialFormat": {
      "type": "string",
      "description": "When a user is required to enter their initials,\nthis property\nspecifies how initials are rendered.\nThe examples show the\ninitials for \"William Henry Gates\".\n\n\n- `first1last1`<br> \"WG\"\n- `last2`<br> \"GA\"\n- `first2`<br> \"WI\"\n- `last2_cjk`<br> first two characters from last name in CJK characters.\n\n<!-- Components/BusinessObjects/Models/ConcealedApiRestModels/localePolicyEnums.cs -->\n"
    },
    "customDateFormat": {
      "type": "string",
      "description": ""
    },
    "customTimeFormat": {
      "type": "string",
      "description": ""
    },
    "useLongCurrencyFormat": {
      "type": "string",
      "description": "When **true,** use the long currency format for the locale."
    },
    "currencyNegativeFormat": {
      "type": "string",
      "description": "Determines how negative currency values\nare displayed.\n\nIn most cases, you should not need to change\nthis value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting).\n\nValid values:\n\n- `Default`<br>\n  `0`\n- `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar`<br>\n  `($1,234,567.89)`\n- `Minus_CSym_1_Comma_234_Comma_567_Period_89`<br>\n  `-$1,234,567.89`\n- `Minus_CSym_Space_1_Period_234_Period_567_Comma_89`<br>\n  `-$ 1.234.567,89`\n- `CSym_Space_Minus_1_Period_234_Period_567_Comma_89`<br>\n  `$ -1.234.567,89`\n- `Minus_1_Period_234_Period_567_Comma_89_Space_CSym`<br>\n  `-1.234.567,89 $`\n- `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar`<br>\n  `(1 234 567,89 $)`\n- `Minus_1_Space_234_Space_567_Comma_89_Space_CSym`<br>\n  `-1 234 567,89 $`\n- `CSym_Minus_1_Quote_234_Quote_567_Period_89`<br>\n  `$-1'234'567.89`\n- `Minus_CSym_1_Period_234_Period_567_Comma_89`<br>\n  `-$1.234.567,89`\n- `Minus_CSym_1_Comma_234_Comma_567`<br>\n  `-$1,234,567`\n- `Minus_CSym_12_Comma_34_Comma_567_Period_89`<br>\n  `-$12,34,567.89`\n- `OPar_CSym_Space_1234_Comma_567_Period_89_CPar`<br>\n  `($ 1234,567.89)`\n- `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89`<br>\n  `$ -12,34,567.89`\n- `CSym_Minus_12_Comma_34_Comma_567_Period_89`<br>\n  `$-1,234,567.89`\n- `CSym_Space_Minus_1_Space_234_Space_567_Comma_89`<br>\n  `$ -1 234 567,89`\n- `CSym_Space_Minus_1_Space_234_Space_567_Period_89`<br>\n  `$ -1 234 567.89`\n- `Minus_CSym_Space_1_Space_234_Space_567_Comma_89`<br>\n  `-$ 1 234 567,89`\n- `Minus_1_Space_234_Space_567_Comma_89_CSym`<br>\n  `-1 234 567,89$`\n- `Minus_1_Space_234_Space_567_Period_89_Space_CSym`<br>\n  `-1 234 567.89 $`\n- `OPar_CSym_1_Period_234_Period_567_CPar`<br>\n  `(1.234.567)`\n- `OPar_CSym_1_Comma_234_Comma_567_CPar`<br>\n  `($1,234,567)`\n- `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym`<br>\n  `-1,234,567.89 $`\n- `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89`<br>\n  `-$ 1,234,567.89`\n- `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar`<br>\n  `($ 1.234.567,89)`\n- `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar`<br>\n  `($ 1'234'567.89)`\n- `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar`<br>\n  `($ 1 234 567,89)`\n- `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar`<br>\n  `($ 1 234 567.89)`\n- `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar`<br>\n  `($12,34,567.89)`\n- `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar`<br>\n  `($ 12,34,567.89)`\n- `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar`<br>\n  `(1,234,567.89 $)`\n- `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar`<br>\n  `(1.234.567,89 $)`\n- `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar`<br>\n  `(1 234 567,89$)`\n- `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar`<br>\n  `(1 234 567.89 $)`\n- `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar`<br>\n  `($ 1,234,567.89)`\n- `Minus_CSym_1_Period_234_Period_567`<br>\n  `-$ 1.234.567`\n- `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89`<br>\n  `-$ 1'234'567.89`\n- `Minus_CSym_Space_1_Space_234_Space_567_Period_89`<br>\n  `-$ 1 234 567.89`\n- `CSym_Minus_1_Comma_234_Comma_567`<br>\n  `$-1,234,567`\n- `CSym_Minus_1_Period_234_Period_567`<br>\n  `$-1.234.567`\n- `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89`<br>\n  `$ -1'234'567.89`\n- `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89`<br>\n  `$ -1,234,567.89`\n- `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89`<br>\n  `-$ 12,34,567.89`\n- `Minus_1_Period_234_Period_567_Space_CSym`<br>\n  `-123.456.789 $`\n- `CSym_Minus_1_Space_234_Space_567_Comma_89`<br>\n  `$-123 456 789,00`\n- `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym`<br>\n  `-123'456'789.00 $`\n- `CSym_1_Comma_234_Comma_567_Period_89_Minus`<br>\n  `$123,456,789.00-`\n- `CSym_Minus_1_Period_234_Period_567_Comma_89`<br>\n  `$-123.456.789,00`\n- `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar`<br>\n  `($123.456.789,00)`\n- `Minus_CSym_1234_Comma_567_Period_89`<br>\n  `-$123456,789.00`\n- `Minus_CSym_1_Space_234_Space_567_Comma_89`<br>\n  `-$123 456 789,00`\n"
    },
    "currencyPositiveFormat": {
      "type": "string",
      "description": "Determines how positive currency values\nare displayed.\n\nIn most cases, you should not need to change\nthis value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting).\n\nValid values:\n\n\n- `Default`<br>\n  Uses the current locale.\n- `CSym_1_Comma_234_Comma_567_Period_89`<br>\n  `$1,234,567.89`\n- `CSym_Space_1_Period_234_Period_567_Comma_89`<br>\n  `$ 1.234.567,89`\n- `Leading_1_Period_234_Period_567_Comma_89_Space_CSym`<br>\n  `1.234.567,89 $`\n- `Leading_1_Space_234_Space_567_Comma_89_Space_CSym`<br>\n  `1 234 567,89 $`\n- `CSym_Space_1_Quote_234_Quote_567_Period_89`<br>\n  `$ 1'234'567.89`\n- `CSym_1_Comma_234_Comma_567`<br>\n  `$1,234,567`\n- `CSym_Space_12_Comma_34_Comma_567_Period_89`<br>\n  `$ 12,34,567.89`\n- `CSym_12_Comma_34_Comma_567_Period_89`<br>\n  `$12,34,567.89`\n- `CSym_Space_1234_Comma_567_Period_89`<br>\n  `$ 1234,567.89`\n- `Leading_1_Space_234_Space_567_Period_89_Space_CSym`<br>\n  `1 234 567.89 $`\n- `CSym_Space_1_Space_234_Space_567_Comma_89`<br>\n  `$ 1 234 567,89`\n- `CSym_Space_1_Space_234_Space_567_Period_89`<br>\n  `$ 1 234 567.89`\n- `Leading_1_Space_234_Space_567_Comma_89_CSym`<br>\n  `1 234 567,89$`\n- `CSym_1_Period_234_Period_567`<br>\n  `$1.234.567`\n- `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym`<br>\n  `1,234,567. $` (New Armenian)\n- `CSym_Space_1_Comma_234_Comma_567_Period_89`<br>\n  `$ 1,234,567.89` (Persian)\n- `CSym_1_Period_234_Period_567_Comma_89`<br>\n  `$123.456.789,00` (es-CO)\n- `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym`<br>\n  `123'456'789.00 $` (fr-ch)\n- `CSym_1234_Comma_567_Period_89`<br>\n  `$123456,789.00` (es-PR)\n- `Leading_1_Period_234_Period_567_Space_CSym`<br>\n  `123.456.789 $`\n- `CSym_1_Space_234_Space_567_Comma_89`<br>\n  `$123 456 789,00` (en-ZA, es-CR)\n"
    }
  },
  "description": "Allows you to customize locale settings.",
  "x-ms-summary": "Allows you to customize locale settings.",
  "x-ds-definition-name": "localePolicyTab"
}

{
  "type": "object",
  "properties": {
    "lockType": {
      "type": "string",
      "description": "The type of lock.  Currently `edit` is the only supported type."
    },
    "lockToken": {
      "type": "string",
      "description": "A unique identifier provided to the owner of the lock. You must use this token with subsequent calls to prove ownership of the lock."
    },
    "lockedByApp": {
      "type": "string",
      "description": "The human-readable name of the application that is locking the envelope or template. This value displays to the user in error messages when lock conflicts occur."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "lockedByUser": {
      "$ref": "#/components/schemas/userInfo"
    },
    "useScratchPad": {
      "type": "string",
      "description": "When **true,** a scratchpad is used to edit information.\n "
    },
    "lockedUntilDateTime": {
      "type": "string",
      "description": "The date and time that the lock expires."
    },
    "lockDurationInSeconds": {
      "type": "string",
      "description": "The number of seconds to lock the envelope for editing.  This value must be greater than `0` seconds."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "lockInformation"
}

{
  "type": "object",
  "properties": {
    "lockType": {
      "type": "string",
      "description": "The type of lock.  Currently `edit` is the only supported type."
    },
    "lockedByApp": {
      "type": "string",
      "description": "A friendly name of the application used to lock the envelope.  Will be used in error messages to the user when lock conflicts occur."
    },
    "useScratchPad": {
      "type": "string",
      "description": "When **true,** a scratchpad is used to edit information.\n "
    },
    "templatePassword": {
      "type": "string",
      "description": "The [password for the template](https://support.docusign.com/s/document-item?bundleId=xry1643227563338&topicId=xwo1578456395432.html). If you are using a lock for a template that has a password or an envelope that is based on a template that has a password, you must enter the `templatePassword` to save the changes."
    },
    "lockDurationInSeconds": {
      "type": "string",
      "description": "The number of seconds to lock the envelope for editing.  Must be greater than 0 seconds."
    }
  },
  "description": "This request object contains information about the lock that you want to create or update.",
  "x-ms-summary": "This request object contains information about the lock that you want to create or update.",
  "x-ds-definition-name": "lockRequest"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name associated with the account."
    },
    "email": {
      "type": "string",
      "description": "The email address for 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."
    },
    "baseUrl": {
      "type": "string",
      "description": "The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl."
    },
    "userName": {
      "type": "string",
      "description": "The name of this user as defined by the account."
    },
    "accountId": {
      "type": "string",
      "description": "The account ID associated with the envelope."
    },
    "isDefault": {
      "type": "string",
      "description": "This value is true if this is the default account for the user, otherwise false is returned."
    },
    "accountIdGuid": {
      "type": "string",
      "description": "The GUID associated with the account ID."
    },
    "siteDescription": {
      "type": "string",
      "description": "An optional descirption of the site that hosts the account."
    },
    "loginUserSettings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "A list of user-level settings that indicate what user-specific features are available."
    },
    "loginAccountSettings": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "A list of settings on the account that indicate what features are available."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "loginAccount"
}

{
  "type": "object",
  "properties": {
    "apiPassword": {
      "type": "string",
      "description": "Contains a token that can be used for authentication in API calls instead of using the user name and password. Only returned if the `api_password=true` query string is added to the URL."
    },
    "loginAccounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/loginAccount"
      },
      "description": "The list of accounts that authenticating user is a member of."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "loginInformation"
}

{
  "type": "object",
  "properties": {
    "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."
    },
    "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"
    },
    "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"
    },
    "pageNumber": {
      "type": "string",
      "description": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "matchBox"
}

{
  "type": "object",
  "properties": {
    "group": {
      "$ref": "#/components/schemas/group"
    },
    "shared": {
      "type": "string",
      "description": "How the item is shared. One of:\n\n\n- `not_shared`: The item is not shared.\n\n- `shared_to`: The item is shared."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    }
  },
  "description": "Information about items shared among groups.",
  "x-ms-summary": "Information about items shared among groups.",
  "x-ds-definition-name": "memberGroupSharedItem"
}

{
  "type": "object",
  "properties": {
    "user": {
      "$ref": "#/components/schemas/userInfo"
    },
    "folders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/folderSharedItem"
      },
      "description": "List of information about shared folders."
    },
    "envelopes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/sharedItem"
      },
      "description": "List of information about shared envelopes."
    },
    "templates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/templateSharedItem"
      },
      "description": "List of information about shared templates."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    }
  },
  "description": "Information about shared items.",
  "x-ms-summary": "Information about shared items.",
  "x-ds-definition-name": "memberSharedItems"
}

{
  "type": "object",
  "properties": {
    "row": {
      "type": "string",
      "description": "Specifies the row number in a Salesforce table that the merge field value corresponds to."
    },
    "path": {
      "type": "string",
      "description": "Sets the object associated with the custom tab. Currently this is the Salesforce Object."
    },
    "writeBack": {
      "type": "string",
      "description": "When **true,** data entered into the merge field during Signing will update the mapped Salesforce field."
    },
    "rowMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "pathExtended": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/pathExtendedElement"
      },
      "description": "Reserved for DocuSign."
    },
    "pathMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "allowSenderToEdit": {
      "type": "string",
      "description": "When **true,** the sender can modify the value of the `mergeField` tab during the sending process."
    },
    "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`."
    },
    "writeBackMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "pathExtendedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "allowSenderToEditMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "configurationTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "Contains information for transferring values between Salesforce data fields and DocuSign tabs.\n",
  "x-ms-summary": "Contains information for transferring values between Salesforce data fields and DocuSign tabs.\n",
  "x-ds-definition-name": "mergeField"
}

{
  "type": "object",
  "properties": {
    "deviceId": {
      "type": "string",
      "description": ""
    },
    "platform": {
      "type": "string",
      "description": "The Platform of the client application"
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "mobileNotifierConfiguration"
}

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

{
  "type": "object",
  "properties": {
    "currency": {
      "type": "string",
      "description": "The three-letter\n[ISO 4217][ISO 4217] currency code for the payment.\n\nFor example:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nThis is a read-only property.\n\n[ISO 4217]:          https://en.wikipedia.org/wiki/ISO_4217\n"
    },
    "displayAmount": {
      "type": "string",
      "description": "The payment amount as displayed\nin the `currency`.\n\nFor example, if the payment amount\nis USD 12.59,\nthe `amountInBaseUnit` is 1259 (cents),\nand the displayed amount is `$12.59 USD`.\n\nThis is a read-only property.\n"
    },
    "amountInBaseUnit": {
      "type": "string",
      "description": "The total payment amount\nin the currency's base unit.\nFor example, for USD\nthe base currency is one cent.\n"
    }
  },
  "description": "Describes information\nabout the `total` of a payment.\n",
  "x-ms-summary": "Describes information\nabout the `total` of a payment.\n",
  "x-ds-definition-name": "money"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the item."
    },
    "value": {
      "type": "string",
      "description": "The current value of the item."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "originalValue": {
      "type": "string",
      "description": "The initial value of the item."
    }
  },
  "description": "A name-value pair that describes an item and provides a value for the item.",
  "x-ms-summary": "A name-value pair that describes an item and provides a value for the item.",
  "x-ds-definition-name": "nameValue"
}

{
  "type": "object",
  "properties": {
    "accountName": {
      "type": "string",
      "description": "The account name for the new account."
    },
    "initialUser": {
      "$ref": "#/components/schemas/userInformation"
    },
    "taxExemptId": {
      "type": "string",
      "description": ""
    },
    "enablePreAuth": {
      "type": "string",
      "description": ""
    },
    "paymentMethod": {
      "type": "string",
      "description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
    },
    "processPayment": {
      "type": "string",
      "description": ""
    },
    "accountSettings": {
      "$ref": "#/components/schemas/accountSettingsInformation"
    },
    "distributorCode": {
      "type": "string",
      "description": "The Distributor Code that you received from DocuSign."
    },
    "planInformation": {
      "$ref": "#/components/schemas/planInformation"
    },
    "paymentProcessor": {
      "type": "string",
      "description": ""
    },
    "addressInformation": {
      "$ref": "#/components/schemas/accountAddress"
    },
    "distributorPassword": {
      "type": "string",
      "description": "The password for the `distributorCode`."
    },
    "envelopePartitionId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "referralInformation": {
      "$ref": "#/components/schemas/referralInformation"
    },
    "creditCardInformation": {
      "$ref": "#/components/schemas/creditCardInformation"
    },
    "socialAccountInformation": {
      "$ref": "#/components/schemas/socialAccountInformation"
    },
    "paymentProcessorInformation": {
      "$ref": "#/components/schemas/paymentProcessorInformation"
    },
    "directDebitProcessorInformation": {
      "$ref": "#/components/schemas/directDebitProcessorInformation"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "newAccountDefinition"
}

{
  "type": "object",
  "properties": {
    "userId": {
      "type": "string",
      "description": "Specifies the user ID of the new user."
    },
    "baseUrl": {
      "type": "string",
      "description": "The URL that should be used for successive calls to this account. It includes the protocal (https), the DocuSign server where the account is located, and the account number. Use this Url to make API calls against this account. Many of the API calls provide Uri's that are relative to this baseUrl."
    },
    "accountId": {
      "type": "string",
      "description": "The account ID associated with the envelope."
    },
    "accountName": {
      "type": "string",
      "description": "The account name for the new account."
    },
    "apiPassword": {
      "type": "string",
      "description": "Contains a token that can be used for authentication in API calls instead of using the user name and password."
    },
    "accountIdGuid": {
      "type": "string",
      "description": "The GUID associated with the account ID."
    },
    "billingPlanPreview": {
      "$ref": "#/components/schemas/billingPlanPreview"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "newAccountSummary"
}

{
  "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": "Specifies the user ID for the new user."
    },
    "userName": {
      "type": "string",
      "description": "The name of the user."
    },
    "userStatus": {
      "type": "string",
      "description": "Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`\n"
    },
    "apiPassword": {
      "type": "string",
      "description": "Contains a token that can be used for authentication in API calls instead of using the user name and password."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "membershipId": {
      "type": "string",
      "description": "The user's membership ID."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the item was created."
    },
    "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"
    },
    "permissionProfileName": {
      "type": "string",
      "description": "The name of the account permission profile. \n\nExample: `Account Administrator`"
    }
  },
  "description": "Object representing a new user.",
  "x-ms-summary": "Object representing a new user.",
  "x-ds-definition-name": "newUser"
}

{
  "type": "object",
  "properties": {
    "newUsers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userInformation"
      },
      "description": "A list of one or more new users."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "newUsersDefinition"
}

{
  "type": "object",
  "properties": {
    "newUsers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/newUser"
      },
      "description": "A list of one or more new users."
    }
  },
  "description": "Object representing a summary of data for new users.",
  "x-ms-summary": "Object representing a summary of data for new users.",
  "x-ds-definition-name": "newUsersSummary"
}

{
  "type": "object",
  "properties": {
    "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."
    },
    "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`)."
    },
    "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"
    },
    "required": {
      "type": "string",
      "description": "When **true,** the signer is required to fill out this tab."
    },
    "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."
    },
    "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."
    },
    "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"
    },
    "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": "Specifies the page number on which the tab is located."
    },
    "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."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "requiredMetadata": {
      "$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."
    },
    "formOrderMetadata": {
      "$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"
    },
    "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": "A tab that alerts notary recipients that\nthey must take action on the page.\nOnly one notarize tab can appear on a page.",
  "x-ms-summary": "A tab that alerts notary recipients that\nthey must take action on the page.\nOnly one notarize tab can appear on a page.",
  "x-ds-definition-name": "notarize"
}

{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "string",
      "description": "The date the this object was created."
    },
    "userInfo": {
      "$ref": "#/components/schemas/userInformation"
    },
    "searchable": {
      "type": "string",
      "description": "When **true,** this notary is searchable."
    },
    "createdDate": {
      "type": "string",
      "description": "The creation date of the account in UTC timedate format."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "notary"
}

{
  "type": "object",
  "properties": {
    "jurisdictions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jurisdictionSummary"
      },
      "description": ""
    },
    "hasDocusignCertificate": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "notaryContactDetails"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The notary's full legal name.\n\nMaximum Length: 100 characters.\n"
    },
    "note": {
      "type": "string",
      "description": "A note sent to the notary in the signing email.\nThis note is visible only to this notary.\n\nMaximum Length: 1000 characters.\n"
    },
    "tabs": {
      "$ref": "#/components/schemas/EnvelopeRecipientTabs"
    },
    "email": {
      "type": "string",
      "description": "The notary's email address.\n\nMaximum Length: 100 characters.\n"
    },
    "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."
    },
    "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."
    },
    "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. "
    },
    "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."
    },
    "totalTabCount": {
      "type": "string",
      "description": "The total number of tabs in the documents. This property is read-only."
    },
    "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."
    },
    "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. "
    },
    "hostRecipientId": {
      "type": "string",
      "description": "The host recipient ID."
    },
    "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. "
    },
    "declinedDateTime": {
      "type": "string",
      "description": "The date and time the recipient declined the document. This property is read-only."
    },
    "designatorIdGuid": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "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."
    },
    "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"
    },
    "faxNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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"
    },
    "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.**"
    },
    "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"
    },
    "recipientTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "socialAuthentications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/socialAuthentication"
      },
      "description": "Deprecated."
    },
    "deliveryMethodMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "signingGroupIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "idCheckInformationInput": {
      "$ref": "#/components/schemas/idCheckInformationInput"
    },
    "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."
    },
    "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."
    },
    "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": "This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`.\n\nIt describes information about the notary host.\nThe following information is required\nwhen using the eNotary in-person signing flow:\n\n* `name`: Specifies the notary's full legal name.\n* `email`: Specifies the notary's email address.\n* `recipientId`: A unique ID number for the notary signing host.\n",
  "x-ms-summary": "This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`.\n\nIt describes information about the notary host.\nThe following information is required\nwhen using the eNotary in-person signing flow:\n\n* `name`: Specifies the notary's full legal name.\n* `email`: Specifies the notary's email address.\n* `recipientId`: A unique ID number for the notary signing host.\n",
  "x-ds-definition-name": "notaryHost"
}

{
  "type": "object",
  "properties": {
    "signerName": {
      "type": "string",
      "description": "The in-person signer's full legal name.\n\nRequired when `inPersonSigningType` is `inPersonSigner`.\nFor eNotary flow, use `name` instead.\n\nMaximum Length: 100 characters.\n"
    },
    "createdDate": {
      "type": "string",
      "description": "The creation date of the account in UTC timedate format."
    },
    "documentName": {
      "type": "string",
      "description": "The name of the document."
    },
    "jurisdiction": {
      "$ref": "#/components/schemas/jurisdiction"
    },
    "notaryJournalId": {
      "type": "string",
      "description": "A unique GUID for this journal entry."
    },
    "notaryJournalMetaData": {
      "$ref": "#/components/schemas/notaryJournalMetaData"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "notaryJournal"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the witness."
    },
    "address": {
      "type": "string",
      "description": "The address of the witness."
    },
    "signatureImage": {
      "type": "string",
      "description": "A base64-encoded image of the signature."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "notaryJournalCredibleWitness"
}

{
  "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."
    },
    "notaryJournals": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/notaryJournal"
      },
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "notaryJournalList"
}

{
  "type": "object",
  "properties": {
    "comment": {
      "type": "string",
      "description": "A freeform comment that the notary can add to the journal entry."
    },
    "signerIdType": {
      "type": "string",
      "description": "A string that describes the ID that the signer presented. For example `drivers license` or `military ID`."
    },
    "signatureImage": {
      "type": "string",
      "description": "A base64-encoded image of the signature."
    },
    "credibleWitnesses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/notaryJournalCredibleWitness"
      },
      "description": "An array of witnesses."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "notaryJournalMetaData"
}

{
  "type": "object",
  "properties": {
    "county": {
      "type": "string",
      "description": "The county that the commission is valid in."
    },
    "sealType": {
      "type": "string",
      "description": "The seal type used for this juridiction.\n\n- `not_available`\n- `system_created`\n- `user_uploaded`"
    },
    "commissionId": {
      "type": "string",
      "description": "The notary's commission identification. This varies from jurisdiction to jurisdiction."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "jurisdiction": {
      "$ref": "#/components/schemas/jurisdiction"
    },
    "registeredName": {
      "type": "string",
      "description": "The registered name of the notary."
    },
    "commissionExpiration": {
      "type": "string",
      "description": "The expiration date of the notary's commission in format: `MM/DD/YYYY`."
    }
  },
  "description": "A notary jurisdiction.",
  "x-ms-summary": "A notary jurisdiction.",
  "x-ds-definition-name": "notaryJurisdiction"
}

{
  "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."
    },
    "notaryJurisdictions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/notaryJurisdiction"
      },
      "description": "An array of jurisdictions."
    }
  },
  "description": "A paged list of jurisdictions.",
  "x-ms-summary": "A paged list of jurisdictions.",
  "x-ds-definition-name": "notaryJurisdictionList"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The full legal name of the recipient. Maximum length: 100 characters.\n\nNote: 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. Notification of the document to sign is sent to this email address.\n\nMaximum length: 100 characters."
    },
    "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."
    },
    "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 user's last name. \nMaximum Length: 50 characters."
    },
    "notaryId": {
      "type": "string",
      "description": "Not applicable to Notary tab."
    },
    "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 user's first name. \nMaximum 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."
    },
    "notaryType": {
      "type": "string",
      "description": "The notary type. This property is read-only. Valid values:\n\n- `inperson`\n- `remote`"
    },
    "statusCode": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "delegatedBy": {
      "$ref": "#/components/schemas/delegationInfo"
    },
    "delegatedTo": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/delegationInfo"
      },
      "description": ""
    },
    "phoneNumber": {
      "$ref": "#/components/schemas/recipientPhoneNumber"
    },
    "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"
    },
    "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"
    },
    "notarySigners": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of strings that correspond to the `recipientId` of each signer in the notary group. This property is read-only."
    },
    "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 item was created."
    },
    "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. "
    },
    "isBulkRecipient": {
      "type": "string",
      "description": "Reserved for DocuSign.\n"
    },
    "liveOakStartURL": {
      "type": "string",
      "description": "URL that directs the recipient to LiveOak to complete the remote online notarization process. This property is read-only."
    },
    "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"
    },
    "notarySourceType": {
      "type": "string",
      "description": ""
    },
    "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"
    },
    "notaryThirdPartyPartner": {
      "type": "string",
      "description": ""
    },
    "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": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "notaryRecipient"
}

{
  "type": "object",
  "properties": {
    "notary": {
      "$ref": "#/components/schemas/notary"
    },
    "jurisdictions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/jurisdiction"
      },
      "description": ""
    }
  },
  "description": "Describes a single notary jurisdiction.",
  "x-ms-summary": "Describes a single notary jurisdiction.",
  "x-ds-definition-name": "notaryResult"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": ""
    },
    "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."
    },
    "source": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "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."
    },
    "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"
    },
    "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."
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "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": "Specifies the page number on which the tab is located."
    },
    "scaleValue": {
      "type": "string",
      "description": "Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size."
    },
    "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."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "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."
    },
    "formOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "xPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "yPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "documentIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "pageNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "scaleValueMetadata": {
      "$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": "A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/",
  "x-ms-summary": "A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary].\n\n[notary]: /docs/notary-api/",
  "x-ds-definition-name": "notarySeal"
}

{
  "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."
    },
    "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": ""
    },
    "tabType": {
      "type": "string",
      "description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
    },
    "tooltip": {
      "type": "string",
      "description": "**Note:** Note tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient.\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"
    },
    "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\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`.\n"
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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": "A tab that displays additional information, in the form of a\nnote, for the recipient.\n",
  "x-ms-summary": "A tab that displays additional information, in the form of a\nnote, for the recipient.\n",
  "x-ds-definition-name": "note"
}

{
  "type": "object",
  "properties": {
    "reminders": {
      "$ref": "#/components/schemas/reminders"
    },
    "expirations": {
      "$ref": "#/components/schemas/expirations"
    },
    "useAccountDefaults": {
      "type": "string",
      "description": "When **true,** the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When **false,** the reminders and expirations settings specified in this request are used. The default value is **false.**"
    }
  },
  "description": "A complex element that specifies the notification settings for the envelope.",
  "x-ms-summary": "A complex element that specifies the notification settings for the envelope.",
  "x-ds-definition-name": "notification"
}

{
  "type": "object",
  "properties": {
    "senderEmailNotifications": {
      "$ref": "#/components/schemas/senderEmailNotifications"
    },
    "signerEmailNotifications": {
      "$ref": "#/components/schemas/signerEmailNotifications"
    }
  },
  "description": "Contains details about the default notification settings for the envelope notifications that senders and signers receive.",
  "x-ms-summary": "Contains details about the default notification settings for the envelope notifications that senders and signers receive.",
  "x-ds-definition-name": "notificationDefaultSettings"
}

{
  "type": "object",
  "properties": {
    "emailNotifications": {
      "$ref": "#/components/schemas/notificationDefaultSettings"
    },
    "apiEmailNotifications": {
      "$ref": "#/components/schemas/notificationDefaultSettings"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "notificationDefaults"
}

{
  "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`)."
    },
    "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`.\n"
    },
    "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": "Number tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\nSee [Number fields](https://raw.githubusercontent.com)\nto learn more about this tab type.\n",
  "x-ms-summary": "Number tabs validate that the entered value is a number.\nThey do not support advanced validation or display options.\nSee [Number fields](https://raw.githubusercontent.com)\nto learn more about this tab type.\n",
  "x-ds-definition-name": "number"
}

{
  "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 `numericalValue` of the tab\ndisplayed according to its locale policy.\n\nFor example,\nif the locale policy is `en-US`\nand the `numericalValue` is `-1234.56`,\nthis property will contain the string\n`\"($ 1,234.56)\"`.\n\n"
    },
    "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 tab is shared.\n"
    },
    "source": {
      "type": "string",
      "description": ""
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "documentId": {
      "type": "string",
      "description": "Specifies the document ID number that the tab is placed on. This ID must refer to an existing document.\n"
    },
    "mergeField": {
      "$ref": "#/components/schemas/mergeField"
    },
    "pageNumber": {
      "type": "string",
      "description": "Specifies the page number on which the tab is located."
    },
    "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.\nThis can only be used when adding new tabs for a recipient.\nWhen 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"
    },
    "numericalValue": {
      "type": "string",
      "description": "The raw numerical value of the tab.\n\nFor example,\nif the locale policy is `en-US`\nand the `numericalValue` is `-1234.56`,\nthe `value` property will contain the string\n`\"($ 1,234.56)\"`.\n"
    },
    "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. "
    },
    "validationType": {
      "type": "string",
      "description": "Specifies how numerical data is validated. Valid values:\n\n- `number`\n- `currency`\n"
    },
    "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"
    },
    "maxNumericalValue": {
      "type": "string",
      "description": "The maximum value that the numerical tab can take on.\nThe largest value allowed, and the default if not specified, is\n`999999999.99`"
    },
    "minNumericalValue": {
      "type": "string",
      "description": "The minimum value that the numerical tab can take on.\nThe smallest value allowed, and the default if not specified, is\n`-999999999.99`"
    },
    "shareToRecipients": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "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"
    },
    "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"
    },
    "originalNumericalValue": {
      "type": "string",
      "description": "The original value of the tab."
    },
    "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"
    },
    "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": "Numerical tabs provide robust display and validation features,\nincluding formatting for different regions and currencies,\nand minimum and maximum value validation.\nSee [Number fields](https://raw.githubusercontent.com)\nto learn more about this tab type.\n",
  "x-ms-summary": "Numerical tabs provide robust display and validation features,\nincluding formatting for different regions and currencies,\nand minimum and maximum value validation.\nSee [Number fields](https://raw.githubusercontent.com)\nto learn more about this tab type.\n",
  "x-ds-definition-name": "numerical"
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size."
    },
    "scope": {
      "type": "string",
      "description": "Must be set to \"api\"."
    },
    "expires_in": {
      "type": "string",
      "description": ""
    },
    "token_type": {
      "type": "string",
      "description": ""
    },
    "access_token": {
      "type": "string",
      "description": "Access token information."
    },
    "refresh_token": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "oauthAccess"
}

{
  "type": "object",
  "properties": {
    "deviceName": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "deviceModel": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "gpsLatitude": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "gpsLongitude": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "accountEsignId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "offlineSigningHash": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Reserved for DocuSign.",
  "x-ms-summary": "Reserved for DocuSign.",
  "x-ds-definition-name": "offlineAttributes"
}

{
  "type": "object",
  "properties": {
    "dpi": {
      "type": "string",
      "description": "The number of dots per inch used for the page image."
    },
    "width": {
      "type": "string",
      "description": "The width of the page in pixels.\nMust be an integer."
    },
    "height": {
      "type": "string",
      "description": "The height of the page in pixels.\nMust be an integer."
    },
    "pageId": {
      "type": "string",
      "description": "The ID of the page."
    },
    "mimeType": {
      "type": "string",
      "description": "The MIME type."
    },
    "sequence": {
      "type": "string",
      "description": "The sequence of the page in the document, or page number."
    },
    "imageBytes": {
      "type": "string",
      "description": "The number of image bytes."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    }
  },
  "description": "Description of a page of a document.",
  "x-ms-summary": "Description of a page of a document.",
  "x-ds-definition-name": "page"
}

{
  "type": "object",
  "properties": {
    "pages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/page"
      },
      "description": "An array of page objects."
    },
    "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": "pageImages"
}

{
  "type": "object",
  "properties": {
    "rotate": {
      "type": "string",
      "description": "Sets the direction the page image is rotated. The possible settings are: left or right"
    },
    "password": {
      "type": "string",
      "description": "The user's encrypted password hash."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "pageRequest"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": ""
    },
    "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"
    },
    "email": {
      "type": "string",
      "description": ""
    },
    "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."
    },
    "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 user's last name. \nMaximum Length: 50 characters."
    },
    "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 user's first name. \nMaximum Length: 50 characters."
    },
    "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": "Reserved for DocuSign."
    },
    "phoneNumber": {
      "$ref": "#/components/schemas/recipientPhoneNumber"
    },
    "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"
    },
    "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 string can be a maximum of 100 characters.\n"
    },
    "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."
    },
    "totalTabCount": {
      "type": "string",
      "description": "The total number of tabs in the documents. This property is read-only."
    },
    "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."
    },
    "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/"
    },
    "participateFor": {
      "type": "string",
      "description": ""
    },
    "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. "
    },
    "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. "
    },
    "declinedDateTime": {
      "type": "string",
      "description": "The date and time the recipient declined the document. This property is read-only."
    },
    "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."
    },
    "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"
    },
    "faxNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "firstNameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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.**"
    },
    "participateForGuid": {
      "type": "string",
      "description": ""
    },
    "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"
    },
    "recipientTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "socialAuthentications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/socialAuthentication"
      },
      "description": "Deprecated."
    },
    "deliveryMethodMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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"
    },
    "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."
    },
    "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."
    },
    "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": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "participant"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": ""
    },
    "type": {
      "type": "string",
      "description": "The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`\n"
    },
    "typeName": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "pathExtendedElement"
}

{
  "type": "object",
  "properties": {
    "vendor": {
      "type": "string",
      "description": ""
    },
    "partner": {
      "type": "string",
      "description": ""
    },
    "currency": {
      "type": "string",
      "description": "The three-letter\n[ISO 4217][ISO 4217] currency code for the payment.\n\nFor example:\n\n* AUD Australian dollar\n* CAD Canadian dollar\n* EUR Euro\n* GBP Great Britain pound\n* USD United States dollar\n\nThis is a read-only property.\n\n[ISO 4217]:          https://en.wikipedia.org/wiki/ISO_4217\n"
    },
    "password": {
      "type": "string",
      "description": "The user's encrypted password hash."
    },
    "userName": {
      "type": "string",
      "description": "The name of the user."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "payPalLegacySettings"
}

{
  "type": "object",
  "properties": {
    "total": {
      "$ref": "#/components/schemas/money"
    },
    "status": {
      "type": "string",
      "description": "This read-only property describes the status of a payment.\n\n* `new`<br>\n  This is a new payment request.\n  The envelope has been created,\n  but no payment authorizations have been made.\n\n* `auth_complete`<br>\n  A recipient has entered their credit card information,\n  but the envelope has not been completed.\n  The card has not been charged.\n\n* `payment_complete`<br>\n  The recipient's card has been charged.\n\n* `payment_capture_failed`<br>\n  Final charge failed.\n  This can happen when too much time\n  passes between authorizing the payment\n  and completing the document.\n\n* `future_payment_saved` <br>\nThe recipient's payment method has been saved to the sender's payment gateway.\n"
    },
    "chargeId": {
      "type": "string",
      "description": "The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment."
    },
    "lineItems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/paymentLineItem"
      },
      "description": "A payment formula can have\none or more line items\nthat provide detail about\nindividual items in a payment request.\n\nThe list of line items\nare returned as metadata\nto the payment gateway.\n"
    },
    "customerId": {
      "type": "string",
      "description": "The customer ID."
    },
    "gatewayName": {
      "type": "string",
      "description": "Name of the gateway connected to sender's DocuSign account.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`\n* `CyberSource`\n* `Zuora`\n* `Elavon`"
    },
    "currencyCode": {
      "type": "string",
      "description": "Specifies the three-letter\n[ISO 4217][ISO 4217] currency code for the payment.\n\nSupported currencies are:\n\n* AUD: Australian dollar\n* CAD: Canadian dollar\n* EUR: Euro\n* GBP: Great Britain pound\n* USD: United States dollar\n\nSpecifying any other ISO 4217 code for payments is an error.\n\n[ISO 4217]:          https://en.wikipedia.org/wiki/ISO_4217\n"
    },
    "signerValues": {
      "$ref": "#/components/schemas/paymentSignerValues"
    },
    "paymentOption": {
      "type": "string",
      "description": "This property specifies how the signer's collected payment details will be used.\n\nValid values:\n\n- `authorize`: The payment details will be used to collect payment. This is the default value.\n- `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway.\n- `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment."
    },
    "customMetadata": {
      "type": "string",
      "description": "This is a sender-defined field that passes any extra metadata about the payment that will show up in the Authorize.net transaction under **Description** in the merchant gateway portal. The custom metadata will be recorded in downloaded Authorize.net reports. \n\nThe following example shows what the **Description** field of the transaction will look like: \n\n`<envelopeID>, <customMetadata>`"
    },
    "subGatewayName": {
      "type": "string",
      "description": ""
    },
    "paymentSourceId": {
      "type": "string",
      "description": "The payment source ID."
    },
    "gatewayAccountId": {
      "type": "string",
      "description": "A GUID that identifies the payment gateway\nconnected to the sender's DocuSign account.\n\nThere is no public API\nfor connecting payment gateway accounts\nYou must connect and manage payment gateway accounts\nthrough the DocuSign Admin console\nand through your chosen payment gateway.\n\nYou can get the gateway account ID\nin the Payments section\nof the DocuSign Admin console.\n\n\n[paymentgateways]:  https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=knc1573854895499.html\n"
    },
    "gatewayDisplayName": {
      "type": "string",
      "description": "Display name of the gateway connected to sender's DocuSign account.\n\nPossible values are: Stripe, Braintree, Authorize.Net, CyberSource, Zuora, Elavon."
    },
    "currencyCodeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "allowedPaymentMethods": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of accepted payment methods:\n\n* `CreditCard`\n* `ApplePay`\n* `AndroidPay`\n* `BankAccount`\n\nFor example, if you only accept credit cards and ACH transfers, you would set this property to:\n\n`'[\"BankAccount\", \"CreditCard\"]'`\n\nDo not specify `BankAccount` (ACH) if you are also using in-person signing.\n"
    },
    "customMetadataRequired": {
      "type": "boolean",
      "description": "A sender-defined field that specifies whether custom metadata is required for the transaction. When **true,** custom metadata is required. This property only applies if you are using an Authorize.net payment gateway account."
    },
    "gatewayAccountIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "When a formula tab\nhas a `paymentDetails` property,\nthe formula tab\nis a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[paymentguide]:     https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html\n",
  "x-ms-summary": "When a formula tab\nhas a `paymentDetails` property,\nthe formula tab\nis a payment item.\nSee [Requesting Payments Along with Signatures][paymentguide]\nin the DocuSign Support Center\nto learn more about payments.\n\n[paymentguide]:     https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html\n",
  "x-ds-definition-name": "paymentDetails"
}

{
  "type": "object",
  "properties": {
    "config": {
      "$ref": "#/components/schemas/paymentGatewayAccountSetting"
    },
    "isLegacy": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "isEnabled": {
      "type": "string",
      "description": "When **true,** the payment gateway account is enabled."
    },
    "displayName": {
      "type": "string",
      "description": "A user-defined name for a connected gateway account.\n\nThis name is used in the Admin panel in the list of connected accounts and in Tagger in the payment gateway selector.\n\nThe human-readable version of `paymentGatewayAccountId`."
    },
    "lastModified": {
      "type": "string",
      "description": "The UTC DateTime that the payment gateway account was last updated."
    },
    "paymentGateway": {
      "type": "string",
      "description": "Payment gateway used by the connected gateway account.\nThis is the name used by the API.\nFor a human-readable version use `paymentGatewayDisplayName`.\n\nPossible values are:\n\n* `Stripe`\n* `Braintree`\n* `AuthorizeDotNet`\n* `CyberSource`\n* `Zuora`\n* `Elavon`"
    },
    "allowCustomMetadata": {
      "type": "boolean",
      "description": "When **true,** the sender can pass custom metadata about the payment to the payment gateway. You pass in this metadata on an EnvelopeRecipientTab, in the `customMetadata` property under `paymentDetails`. \n\nFor example, this property is set to **true** for the Authorize.net gateway by default. As a result, the extra metadata that you send displays for the Authorize.net transaction in the merchant gateway portal under **Description.**\n\n**Note:** This property is read-only and cannot be changed."
    },
    "supportedCurrencies": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of ISO 4217 currency codes for the currencies that the payment gateway account supports.\n\nExamples: \n\n- `USD`\n- `CAD`\n- `EUR`\n- `HKD`"
    },
    "payPalLegacySettings": {
      "$ref": "#/components/schemas/payPalLegacySettings"
    },
    "zeroDecimalCurrencies": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "paymentGatewayAccountId": {
      "type": "string",
      "description": "A GUID that identifies the payment gateway account. For a human-readable version use `displayName`."
    },
    "supportedPaymentMethods": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of paymentMethodWithOptions objects that specify the payment methods that are available for the gateway."
    },
    "paymentGatewayDisplayName": {
      "type": "string",
      "description": "The display name of the payment gateway that the connected gateway account uses.\nThis is the human-readable version of `paymentGateway`.\n\nPossible values are:\n\n* Stripe\n* Braintree\n* Authorize.Net\n* CyberSource\n* Zuora\n* Elavon"
    },
    "supportedPaymentMethodsWithOptions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/paymentMethodWithOptions"
      },
      "description": "An array of `paymentMethodWithOptions` objects that specify the payment methods that are available for the gateway, as well as the payment options that are compatible with each payment method."
    }
  },
  "description": "This object contains details about a payment gateway account.",
  "x-ms-summary": "This object contains details about a payment gateway account.",
  "x-ds-definition-name": "paymentGatewayAccount"
}

{
  "type": "object",
  "properties": {
    "apiFields": {
      "type": "string",
      "description": ""
    },
    "merchantId": {
      "type": "string",
      "description": ""
    },
    "credentialStatus": {
      "type": "string",
      "description": ""
    },
    "authorizationCode": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "paymentGatewayAccountSetting"
}

{
  "type": "object",
  "properties": {
    "paymentGatewayAccounts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/paymentGatewayAccount"
      },
      "description": "A list of payment gateway accounts."
    }
  },
  "description": "Holds information about connected payment accounts.",
  "x-ms-summary": "Holds information about connected payment accounts.",
  "x-ds-definition-name": "paymentGatewayAccountsInfo"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "This is a sender-defined\nproduct name, service name,\nor other designation for the line item.\n"
    },
    "itemCode": {
      "type": "string",
      "description": "This is the sender-defined\nSKU, inventory number, or other item code\nfor the line item.\n"
    },
    "description": {
      "type": "string",
      "description": "A sender-defined description of the line item.\n"
    },
    "amountReference": {
      "type": "string",
      "description": "This is a the `tabLabel`\nthat specifies the amount paid\nfor the line items.\n\n"
    }
  },
  "description": "A line item describes details\nabout an individual line item\nin a payment request.\n\n",
  "x-ms-summary": "A line item describes details\nabout an individual line item\nin a payment request.\n\n",
  "x-ds-definition-name": "paymentLineItem"
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The name of a payment method that the gateway accepts.\n\nPossible values are:\n\n- `CreditCard`\n- `ApplePay`\n- `AndroidPay`\n- `BankAccount`\n- `PayPal`"
    },
    "supportedOptions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The payment options that are compatible with the payment method in the `type` property.\n\nPossible values are:\n\n- `save` \n- `save_and_authorize`\n- `authorize`"
    },
    "supportedCurrencies": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of ISO 4217 currency codes for the currencies that the payment gateway account supports.\n\nExamples: \n\n- `USD`\n- `CAD`\n- `EUR`\n- `HKD`"
    }
  },
  "description": "This object contains information about a payment method that the gateway accepts and the payment options that are compatible with it.",
  "x-ms-summary": "This object contains information about a payment method that the gateway accepts and the payment options that are compatible with it.",
  "x-ds-definition-name": "paymentMethodWithOptions"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The email address associated with the payment processor."
    },
    "address": {
      "$ref": "#/components/schemas/addressInformation"
    },
    "billingAgreementId": {
      "type": "string",
      "description": "The ID of the billing agreement."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "paymentProcessorInformation"
}

{
  "type": "object",
  "properties": {
    "paymentOption": {
      "type": "string",
      "description": "This property specifies how the signer's collected payment details will be used.\n\nValid values:\n\n- `authorize`: The payment details will be used to collect payment. This is the default value.\n- `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway.\n- `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "paymentSignerValues"
}

{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userInformation"
      },
      "description": "A list of user objects containing information about the users who are associated with the account permission profile."
    },
    "settings": {
      "$ref": "#/components/schemas/accountRoleSettings"
    },
    "userCount": {
      "type": "string",
      "description": "The total number of users in the group associated with the account permission profile."
    },
    "modifiedDateTime": {
      "type": "string",
      "description": "The date and time when the permission profile was last modified."
    },
    "modifiedByUsername": {
      "type": "string",
      "description": "The username of the user who last modified the permission profile."
    },
    "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"
    },
    "permissionProfileName": {
      "type": "string",
      "description": "The name of the account permission profile. \n\nExample: `Account Administrator`"
    }
  },
  "description": "This object defines the account permissions for a profile that you can apply to a group of users.",
  "x-ms-summary": "This object defines the account permissions for a profile that you can apply to a group of users.",
  "x-ds-definition-name": "permissionProfile"
}

{
  "type": "object",
  "properties": {
    "permissionProfiles": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/permissionProfile"
      },
      "description": "A complex type containing a collection of permission profiles."
    }
  },
  "description": "Contains details about the permission profiles associated with an account.",
  "x-ms-summary": "Contains details about the permission profiles associated with an account.",
  "x-ds-definition-name": "permissionProfileInformation"
}

{
  "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": ""
    },
    "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": "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."
    },
    "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"
    },
    "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"
    },
    "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": "Specifies the page number on which the tab is located."
    },
    "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 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[notary]: /docs/notary-api/",
  "x-ms-summary": "A 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[notary]: /docs/notary-api/",
  "x-ds-definition-name": "phoneNumber"
}

{
  "type": "object",
  "properties": {
    "addOns": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/addOn"
      },
      "description": "Reserved for DocuSign."
    },
    "planId": {
      "type": "string",
      "description": "DocuSign's ID for the account plan."
    },
    "currencyCode": {
      "type": "string",
      "description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account."
    },
    "planFeatureSets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/featureSet"
      },
      "description": "Reserved for DocuSign."
    },
    "recipientDomains": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientDomain"
      },
      "description": ""
    },
    "freeTrialDaysOverride": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "An object used to identify the features and attributes of the account being created.",
  "x-ms-summary": "An object used to identify the features and attributes of the account being created.",
  "x-ds-definition-name": "planInformation"
}

{
  "type": "object",
  "properties": {
    "x1": {
      "type": "string",
      "description": ""
    },
    "x2": {
      "type": "string",
      "description": ""
    },
    "y1": {
      "type": "string",
      "description": ""
    },
    "y2": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "polyLine"
}

{
  "type": "object",
  "properties": {
    "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."
    },
    "locked": {
      "type": "string",
      "description": "When **true,** the signer cannot change the data of the custom tab."
    },
    "shared": {
      "type": "string",
      "description": "When **true,** indicates that the 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": ""
    },
    "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"
    },
    "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."
    },
    "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."
    },
    "polyLines": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/polyLine"
      },
      "description": "An array of `polyLine` objects that contain x- and y-coordinates representing the locations of the lines."
    },
    "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"
    },
    "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"
    },
    "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": "Specifies the page number on which the tab is located."
    },
    "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."
    },
    "overlayType": {
      "type": "string",
      "description": "The type of overlay to use. The API currently supports only the `outline` overlay type."
    },
    "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."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "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"
    },
    "lockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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"
    },
    "graphicsContext": {
      "$ref": "#/components/schemas/graphicsContext"
    },
    "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"
    },
    "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."
    },
    "formOrderMetadata": {
      "$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"
    },
    "overlayTypeMetadata": {
      "$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 enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates.",
  "x-ms-summary": "This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates.",
  "x-ds-definition-name": "polyLineOverlay"
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "The URI for the PowerForm."
    },
    "name": {
      "type": "string",
      "description": "The name of the PowerForm."
    },
    "isActive": {
      "type": "string",
      "description": "When **true,** indicates that the PowerForm is active and can be sent to recipients. This is the default value.\n\nWhen **false,** the PowerForm cannot be emailed or accessed by a recipient, even if they arrive at the PowerForm URL. \n\nIf a recipient attempts to sign an inactive PowerForm, an error message informs the recipient that the document is not active and suggests that they contact the sender.\n"
    },
    "lastUsed": {
      "type": "string",
      "description": "The UTC DateTime when the PowerForm was last used."
    },
    "createdBy": {
      "type": "string",
      "description": "The ID of the user who created the PowerForm."
    },
    "emailBody": {
      "type": "string",
      "description": "The body of the email message sent to the recipients. \n\nMaximum length: 10000 characters."
    },
    "envelopes": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelope"
      },
      "description": ""
    },
    "timesUsed": {
      "type": "string",
      "description": "The number of times the PowerForm has been used. "
    },
    "recipients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/powerFormRecipient"
      },
      "description": "An array of recipient objects that provides details about the recipients of the envelope."
    },
    "senderName": {
      "type": "string",
      "description": "The sender's name."
    },
    "templateId": {
      "type": "string",
      "description": "The ID of the template used to create the PowerForm."
    },
    "powerFormId": {
      "type": "string",
      "description": "The ID of the PowerForm."
    },
    "signingMode": {
      "type": "string",
      "description": "The signing mode to use. Valid values are:\n \n- `email`: Verifies the recipient's identity using email authentication before the recipient can sign a document. The recipient enters their email address and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code for the PowerForm to the recipient. If the recipient does not provide a valid email address, they cannot open and sign the document.  \n- `direct`: Does not require any verification. After a recipient enters their email address and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process. Because the recipient's identity is not verified by using email authentication, we strongly recommend that you only use the `direct` signing mode when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check).  \n\n**Note:** In the account settings, `enablePowerFormDirect` must be **true** to use `direct` as the `signingMode`."
    },
    "emailSubject": {
      "type": "string",
      "description": "The subject line of the email message that is sent to all recipients.\n\nFor information about adding merge field information to the email subject, see [Template Email Subject Merge Fields](/docs/esign-rest-api/reference/templates/templates/create/#template-email-subject-merge-fields).\n\n**Note:** The subject line is limited to 100 characters, including any merged fields.It is not truncated. It is an error if the text is longer than 100 characters.\n"
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "instructions": {
      "type": "string",
      "description": "The instructions that display on the landing page for the first recipient. These instructions are important if the recipient accesses the PowerForm by a method other than email. If instructions are entered, they display as an introduction after the recipient accesses the PowerForm.  Limit: 2000 characters."
    },
    "powerFormUrl": {
      "type": "string",
      "description": "The URL for the PowerForm."
    },
    "senderUserId": {
      "type": "string",
      "description": "The ID of the sender."
    },
    "templateName": {
      "type": "string",
      "description": "The name of the template used to create the PowerForm."
    },
    "maxUseEnabled": {
      "type": "string",
      "description": "When **true,** you can set a maximum number of uses for the PowerForm."
    },
    "usesRemaining": {
      "type": "string",
      "description": "The number of times the PowerForm can still be used."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the item was created."
    },
    "limitUseInterval": {
      "type": "string",
      "description": "The length of time before the same recipient can sign the same PowerForm. This property is used in combination with the `limitUseIntervalUnits` property."
    },
    "limitUseIntervalUnits": {
      "type": "string",
      "description": "The units associated with the `limitUseInterval`. Valid values are:\n\n- `minutes`\n- `hours\n- `days`\n- `weeks`\n- `months`\n\nFor example, to limit a recipient to signing once per year, set the `limitUseInterval` to 365 and the `limitUseIntervalUnits` to `days`.\n"
    },
    "limitUseIntervalEnabled": {
      "type": "string",
      "description": "When **true,** the `limitUseInterval` is enabled."
    }
  },
  "description": "Contains details about a PowerForm.",
  "x-ms-summary": "Contains details about a PowerForm.",
  "x-ds-definition-name": "powerForm"
}

{
  "type": "object",
  "properties": {
    "envelopeId": {
      "type": "string",
      "description": "The envelope ID of the envelope status that failed to post."
    },
    "recipients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/powerFormFormDataRecipient"
      },
      "description": "An array of recipient objects that provides details about the recipients of the envelope."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "powerFormFormDataEnvelope"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the recipient."
    },
    "email": {
      "type": "string",
      "description": ""
    },
    "formData": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": ""
    },
    "recipientId": {
      "type": "string",
      "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "powerFormFormDataRecipient"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the PowerForm recipient.\n\n**Note:** For self-service documents where you do not know who the recipients are in advance, you can leave this property blank."
    },
    "email": {
      "type": "string",
      "description": "The email address of the recipient.\n\n**Note:** For self-service documents where you do not know who the recipients are in advance, you can leave this property blank."
    },
    "roleName": {
      "type": "string",
      "description": "The role associated with the recipient (for example, `Member`).\n\nThis property is required when you are working with template recipients and PowerForm recipients."
    },
    "accessCode": {
      "type": "string",
      "description": "(Optional) The access code that the recipient must enter to access the PowerForm.\n\nMaximum Length: 50 characters. The code must also 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."
    },
    "emailLocked": {
      "type": "string",
      "description": "When **true,** the recipient's email address is locked and cannot be edited."
    },
    "routingOrder": {
      "type": "string",
      "description": "Specifies the routing order of the recipient in the envelope. "
    },
    "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."
    },
    "userNameLocked": {
      "type": "string",
      "description": "When **true,** the `userName` property for the recipient is locked and cannot be edited."
    },
    "idCheckRequired": {
      "type": "string",
      "description": "Indicates if authentication is configured for the account. Valid values are:\n\n- `always`: Authentication checks are performed on every envelope. \n- `never`: Authentication checks are not performed on any envelopes. \n- `optional:` Authentication is configurable per envelope."
    },
    "accessCodeLocked": {
      "type": "string",
      "description": "When **true,** the `accessCode` property is locked and cannot be edited."
    },
    "accessCodeRequired": {
      "type": "string",
      "description": "When **true,** the recipient must enter the `accessCode` to access the PowerForm."
    },
    "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."
    },
    "templateRequiresIdLookup": {
      "type": "string",
      "description": "When **true,** the template used to create the PowerForm requires ID lookup for the recipient."
    }
  },
  "description": "**Note:** For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`.",
  "x-ms-summary": "**Note:** For a self-service PowerForm on a website, you can specify the intended recipients generically (for example, use `Member` as the `Name`), and omit personal details such as `email`.",
  "x-ds-definition-name": "powerFormRecipient"
}

{
  "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": "integer",
      "format": "int32",
      "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": "integer",
      "format": "int32",
      "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": "integer",
      "format": "int32",
      "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": "integer",
      "format": "int32",
      "description": "The starting index position of the current result set."
    },
    "powerFormSenders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userInfo"
      },
      "description": "An array of `userInfo` objects containing information about users who have sent PowerForms."
    }
  },
  "description": "This object includes information about the users who have sent PowerForms.",
  "x-ms-summary": "This object includes information about the users who have sent PowerForms.",
  "x-ds-definition-name": "powerFormSendersResponse"
}

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

{
  "type": "object",
  "properties": {
    "powerForms": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/powerForm"
      },
      "description": "An array of PowerForm objects."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "powerFormsRequest"
}

{
  "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. "
    },
    "powerForms": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/powerForm"
      },
      "description": "An array of PowerForm objects."
    },
    "endPosition": {
      "type": "integer",
      "format": "int32",
      "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": "integer",
      "format": "int32",
      "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": "integer",
      "format": "int32",
      "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": "integer",
      "format": "int32",
      "description": "The starting index position of the current result set."
    }
  },
  "description": "A list of PowerForms.",
  "x-ms-summary": "A list of PowerForms.",
  "x-ds-definition-name": "powerFormsResponse"
}

{
  "type": "object",
  "properties": {
    "formData": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/formDataItem"
      },
      "description": ""
    },
    "senderName": {
      "type": "string",
      "description": "The sender's name."
    },
    "senderEmail": {
      "type": "string",
      "description": "The sender's email address."
    },
    "senderUserId": {
      "type": "string",
      "description": "The ID of the sender."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "prefillFormData"
}

{
  "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"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "senderNameTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/senderName"
      },
      "description": ""
    },
    "senderCompanyTabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/senderCompany"
      },
      "description": ""
    }
  },
  "description": "Prefill tabs are tabs\nthat the sender can fill in\nbefore the envelope is sent.\nThey are sometimes called\nsender tags or pre-fill fields.\n\nOnly the following tab types can be\nprefill tabs:\n\n- text\n- check boxes\n- radio buttons\n\n\n\n[Pre-Fill Your Own Document Fields][app]\ndescribes how prefill tabs\nwork in the web application.\n\n\n[Customize your envelopes with pre-fill fields][catblog]\nshows how to use prefill tabs\nin your application using the eSignature\nSDKs.\n\n[app]:      https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html\n[catblog]:  https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields",
  "x-ms-summary": "Prefill tabs are tabs\nthat the sender can fill in\nbefore the envelope is sent.\nThey are sometimes called\nsender tags or pre-fill fields.\n\nOnly the following tab types can be\nprefill tabs:\n\n- text\n- check boxes\n- radio buttons\n\n\n\n[Pre-Fill Your Own Document Fields][app]\ndescribes how prefill tabs\nwork in the web application.\n\n\n[Customize your envelopes with pre-fill fields][catblog]\nshows how to use prefill tabs\nin your application using the eSignature\nSDKs.\n\n[app]:      https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html\n[catblog]:  https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields",
  "x-ds-definition-name": "prefillTabs"
}

{
  "type": "object",
  "properties": {
    "rights": {
      "type": "string",
      "description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`"
    },
    "options": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of option strings supported by this setting."
    }
  },
  "description": "Metadata about a property.",
  "x-ms-summary": "Metadata about a property.",
  "x-ds-definition-name": "propertyMetadata"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": ""
    },
    "isoCode": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "province"
}

{
  "type": "object",
  "properties": {
    "defaultPlanId": {
      "type": "string",
      "description": ""
    },
    "distributorCode": {
      "type": "string",
      "description": "The code that identifies the billing plan groups and plans for the new account."
    },
    "passwordRuleText": {
      "type": "string",
      "description": ""
    },
    "planPromotionText": {
      "type": "string",
      "description": ""
    },
    "defaultConnectionId": {
      "type": "string",
      "description": ""
    },
    "distributorPassword": {
      "type": "string",
      "description": "The password for the `distributorCode`."
    },
    "purchaseOrderOrPromAllowed": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "provisioningInformation"
}

{
  "type": "object",
  "properties": {
    "amount": {
      "type": "string",
      "description": "The total amount of the purchase."
    },
    "appName": {
      "type": "string",
      "description": "The AppName of the client application."
    },
    "platform": {
      "type": "string",
      "description": "The Platform of the client application"
    },
    "quantity": {
      "type": "string",
      "description": "The quantity of envelopes to add to the account."
    },
    "productId": {
      "type": "string",
      "description": "The Product ID from the AppStore."
    },
    "storeName": {
      "type": "string",
      "description": "The name of the AppStore."
    },
    "receiptData": {
      "type": "string",
      "description": "The encrypted Base64 encoded receipt data."
    },
    "currencyCode": {
      "type": "string",
      "description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the purchase.\n"
    },
    "transactionId": {
      "type": "string",
      "description": "Specifies the Transaction ID from the AppStore."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "purchasedEnvelopesInformation"
}

{
  "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."
    },
    "value": {
      "type": "string",
      "description": "Specifies the value of the tab. "
    },
    "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."
    },
    "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."
    },
    "caption": {
      "type": "string",
      "description": ""
    },
    "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."
    },
    "selected": {
      "type": "string",
      "description": "When **true,** the radio button is selected."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "pageNumber": {
      "type": "string",
      "description": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n"
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "mergeFieldXml": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "tabIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "valueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "italicMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "lockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "statusMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "captionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "fontSizeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requiredMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "selectedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "fontColorMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "underlineMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "xPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "yPositionMetadata": {
      "$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"
    },
    "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"
    },
    "anchorIgnoreIfNotPresent": {
      "type": "string",
      "description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
    },
    "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"
    },
    "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": "One of the selectable radio buttons\nin the `radios` property\nof a [`radioGroup`](https://raw.githubusercontent.com) tab.\n",
  "x-ms-summary": "One of the selectable radio buttons\nin the `radios` property\nof a [`radioGroup`](https://raw.githubusercontent.com) tab.\n",
  "x-ds-definition-name": "radio"
}

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "Specifies the value of the tab. "
    },
    "radios": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/radio"
      },
      "description": "Specifies the locations and status for radio buttons that are grouped together."
    },
    "shared": {
      "type": "string",
      "description": "When **true,** this custom tab is shared."
    },
    "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"
    },
    "groupName": {
      "type": "string",
      "description": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name."
    },
    "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."
    },
    "requireAll": {
      "type": "string",
      "description": "When **true** and shared is true, information must be entered in this field to complete the envelope. "
    },
    "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"
    },
    "originalValue": {
      "type": "string",
      "description": "The initial value of the tab. "
    },
    "valueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "sharedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "templateLocked": {
      "type": "string",
      "description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
    },
    "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"
    },
    "templateRequired": {
      "type": "string",
      "description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
    },
    "groupNameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "shareToRecipients": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "documentIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requireAllMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "originalValueMetadata": {
      "$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"
    },
    "templateLockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientIdGuidMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "templateRequiredMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "shareToRecipientsMetadata": {
      "$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."
    },
    "conditionalParentLabelMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "conditionalParentValueMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "requireInitialOnSharedChangeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "This group tab is used to place radio buttons on a document.\nThe `radios` property\ncontains a list of\n[`radio`](https://raw.githubusercontent.com)\nobjects  associated with the group. Only one radio button can\nbe selected in a group.\n",
  "x-ms-summary": "This group tab is used to place radio buttons on a document.\nThe `radios` property\ncontains a list of\n[`radio`](https://raw.githubusercontent.com)\nobjects  associated with the group. Only one radio button can\nbe selected in a group.\n",
  "x-ds-definition-name": "radioGroup"
}

{
  "type": "object",
  "properties": {
    "phoneNumber": {
      "$ref": "#/components/schemas/recipientPhoneNumber"
    },
    "secondaryDeliveryMethod": {
      "type": "string",
      "description": "The secondary 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/"
    },
    "secondaryDeliveryStatus": {
      "type": "string",
      "description": "The status of the delivery. This property is read-only.\n\nOne of:\n\n- `autoresponded`\n- `optedout`\n- `limitreached`\n"
    },
    "secondaryDeliveryMethodMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "Describes an additional notification method.",
  "x-ms-summary": "Describes an additional notification method.",
  "x-ds-definition-name": "recipientAdditionalNotification"
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "string",
      "description": "A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size."
    },
    "name": {
      "type": "string",
      "description": "The name of the attachment."
    },
    "label": {
      "type": "string",
      "description": "An optional label for the attachment."
    },
    "remoteUrl": {
      "type": "string",
      "description": "The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads."
    },
    "attachmentId": {
      "type": "string",
      "description": "The unique identifier for the attachment."
    },
    "attachmentType": {
      "type": "string",
      "description": "Specifies the type of the attachment for the recipient. Possible values are:\n\n- `.htm`\n- `.xml`"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "recipientAttachment"
}

{
  "type": "object",
  "properties": {
    "active": {
      "type": "string",
      "description": ""
    },
    "domainCode": {
      "type": "string",
      "description": ""
    },
    "domainName": {
      "type": "string",
      "description": ""
    },
    "recipientDomainId": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "recipientDomain"
}

{
  "type": "object",
  "properties": {
    "emailBody": {
      "type": "string",
      "description": "The body of the email message."
    },
    "emailSubject": {
      "type": "string",
      "description": "The subject line for the email notification."
    },
    "emailBodyMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "supportedLanguage": {
      "type": "string",
      "description": "The language to use for the standard email format and signing view for a recipient.\n\nFor example, this setting determines the language of the recipient's email notification message. It also determines the language used for buttons and tabs in both the email notification and the signing experience.\n\n**Note:** This setting affects only DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it.\n\nTo retrieve the possible values, use the [Accounts::listSupportedLanguages][ListLang] method.\n\n[ListLang]: /docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/\n"
    },
    "emailSubjectMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "supportedLanguageMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "Sets custom email subject and email body for individual\nrecipients. **Note:** You must explicitly set `supportedLanguage`\nif you use this feature.\n",
  "x-ms-summary": "Sets custom email subject and email body for individual\nrecipients. **Note:** You must explicitly set `supportedLanguage`\nif you use this feature.\n",
  "x-ds-definition-name": "recipientEmailNotification"
}

{
  "type": "object",
  "properties": {
    "includeDocuments": {
      "type": "string",
      "description": "When **true,**\nthe Connect webhook messages\nwill include the envelope's PDF documents.\nIncluding the PDF documents\ngreatly increases the size of the notification messages.\nEnsure that your listener can handle\nincoming messages that are 25MB or larger."
    },
    "recipientEventStatusCode": {
      "type": "string",
      "description": "Send a webhook notification for the following recipient statuses: Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "recipientEvent"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the recipient."
    },
    "email": {
      "type": "string",
      "description": "The recipient's email address."
    },
    "SentTime": {
      "type": "string",
      "description": "The date and time the envelope was sent to the recipient."
    },
    "formData": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/formDataItem"
      },
      "description": "An array of form data objects."
    },
    "SignedTime": {
      "type": "string",
      "description": "The date and time the recipient signed the documents."
    },
    "recipientId": {
      "type": "string",
      "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."
    },
    "DeclinedTime": {
      "type": "string",
      "description": "The date and time the recipient declined the envelope."
    },
    "DeliveredTime": {
      "type": "string",
      "description": "The date and time the recipient viewed the documents in the envelope in the DocuSign signing UI."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "recipientFormData"
}

{
  "type": "object",
  "properties": {
    "groupName": {
      "type": "string",
      "description": "The name of the group."
    },
    "recipients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientOption"
      },
      "description": "An array of recipient objects that provides details about the recipients of the envelope."
    },
    "groupMessage": {
      "type": "string",
      "description": "The group message, typically a description of the group."
    }
  },
  "description": "Describes a group of recipients.",
  "x-ms-summary": "Describes a group of recipients.",
  "x-ds-definition-name": "recipientGroup"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": ""
    },
    "valueType": {
      "type": "string",
      "description": ""
    },
    "phoneNumberList": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientIdentityPhoneNumber"
      },
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "recipientIdentityInputOption"
}

{
  "type": "object",
  "properties": {
    "number": {
      "type": "string",
      "description": "The telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters.\n\nDo not include the `countryCode`. For US, Canada, and other\n[North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`."
    },
    "extension": {
      "type": "string",
      "description": "The telephone extension, if any."
    },
    "countryCode": {
      "type": "string",
      "description": "The numeric country calling code for the phone number. For example, the country calling code for the US and Canada is 1. For the UK, the country calling code is 44.\n\nDo not include the + symbol."
    },
    "numberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "countryCodeLock": {
      "type": "string",
      "description": ""
    },
    "extensionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "countryCodeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "recipientIdentityPhoneNumber"
}

{
  "type": "object",
  "properties": {
    "workflowId": {
      "type": "string",
      "description": "ID of the Identity Verification worklow used to verify recipients' identity.\n\nThis ID must match one of the [workflowId](https://raw.githubusercontent.com) available to your account."
    },
    "inputOptions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientIdentityInputOption"
      },
      "description": ""
    },
    "workflowLabel": {
      "type": "string",
      "description": ""
    },
    "workflowIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "Specifies ID Verification applied on an envelope by workflow ID.\nSee the [list](https://raw.githubusercontent.com)\nmethod in the [IdentityVerifications](https://raw.githubusercontent.com) resource\nfor more information on how to retrieve workflow IDs available for an account.\nThis can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods.",
  "x-ms-summary": "Specifies ID Verification applied on an envelope by workflow ID.\nSee the [list](https://raw.githubusercontent.com)\nmethod in the [IdentityVerifications](https://raw.githubusercontent.com) resource\nfor more information on how to retrieve workflow IDs available for an account.\nThis can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods.",
  "x-ds-definition-name": "recipientIdentityVerification"
}

{
  "type": "object",
  "properties": {
    "multipleUsers": {
      "type": "string",
      "description": "When **true,** the email address is used by more than one user."
    },
    "recipientNames": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "The names of the recipients associated with the email address."
    },
    "reservedRecipientEmail": {
      "type": "string",
      "description": "When **true,** new names cannot be added to the email address."
    }
  },
  "description": "This response object contains a list of recipients.",
  "x-ms-summary": "This response object contains a list of recipients.",
  "x-ds-definition-name": "recipientNamesResponse"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The full legal name of the recipient. Maximum length: 100 characters."
    },
    "email": {
      "type": "string",
      "description": "The email ID of the agent. This property is required. Maximum length: 100 characters."
    },
    "roleName": {
      "type": "string",
      "description": "Specifies the signing group role of the recipient. This property is required."
    },
    "recipientLabel": {
      "type": "string",
      "description": "An identifier for the recipient. After assigning this value in a `recipient` object, you can reference it in the `conditions` object to set the recipient as a conditional recipient. For an example, see [How to use conditional recipients](https://raw.githubusercontent.com).\n"
    },
    "signingGroupId": {
      "type": "string",
      "description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
    }
  },
  "description": "Describes a recipient who is a member of a conditional group.",
  "x-ms-summary": "Describes a recipient who is a member of a conditional group.",
  "x-ds-definition-name": "recipientOption"
}

{
  "type": "object",
  "properties": {
    "recordVoicePrint": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "recipMayProvideNumber": {
      "type": "string",
      "description": "Boolean. When **true,** the recipient can supply a phone number their choice."
    },
    "senderProvidedNumbers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array containing a list of phone numbers that the recipient can use for SMS text authentication. "
    },
    "recordVoicePrintMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "validateRecipProvidedNumber": {
      "type": "string",
      "description": " Reserved for DocuSign."
    },
    "recipMayProvideNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "senderProvidedNumbersMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "validateRecipProvidedNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "A complex type that contains the elements:\n\n* `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice.\n* `senderProvidedNumbers`: A list of phone numbers that the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.",
  "x-ms-summary": "A complex type that contains the elements:\n\n* `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice.\n* `senderProvidedNumbers`: A list of phone numbers that the recipient can use.\n* `recordVoicePrint`: Reserved for DocuSign.\n* `validateRecipProvidedNumber`: Reserved for DocuSign.",
  "x-ds-definition-name": "recipientPhoneAuthentication"
}

{
  "type": "object",
  "properties": {
    "number": {
      "type": "string",
      "description": "The telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters.\n\nDo not include the `countryCode`. For US, Canada, and other\n[North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`."
    },
    "countryCode": {
      "type": "string",
      "description": "The numeric country calling code for `number`. For example, the country calling code for the US and Canada is `1`, for the UK: `44`,\n\nDo not include the `+` symbol."
    },
    "numberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "countryCodeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "Describes the recipient phone number.",
  "x-ms-summary": "Describes the recipient phone number.",
  "x-ds-definition-name": "recipientPhoneNumber"
}

{
  "type": "object",
  "properties": {
    "pingUrl": {
      "type": "string",
      "description": "The client URL that the DocuSign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received."
    },
    "returnUrl": {
      "type": "string",
      "description": "This property is not supported."
    },
    "clientURLs": {
      "$ref": "#/components/schemas/recipientTokenClientURLs"
    },
    "assertionId": {
      "type": "string",
      "description": "A unique identifier of the authentication event executed by the client application."
    },
    "recipientId": {
      "type": "string",
      "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."
    },
    "pingFrequency": {
      "type": "string",
      "description": "Only used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`.  The default is `300` seconds. Valid values are 60-1200 seconds."
    },
    "xFrameOptions": {
      "type": "string",
      "description": "Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames.\n\nValid values are:\n\n- `deny`: The page cannot be displayed in a frame.\n- `same_origin`: The page can only be displayed in a frame on the same origin as the page itself.\n- `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property."
    },
    "securityDomain": {
      "type": "string",
      "description": "The domain in which the user authenticated."
    },
    "authenticationMethod": {
      "type": "string",
      "description": "Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. \n\nChoose a value from this list: \n* Biometric \n* Email\n* HTTPBasicAuth\n* Kerberos\n* KnowledgeBasedAuth\n* None\n* PaperDocuments\n* Password\n* RSASecureID\n* SingleSignOn_CASiteminder\n* SingleSignOn_InfoCard\n* SingleSignOn_MicrosoftActiveDirectory\n* SingleSignOn_Other\n* SingleSignOn_Passport\n* SingleSignOn_SAML\n* Smartcard\n* SSLMutualAuth\n* X509Certificate\n\nThis information is included in the Certificate of Completion."
    },
    "authenticationInstant": {
      "type": "string",
      "description": "A sender-generated value that indicates the date and time that the signer was authenticated."
    },
    "xFrameOptionsAllowFromUrl": {
      "type": "string",
      "description": "When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property."
    }
  },
  "description": "This request object contains the information necessary to create a recipient preview.",
  "x-ms-summary": "This request object contains the information necessary to create a recipient preview.",
  "x-ds-definition-name": "recipientPreviewRequest"
}

{
  "type": "object",
  "properties": {
    "isInProofFile": {
      "type": "string",
      "description": "Indicates whether a proof file is available for this recipient."
    },
    "hasIdentityAttempts": {
      "type": "string",
      "description": ""
    }
  },
  "description": "The proof file of the recipient. [ID Evidence](https://raw.githubusercontent.com) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](https://raw.githubusercontent.com)",
  "x-ms-summary": "The proof file of the recipient. [ID Evidence](https://raw.githubusercontent.com) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](https://raw.githubusercontent.com)",
  "x-ds-definition-name": "recipientProofFile"
}

{
  "type": "object",
  "properties": {
    "rules": {
      "$ref": "#/components/schemas/recipientRules"
    }
  },
  "description": "Describes the recipient routing rules.",
  "x-ms-summary": "Describes the recipient routing rules.",
  "x-ds-definition-name": "recipientRouting"
}

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

{
  "type": "object",
  "properties": {
    "senderProvidedNumbers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array containing a list of phone numbers that the recipient can use for SMS text authentication. "
    },
    "senderProvidedNumbersMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "Contains the element senderProvidedNumbers which is an Array  of phone numbers the recipient can use for SMS text authentication.",
  "x-ms-summary": "Contains the element senderProvidedNumbers which is an Array  of phone numbers the recipient can use for SMS text authentication.",
  "x-ds-definition-name": "recipientSMSAuthentication"
}

{
  "type": "object",
  "properties": {
    "fontStyle": {
      "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."
    },
    "signatureInitials": {
      "type": "string",
      "description": "Specifies the user's signature in initials format."
    }
  },
  "description": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers.",
  "x-ms-summary": "Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient.\n\nUsed only with recipient types In Person Signers and Signers.",
  "x-ds-definition-name": "recipientSignatureInformation"
}

{
  "type": "object",
  "properties": {
    "sealName": {
      "type": "string",
      "description": "Indicates the name of the electronic seal to apply on documents.\n"
    },
    "signatureProviderName": {
      "type": "string",
      "description": "The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](https://raw.githubusercontent.com). You can also retrieve the list by using the [AccountSignatureProviders: List](https://raw.githubusercontent.com) method.\n\nExample: `universalsignaturepen_default`\n\n"
    },
    "signatureProviderOptions": {
      "$ref": "#/components/schemas/recipientSignatureProviderOptions"
    },
    "sealDocumentsWithTabsOnly": {
      "type": "string",
      "description": "By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document.\n\nTo apply electronic seals on specific documents only, you must enable the  `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed. "
    },
    "signatureProviderNameMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://raw.githubusercontent.com).\n",
  "x-ms-summary": "An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](https://raw.githubusercontent.com).\n",
  "x-ds-definition-name": "recipientSignatureProvider"
}

{
  "type": "object",
  "properties": {
    "sms": {
      "type": "string",
      "description": "The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234."
    },
    "cpfNumber": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "signerRole": {
      "type": "string",
      "description": "The role or capacity of the signing recipient. Examples: Manager, Approver, etc."
    },
    "smsMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "oneTimePassword": {
      "type": "string",
      "description": "A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field."
    },
    "cpfNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "signerRoleMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "oneTimePasswordMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    }
  },
  "description": "Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](https://raw.githubusercontent.com)",
  "x-ms-summary": "Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](https://raw.githubusercontent.com)",
  "x-ds-definition-name": "recipientSignatureProviderOptions"
}

{
  "type": "object",
  "properties": {
    "onCancel": {
      "type": "string",
      "description": ""
    },
    "onDecline": {
      "type": "string",
      "description": ""
    },
    "onException": {
      "type": "string",
      "description": ""
    },
    "onFaxPending": {
      "type": "string",
      "description": ""
    },
    "onTTLExpired": {
      "type": "string",
      "description": ""
    },
    "onIdCheckFailed": {
      "type": "string",
      "description": ""
    },
    "onSessionTimeout": {
      "type": "string",
      "description": ""
    },
    "onSigningComplete": {
      "type": "string",
      "description": ""
    },
    "onViewingComplete": {
      "type": "string",
      "description": ""
    },
    "onAccessCodeFailed": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "recipientTokenClientURLs"
}

{
  "type": "object",
  "properties": {
    "tabs": {
      "$ref": "#/components/schemas/EnvelopeRecipientTabs"
    },
    "combined": {
      "type": "string",
      "description": "When you use the query parameter `combine_same_order_recipients` on the PUT Recipients call, the `recipientUpdateResponse` returns this property. When **true,** it indicates that the recipient has been combined or merged with a matching recipient. Recipient matching occurs as part of template matching, and is based on Recipient Role and Routing Order."
    },
    "recipientId": {
      "type": "string",
      "description": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "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."
    }
  },
  "description": "The recipient details that are returned after you update the recipient.",
  "x-ms-summary": "The recipient details that are returned after you update the recipient.",
  "x-ds-definition-name": "recipientUpdateResponse"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "(Required) Specifies the email of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient."
    },
    "userId": {
      "type": "string",
      "description": "The user ID of the recipient. You can use either the user ID or email and user name to identify the recipient. \n\nIf `userId` is used and a `clientUserId` is provided, the value in the `userId` property must match a `recipientId` (which you can retrieve with a GET recipients call) for the envelope. \n\nIf a `userId` is used and a `clientUserId` is not provided, the `userId` must match the user ID of the authenticating user."
    },
    "pingUrl": {
      "type": "string",
      "description": "The client URL that the DocuSign Signing experience should ping to indicate to the client that Signing is active. An HTTP GET call is executed against the client. The response from the client is ignored. The intent is for the client to reset its session timer when the request is received."
    },
    "userName": {
      "type": "string",
      "description": "The username of the recipient. You can use either `email` and `userName` or `userId` to identify the recipient."
    },
    "returnUrl": {
      "type": "string",
      "description": "(Required) The URL to which the user should be redirected\nafter the signing session has ended.\n\nMaximum Length: 470 characters. If the `returnUrl` exceeds this\nlimit, the user is redirected to a truncated URL\nBe sure to include `https://` in the URL\nor redirecting might fail on some browsers.\n\n\nWhen DocuSign redirects to\nthis URL, it will include an `event` query parameter that your app can use:\n\n* `access_code_failed`: Recipient used incorrect access code.\n* `cancel`: Recipient canceled the signing operation,\n  possibly by using the **Finish Later** option.\n* `decline`: Recipient declined to sign.\n* `exception`: A system error occurred during the signing process.\n* `fax_pending`: Recipient has a fax pending.\n* `id_check_failed`: Recipient failed an ID check.\n* `session_timeout`: The session timed out. An account can control this timeout by using the **Signer Session Timeout** option.\n* `signing_complete`: The recipient completed the signing ceremony.\n* `ttl_expired`: The Time To Live token for the envelope has expired.\n  After being successfully invoked, these tokens expire\n  after five minutes.\n* `viewing_complete`: The recipient completed viewing an envelope\n  that is in a read-only/terminal state,\n  such as completed, declined, or voided.\n\n"
    },
    "clientURLs": {
      "$ref": "#/components/schemas/recipientTokenClientURLs"
    },
    "assertionId": {
      "type": "string",
      "description": "A unique identifier of the authentication event executed by the client application."
    },
    "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": "A sender-created value. If provided, the recipient is treated as an embedded (captive) recipient or signer.\n\nUse your application's client ID (user ID) for the recipient. Doing so enables the details of your application's authentication of the recipient to be connected to the recipient's signature if the signature is disputed or repudiated.\n\nMaximum length: 100 characters."
    },
    "pingFrequency": {
      "type": "string",
      "description": "Only used if `pingUrl` is specified. This is the interval, in seconds, between pings on the `pingUrl`.  The default is `300` seconds. Valid values are 60-1200 seconds."
    },
    "xFrameOptions": {
      "type": "string",
      "description": "Specifies whether a browser should be allowed to render a page in a frame or IFrame. Setting this property ensures that your content is not embedded into unauthorized pages or frames.\n\nValid values are:\n\n- `deny`: The page cannot be displayed in a frame.\n- `same_origin`: The page can only be displayed in a frame on the same origin as the page itself.\n- `allow_from`: The page can only be displayed in a frame on the origin specified by the `xFrameOptionsAllowFromUrl` property."
    },
    "frameAncestors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "messageOrigins": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "securityDomain": {
      "type": "string",
      "description": "The domain in which the user authenticated."
    },
    "authenticationMethod": {
      "type": "string",
      "description": "Required. Choose a value that most closely matches the technique your application used to authenticate the recipient / signer. \n\nChoose a value from this list: \n* Biometric \n* Email\n* HTTPBasicAuth\n* Kerberos\n* KnowledgeBasedAuth\n* None\n* PaperDocuments\n* Password\n* RSASecureID\n* SingleSignOn_CASiteminder\n* SingleSignOn_InfoCard\n* SingleSignOn_MicrosoftActiveDirectory\n* SingleSignOn_Other\n* SingleSignOn_Passport\n* SingleSignOn_SAML\n* Smartcard\n* SSLMutualAuth\n* X509Certificate\n\nThis information is included in the Certificate of Completion."
    },
    "authenticationInstant": {
      "type": "string",
      "description": "A sender-generated value that indicates the date and time that the signer was authenticated."
    },
    "xFrameOptionsAllowFromUrl": {
      "type": "string",
      "description": "When the value of `xFrameOptions` is `allow_from`, this property specifies the origin on which the page is allowed to display in a frame. If the value of `xFrameOptions` is `allow_from`, you must include a value for this property."
    }
  },
  "description": "The request body for the [EnvelopeViews: createRecipient](https://raw.githubusercontent.com)\nand\n[EnvelopeViews: createSharedRecipient](https://raw.githubusercontent.com) methods.",
  "x-ms-summary": "The request body for the [EnvelopeViews: createRecipient](https://raw.githubusercontent.com)\nand\n[EnvelopeViews: createSharedRecipient](https://raw.githubusercontent.com) methods.",
  "x-ds-definition-name": "recipientViewRequest"
}

{
  "type": "object",
  "properties": {
    "seals": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/sealSign"
      },
      "description": "A list of electronic seals to apply to documents."
    },
    "agents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/agent"
      },
      "description": "A list of agent recipients assigned to the documents."
    },
    "editors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/editor"
      },
      "description": "A list of users who can edit the envelope."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signer"
      },
      "description": "A list of signers on the envelope."
    },
    "notaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/notaryRecipient"
      },
      "description": "A list of notary recipients on the envelope."
    },
    "witnesses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/witness"
      },
      "description": "A list of signers who act as witnesses on the envelope."
    },
    "carbonCopies": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/carbonCopy"
      },
      "description": "A list of carbon copy recipients assigned to the documents."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "participants": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/participant"
      },
      "description": ""
    },
    "intermediaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/intermediary"
      },
      "description": "Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added)."
    },
    "recipientCount": {
      "type": "string",
      "description": "The number of recipients in the envelope."
    },
    "inPersonSigners": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/inPersonSigner"
      },
      "description": "Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected."
    },
    "certifiedDeliveries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/certifiedDelivery"
      },
      "description": "A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents."
    },
    "currentRoutingOrder": {
      "type": "string",
      "description": "The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions."
    }
  },
  "description": "Specifies the envelope recipients.",
  "x-ms-summary": "Specifies the envelope recipients.",
  "x-ds-definition-name": "recipients"
}

{
  "type": "object",
  "properties": {
    "recipientUpdateResults": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientUpdateResponse"
      },
      "description": "An array of `recipientUpdateResults` objects that contain details about the recipients."
    }
  },
  "description": "This is the response that the API returns after you update recipients.",
  "x-ms-summary": "This is the response that the API returns after you update recipients.",
  "x-ds-definition-name": "recipientsUpdateSummary"
}

{
  "type": "object",
  "properties": {
    "idType": {
      "type": "string",
      "description": ""
    },
    "industry": {
      "type": "string",
      "description": "The name of the industry associated with the referral. \n\nExample: `Accounting`"
    },
    "promoCode": {
      "type": "string",
      "description": ""
    },
    "shopperId": {
      "type": "string",
      "description": ""
    },
    "publisherId": {
      "type": "string",
      "description": ""
    },
    "referralCode": {
      "type": "string",
      "description": ""
    },
    "referrerName": {
      "type": "string",
      "description": "The name of the referrer."
    },
    "enableSupport": {
      "type": "string",
      "description": "When **true,** customer support is provided as part of the account plan."
    },
    "externalOrgId": {
      "type": "string",
      "description": "An optional external ID for the referral."
    },
    "groupMemberId": {
      "type": "string",
      "description": ""
    },
    "includedSeats": {
      "type": "string",
      "description": "The number of seats (users) included in the plan."
    },
    "planStartMonth": {
      "type": "string",
      "description": ""
    },
    "advertisementId": {
      "type": "string",
      "description": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry.\n\n**Note:** saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DocuSign use only.\n"
    },
    "saleDiscountAmount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "saleDiscountPercent": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "saleDiscountPeriods": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "saleDiscountFixedAmount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "saleDiscountSeatPriceOverride": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry\n\n**Note:** saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DocuSign use only.",
  "x-ms-summary": "A complex type that contains the following information for entering referral and discount information. The following items are included in the referral information (all string content): enableSupport, includedSeats, saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, saleDiscountSeatPriceOverride, planStartMonth, referralCode, referrerName, advertisementId, publisherId, shopperId, promoCode, groupMemberId, idType, and industry\n\n**Note:** saleDiscountPercent, saleDiscountAmount, saleDiscountFixedAmount, saleDiscountPeriods, and saleDiscountSeatPriceOverride are reserved for DocuSign use only.",
  "x-ds-definition-name": "referralInformation"
}

{
  "type": "object",
  "properties": {
    "reminderDelay": {
      "type": "string",
      "description": "An integer specifying the number of days after the recipient receives the envelope that reminder emails are sent to the recipient. The default value is 0."
    },
    "reminderEnabled": {
      "type": "string",
      "description": "When **true,** reminders are enabled. The default value is **false.**"
    },
    "reminderFrequency": {
      "type": "string",
      "description": "An integer specifying the interval in days between reminder emails. The default value is 0."
    }
  },
  "description": "A complex element that specifies reminder settings for the envelope.",
  "x-ms-summary": "A complex element that specifies reminder settings for the envelope.",
  "x-ds-definition-name": "reminders"
}

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

{
  "type": "object",
  "properties": {
    "returnUrl": {
      "type": "string",
      "description": "The URL to which the user should be redirected after the editing session is complete. It must be an absolute URL (e.g. `https://www.example.com` not `www.example.com`).\n\nThe maximum length is 470 characters. If the value exceeds this limit, the user is redirected to a truncated URL.\n\n**Note:** If this property is not provided, the user will have full access to the sending account.\n"
    }
  },
  "description": "The request body for the [TemplateViews: createEdit](https://raw.githubusercontent.com) method.",
  "x-ms-summary": "The request body for the [TemplateViews: createEdit](https://raw.githubusercontent.com) method.",
  "x-ds-definition-name": "returnUrlRequest"
}

{
  "type": "object",
  "properties": {
    "rules": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeDelayRule"
      },
      "description": "User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified."
    },
    "status": {
      "type": "string",
      "description": "Status of the scheduled sending job. Valid values:\n\n* `pending`: The envelope has not yet been sent and the scheduled sending delay has not been initiated.\n* `started`: The sender has initiated the sending process. The delay has not elapsed, so the envelope has not yet been sent to the first recipient.\n* `completed`: The delay has elapsed and the envelope has been sent to the first recipient.\n\nThis property is read-only."
    },
    "bulkListId": {
      "type": "string",
      "description": "The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation."
    },
    "resumeDate": {
      "type": "string",
      "description": "The timestamp of when the envelope is scheduled to be sent in ISO 8601 format.\n\nThis property is read-only.\n"
    }
  },
  "description": "A complex element that specifies the scheduled sending settings for the envelope.",
  "x-ms-summary": "A complex element that specifies the scheduled sending settings for the envelope.",
  "x-ds-definition-name": "scheduledSending"
}

{
  "type": "object",
  "properties": {
    "sealName": {
      "type": "string",
      "description": "The name of a seal."
    },
    "sealDisplayName": {
      "type": "string",
      "description": "The user-friendly display name for a seal."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "sealIdentifier"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Not applicable."
    },
    "note": {
      "type": "string",
      "description": "Not applicable."
    },
    "tabs": {
      "$ref": "#/components/schemas/EnvelopeRecipientTabs"
    },
    "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": "Not applicable."
    },
    "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."
    },
    "accessCode": {
      "type": "string",
      "description": "Not applicable."
    },
    "statusCode": {
      "type": "string",
      "description": "The code associated with the recipient's status. This property is read-only."
    },
    "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": "Not applicable."
    },
    "customFields": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Not applicable."
    },
    "designatorId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "noteMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "routingOrder": {
      "type": "string",
      "description": "(Optional, default: 1) \nSpecifies the routing order of the electronic seal in the envelope.\nThe routing order assigned to your electronic seal cannot be shared with another recipient.\nIt is recommended that you set a routing order for your electronic seals.\n"
    },
    "sentDateTime": {
      "type": "string",
      "description": "Not applicable."
    },
    "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."
    },
    "totalTabCount": {
      "type": "string",
      "description": "Not applicable."
    },
    "completedCount": {
      "type": "string",
      "description": "Not applicable."
    },
    "declinedReason": {
      "type": "string",
      "description": "Not applicable."
    },
    "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": "Not applicable."
    },
    "suppressEmails": {
      "type": "string",
      "description": "Not applicable."
    },
    "templateLocked": {
      "type": "string",
      "description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
    },
    "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": "Not applicable."
    },
    "declinedDateTime": {
      "type": "string",
      "description": "Not applicable."
    },
    "designatorIdGuid": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "templateRequired": {
      "type": "string",
      "description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
    },
    "deliveredDateTime": {
      "type": "string",
      "description": "Not applicable."
    },
    "emailNotification": {
      "$ref": "#/components/schemas/recipientEmailNotification"
    },
    "faxNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "smsAuthentication": {
      "$ref": "#/components/schemas/recipientSMSAuthentication"
    },
    "accessCodeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "documentVisibility": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentVisibility"
      },
      "description": "Not applicable."
    },
    "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": "Not applicable."
    },
    "identityVerification": {
      "$ref": "#/components/schemas/recipientIdentityVerification"
    },
    "recipientAttachments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientAttachment"
      },
      "description": "Not applicable."
    },
    "routingOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "recipientTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "socialAuthentications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/socialAuthentication"
      },
      "description": "Deprecated."
    },
    "deliveryMethodMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "idCheckInformationInput": {
      "$ref": "#/components/schemas/idCheckInformationInput"
    },
    "requireIdLookupMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "idCheckConfigurationName": {
      "type": "string",
      "description": "Not applicable."
    },
    "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."
    },
    "embeddedRecipientStartURL": {
      "type": "string",
      "description": "Not applicable."
    },
    "lockedRecipientSmsEditable": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "recipientSignatureProviders": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientSignatureProvider"
      },
      "description": "(Required) Indicates which electronic seal to apply on documents when creating an envelope."
    },
    "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": "Not applicable."
    }
  },
  "description": "Specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow.\n\nExample:\n\n```json\n\"recipients\": {\n      \"seals\": [\n        {\n          \"recipientId\": \"1\",\n          \"routingOrder\" : 1,\n          \"recipientSignatureProviders\": [\n            {\n              \"sealName\": \"52e9d968-xxxx-xxxx-xxxx-4682bc45c106\"\n            }\n        ]\n      }\n    ]\n  },\n    .\n    .\n    .\n```\nFor more information about Electronic Seals, see [Apply Electronic Seals to Your Documents](https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html).\n",
  "x-ms-summary": "Specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow.\n\nExample:\n\n```json\n\"recipients\": {\n      \"seals\": [\n        {\n          \"recipientId\": \"1\",\n          \"routingOrder\" : 1,\n          \"recipientSignatureProviders\": [\n            {\n              \"sealName\": \"52e9d968-xxxx-xxxx-xxxx-4682bc45c106\"\n            }\n        ]\n      }\n    ]\n  },\n    .\n    .\n    .\n```\nFor more information about Electronic Seals, see [Apply Electronic Seals to Your Documents](https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html).\n",
  "x-ds-definition-name": "sealSign"
}

{
  "type": "object",
  "properties": {
    "endSeatCount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "beginSeatCount": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "discountPercent": {
      "type": "string",
      "description": "The percent of the discount. \n\nExample: `\"0.00\"`"
    }
  },
  "description": "This object contains information about a seat discount.",
  "x-ms-summary": "This object contains information about a seat discount.",
  "x-ds-definition-name": "seatDiscount"
}

{
  "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": ""
    },
    "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."
    },
    "source": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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": "Specifies the page number on which the tab is located."
    },
    "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": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "senderCompany"
}

{
  "type": "object",
  "properties": {
    "changedSigner": {
      "type": "string",
      "description": "When **true,** the sender receives an email notification if the signer changes."
    },
    "deliveryFailed": {
      "type": "string",
      "description": "When **true,** the sender receives an email notification if envelope delivery fails."
    },
    "purgeDocuments": {
      "type": "string",
      "description": "When **true,** the user receives an email notification when a document purge occurs."
    },
    "recipientViewed": {
      "type": "string",
      "description": "When **true,** the sender receives notification that a recipient viewed the envelope."
    },
    "envelopeComplete": {
      "type": "string",
      "description": "When **true,** the user receives an email notification when the envelope has been completed."
    },
    "withdrawnConsent": {
      "type": "string",
      "description": "When **true,** the user receives an email notification if consent is withdrawn."
    },
    "commentsReceiveAll": {
      "type": "string",
      "description": "When **true,** the user receives all comments."
    },
    "offlineSigningFailed": {
      "type": "string",
      "description": "When **true,** the user receives an email notification if offline signing failed."
    },
    "senderEnvelopeDeclined": {
      "type": "string",
      "description": "When **true,** the sender receives notification that the envelope was declined."
    },
    "commentsOnlyPrivateAndMention": {
      "type": "string",
      "description": "When **true,** the user receives only comments that mention their own user name."
    },
    "clickwrapResponsesLimitNotificationEmail": {
      "type": "string",
      "description": ""
    },
    "powerformResponsesLimitNotificationEmail": {
      "type": "string",
      "description": ""
    }
  },
  "description": "Contains the settings for the email notifications that senders receive about the envelopes that they send.",
  "x-ms-summary": "Contains the settings for the email notifications that senders receive about the envelopes that they send.",
  "x-ds-definition-name": "senderEmailNotifications"
}

{
  "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": ""
    },
    "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."
    },
    "source": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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": "Specifies the page number on which the tab is located."
    },
    "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": "Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document."
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "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": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "senderName"
}

{
  "type": "object",
  "properties": {
    "sequence": {
      "type": "string",
      "description": "Specifies the order in which templates are overlaid."
    },
    "templateId": {
      "type": "string",
      "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. "
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "serverTemplate"
}

{
  "type": "object",
  "properties": {
    "buildSHA": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "buildBranch": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "linkedSites": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": ""
    },
    "buildVersion": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "serviceVersions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/serviceVersion"
      },
      "description": ""
    },
    "buildBranchDeployedDateTime": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "serviceInformation"
}

{
  "type": "object",
  "properties": {
    "version": {
      "type": "string",
      "description": "The version of the rest API."
    },
    "versionUrl": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "serviceVersion"
}

{
  "type": "object",
  "properties": {
    "rights": {
      "type": "string",
      "description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`"
    },
    "uiHint": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "uiType": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "options": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of option strings supported by this setting."
    },
    "uiOrder": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "is21CFRPart11": {
      "type": "string",
      "description": "When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES)."
    }
  },
  "description": "Metadata that indicates whether a property is editable and describes setting-specific options.",
  "x-ms-summary": "Metadata that indicates whether a property is editable and describes setting-specific options.",
  "x-ds-definition-name": "settingsMetadata"
}

{
  "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`"
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    }
  },
  "description": "Information about the shared item.",
  "x-ms-summary": "Information about the shared item.",
  "x-ds-definition-name": "sharedItem"
}

{
  "type": "object",
  "properties": {
    "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.\n"
    },
    "stamp": {
      "$ref": "#/components/schemas/stamp"
    },
    "tabId": {
      "type": "string",
      "description": "The unique identifier for the tab."
    },
    "width": {
      "type": "string",
      "description": "Not applicable to Sign Here tab."
    },
    "height": {
      "type": "string",
      "description": "Not applicable to Sign Here 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"
    },
    "optional": {
      "type": "string",
      "description": "When **true,** the recipient does not need to complete this tab to complete 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."
    },
    "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."
    },
    "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"
    },
    "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 (+1, -7)\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 (+1, -7)\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": "Specifies the page number on which the tab is located.\nMust be 1 for supplemental documents.\n"
    },
    "scaleValue": {
      "type": "string",
      "description": "Scales the size of the tab. This field accepts values from 0.5 to 2.0, where  0.5 is half the normal size, 1.0 is normal size, and 2.0 is twice the normal size."
    },
    "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."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "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."
    },
    "isSealSignTab": {
      "type": "string",
      "description": "When **true,**  the tab contains a visual representation for an electronic seal in a document."
    },
    "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"
    },
    "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"
    },
    "handDrawRequired": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "optionalMetadata": {
      "$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."
    },
    "formOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "stampTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "xPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "yPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "documentIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "pageNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "scaleValueMetadata": {
      "$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": "A tab that allows the recipient to sign a document. May be\noptional.\n",
  "x-ms-summary": "A tab that allows the recipient to sign a document. May be\noptional.\n",
  "x-ds-definition-name": "signHere"
}

{
  "type": "object",
  "properties": {
    "rights": {
      "type": "string",
      "description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`"
    },
    "groupId": {
      "type": "string",
      "description": "The ID of the group being accessed."
    },
    "groupName": {
      "type": "string",
      "description": "The name of the group. The search_text provided in the call automatically performs a wild card search on group_name."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "signatureGroup"
}

{
  "type": "object",
  "properties": {
    "rights": {
      "type": "string",
      "description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`"
    },
    "groupId": {
      "type": "string",
      "description": "The ID of the group being accessed."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "signatureGroupDef"
}

{
  "type": "object",
  "properties": {
    "signerType": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "requiredSignatureProviderOptionIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Reserved for DocuSign."
    }
  },
  "description": "Contains additional information that a specific signature provider requires.",
  "x-ms-summary": "Contains additional information that a specific signature provider requires.",
  "x-ds-definition-name": "signatureProviderRequiredOption"
}

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of signature. Valid values are:\n\n- `electronic`: Indicates an **electronic** signature that is used by common law countries such as the United States, United Kingdom, and Australia. This is the default signature type that DocuSign uses.\n- `universal`: Indicates a **digital** signature that is accepted by both common law and civil law countries. To use digital signatures, you must use the [DocuSign Signature Appliance](https://raw.githubusercontent.com).\n\nFor more information, see [Standards Based Signatures](https://raw.githubusercontent.com)."
    },
    "isDefault": {
      "type": "string",
      "description": "When **true,** the signature type is the default type."
    }
  },
  "description": "This object contains information about the type of signature.",
  "x-ms-summary": "This object contains information about the type of signature.",
  "x-ds-definition-name": "signatureType"
}

{
  "type": "object",
  "properties": {
    "rights": {
      "type": "string",
      "description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`"
    },
    "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."
    },
    "userName": {
      "type": "string",
      "description": "The name of the user."
    },
    "isDefault": {
      "type": "string",
      "description": "Boolean that specifies whether the signature is the default signature for the user."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "signatureUser"
}

{
  "type": "object",
  "properties": {
    "rights": {
      "type": "string",
      "description": "Indicates whether the property is editable. Valid values are:\n\n- `editable`\n- `read_only`"
    },
    "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."
    },
    "isDefault": {
      "type": "string",
      "description": "Boolean that specifies whether the signature is the default signature for the user."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "signatureUserDef"
}

{
  "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. The system sends notifications about the documents to sign to this address. Maximum length: 100 characters. "
    },
    "status": {
      "type": "string",
      "description": "Specifies the status of the recipient at the time of the request. This property is read-only. Possible values are:\n\n- `created`: The recipient is in a draft state. This is only associated with draft envelopes (envelopes with a created status).\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `delivered`: The recipient has viewed the documents in an envelope through the DocuSign signing web site. This is not an email delivery of the documents in an envelope.\n- `signed`; The recipient has completed (performed all required interactions, such as signing or entering data) all required tags in an envelope. This is a temporary state during processing, after which the recipient is automatically moved to completed.\n- `declined`: The recipient declined to sign the documents in the envelope.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `faxpending`: The recipient has finished signing and the system is waiting a fax attachment by the recipient before completing their signing step.\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used by the DocuSign webapp (also known as the DocuSign console) to inform senders about the auto-responded email.\n"
    },
    "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": "The `recipientId` of the notary for this signer."
    },
    "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": "Reserved for DocuSign."
    },
    "delegatedBy": {
      "$ref": "#/components/schemas/delegationInfo"
    },
    "delegatedTo": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/delegationInfo"
      },
      "description": ""
    },
    "phoneNumber": {
      "$ref": "#/components/schemas/recipientPhoneNumber"
    },
    "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"
    },
    "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 item was created."
    },
    "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. "
    },
    "isBulkRecipient": {
      "type": "string",
      "description": "When **true,** this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. \n\nNote that when this is true the email and name for the recipient becomes bulk@recipient.com and \"Bulk Recipient\". These fields can not be changed for the bulk recipient. \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. When **true,** the agent 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 agent 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": "Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. Valid values:\n\n* `docusign_express`: Requires a DocuSign Express certificate.\n* `safe`: Requires a SAFE-BioPharma certificate.\n* `open_trust`: Requires an OpenTrust certificate. \n\n**Important:** There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information. \n "
    },
    "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 signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document.",
  "x-ms-summary": "A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document.",
  "x-ds-definition-name": "signer"
}

{
  "type": "object",
  "properties": {
    "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."
    },
    "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."
    },
    "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"
    },
    "optional": {
      "type": "string",
      "description": "When **true,** the recipient does not need to complete this tab to complete 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."
    },
    "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."
    },
    "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 (+0, -24)\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 (+0, -24)\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`."
    },
    "scaleValue": {
      "type": "string",
      "description": "Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size."
    },
    "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."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "handDrawRequired": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "optionalMetadata": {
      "$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."
    },
    "formOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "xPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "yPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "documentIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "pageNumberMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "scaleValueMetadata": {
      "$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": "A tab that allows the recipient to attach supporting\ndocuments to an envelope.\n",
  "x-ms-summary": "A tab that allows the recipient to attach supporting\ndocuments to an envelope.\n",
  "x-ds-definition-name": "signerAttachment"
}

{
  "type": "object",
  "properties": {
    "faxReceived": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "envelopeVoided": {
      "type": "string",
      "description": "When **true,** the user receives notification that the envelope has been voided."
    },
    "purgeDocuments": {
      "type": "string",
      "description": "When **true,** the user receives an email notification when a document purge occurs."
    },
    "envelopeComplete": {
      "type": "string",
      "description": "When **true,** the user receives an email notification when the envelope has been completed."
    },
    "envelopeDeclined": {
      "type": "string",
      "description": "When **true,** the user receives notification that the envelope has been declined."
    },
    "reassignedSigner": {
      "type": "string",
      "description": "When **true,** the user receives notification that the envelope has been reassigned."
    },
    "agentNotification": {
      "type": "string",
      "description": "When **true,** the user receives agent notification emails."
    },
    "envelopeCorrected": {
      "type": "string",
      "description": "When **true,** the user receives notification that the envelope has been corrected."
    },
    "commentsReceiveAll": {
      "type": "string",
      "description": "When **true,** the user receives all comments."
    },
    "envelopeActivation": {
      "type": "string",
      "description": "When **true,** the user receives notification that the envelope has been activated."
    },
    "offlineSigningFailed": {
      "type": "string",
      "description": "When **true,** the user receives an email notification if offline signing failed."
    },
    "carbonCopyNotification": {
      "type": "string",
      "description": "When **true,** the user receives notifications of carbon copy deliveries."
    },
    "whenSigningGroupMember": {
      "type": "string",
      "description": "When **true,** the user receives notification that he or she is a member of the signing group."
    },
    "documentMarkupActivation": {
      "type": "string",
      "description": "When **true,** the user receives notification that document markup has been activated."
    },
    "certifiedDeliveryNotification": {
      "type": "string",
      "description": "When **true,** the user receives notifications of certified deliveries."
    },
    "commentsOnlyPrivateAndMention": {
      "type": "string",
      "description": "When **true,** the user receives only comments that mention their own user name."
    }
  },
  "description": "An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account email notification settings when the user is created.\n",
  "x-ms-summary": "An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account email notification settings when the user is created.\n",
  "x-ds-definition-name": "signerEmailNotifications"
}

{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signingGroupUser"
      },
      "description": "User management information."
    },
    "created": {
      "type": "string",
      "description": "The UTC DateTime when the signing group was created. This property is read-only."
    },
    "modified": {
      "type": "string",
      "description": "The UTC DateTime when the signing group was last modified. This property is read-only."
    },
    "createdBy": {
      "type": "string",
      "description": "The name of the user who created the signing group. This property is read-only."
    },
    "groupName": {
      "type": "string",
      "description": "The name of the group."
    },
    "groupType": {
      "type": "string",
      "description": "The type of the group. The only valid value for this request is `sharedSigningGroup`."
    },
    "groupEmail": {
      "type": "string",
      "description": "The email address for the signing group. You can use a group email address to email all of the group members at the same time."
    },
    "modifiedBy": {
      "type": "string",
      "description": "The user ID (GUID) of the user who last modified this user record. This property is read-only."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "signingGroupId": {
      "type": "string",
      "description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
    }
  },
  "description": "Contains details about a signing group. Signing groups enable you to send an envelope to a predefined group of recipients and have any one member of the group sign your documents. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature.",
  "x-ms-summary": "Contains details about a signing group. Signing groups enable you to send an envelope to a predefined group of recipients and have any one member of the group sign your documents. When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature.",
  "x-ds-definition-name": "signingGroup"
}

{
  "type": "object",
  "properties": {
    "groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signingGroup"
      },
      "description": "A collection group objects containing information about the groups."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "signingGroupInformation"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": ""
    },
    "userName": {
      "type": "string",
      "description": "The name of the group member. \n\nMaximum Length: 100 characters. "
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "signingGroupUser"
}

{
  "type": "object",
  "properties": {
    "users": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signingGroupUser"
      },
      "description": "User management information."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "signingGroupUsers"
}

{
  "type": "object",
  "properties": {
    "uri": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "code": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "smartContractInformation"
}

{
  "type": "object",
  "properties": {
    "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."
    },
    "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": ""
    },
    "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"
    },
    "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."
    },
    "endAnchor": {
      "type": "string",
      "description": "Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default.\n\n**Note:** A start anchor, an end anchor, or both are required."
    },
    "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."
    },
    "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"
    },
    "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"
    },
    "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": "Specifies the page number on which the tab is located."
    },
    "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."
    },
    "endPosition": {
      "$ref": "#/components/schemas/smartSectionAnchorPosition"
    },
    "overlayType": {
      "type": "string",
      "description": "The type of overlay to draw on the document. The following overlay types are supported:\n\n- `line`\n- `outline`\n"
    },
    "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"
    },
    "startAnchor": {
      "type": "string",
      "description": "Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.\n\n**Note:** A start anchor, an end anchor, or both are required."
    },
    "anchorString": {
      "type": "string",
      "description": "Specifies the string to find in the document and use as the basis for tab placement."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "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"
    },
    "caseSensitive": {
      "type": "boolean",
      "description": "When **true,** the `startAnchor` and `endAnchor` for the Smart Section must match both the case and the content of the strings in the HTML."
    },
    "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."
    },
    "startPosition": {
      "$ref": "#/components/schemas/smartSectionAnchorPosition"
    },
    "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"
    },
    "lockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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"
    },
    "displaySettings": {
      "$ref": "#/components/schemas/smartSectionDisplaySettings"
    },
    "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."
    },
    "removeEndAnchor": {
      "type": "boolean",
      "description": "When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying."
    },
    "tabTypeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "toolTipMetadata": {
      "$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."
    },
    "formOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "removeStartAnchor": {
      "type": "boolean",
      "description": "When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying."
    },
    "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"
    },
    "overlayTypeMetadata": {
      "$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": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "smartSection"
}

{
  "type": "object",
  "properties": {
    "xPosition": {
      "type": "number",
      "format": "double",
      "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"
    },
    "yPosition": {
      "type": "number",
      "format": "double",
      "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"
    },
    "pageNumber": {
      "type": "integer",
      "format": "int32",
      "description": "Specifies the page number on which the tab is located."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "smartSectionAnchorPosition"
}

{
  "type": "object",
  "properties": {
    "arrowOpen": {
      "type": "string",
      "description": "Indicates the direction of the disclosure arrow\nwhen the collapsible section is in the open state.\n\nOne of the following:\n\n- `up`: In the open state, the disclosure arrow points up.\n- `down`: In the open state, the disclosure arrow points down.\n- `left`: In the open state, the disclosure arrow points left.\n- `right`: In the open state, the disclosure arrow points right.\n"
    },
    "arrowSize": {
      "type": "string",
      "description": "Indicates the size of the collapsible arrows. Possible values are:\n\n- `small`\n- `large` (default)\n"
    },
    "arrowColor": {
      "type": "string",
      "description": "A CSS color value (such as `#DCF851`) that indicates the color of the arrow.\n"
    },
    "arrowStyle": {
      "type": "string",
      "description": "The name of the CSS style to be used on collapsible arrow section.\n"
    },
    "labelStyle": {
      "type": "string",
      "description": "The name of the CSS style to be used for the collapsible container's label."
    },
    "arrowClosed": {
      "type": "string",
      "description": "Indicates the direction of the disclosure arrow\nwhen the collapsible section is in the closed state.\n\nOne of the following:\n\n- `up`: In the closed state, the disclosure arrow points up.\n- `down`: In the closed state, the disclosure arrow points down.\n- `left`: In the closed state, the disclosure arrow points left.\n- `right`: In the closed state, the disclosure arrow points right.\n"
    },
    "arrowLocation": {
      "type": "string",
      "description": "The location of the arrow relative to the collapsible section's label. Possible values are:\n\n- `right` (default)\n- `left`\n"
    },
    "containerStyle": {
      "type": "string",
      "description": "The name of the CSS style to be used for the collapsible container.\n"
    },
    "onlyArrowIsClickable": {
      "type": "boolean",
      "description": "When **true,** only the arrow is clickable to expand or collapse the section.\nWhen **false** (the default), both the label and the arrow are clickable.\n\nIf no arrow is used, this setting is ignored.\n"
    },
    "outerLabelAndArrowStyle": {
      "type": "string",
      "description": "The name of the CSS style to be used for the collapsible container's outer label and arrow style."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "smartSectionCollapsibleDisplaySettings"
}

{
  "type": "object",
  "properties": {
    "display": {
      "type": "string",
      "description": "Indicates the display type. Must be one of the following enum values:\n\n- **inline:** Leaves the HTML where it is in the document. This allows for adding a label or presenting on a separate page.\n- **collapsible:** The HTML in the section may be expanded or collapsed. By default, the section is expanded.\n- **collapsed:** The HTML in the section may be expanded or collapsed. By default, the section is collapsed.\n- **responsive_table:** Converts the section into a responsive table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions.\n- **responsive_table_single_column:** Converts the section into a responsive, single-column table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions. The table is converted to a single column in which each column becomes a row and is stacked.\n- **print_only:** Prevents this portion of the HTML from displaying in the responsive signing view."
    },
    "preLabel": {
      "type": "string",
      "description": "Enables you to add descriptive text that appears before a collapsed section or continue button."
    },
    "cellStyle": {
      "type": "string",
      "description": "Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types."
    },
    "tableStyle": {
      "type": "string",
      "description": "Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`."
    },
    "displayLabel": {
      "type": "string",
      "description": "The label to add to this display section in the signing page.\n"
    },
    "displayOrder": {
      "type": "integer",
      "format": "int32",
      "description": "The position on the page where the display section appears."
    },
    "labelWhenOpened": {
      "type": "string",
      "description": "The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`."
    },
    "inlineOuterStyle": {
      "type": "string",
      "description": "Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`."
    },
    "displayPageNumber": {
      "type": "integer",
      "format": "int32",
      "description": "The number of the page on which the display section appears."
    },
    "collapsibleSettings": {
      "$ref": "#/components/schemas/smartSectionCollapsibleDisplaySettings"
    },
    "hideLabelWhenOpened": {
      "type": "boolean",
      "description": "When **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`."
    },
    "scrollToTopWhenOpened": {
      "type": "boolean",
      "description": "When **true** and the section is expanded,\nthe position of the section-close control\nscrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`.\n"
    }
  },
  "description": "These properties define how a Smart Section displays. A Smart Section is a type of display section.",
  "x-ms-summary": "These properties define how a Smart Section displays. A Smart Section is a type of display section.",
  "x-ds-definition-name": "smartSectionDisplaySettings"
}

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "The users email address."
    },
    "provider": {
      "type": "string",
      "description": "The social account provider (Facebook, Yahoo, etc.)"
    },
    "socialId": {
      "type": "string",
      "description": "The ID provided by the Socal Account."
    },
    "userName": {
      "type": "string",
      "description": "The full user name for the account."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "socialAccountInformation"
}

{
  "type": "object",
  "properties": {
    "authentication": {
      "type": "string",
      "description": "Reserved for DocuSign."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "socialAuthentication"
}

{
  "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."
    },
    "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."
    },
    "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 one-line field that allows the recipient to enter a Social\nSecurity Number. The SSN can be typed with or without\ndashes. It uses the same parameters as a Text tab, with the\nvalidation message and pattern set for SSN information.\n",
  "x-ms-summary": "A one-line field that allows the recipient to enter a Social\nSecurity Number. The SSN can be typed with or without\ndashes. It uses the same parameters as a Text tab, with the\nvalidation message and pattern set for SSN information.\n",
  "x-ds-definition-name": "ssn"
}

{
  "type": "object",
  "properties": {
    "ssn4": {
      "type": "string",
      "description": "The last four digits of the recipient's Social Security Number (SSN)."
    },
    "displayLevelCode": {
      "type": "string",
      "description": "Specifies the display level for the recipient. Valid values are:\n* `ReadOnly`\n* `Editable`\n* `DoNotDisplay`"
    },
    "receiveInResponse": {
      "type": "string",
      "description": "A Boolean value that specifies whether the information must be returned in the response."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "ssn4InformationInput"
}

{
  "type": "object",
  "properties": {
    "ssn9": {
      "type": "string",
      "description": "The recipient's full Social Security Number (SSN)."
    },
    "displayLevelCode": {
      "type": "string",
      "description": "Specifies the display level for the recipient. Valid values are:\n* `ReadOnly`\n* `Editable`\n* `DoNotDisplay`"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "ssn9InformationInput"
}

{
  "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."
    },
    "imageType": {
      "type": "string",
      "description": "Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`"
    },
    "externalID": {
      "type": "string",
      "description": "Optionally specify an external identifier for the user's signature."
    },
    "customField": {
      "type": "string",
      "description": ""
    },
    "imageBase64": {
      "type": "string",
      "description": ""
    },
    "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"
    },
    "phoneticName": {
      "type": "string",
      "description": "The phonetic spelling of the `signatureName`."
    },
    "signatureName": {
      "type": "string",
      "description": "Specifies the user's signature name."
    },
    "stampImageUri": {
      "type": "string",
      "description": "The URI for retrieving the image of the user's stamp."
    },
    "adoptedDateTime": {
      "type": "string",
      "description": "The UTC date and time when the user adopted the signature."
    },
    "createdDateTime": {
      "type": "string",
      "description": "The UTC DateTime when the item was created."
    },
    "dateStampProperties": {
      "$ref": "#/components/schemas/dateStampProperties"
    },
    "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": "stamp"
}

{
  "type": "object",
  "properties": {
    "languages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/nameValue"
      },
      "description": "A list of languages that you can use for a recipient's language setting. These are the languages that you can set for the standard email format and signing view for each recipient.\n\nFor example, in the recipient's email notification, this setting affects elements such as the standard introductory text describing the request to sign. It also determines the language used for buttons and tabs in both the email notification and the signing experience.\n\n**Note:** Setting a language for a recipient affects only the DocuSign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it.\n\nExample:\n\n```\n{\n    \"languages\": [\n        {\n            \"name\": \"Arabic (ar)\",\n            \"value\": \"ar\"\n        },\n        {\n            \"name\": \"Bulgarian (bg)\",\n            \"value\": \"bg\"\n        },\n        .\n        .\n        .\n}\n```"
    }
  },
  "description": "A list of supported languages.",
  "x-ms-summary": "A list of supported languages.",
  "x-ds-definition-name": "supportedLanguages"
}

{
  "type": "object",
  "properties": {
    "allowTabOrder": {
      "type": "string",
      "description": "When **true,** account users can set a tab order for the signing process.\n\n**Note:** Only Admin users can change this setting."
    },
    "drawTabsEnabled": {
      "type": "string",
      "description": ""
    },
    "listTabsEnabled": {
      "type": "string",
      "description": "When **true,** list tabs are enabled."
    },
    "noteTabsEnabled": {
      "type": "string",
      "description": "When **true,** note tabs are enabled."
    },
    "tabScaleEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "textTabsEnabled": {
      "type": "string",
      "description": "When **true,** text tabs are enabled."
    },
    "drawTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "listTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "noteTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "radioTabsEnabled": {
      "type": "string",
      "description": "When **true,** radio button tabs are enabled."
    },
    "tabScaleMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "textTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "radioTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "tabLockingEnabled": {
      "type": "string",
      "description": "When **true,** tab locking is enabled.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "prefillTabsEnabled": {
      "type": "string",
      "description": ""
    },
    "tabLocationEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "tabLockingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "checkboxTabsEnabled": {
      "type": "string",
      "description": "When **true,** checkbox tabs are enabled."
    },
    "prefillTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "tabDataLabelEnabled": {
      "type": "string",
      "description": "When **true,** [data\nlabels](https://support.docusign.com/en/videos/Data-Labels) are enabled.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "tabLocationMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "checkBoxTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dataFieldSizeEnabled": {
      "type": "string",
      "description": "When **true,** setting character limits for input fields is enabled."
    },
    "numericalTabsEnabled": {
      "type": "string",
      "description": ""
    },
    "tabDataLabelMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "allowTabOrderMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dataFieldRegexEnabled": {
      "type": "string",
      "description": "When **true,** regular expressions are enabled for tabs that contain data fields."
    },
    "dataFieldSizeMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "numericalTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "dataFieldRegexMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "calculatedFieldsEnabled": {
      "type": "string",
      "description": "When **true,** [calculated fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) are enabled for tabs."
    },
    "savingCustomTabsEnabled": {
      "type": "string",
      "description": "When **true,** saving custom tabs is enabled."
    },
    "sharedCustomTabsEnabled": {
      "type": "string",
      "description": "When **true,** shared custom tabs are enabled."
    },
    "calculatedFieldsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "savingCustomTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "sharedCustomTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "tabTextFormattingEnabled": {
      "type": "string",
      "description": "When **true,** text formatting (such as font type, font size,\nfont color, bold, italic, and underline) is enabled for tabs that\nsupport formatting.\n\n**Note:** Only Admin users can change this setting.\n"
    },
    "approveDeclineTabsEnabled": {
      "type": "string",
      "description": "When **true,** approve and decline tabs are enabled."
    },
    "firstLastEmailTabsEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "tabTextFormattingMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "approveDeclineTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "firstLastEmailTabsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    },
    "senderToChangeTabAssignmentsEnabled": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "senderToChangeTabAssignmentsMetadata": {
      "$ref": "#/components/schemas/settingsMetadata"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "tabAccountSettings"
}

{
  "type": "object",
  "properties": {
    "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."
    },
    "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"
    },
    "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."
    },
    "tabScope": {
      "type": "string",
      "description": "The scope of the tab group. Possible values are:\n\n- `document`\n- `envelope` (default)"
    },
    "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."
    },
    "groupRule": {
      "type": "string",
      "description": "Specifies how `maximumAllowed` and `minimumRequired`\nare interpreted when selecting tabs in a `tabGroup`.\n\nPossible values are:\n\n- `SelectAtLeast`\n- `SelectAtMost`\n- `SelectExactly`\n- `SelectARange`\n\n"
    },
    "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"
    },
    "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"
    },
    "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."
    },
    "groupLabel": {
      "type": "string",
      "description": "A unique identifier for a tab group. To assign a tab to the `tabGroup`, you assign the `TabGroupLabel` to the `tab.TabGroupLabels` array."
    },
    "mergeField": {
      "$ref": "#/components/schemas/mergeField"
    },
    "pageNumber": {
      "type": "string",
      "description": "Specifies the page number on which the tab is located."
    },
    "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 group 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."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "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"
    },
    "maximumAllowed": {
      "type": "string",
      "description": "The maximum number of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation."
    },
    "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"
    },
    "minimumRequired": {
      "type": "string",
      "description": "The minimum number of of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation."
    },
    "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"
    },
    "tabOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabScopeMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "templateRequired": {
      "type": "string",
      "description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
    },
    "formOrderMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "groupRuleMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "validationMessage": {
      "type": "string",
      "description": "The message displayed if the custom tab fails input validation (either custom of embedded)."
    },
    "xPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "yPositionMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "documentIdMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "groupLabelMetadata": {
      "$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"
    },
    "maximumAllowedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "tabGroupLabelsMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "templateLockedMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "minimumRequiredMetadata": {
      "$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."
    },
    "validationMessageMetadata": {
      "$ref": "#/components/schemas/propertyMetadata"
    },
    "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": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "tabGroup"
}

{
  "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": ""
    },
    "type": {
      "type": "string",
      "description": "The type of this tab. Values are:\n\n- `Approve`\n- `CheckBox`\n- `Company`\n- `Date`\n- `DateSigned`\n- `Decline`\n- `Email`\n- `EmailAddress`\n- `EnvelopeId`\n- `FirstName`\n- `Formula`\n- `FullName`\n- `InitialHere`\n- `InitialHereOptional`\n- `LastName`\n- `List`\n- `Note`\n- `Number`\n- `Radio`\n- `SignerAttachment`\n- `SignHere`\n- `SignHereOptional`\n- `Ssn`\n- `Text`\n- `Title`\n- `Zip5`\n- `Zip5Dash4`"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "If the tab is a list, this represents the values that are possible for the tab."
    },
    "width": {
      "type": "string",
      "description": "The width of the tab in pixels.\nMust be an integer."
    },
    "anchor": {
      "type": "string",
      "description": "An optional string that is used to auto-match tabs to strings located in the documents of an envelope."
    },
    "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."
    },
    "editable": {
      "type": "string",
      "description": "When **true,** the custom tab is editable. Otherwise the custom tab cannot be modified."
    },
    "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."
    },
    "selected": {
      "type": "string",
      "description": "When **true,** the radio button is selected."
    },
    "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"
    },
    "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"
    },
    "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"
    },
    "underline": {
      "type": "string",
      "description": "When **true,** the information in the tab is underlined."
    },
    "mergeField": {
      "$ref": "#/components/schemas/mergeField"
    },
    "requireAll": {
      "type": "string",
      "description": "When **true** and shared is true, information must be entered in this field to complete the envelope. "
    },
    "scaleValue": {
      "type": "string",
      "description": "Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size."
    },
    "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."
    },
    "initialValue": {
      "type": "string",
      "description": "The original value of the tab."
    },
    "lastModified": {
      "type": "string",
      "description": "The UTC DateTime this object was last modified. This is in ISO 8601 format."
    },
    "localePolicy": {
      "$ref": "#/components/schemas/localePolicyTab"
    },
    "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"
    },
    "collaborative": {
      "type": "string",
      "description": ""
    },
    "maximumLength": {
      "type": "string",
      "description": "The maximum number of entry characters supported by the custom tab."
    },
    "numericalValue": {
      "type": "string",
      "description": ""
    },
    "validationType": {
      "type": "string",
      "description": "Specifies how numerical data is validated. Valid values:\n\n- `number`\n- `currency`\n"
    },
    "createdByUserId": {
      "type": "string",
      "description": "The userId of the DocuSign user who created this object."
    },
    "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."
    },
    "includedInEmail": {
      "type": "string",
      "description": "When **true,** the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs."
    },
    "paymentItemCode": {
      "type": "string",
      "description": "If the custom tab is for a payment request, this is the external code for the item associated with the charge. For example, this might be your product id.\n\nExample: `SHAK1`\n\nMaximum Length: 100 characters."
    },
    "paymentItemName": {
      "type": "string",
      "description": "If the custom tab is for a payment request, this is the name of the item associated with the charge.\n\nMaximum Length: 100 characters.\n\nExample: `Hamlet`"
    },
    "maxNumericalValue": {
      "type": "string",
      "description": ""
    },
    "minNumericalValue": {
      "type": "string",
      "description": ""
    },
    "stampTypeMetadata": {
      "$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."
    },
    "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/"
    },
    "signatureProviderId": {
      "type": "string",
      "description": "Reserved for DocuSign."
    },
    "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"
    },
    "createdByDisplayName": {
      "type": "string",
      "description": "The user name of the DocuSign user who created this object."
    },
    "lastModifiedByUserId": {
      "type": "string",
      "description": "The userId of the DocuSign user who last modified this object."
    },
    "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."
    },
    "paymentItemDescription": {
      "type": "string",
      "description": "If the custom tab is for a payment request, this is the description of the item associated with the charge.\n\nExample: `The Danish play by Shakespeare`\n\nMaximum Length: 100 characters."
    },
    "anchorIgnoreIfNotPresent": {
      "type": "string",
      "description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
    },
    "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"
    },
    "lastModifiedByDisplayName": {
      "type": "string",
      "description": "The User Name of the DocuSign user who last modified this object."
    },
    "requireInitialOnSharedChange": {
      "type": "string",
      "description": "Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "tabMetadata"
}

{
  "type": "object",
  "properties": {
    "tabs": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/tabMetadata"
      },
      "description": "A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "tabMetadataList"
}

{
  "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": "Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients.",
  "x-ms-summary": "Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients.",
  "x-ds-definition-name": "tabs"
}

{
  "type": "object",
  "properties": {
    "listCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/listCustomField"
      },
      "description": "An array of list custom fields."
    },
    "textCustomFields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/textCustomField"
      },
      "description": "An array of text custom fields."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "templateCustomFields"
}

{
  "type": "object",
  "properties": {
    "documentVisibility": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/documentVisibility"
      },
      "description": "An array of `documentVisibility` objects that specifies which documents are visible to which recipients."
    }
  },
  "description": "A list of `documentVisibility` objects that specify whether the documents associated with a template are visible to recipients.",
  "x-ms-summary": "A list of `documentVisibility` objects that specify whether the documents associated with a template are visible to recipients.",
  "x-ds-definition-name": "templateDocumentVisibilityList"
}

{
  "type": "object",
  "properties": {
    "templateId": {
      "type": "string",
      "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. "
    },
    "templateDocuments": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/envelopeDocument"
      },
      "description": "An array of document objects that contain information about the documents associated with the template."
    }
  },
  "description": "The results of this method.",
  "x-ms-summary": "The results of this method.",
  "x-ds-definition-name": "templateDocumentsResult"
}

{
  "type": "object",
  "properties": {
    "templates": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/templateSummary"
      },
      "description": "An array of `templateSummary` objects that contain information about templates."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "templateInformation"
}

{
  "type": "object",
  "properties": {
    "documentEndPage": {
      "type": "string",
      "description": ""
    },
    "matchPercentage": {
      "type": "string",
      "description": ""
    },
    "documentStartPage": {
      "type": "string",
      "description": ""
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "templateMatch"
}

{
  "type": "object",
  "properties": {
    "password": {
      "type": "string",
      "description": "The user's encrypted password hash."
    },
    "reminders": {
      "$ref": "#/components/schemas/reminders"
    },
    "expirations": {
      "$ref": "#/components/schemas/expirations"
    },
    "useAccountDefaults": {
      "type": "string",
      "description": "When **true,** the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When **false,** the reminders and expirations settings specified in this request are used. The default value is **false.**"
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "templateNotificationRequest"
}

{
  "type": "object",
  "properties": {
    "seals": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/sealSign"
      },
      "description": "Specifies one or more electronic seals to apply on documents. For more information on Electronic Seals , see https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html"
    },
    "agents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/agent"
      },
      "description": "A list of agent recipients assigned to the documents."
    },
    "editors": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/editor"
      },
      "description": "A list of users who can edit the envelope."
    },
    "signers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/signer"
      },
      "description": "A list of signers on the envelope."
    },
    "notaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/notaryRecipient"
      },
      "description": "A list of notary recipients on the envelope."
    },
    "witnesses": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/witness"
      },
      "description": "A list of signers who act as witnesses on the envelope."
    },
    "carbonCopies": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/carbonCopy"
      },
      "description": "A list of carbon copy recipients assigned to the documents."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "participants": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/participant"
      },
      "description": ""
    },
    "intermediaries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/intermediary"
      },
      "description": "Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added)."
    },
    "recipientCount": {
      "type": "string",
      "description": "The list of recipient event statuses that will trigger Connect to send updates to the url. It can be a two-part list with:\n\n* recipientEventStatusCode - The recipient status, this can be Sent, Delivered, Completed, Declined, AuthenticationFailed, and AutoResponded.\n* includeDocuments - When **true,** the envelope time zone information is included in the message."
    },
    "inPersonSigners": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/inPersonSigner"
      },
      "description": "Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected."
    },
    "certifiedDeliveries": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/certifiedDelivery"
      },
      "description": "A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents."
    },
    "currentRoutingOrder": {
      "type": "string",
      "description": "The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions."
    }
  },
  "description": "",
  "x-ms-summary": "",
  "x-ds-definition-name": "templateRecipients"
}

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Specifies the recipient's name.\n\nFor an in-person signer, this is the name of the host."
    },
    "tabs": {
      "$ref": "#/components/schemas/EnvelopeRecipientTabs"
    },
    "email": {
      "type": "string",
      "description": "The email address of the person associated with a role name. It is the email address of the person specified in the `name` property.\n\nFor an in-person signer, this is the email address of the host."
    },
    "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."
    },
    "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."
    },
    "phoneNumber": {
      "$ref": "#/components/schemas/recipientPhoneNumber"
    },
    "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"
    },
    "routingOrder": {
      "type": "string",
      "description": "Specifies the routing order of the recipient in the envelope. "
    },
    "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/"
    },
    "signingGroupId": {
      "type": "string",
      "description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
    },
    "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."
    },
    "emailNotification": {
      "$ref": "#/components/schemas/recipientEmailNotification"
    },
    "inPersonSignerName": {
      "type": "string",
      "description": "The full legal name of the in-person signer.\n\nMaximum Length: 100 characters."
    },
    "additionalNotifications": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/recipientAdditionalNotification"
      },
      "description": "An array of additional notification objects."
    },
    "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]]` "
    },
    "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)"
    }
  },
  "description": "Information about a specific role.",
  "x-ms-summary": "Information about a specific role.",
  "x-ds-definition-name": "templateRole"
}

{
  "type": "object",
  "properties": {
    "owner": {
      "$ref": "#/components/schemas/userInfo"
    },
    "shared": {
      "type": "string",
      "description": "How the template is shared. One of:\n\n- `not_shared`\n- `shared_to`\n"
    },
    "password": {
      "type": "string",
      "description": "The user's encrypted password hash."
    },
    "templateId": {
      "type": "string",
      "description": "The unique identifier of the template. If this is not provided, DocuSign will generate a value. "
    },
    "sharedUsers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/userSharedItem"
      },
      "description": "List of users that share the template."
    },
    "errorDetails": {
      "$ref": "#/components/schemas/errorDetails"
    },
    "sharedGroups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/memberGroupSharedItem"
      },
      "description": "List of groups that share the template."
    },
    "templateName": {
      "type": "string",
      "description": "The name of the shared template."
    }
  },
  "description": "Information about shared templates.",
  "x-ms-summary": "Information about shared templates.",
  "x-ds-definition-name": "templateSharedItem"
}

{
  "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"
}