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