UserCustomSettings
{
"type": "object",
"properties": {
"customSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nameValue"
},
"description": "The name/value pair information for the user custom setting."
}
},
"x-ds-order": "30",
"description": "Users' custom settings",
"x-ms-summary": "Users' custom settings",
"x-ds-category": "Users",
"x-ds-definition-name": "customSettingsInformation"
}
UserProfileImageGetUserProfileImageResponse
{
"type": "string",
"format": "binary"
}
UserProfiles
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The user's job title.\n\nLimit: 100 characters."
},
"address": {
"$ref": "#/components/schemas/addressInformation"
},
"companyName": {
"type": "string",
"description": "The name of the user's company."
},
"userDetails": {
"$ref": "#/components/schemas/userInformation"
},
"usageHistory": {
"$ref": "#/components/schemas/usageHistory"
},
"displayProfile": {
"type": "string",
"description": "When **true,** the user's ID card can be viewed from signed documents and envelope history."
},
"profileImageUri": {
"type": "string",
"description": "The URL for retrieving the user's profile image."
},
"displayPersonalInfo": {
"type": "string",
"description": "When **true,** the user's address and phone number display on the ID card."
},
"displayUsageHistory": {
"type": "string",
"description": "When **true,** the user's usage information displays on the ID card."
},
"authenticationMethods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/authenticationMethod"
},
"description": "Indicates the authentication methods that the user uses. These properties cannot be modified by the PUT operation. "
},
"displayOrganizationInfo": {
"type": "string",
"description": " When **true,** the user's company and title information display on the ID card. "
},
"userProfileLastModifiedDate": {
"type": "string",
"description": "The date and time that the user's profile was last modified."
}
},
"x-ds-order": "20",
"description": "Users' profiles",
"x-ms-summary": "Users' profiles",
"x-ds-category": "Users",
"x-ds-definition-name": "userProfile"
}
UserSignatures
{
"type": "object",
"properties": {
"nrdsId": {
"type": "string",
"description": "The National Association of Realtors (NAR) membership ID for a user who is a realtor."
},
"status": {
"type": "string",
"description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."
},
"imageType": {
"type": "string",
"description": "The format of the signature image, such as:\n\n- `GIF`\n- `PNG`\n- `JPG`\n- `PDF`\n- `BMP`"
},
"isDefault": {
"type": "string",
"description": "Boolean that specifies whether the signature is the default signature for the user."
},
"stampType": {
"type": "string",
"description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null"
},
"externalID": {
"type": "string",
"description": "An external ID for the signature or stamp.\n\n**Note:** If a recipient uses a stamp instead of a signature, this is the stamp vendor's serial number for the stamp."
},
"nrdsStatus": {
"type": "string",
"description": "The realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are:\n\n- `Active`\n- `Inactive`\n- `Terminate`\n- `Provisional`\n- `Deceased`\n- `Suspend`\n- `Unknown`"
},
"customField": {
"type": "string",
"description": "Serialized information about any custom [eHanko stamps](https://support.docusign.com/s/articles/Sending-and-Signing-with-eHanko) that have been ordered from an eHanko provider, including the order status, purchase order id, time created, and time modified."
},
"imageBase64": {
"type": "string",
"description": "A Base64-encoded representation of the signature image."
},
"signatureId": {
"type": "string",
"description": "The ID associated with the signature name. You can use this property in the URI in place of the signature name. This enables the use of special characters (such as \"&\", \"<\", and \">\") in a signature name.\n\n**Note:** When you update a signature, its signature ID might change. In that case you need to use `signatureName` to get the new `signatureId`."
},
"stampFormat": {
"type": "string",
"description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. "
},
"stampSizeMM": {
"type": "string",
"description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"nrdsLastName": {
"type": "string",
"description": "The realtor's last name."
},
"phoneticName": {
"type": "string",
"description": "The phonetic spelling of the `signatureName`."
},
"signatureFont": {
"type": "string",
"description": "The font type for the signature, if the signature is not drawn. The supported font types are:\n\n\"7_DocuSign\", \"1_DocuSign\", \"6_DocuSign\", \"8_DocuSign\", \"3_DocuSign\", \"Mistral\", \"4_DocuSign\", \"2_DocuSign\", \"5_DocuSign\", \"Rage Italic\"\n"
},
"signatureName": {
"type": "string",
"description": "Specifies the user's signature name."
},
"signatureType": {
"type": "string",
"description": "Specifies the type of signature. Possible values include:\n\n- `RubberStamp`: A DocuSign pre-formatted signature style. This is the default value.\n- `Imported`: A signature image that the user uploaded.\n- `Drawn`: A freehand drawing of the user's signature and initials."
},
"stampImageUri": {
"type": "string",
"description": "The URI for retrieving the image of the user's stamp."
},
"adoptedDateTime": {
"type": "string",
"description": "The date and time the user adopted their signature."
},
"createdDateTime": {
"type": "string",
"description": "The UTC date and time when the user created the signature."
},
"signatureRights": {
"type": "string",
"description": "The rights that the user has to the signature. Valid values are:\n\n- `none`\n- `read`\n- `admin`"
},
"initialsImageUri": {
"type": "string",
"description": "The URI for retrieving the image of the user's initials."
},
"signatureImageUri": {
"type": "string",
"description": "An endpoint URI that you can use to retrieve the user's signature image."
},
"signatureInitials": {
"type": "string",
"description": " The initials associated with the signature."
},
"initials150ImageId": {
"type": "string",
"description": "The ID of the user's initials image."
},
"dateStampProperties": {
"$ref": "#/components/schemas/dateStampProperties"
},
"signature150ImageId": {
"type": "string",
"description": "The ID of the user's signature image."
},
"lastModifiedDateTime": {
"type": "string",
"description": "The UTC date and time when the signature was last modified."
},
"disallowUserResizeStamp": {
"type": "string",
"description": "When **true,** users may not resize the stamp."
}
},
"x-ds-order": "40",
"description": "Users' signatures",
"x-ms-summary": "Users' signatures",
"x-ds-category": "Users",
"x-ds-definition-name": "userSignature"
}
UserSignaturesGetUserSignatureImageResponse
{
"type": "string",
"format": "binary"
}
UserSignaturesPutUserSignatureImageRequest
{
"type": "string",
"format": "binary"
}
Users
{
"type": "object",
"properties": {
"uri": {
"type": "string",
"description": "A URI containing the user ID."
},
"email": {
"type": "string",
"description": "The user's email address."
},
"title": {
"type": "string",
"description": "The salutation for the user, such as Ms, Dr, Capt., etc.\n\nLimit: 10 characters."
},
"userId": {
"type": "string",
"description": "The ID of the user to access.\n\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings."
},
"company": {
"type": "string",
"description": "The name of the user's company."
},
"isAdmin": {
"type": "string",
"description": "Determines if the feature set is actively set as part of the plan."
},
"jobTitle": {
"type": "string",
"description": "The user's job title."
},
"lastName": {
"type": "string",
"description": "The user's last name. \nMaximum Length: 50 characters."
},
"password": {
"type": "string",
"description": "The user's password."
},
"userName": {
"type": "string",
"description": "The user's full name.\n<!--\n`title` + `firstName` + `middleName` + `lastName` + `suffixName`\n-->"
},
"userType": {
"type": "string",
"description": "The type of user, for example `CompanyUser`."
},
"firstName": {
"type": "string",
"description": "The user's first name. \nMaximum Length: 50 characters."
},
"groupList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/group"
},
"description": "A list of the group information for groups to add the user to.\nUse [UserGroups: listGroups](https://raw.githubusercontent.com) to get information about groups.\n\nWhen setting a user's group, only the `groupId` is required.\n"
},
"lastLogin": {
"type": "string",
"description": "The date and time when the user last logged in to the system."
},
"subscribe": {
"type": "string",
"description": ""
},
"middleName": {
"type": "string",
"description": "The user's middle name. \nLimit: 50 characters."
},
"suffixName": {
"type": "string",
"description": "The suffix for the user's name, such as Jr, IV, PhD, etc.\n\nLimit: 50 characters. "
},
"userStatus": {
"type": "string",
"description": "Status of the user's account. One of:\n\n- `ActivationRequired`\n- `ActivationSent`\n- `Active`\n- `Closed`\n- `Disabled`\n"
},
"countryCode": {
"type": "string",
"description": ""
},
"homeAddress": {
"$ref": "#/components/schemas/addressInformation"
},
"loginStatus": {
"type": "string",
"description": "Shows the current status of the user's password. Possible values are: \n\n* password_reset\n* password_active\n* password_expired\n* password_locked\n* password_reset_failed \n"
},
"workAddress": {
"$ref": "#/components/schemas/addressInformation"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"isNAREnabled": {
"type": "string",
"description": "When **true,** National Association of Realtors (NAR) signature logos are enabled for the user."
},
"userSettings": {
"$ref": "#/components/schemas/userSettingsInformation"
},
"customSettings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/nameValue"
},
"description": "The name/value pair information for the user custom setting."
},
"createdDateTime": {
"type": "string",
"description": "The UTC DateTime when the item was created."
},
"hasRemoteNotary": {
"type": "boolean",
"description": ""
},
"profileImageUri": {
"type": "string",
"description": "The URL for retrieving the user's profile image."
},
"defaultAccountId": {
"type": "string",
"description": "The default account ID associated with the user."
},
"initialsImageUri": {
"type": "string",
"description": "The URI for retrieving the image of the user's initials."
},
"isAlternateAdmin": {
"type": "string",
"description": ""
},
"signatureImageUri": {
"type": "string",
"description": "An endpoint URI that you can use to retrieve the user's signature image."
},
"passwordExpiration": {
"type": "string",
"description": "If password expiration is enabled, the date-time when the user's password expires."
},
"permissionProfileId": {
"type": "string",
"description": "The ID of the permission profile associated with the user."
},
"sendActivationEmail": {
"type": "string",
"description": "This field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](https://raw.githubusercontent.com)."
},
"activationAccessCode": {
"type": "string",
"description": "The activation code a new user must enter when activating their account."
},
"enableConnectForUser": {
"type": "string",
"description": "Boolean value that specifies whether the user is enabled for updates from DocuSign Connect."
},
"connectConfigurations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/connectUserObject"
},
"description": "Object representing the user's custom Connect configuration."
},
"forgottenPasswordInfo": {
"$ref": "#/components/schemas/forgottenPasswordInformation"
},
"permissionProfileName": {
"type": "string",
"description": "The name of the permission profile associated with the user."
},
"userAddedToAccountDateTime": {
"type": "string",
"description": "The date and time that the user was added to the account."
},
"userProfileLastModifiedDate": {
"type": "string",
"description": "The date and time that the user's profile was last modified."
},
"sendActivationOnInvalidLogin": {
"type": "string",
"description": "When **true,** specifies that an additional activation email be sent if user's log on fails before the account is activated."
}
},
"x-ds-order": "10",
"description": "The Users resource enables you to create and manage account users.",
"x-ms-summary": "The Users resource enables you to create and manage account users.",
"x-ds-category": "Users",
"x-ds-definition-name": "userInformation"
}
WorkspaceItems
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the workspace item."
},
"uri": {
"type": "string",
"description": "A URI containing the user ID."
},
"name": {
"type": "string",
"description": "The name of the file or folder."
},
"type": {
"type": "string",
"description": "The type of workspace item. Valid values are:\n\n- `file`\n- `folder`"
},
"sha256": {
"type": "string",
"description": "A 64-byte, Secure Hash Algorithm 256 (SHA256) checksum that the caller computes across the entirety of the original content of a file. DocuSign compares this value to its own computation. If the two values are not equal, the original content and received content are not the same and the upload is refused."
},
"created": {
"type": "string",
"description": "The UTC DateTime when the workspace item was created."
},
"fileUri": {
"type": "string",
"description": "The URI for retrieving the file."
},
"fileSize": {
"type": "string",
"description": "The size of the file in bytes."
},
"isPublic": {
"type": "string",
"description": " When **true,** the item is public."
},
"extension": {
"type": "string",
"description": "The file extension of a file item."
},
"pageCount": {
"type": "string",
"description": "The number of pages in a file."
},
"thumbnail": {
"$ref": "#/components/schemas/page"
},
"thumbWidth": {
"type": "string",
"description": "The width of the thumbnail image."
},
"contentType": {
"type": "string",
"description": "If the item is a file, this property specifies the content type of the file."
},
"createdById": {
"type": "string",
"description": "The ID of the user who created the workspace item."
},
"thumbHeight": {
"type": "string",
"description": "The height of the thumbnail image."
},
"lastModified": {
"type": "string",
"description": "The UTC DateTime that the item was last modified."
},
"parentFolderId": {
"type": "string",
"description": "The ID of the parent folder, or the special value `root` for the root folder."
},
"parentFolderUri": {
"type": "string",
"description": "The URI of the parent folder."
},
"lastModifiedById": {
"type": "string",
"description": "The ID of the user who last modified the item."
},
"userAuthorization": {
"$ref": "#/components/schemas/workspaceUserAuthorization"
},
"callerAuthorization": {
"$ref": "#/components/schemas/workspaceUserAuthorization"
},
"createdByInformation": {
"$ref": "#/components/schemas/workspaceUser"
},
"lastModifiedByInformation": {
"$ref": "#/components/schemas/workspaceUser"
}
},
"x-ds-order": "130",
"description": "This object contains information about a file or folder in a workspace.",
"x-ms-summary": "This object contains information about a file or folder in a workspace.",
"x-ds-category": "Workspaces",
"x-ds-definition-name": "workspaceItem"
}
Workspaces
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the workspace. Valid values are:\n\n- `active`\n- `closed`"
},
"created": {
"type": "string",
"description": "The UTC DateTime when the workspace user authorization was created."
},
"settings": {
"$ref": "#/components/schemas/workspaceSettings"
},
"workspaceId": {
"type": "string",
"description": "The ID of the workspace, always populated."
},
"lastModified": {
"type": "string",
"description": "Utc date and time the comment was last updated (can only be done by creator.)"
},
"workspaceUri": {
"type": "string",
"description": "The relative URI for accessing the workspace."
},
"workspaceName": {
"type": "string",
"description": "The name of the workspace."
},
"workspaceBaseUrl": {
"type": "string",
"description": "The relative URL for accessing the workspace."
},
"billableAccountId": {
"type": "string",
"description": "The ID of the account to bill."
},
"callerInformation": {
"$ref": "#/components/schemas/workspaceUser"
},
"createdByInformation": {
"$ref": "#/components/schemas/workspaceUser"
},
"workspaceDescription": {
"type": "string",
"description": "Text describing the purpose of the workspace."
},
"lastModifiedByInformation": {
"$ref": "#/components/schemas/workspaceUser"
}
},
"x-ds-order": "140",
"description": "A DocuSign workspace is a collaboration area for sharing files and data.",
"x-ms-summary": "A DocuSign workspace is a collaboration area for sharing files and data.",
"x-ds-category": "Workspaces",
"x-ds-definition-name": "workspace"
}
accessCodeFormat
{
"type": "object",
"properties": {
"minimumLength": {
"type": "string",
"description": "Minimum length of the access code string."
},
"formatRequired": {
"type": "string",
"description": "Boolean specifying whether this format configuration is required."
},
"letterRequired": {
"type": "string",
"description": "Boolean specifying whether alphabetical characters are required in the access code string."
},
"numberRequired": {
"type": "string",
"description": "Boolean specifying whether numerical characters (0-9) are required in the access code string."
},
"minimumLengthMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"formatRequiredMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"letterRequiredMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"numberRequiredMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"specialCharacterRequired": {
"type": "string",
"description": "Boolean specifying whether special characters are required in the access code string. The string cannot contain the special characters '<', '>', '&', or '#'."
},
"specialCharacterRequiredMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
}
},
"description": "Object specifying the format of the string provided to a recipient in order to access an envelope.",
"x-ms-summary": "Object specifying the format of the string provided to a recipient in order to access an envelope.",
"x-ds-definition-name": "accessCodeFormat"
}
accountAddress
{
"type": "object",
"properties": {
"fax": {
"type": "string",
"description": "The fax number associated with the account."
},
"city": {
"type": "string",
"description": "The city associated with the address. Maximum length: 40 characters."
},
"email": {
"type": "string",
"description": "The email address associated with the account."
},
"phone": {
"type": "string",
"description": "The phone number associated with the account."
},
"state": {
"type": "string",
"description": "The state or province associated with the address. Maximum length: 40 characters."
},
"country": {
"type": "string",
"description": "The country associated with the address. Maximum length: 50 characters."
},
"address1": {
"type": "string",
"description": "The first line of the address. Maximum length: 100 characters."
},
"address2": {
"type": "string",
"description": "The second line of the address. Maximum length: 100 characters."
},
"lastName": {
"type": "string",
"description": "The last name of the user associated with the account."
},
"firstName": {
"type": "string",
"description": "The first name of the user associated with the account. Maximum Length: 50 characters."
},
"postalCode": {
"type": "string",
"description": "The postal code associated with the address. Maximum length: 20 characters."
},
"supportedCountries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/country"
},
"description": "An array of supported countries associated with the account."
}
},
"description": "Contains information about the address associated with the account.",
"x-ms-summary": "Contains information about the address associated with the account.",
"x-ds-definition-name": "accountAddress"
}
accountBillingPlan
{
"type": "object",
"properties": {
"addOns": {
"type": "array",
"items": {
"$ref": "#/components/schemas/addOn"
},
"description": "Reserved for DocuSign."
},
"planId": {
"type": "string",
"description": "DocuSign's ID for the account plan."
},
"planName": {
"type": "string",
"description": "The name of the Billing Plan."
},
"productId": {
"type": "string",
"description": "The Product ID from the AppStore."
},
"canUpgrade": {
"type": "string",
"description": "When **true,** specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response."
},
"isDowngrade": {
"type": "string",
"description": "When **true,** the account has been downgraded from a premium account type. Otherwise **false.**"
},
"renewalDate": {
"type": "string",
"description": ""
},
"taxExemptId": {
"type": "string",
"description": ""
},
"currencyCode": {
"type": "string",
"description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code to use for the account."
},
"paymentCycle": {
"type": "string",
"description": "The payment cycle associated with the plan. Valid values: \n\n- `Monthly`\n- `Annually` "
},
"perSeatPrice": {
"type": "string",
"description": "The per-seat price associated with the plan.\n\nExample: `\"456.0000\"`"
},
"enableSupport": {
"type": "string",
"description": "When **true,** customer support is provided as part of the account plan."
},
"includedSeats": {
"type": "string",
"description": "The number of seats (users) included in the plan."
},
"paymentMethod": {
"type": "string",
"description": " The payment method used with the plan. Valid values: CreditCard, PurchaseOrder, Premium, or Freemium. "
},
"planStartDate": {
"type": "string",
"description": "The date that the Account started using the current plan."
},
"renewalStatus": {
"type": "string",
"description": "The renewal status for the account. Valid values are:\n\n* `auto`: The account automatically renews.\n* `queued_for_close`: The account will be closed at the `billingPeriodEndDate`.\n* `queued_for_downgrade`: The account will be downgraded at the `billingPeriodEndDate`.\n\n**Note:** For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response."
},
"seatDiscounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/seatDiscount"
},
"description": " A complex type that contains any seat discount information. Valid values:\n \n - `BeginSeatCount` \n - `EndSeatCount`\n - `SeatDiscountPercent`\n \n"
},
"supportPlanFee": {
"type": "string",
"description": "The support plan fee charged for this plan.\n\nExample: `\"$0.00\"`"
},
"planFeatureSets": {
"type": "array",
"items": {
"$ref": "#/components/schemas/featureSet"
},
"description": "A complex type that sets the feature sets for the account. It contains the following information (all string content):\n\n* currencyFeatureSetPrices - Contains the currencyCode and currencySymbol for the alternate currency values for envelopeFee, fixedFee, seatFee that are configured for this plan feature set.\n* envelopeFee - An incremental envelope cost for plans with envelope overages (when isEnabled=true).\n* featureSetId - A unique ID for the feature set.\n* fixedFee - A one-time fee associated with the plan (when isEnabled=true).\n* isActive - Specifies whether the feature set is actively set as part of the plan.\n* isEnabled - Specifies whether the feature set is actively enabled as part of the plan.\n* name - The name of the feature set.\n* seatFee - An incremental seat cost for seat-based plans (when isEnabled=true).\n"
},
"canCancelRenewal": {
"type": "string",
"description": "Reserved for DocuSign."
},
"incrementalSeats": {
"type": "string",
"description": "Reserved for DocuSign."
},
"notificationType": {
"type": "string",
"description": ""
},
"planClassification": {
"type": "string",
"description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`"
},
"supportIncidentFee": {
"type": "string",
"description": "The support incident fee charged for each support incident.\n\nExample: `\"$0.00\"`"
},
"otherDiscountPercent": {
"type": "string",
"description": " Any other percentage discount for the plan. "
},
"subscriptionStartDate": {
"type": "string",
"description": ""
},
"downgradePlanInformation": {
"$ref": "#/components/schemas/downgradePlanUpdateResponse"
},
"appStoreReceiptPurchaseDate": {
"type": "string",
"description": ""
},
"appStoreReceiptExpirationDate": {
"type": "string",
"description": ""
}
},
"description": "Contains information about an account billing plan.",
"x-ms-summary": "Contains information about an account billing plan.",
"x-ds-definition-name": "accountBillingPlan"
}
accountBillingPlanResponse
{
"type": "object",
"properties": {
"billingPlan": {
"$ref": "#/components/schemas/accountBillingPlan"
},
"taxExemptId": {
"type": "string",
"description": ""
},
"paymentMethod": {
"type": "string",
"description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
},
"billingAddress": {
"$ref": "#/components/schemas/accountAddress"
},
"successorPlans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/billingPlan"
},
"description": "A list of billing plans that the current billing plan can be rolled into."
},
"entityInformation": {
"$ref": "#/components/schemas/billingEntityInformationResponse"
},
"referralInformation": {
"$ref": "#/components/schemas/referralInformation"
},
"creditCardInformation": {
"$ref": "#/components/schemas/creditCardInformation"
},
"downgradePlanInformation": {
"$ref": "#/components/schemas/downgradePlanUpdateResponse"
},
"downgradeRequestInformation": {
"$ref": "#/components/schemas/downgradeRequestInformation"
},
"paymentProcessorInformation": {
"$ref": "#/components/schemas/paymentProcessorInformation"
},
"directDebitProcessorInformation": {
"$ref": "#/components/schemas/directDebitProcessorInformation"
},
"billingAddressIsCreditCardAddress": {
"type": "string",
"description": "When **true,** the credit card address information is the same as that returned as the billing address. If false, then the billing address is considered a billing contact address, and the credit card address can be different."
}
},
"description": "Defines an account billing plan response object.",
"x-ms-summary": "Defines an account billing plan response object.",
"x-ds-definition-name": "accountBillingPlanResponse"
}
accountIdentityInputOption
{
"type": "object",
"properties": {
"valueType": {
"type": "string",
"description": ""
},
"isRequired": {
"type": "boolean",
"description": ""
},
"optionName": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountIdentityInputOption"
}
accountIdentityVerificationResponse
{
"type": "object",
"properties": {
"identityVerification": {
"type": "array",
"items": {
"$ref": "#/components/schemas/accountIdentityVerificationWorkflow"
},
"description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](https://raw.githubusercontent.com) method in the [IdentityVerifications](https://raw.githubusercontent.com) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountIdentityVerificationResponse"
}
accountIdentityVerificationStep
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the Identity Verification workflow step."
},
"type": {
"type": "string",
"description": "Reserved for DocuSign."
}
},
"description": "Information about a specific step in an Identity Verification workflow.",
"x-ms-summary": "Information about a specific step in an Identity Verification workflow.",
"x-ds-definition-name": "accountIdentityVerificationStep"
}
accountIdentityVerificationWorkflow
{
"type": "object",
"properties": {
"ownerType": {
"type": "string",
"description": ""
},
"isDisabled": {
"type": "string",
"description": "When **true,** the workflow is disabled."
},
"workflowId": {
"type": "string",
"description": "Workflow unique ID</br>This is the ID you must specify when setting ID Verification in an envelope using the `identityVerification`\n[core recipient parameter](/docs/esign-rest-api/reference/envelopes/enveloperecipients/#core-recipient-parameters)"
},
"defaultName": {
"type": "string",
"description": "The name of the Identity Verification workflow."
},
"inputOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/accountIdentityInputOption"
},
"description": ""
},
"workflowLabel": {
"type": "string",
"description": ""
},
"signatureProvider": {
"$ref": "#/components/schemas/accountSignatureProvider"
},
"defaultDescription": {
"type": "string",
"description": "Text describing the purpose of the Identity Verification workflow."
},
"workflowResourceKey": {
"type": "string",
"description": "Reserved for DocuSign."
}
},
"description": "Specifies an Identity Verification workflow.",
"x-ms-summary": "Specifies an Identity Verification workflow.",
"x-ds-definition-name": "accountIdentityVerificationWorkflow"
}
accountInformation
{
"type": "object",
"properties": {
"brands": {
"$ref": "#/components/schemas/AccountBrands"
},
"planName": {
"type": "string",
"description": "The name of the Billing Plan."
},
"dssValues": {
"type": "object",
"description": "",
"additionalProperties": {
"type": "string"
}
},
"canUpgrade": {
"type": "string",
"description": "When **true,** specifies that you can upgrade the account through the API. For GET methods, you must set the `include_metadata` query parameter to **true** for this property to appear in the response."
},
"seatsInUse": {
"type": "string",
"description": "The number of users currently active on the account."
},
"accountName": {
"type": "string",
"description": "The name of the current account."
},
"createdDate": {
"type": "string",
"description": "The creation date of the account in UTC timedate format."
},
"isDowngrade": {
"type": "string",
"description": "When **true,** the account has been downgraded from a premium account type. Otherwise **false.**"
},
"planEndDate": {
"type": "string",
"description": "The date that the current plan will end."
},
"currencyCode": {
"type": "string",
"description": "Specifies the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the account."
},
"seatsAllowed": {
"type": "string",
"description": "The number of active users the account can have at one time."
},
"accountIdGuid": {
"type": "string",
"description": "The GUID associated with the account ID."
},
"currentPlanId": {
"type": "string",
"description": "ID of the plan used to create this account."
},
"paymentMethod": {
"type": "string",
"description": "The payment method used for the billing plan. Valid values are:\n\n- `NotSupported`\n- `CreditCard`\n- `PurchaseOrder`\n- `Premium`\n- `Freemium`\n- `FreeTrial`\n- `AppStore`\n- `DigitalExternal`\n- `DirectDebit`"
},
"planStartDate": {
"type": "string",
"description": "The date that the Account started using the current plan."
},
"billingProfile": {
"type": "string",
"description": "Reserved for DocuSign.\n"
},
"suspensionDate": {
"type": "string",
"description": "The date on which the account was suspended."
},
"accountSettings": {
"$ref": "#/components/schemas/accountSettingsInformation"
},
"distributorCode": {
"type": "string",
"description": "The code that identifies the billing plan groups and plans for the new account."
},
"recipientDomains": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientDomain"
},
"description": ""
},
"suspensionStatus": {
"type": "string",
"description": "Indicates whether the account is currently suspended."
},
"connectPermission": {
"type": "string",
"description": ""
},
"envelopeUnitPrice": {
"type": "string",
"description": "The price of sending an envelope, represented in the account's local currency."
},
"externalAccountId": {
"type": "string",
"description": "The Account ID displayed on the user's Account page."
},
"status21CFRPart11": {
"type": "string",
"description": "The status of the account content per (Title 21 CFR Part 11)[https://www.fda.gov/regulatory-information/search-fda-guidance-documents/part-11-electronic-records-electronic-signatures-scope-and-application]. This regulation defines the criteria under which electronic records and electronic signatures are considered trustworthy."
},
"docuSignLandingUrl": {
"type": "string",
"description": "URL of the landing page used to create the account."
},
"planClassification": {
"type": "string",
"description": "Identifies the type of plan. Examples include:\n\n- `business`\n- `corporate`\n- `enterprise` \n- `free`"
},
"displayApplianceUrl": {
"type": "string",
"description": ""
},
"useDisplayAppliance": {
"type": "boolean",
"description": ""
},
"billingPeriodEndDate": {
"type": "string",
"description": "The billing period end date in UTC timedate format."
},
"allowTransactionRooms": {
"type": "string",
"description": "When **true,** the transaction rooms feature exposed through the Workspaces API is enabled."
},
"billingPeriodStartDate": {
"type": "string",
"description": "The billing period start date in UTC timedate format."
},
"envelopeSendingBlocked": {
"type": "string",
"description": "When **true,** the ability to send envelopes is blocked. When **false,** envelopes can be sent."
},
"displayApplianceStartUrl": {
"type": "string",
"description": ""
},
"billingPeriodDaysRemaining": {
"type": "string",
"description": "Number of days remaining in the current billing period."
},
"billingPeriodEnvelopesSent": {
"type": "string",
"description": "The number of envelopes that have been sent in the current billing period."
},
"billingPeriodEnvelopesAllowed": {
"type": "string",
"description": "The number of envelopes that can be sent in the current billing period (can be unlimited)."
},
"forgottenPasswordQuestionsCount": {
"type": "string",
"description": " A complex element that contains up to four Question/Answer pairs for forgotten password information for a user."
}
},
"description": "Contains account Information.",
"x-ms-summary": "Contains account Information.",
"x-ds-definition-name": "accountInformation"
}
accountMinimumPasswordLength
{
"type": "object",
"properties": {
"maximumLength": {
"type": "string",
"description": "The maximum number of entry characters supported by the custom tab."
},
"minimumLength": {
"type": "string",
"description": "Minimum length of the access code string."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountMinimumPasswordLength"
}
accountNotification
{
"type": "object",
"properties": {
"reminders": {
"$ref": "#/components/schemas/reminders"
},
"expirations": {
"$ref": "#/components/schemas/expirations"
},
"userOverrideEnabled": {
"type": "string",
"description": "When **true,** the user can override envelope expirations."
}
},
"description": "A complex element that specifies notifications (expirations and reminders) for the envelope.",
"x-ms-summary": "A complex element that specifies notifications (expirations and reminders) for the envelope.",
"x-ds-definition-name": "accountNotification"
}
accountPasswordExpirePasswordDays
{
"type": "object",
"properties": {
"maximumDays": {
"type": "string",
"description": ""
},
"minimumDays": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountPasswordExpirePasswordDays"
}
accountPasswordLockoutDurationMinutes
{
"type": "object",
"properties": {
"maximumMinutes": {
"type": "string",
"description": ""
},
"minimumMinutes": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountPasswordLockoutDurationMinutes"
}
accountPasswordLockoutDurationType
{
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of option strings supported by this setting."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountPasswordLockoutDurationType"
}
accountPasswordMinimumPasswordAgeDays
{
"type": "object",
"properties": {
"maximumAge": {
"type": "string",
"description": ""
},
"minimumAge": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountPasswordMinimumPasswordAgeDays"
}
accountPasswordQuestionsRequired
{
"type": "object",
"properties": {
"maximumQuestions": {
"type": "string",
"description": "The maximum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or greater than `minimumQuestions`."
},
"minimumQuestions": {
"type": "string",
"description": "The minimum number of password reset questions allowed for the account. This number must be between `0` and `4`, and equal to or less than `maximumQuestions`."
}
},
"description": "Information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password.",
"x-ms-summary": "Information about the number of password questions required (0 to 4) to confirm a user's identity when a user needs to reset their password.",
"x-ds-definition-name": "accountPasswordQuestionsRequired"
}
accountPasswordRules
{
"type": "object",
"properties": {
"expirePassword": {
"type": "string",
"description": "When **true,** passwords expire. The default value is `false`."
},
"questionsRequired": {
"type": "string",
"description": "The number of security questions required to confirm the user’s identity before the user can reset their password. The default value is `0`."
},
"expirePasswordDays": {
"type": "string",
"description": "The number of days before passwords expire. To use this property, the `expirePassword` property must be set to **true.**"
},
"lockoutDurationType": {
"type": "string",
"description": "The interval associated with the user lockout after a failed login attempt.\n\nPossible values are:\n\n- `minutes` (default)\n- `hours`\n- `days`"
},
"passwordIncludeDigit": {
"type": "string",
"description": "When **true,** passwords must include a digit. The default value is `false`."
},
"passwordStrengthType": {
"type": "string",
"description": "The type of password strength. Possible values are:\n\n- `basic`: The minimum password length is 6 characters with no other password requirements.\n- `medium`: The minimum password length is 7 characters. Passwords must also have one uppercase letter, one lowercase letter, and one number or special character.\n- `strong`: The minimum password length is 9 characters. Passwords must also have one uppercase letter, one lowercase letter, one number, and one special character.\n- `custom`: This option enables you to customize password requirements, including the following properties:\n\n - `minimumPasswordLength`\n - `minimumPasswordAgeDays`\n - `passwordIncludeDigit`\n - `passwordIncludeDigitOrSpecialCharacter`\n - `passwordIncludeLowerCase`\n - `passwordIncludeSpecialCharacter`\n - `passwordIncludeUpperCase`\n - `questionsRequired`"
},
"minimumPasswordLength": {
"type": "string",
"description": "The minimum number of characters in the password. This value must be a number between `6` and `15`. The default value is `6`."
},
"lockoutDurationMinutes": {
"type": "string",
"description": "The number of minutes a user is locked out of the system after three failed login attempts. The default value is `2`."
},
"minimumPasswordAgeDays": {
"type": "string",
"description": "The minimum number of days after a password is set before it can be changed. This value can be `0` or more days. The default value is `0`."
},
"passwordIncludeLowerCase": {
"type": "string",
"description": "When **true,** passwords must include a lowercase letter. The default value is `false`."
},
"passwordIncludeUpperCase": {
"type": "string",
"description": "When **true,** passwords must include an uppercase letter. The default value is `false`."
},
"questionsRequiredMetadata": {
"$ref": "#/components/schemas/accountPasswordQuestionsRequired"
},
"expirePasswordDaysMetadata": {
"$ref": "#/components/schemas/accountPasswordExpirePasswordDays"
},
"lockoutDurationTypeMetadata": {
"$ref": "#/components/schemas/accountPasswordLockoutDurationType"
},
"passwordStrengthTypeMetadata": {
"$ref": "#/components/schemas/accountPasswordStrengthType"
},
"minimumPasswordLengthMetadata": {
"$ref": "#/components/schemas/accountMinimumPasswordLength"
},
"lockoutDurationMinutesMetadata": {
"$ref": "#/components/schemas/accountPasswordLockoutDurationMinutes"
},
"minimumPasswordAgeDaysMetadata": {
"$ref": "#/components/schemas/accountPasswordMinimumPasswordAgeDays"
},
"passwordIncludeSpecialCharacter": {
"type": "string",
"description": "When **true,** passwords must include a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."
},
"passwordIncludeDigitOrSpecialCharacter": {
"type": "string",
"description": "When **true,** passwords must include either a digit or a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountPasswordRules"
}
accountPasswordStrengthType
{
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/accountPasswordStrengthTypeOption"
},
"description": "An array of option strings supported by this setting."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountPasswordStrengthType"
}
accountPasswordStrengthTypeOption
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"minimumLength": {
"type": "string",
"description": "Minimum length of the access code string."
},
"passwordIncludeDigit": {
"type": "string",
"description": "When **true,** passwords must include a digit. The default value is `false`."
},
"passwordIncludeLowerCase": {
"type": "string",
"description": "When **true,** passwords must include a lowercase letter. The default value is `false`."
},
"passwordIncludeUpperCase": {
"type": "string",
"description": "When **true,** passwords must include an uppercase letter. The default value is `false`."
},
"passwordIncludeSpecialCharacter": {
"type": "string",
"description": "When **true,** passwords must include a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."
},
"passwordIncludeDigitOrSpecialCharacter": {
"type": "string",
"description": "When **true,** passwords must include either a digit or a special character. The default value is `false`.\n\n**Note:** Passwords cannot include angle brackets (`<` `>`) or spaces."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountPasswordStrengthTypeOption"
}
accountRoleSettings
{
"type": "object",
"properties": {
"webForms": {
"type": "string",
"description": ""
},
"vaultingMode": {
"type": "string",
"description": "Reserved for DocuSign."
},
"allowVaulting": {
"type": "string",
"description": "Reserved for DocuSign."
},
"powerFormRole": {
"type": "string",
"description": "The PowerForms rights associated with the account permission profile. Valid values are:\n\n- `none` \n- `user` \n- `admin`\n"
},
"allowApiAccess": {
"type": "string",
"description": "When **true,** users can manage documents by using the API."
},
"allowAutoTagging": {
"type": "string",
"description": " When **true,** auto-tagging is enabled for the account."
},
"allowBulkSending": {
"type": "string",
"description": "When **true,** bulk sending is enabled for users."
},
"webFormsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowTransactions": {
"type": "string",
"description": ""
},
"canCreateWorkspaces": {
"type": "string",
"description": "Reserved for DocuSign."
},
"disableOtherActions": {
"type": "string",
"description": "When **true,** users can access the **Other Actions** menu."
},
"allowESealRecipients": {
"type": "string",
"description": "When **true,** users can add electronic seal ([eSeal](https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html)) recipients."
},
"allowEnvelopeSending": {
"type": "string",
"description": "When **true,** users can send envelopes."
},
"canCreateTransaction": {
"type": "string",
"description": ""
},
"canDeleteTransaction": {
"type": "string",
"description": ""
},
"vaultingModeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowVaultingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowedTemplateAccess": {
"type": "string",
"description": "Specifies the level of access that users have to account templates. Valid values are: \n\n- `none` \n- `use`\n- `create`\n- `share`"
},
"disableDocumentUpload": {
"type": "string",
"description": "When **true,** users cannot upload documents."
},
"powerFormRoleMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowAccountManagement": {
"type": "string",
"description": "When **true,** users have full administrative access to the account."
},
"allowApiAccessMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSignerAttachments": {
"type": "string",
"description": "When **true,** users can add requests for attachments from signers."
},
"canSendEnvelopesViaSMS": {
"type": "string",
"description": ""
},
"useNewSendingInterface": {
"type": "string",
"description": "Reserved for DocuSign."
},
"allowApiAccessToAccount": {
"type": "string",
"description": "When **true,** users can access the account by using the eSignature API."
},
"allowWetSigningOverride": {
"type": "string",
"description": "When **true,** users can override the default account setting that controls whether recipients can sign documents on paper. The option to overrride this setting occurs during the sending process on a per-envelope basis."
},
"allowedClickwrapsAccess": {
"type": "string",
"description": ""
},
"enableApiRequestLogging": {
"type": "string",
"description": "When **true,** API request logging is enabled.\n\n**Note:** Logging limits apply."
},
"allowAutoTaggingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowBulkSendingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowedAddressBookAccess": {
"type": "string",
"description": "Specifies the level of access that users have to the account's address book. Valid values are:\n\n- `personal`\n- `useShared`\n- `usePersonalAndShared`\n- `personalAndShared`\n"
},
"signingUiVersionMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowApiSequentialSigning": {
"type": "string",
"description": "When **true,** users may specify sequential signing recipients when they send documents by using the API."
},
"allowTransactionsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowDocuSignDesktopClient": {
"type": "string",
"description": "When **true,** the DocuSign Desktop Client is enabled for users.\n"
},
"allowSupplementalDocuments": {
"type": "string",
"description": "When **true,** senders can include supplemental documents."
},
"allowedOrchestrationAccess": {
"type": "string",
"description": ""
},
"canCreateWorkspacesMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"disableOtherActionsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowESealRecipientsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowEnvelopeSendingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowTaggingInSendAndCorrect": {
"type": "string",
"description": "When **true,** the tagger palette is visible during the sending and correct flows and users can add tabs to documents."
},
"canCreateTransactionMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"canDeleteTransactionMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowedTemplateAccessMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"disableDocumentUploadMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"supplementalDocumentsMustRead": {
"type": "string",
"description": "When **true,** senders can require recipients to read supplemental documents."
},
"supplementalDocumentsMustView": {
"type": "string",
"description": "When **true,** users can require recipients to view supplemental documents."
},
"allowAccountManagementMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSignerAttachmentsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"canSendEnvelopesViaSMSMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"useNewSendingInterfaceMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowApiAccessToAccountMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowApiSendingOnBehalfOfOthers": {
"type": "string",
"description": "When **true,** users can send envelopes on behalf of others."
},
"allowWetSigningOverrideMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowedClickwrapsAccessMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"canDeleteDocumentsInTransaction": {
"type": "string",
"description": ""
},
"enableApiRequestLoggingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"supplementalDocumentsMustAccept": {
"type": "string",
"description": "When **true,** senders can require recipients to accept supplemental documents."
},
"allowedAddressBookAccessMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSequentialSigningInterface": {
"type": "string",
"description": "When **true,** the sequential signing user interface is enabled."
},
"allowApiSequentialSigningMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableTransactionPointIntegration": {
"type": "string",
"description": "Reserved for DocuSign."
},
"useNewDocuSignExperienceInterface": {
"type": "string",
"description": "Reserved for DocuSign."
},
"allowDocuSignDesktopClientMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSupplementalDocumentsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowedOrchestrationAccessMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableRecipientViewingNotifications": {
"type": "string",
"description": "When **true,** senders are notified when recipients view the documents that they send."
},
"allowTaggingInSendAndCorrectMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowedToBeEnvelopeTransferRecipient": {
"type": "string",
"description": "When **true,** users can be recipients of envelopes transferred to them by administrators of other accounts. "
},
"supplementalDocumentsMustReadMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"supplementalDocumentsMustViewMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowApiSendingOnBehalfOfOthersMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSendersToSetRecipientEmailLanguage": {
"type": "string",
"description": "When **true,** senders can set the language of the email that is sent to recipients."
},
"canDeleteDocumentsInTransactionMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableKeyTermsSuggestionsByDocumentType": {
"type": "string",
"description": ""
},
"supplementalDocumentsMustAcceptMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSequentialSigningInterfaceMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableTransactionPointIntegrationMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"useNewDocuSignExperienceInterfaceMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableRecipientViewingNotificationsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowedToBeEnvelopeTransferRecipientMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSendersToSetRecipientEmailLanguageMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableKeyTermsSuggestionsByDocumentTypeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"receiveCompletedSelfSignedDocumentsAsEmailLinks": {
"type": "string",
"description": "When **true,** senders receive emails about completed, self-signed documents that contain links to the completed documents instead of PDF attachments."
},
"allowPowerFormsAdminToAccessAllPowerFormEnvelopes": {
"type": "string",
"description": "When **true,** PowerForm Administrators can access all of the PowerForm envelopes associated with the account."
},
"receiveCompletedSelfSignedDocumentsAsEmailLinksMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowPowerFormsAdminToAccessAllPowerFormEnvelopesMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
}
},
"description": "This object defines account permissions for users who are associated with the account permission profile. ",
"x-ms-summary": "This object defines account permissions for users who are associated with the account permission profile. ",
"x-ds-definition-name": "accountRoleSettings"
}
accountSeals
{
"type": "object",
"properties": {
"seals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/sealIdentifier"
},
"description": "A list of electronic seals to apply to documents."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountSeals"
}
accountSettingsInformation
{
"type": "object",
"properties": {
"usesAPI": {
"type": "string",
"description": "When **true,**\nthe account can use the API.\n\n**Note:** Only SysAdmin users can change this setting.\n"
},
"allowACE": {
"type": "string",
"description": ""
},
"bulkSend": {
"type": "string",
"description": "When **true,** this user can use the bulk send feature for the account."
},
"exitPrompt": {
"type": "string",
"description": ""
},
"accountName": {
"type": "string",
"description": "The name on the account."
},
"allowMarkup": {
"type": "string",
"description": "When **true,** the Document Markup feature is enabled.\n\n**Note:** To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting at the account level.\n"
},
"autoNavRule": {
"type": "string",
"description": "Specifies how auto-navigation works.\nValid values are:\n\n- `off`\n- `required_fields`\n- `required_and_blank_fields`\n- `all_fields`\n- `page_then_required_fields`\n- `page_then_required_and_blank_fields`\n- `page_then_all_fields`\n"
},
"enableDSPro": {
"type": "string",
"description": "Reserved for DocuSign."
},
"expressSend": {
"type": "string",
"description": "Boolean that specifies whether a member of an account can express send (without tags) or must send with tags on documents."
},
"hidePricing": {
"type": "string",
"description": "Boolean that specifies whether to hide the pricing functionality for an account."
},
"allowSignNow": {
"type": "string",
"description": "When **true,**\nthe account administrator can enable\nthe Sign Now feature.\n"
},
"enableSearch": {
"type": "string",
"description": ""
},
"readOnlyMode": {
"type": "string",
"description": ""
},
"allowBulkSend": {
"type": "string",
"description": "When **true,** bulk send functionality is enabled for the account.\n\n**Note:** Only Admin users can change this setting."
},
"allowInPerson": {
"type": "string",
"description": "When **true,** the account administrator can enable in-person signing.\n\n**Note:** Only SysAdmin users can change this setting.\n\n"
},
"allowWebForms": {
"type": "string",
"description": ""
},
"enableAutoNav": {
"type": "string",
"description": "When **true,** enables the account to set the AutoNav rule setting, which enables a sender to override the auto-navigation setting per envelope.\n\n**Note:** To change this setting, you must be a SysAdmin user or `EnableAutoNavByDSAdmin must be set."
},
"faxOutEnabled": {
"type": "string",
"description": "When **true,** fax delivery to recipients is allowed for the account.\n\n**Note:** Only Admin users can change this setting."
},
"idCheckExpire": {
"type": "string",
"description": "Determines when a user's authentication with the account expires. Valid values are:\n\n- `always`: Users are required to authenticate each time.\n- `variable`: If the authentication for a user is valid and falls within the value for the `idCheckExpireDays` property, the user is not required to authenticate again.\n\n**Note:** Only Admin users can change this setting."
},
"showTutorials": {
"type": "string",
"description": "When **true,**\nshow tutorials.\n"
},
"adoptSigConfig": {
"type": "string",
"description": "When **true,** [Signature Adoption Configuration](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=dsz1583277358168.html) is enabled. \n\n**Note:** Only Admin users can change this setting."
},
"allowIDVLevel1": {
"type": "string",
"description": "When **true,** IDV Level 1 is allowed. The default value is **false.**"
},
"allowIDVLevel2": {
"type": "string",
"description": ""
},
"allowIDVLevel3": {
"type": "string",
"description": ""
},
"allowReminders": {
"type": "string",
"description": "When **true,**\nan account administrator can to turn on reminders\nand expiration defaults for the account.\n\n**Note:** Only Admin users can change this setting.\n"
},
"billingAddress": {
"$ref": "#/components/schemas/addressInformation"
},
"enableSearchUI": {
"type": "string",
"description": ""
},
"enableVaulting": {
"type": "string",
"description": "When **true,** Vaulting is enabled for the account."
},
"finishReminder": {
"type": "string",
"description": ""
},
"rsaVeridUserId": {
"type": "string",
"description": "The user ID for the RSA account.\n\n**Note:**\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it.\n"
},
"sessionTimeout": {
"type": "string",
"description": "The amount of idle activity time, in minutes, before a user is automatically logged out of the system. The minimum setting is 20 minutes and the maximum setting is 120 minutes.\n"
},
"signDateFormat": {
"type": "string",
"description": "The format for the signature date. Valid values are:\n\n- `d/M/yyyy`\n- `dd-MM-yy`\n- `dd-MMM-yy`\n- `dd-MM-yyyy`\n- `dd.MM.yyyy`\n- `dd-MMM-yyyy`\n- `dd MMMM yyyy`\n- `M/d/yyyy`\n- `MM-dd-yyyy`\n- `MM/dd/yyyy`\n- `MM/dd/yy`\n- `MMM-dd-yyyy`\n- `MMM d, yyyy`\n- `MMMM d, yyyy`\n- `yyyy-MM-dd`\n- `yyyy-MMM-dd`\n- `yyyy/MM/dd`\n- `yyyy MMMM d`\n\n**Note:** Only Admin users can change this setting.\n"
},
"signTimeFormat": {
"type": "string",
"description": "The format for the signature time. Valid values are:\n\n- `none`\n- `HH:mm`\n- `h:mm`\n- `HH:mm:ss`\n- `h:mm:ss`\n"
},
"useDerivedKeys": {
"type": "string",
"description": "Reserved for DocuSign.\n"
},
"advancedCorrect": {
"type": "string",
"description": "When **true,** the Advanced Correction feature is enabled for this account."
},
"allowCDWithdraw": {
"type": "string",
"description": "When **true,** indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false.**\n**Note:** Only Admin users can change this setting."
},
"allowExpression": {
"type": "string",
"description": "If the account plan does not include calculated fields, this setting allows an account to use them.\n\n"
},
"allowSharedTabs": {
"type": "string",
"description": "When **true,**\nshared tabs are enabled for the account.\n\n**Note:** Only Admin users can change this setting.\n"
},
"bccEmailArchive": {
"type": "string",
"description": "Boolean that specifies whether BCC for Email Archive is enabled for the account. BCC for Email Archive allows you to set up an archive email address so that a BCC copy of an envelope is sent only to that address."
},
"cfrUseWideImage": {
"type": "string",
"description": "Boolean that specifies whether to use a shorter/wider format when generating the CFR Part 11 signature image."
},
"enableClickPlus": {
"type": "string",
"description": ""
},
"enablePowerForm": {
"type": "string",
"description": "When **true,** enables PowerForms for the account.\n\n**Note:** Only SysAdmin users can change this setting."
},
"idCheckRequired": {
"type": "string",
"description": "Indicates if authentication is configured for the account. Valid values are:\n\n- `always`: Authentication checks are performed on every envelope.\n- `never`: Authentication checks are not performed on any envelopes.\n- `optional`: Authentication is configurable per envelope.\n\n**Note:** Only Admin users can change this setting."
},
"rsaVeridRuleset": {
"type": "string",
"description": "The RSA rule set used with the account.\n\n**Note:**\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it.\n"
},
"usesAPIMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"accessCodeFormat": {
"$ref": "#/components/schemas/accessCodeFormat"
},
"allowACEMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowAutoTagging": {
"type": "string",
"description": " When **true,** auto-tagging is enabled for the account."
},
"allowIDVPlatform": {
"type": "string",
"description": ""
},
"allowMergeFields": {
"type": "string",
"description": "When **true,** the account can use\n[merge fields](https://support.docusign.com/s/document-item?bundleId=evk1581360654067&topicId=ipy1581360621906.html)\nwith DocuSign for Salesforce.\n"
},
"allowSMSDelivery": {
"type": "string",
"description": ""
},
"bulkSendMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"canSelfBrandSend": {
"type": "string",
"description": "When **true,** account administrators can self-brand their sending console through the DocuSign console."
},
"canSelfBrandSign": {
"type": "string",
"description": "When **true,** account administrators can self-brand their signing console through the DocuSign console."
},
"convertPdfFields": {
"type": "string",
"description": "Boolean that specifies whether to enable PDF form fields to get converted to DocuSign secure fields when the document is added or uploaded to an envelope."
},
"disableMobileApp": {
"type": "string",
"description": "When **true,** the mobile app distributor key is prevented from connecting for account users."
},
"enableClickwraps": {
"type": "string",
"description": "Boolean that specifies whether clickwraps are enabled in your app. A [clickwrap](https://raw.githubusercontent.com) is an iframe that you embed in your own website or app."
},
"enableWitnessing": {
"type": "string",
"description": "Reserved for DocuSign."
},
"enforceTlsEmails": {
"type": "string",
"description": ""
},
"inSessionEnabled": {
"type": "string",
"description": "When **true,** the account can send in-session (embedded) envelopes.\n\n**Note:** Only Admin users can change this setting."
},
"rsaVeridPassword": {
"type": "string",
"description": "The password for the RSA account.\n\n\n**Note:**\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it.\n"
},
"setRecipSignLang": {
"type": "string",
"description": "When **true,**\nsetting a unique language for a recipient\nnot only affects the email language, but also the signing\nlanguage they are presented with. When **false,** only the email will\nbe affected when the sender specifies a unique language for a\nrecipient.\n\n**Note:** Only Admin users can change this setting.\n"
},
"signTimeShowAmPm": {
"type": "string",
"description": "When **true,**\nthe time shows the AM or PM indicator.\n"
},
"signingUiVersion": {
"type": "string",
"description": "Reserved for DocuSign.\n"
},
"timezoneOffsetUI": {
"type": "string",
"description": "Specifies the time zone\nto use in the UI.\n\nValid values are:\n\n- `TZ_01_AfghanistanStandardTime`\n- `TZ_02_AlaskanStandardTime`\n- `TZ_03_ArabStandardTime`\n- `TZ_04_ArabianStandardTime`\n- `TZ_05_ArabicStandardTime`\n- `TZ_06_ArgentinaStandardTime`\n- `TZ_07_AtlanticStandardTime`\n- `TZ_08_AUS_CentralStandardTime`\n- `TZ_09_AUS_EasternStandardTime`\n- `TZ_10_AzerbaijanStandardTime`\n- `TZ_11_AzoresStandardTime`\n- `TZ_12_BangladeshStandardTime`\n- `TZ_13_CanadaCentralStandardTime`\n- `TZ_14_CapeVerdeStandardTime`\n- `TZ_15_CaucasusStandardTime`\n- `TZ_16_CentralAustraliaStandardTime`\n- `TZ_17_CentralAmericaStandardTime`\n- `TZ_18_CentralAsiaStandardTime`\n- `TZ_19_CentralBrazilianStandardTime`\n- `TZ_20_CentralEuropeStandardTime`\n- `TZ_21_CentralEuropeanStandardTime`\n- `TZ_22_CentralPacificStandardTime`\n- `TZ_23_CentralStandardTime`\n- `TZ_24_CentralStandardTimeMexico`\n- `TZ_25_ChinaStandardTime`\n- `TZ_26_DatelineStandardTime`\n- `TZ_27_E_AfricaStandardTime`\n- `TZ_28_E_AustraliaStandardTime`\n- `TZ_29_E_EuropeStandardTime`\n- `TZ_30_E_SouthAmericaStandardTime`\n- `TZ_31_EasternStandardTime`\n- `TZ_32_EgyptStandardTime`\n- `TZ_33_EkaterinburgStandardTime`\n- `TZ_34_FijiStandardTime`\n- `TZ_35_FLE_StandardTime`\n- `TZ_36_GeorgianStandardTime`\n- `TZ_37_GMT_StandardTime`\n- `TZ_38_GreenlandStandardTime`\n- `TZ_39_GreenwichStandardTime`\n- `TZ_40_GTB_StandardTime`\n- `TZ_41_HawaiianStandardTime`\n- `TZ_42_IndiaStandardTime`\n- `TZ_43_IranStandardTime`\n- `TZ_44_IsraelStandardTime`\n- `TZ_45_JordanStandardTime`\n- `TZ_46_KaliningradStandardTime`\n- `TZ_47_KamchatkaStandardTime`\n- `TZ_48_KoreaStandardTime`\n- `TZ_49_MagadanStandardTime`\n- `TZ_50_MauritiusStandardTime`\n- `TZ_51_MidAtlanticStandardTime`\n- `TZ_52_MiddleEastStandardTime`\n- `TZ_53_MontevideoStandardTime`\n- `TZ_54_MoroccoStandardTime`\n- `TZ_55_MountainStandardTime`\n- `TZ_56_MountainStandardTimeMMexico`\n- `TZ_57_MyanmarStandardTime`\n- `TZ_58_N_CentralAsiaStandardTime`\n- `TZ_59_NamibiaStandardTime`\n- `TZ_60_NepalStandardTime`\n- `TZ_61_NewZealandStandardTime`\n- `TZ_62_NewfoundlandStandardTime`\n- `TZ_63_NorthAsiaEastStandardTime`\n- `TZ_64_NorthAsiaStandardTime`\n- `TZ_65_PacificSAStandardTime`\n- `TZ_66_PacificStandardTime`\n- `TZ_67_PacificStandardTimeMexico`\n- `TZ_68_PakistanStandardTime`\n- `TZ_69_ParaguayStandardTime`\n- `TZ_70_RomanceStandardTime`\n- `TZ_71_RussianStandardTime`\n- `TZ_72_SAEasternStandardTime`\n- `TZ_73_SAPacificStandardTime`\n- `TZ_74_SAWesternStandardTime`\n- `TZ_75_SamoaStandardTime`\n- `TZ_76_SE_AsiaStandardTime`\n- `TZ_77_SingaporeStandardTime`\n- `TZ_78_SouthAfricaStandardTime`\n- `TZ_79_SriLankaStandardTime`\n- `TZ_80_SyriaStandardTime`\n- `TZ_81_TaipeiStandardTime`\n- `TZ_82_TasmaniaStandardTime`\n- `TZ_83_TokyoStandardTime`\n- `TZ_84_TongaStandardTime`\n- `TZ_85_TurkeyStandardTime`\n- `TZ_86_UlaanbaatarStandardTime`\n- `TZ_87_US_EasternStandardTime`\n- `TZ_88_USMountainStandardTime`\n- `TZ_89_VenezuelaStandardTime`\n- `TZ_90_VladivostokStandardTime`\n- `TZ_91_W_AustraliaStandardTime`\n- `TZ_92_W_CentralAfricaStandardTime`\n- `TZ_93_W_EuropeStandardTime`\n- `TZ_94_WestAsiaStandardTime`\n- `TZ_95_WestPacificStandardTime`\n- `TZ_96_YakutskStandardTime`\n"
},
"useNewBlobForPdf": {
"type": "string",
"description": "Reserved for DocuSign.\n"
},
"validationsBrand": {
"type": "string",
"description": "Valid values are:\n\n- `docusign`\n- `account`\n"
},
"waterMarkEnabled": {
"type": "string",
"description": "When **true,**\nthe\n[watermark feature](https://support.docusign.com/s/articles/How-do-I-manage-the-watermark-for-In-Process-envelopes-sent-from-my-account)\nis enabled for the account.\n"
},
"accountUISettings": {
"$ref": "#/components/schemas/accountUISettings"
},
"allowDataDownload": {
"type": "string",
"description": "When **true,** senders can download form data from the envelopes that they send.\n\n**Note:** Only Admin users can change this setting.\n"
},
"allowEHankoStamps": {
"type": "string",
"description": "When **true,**\n[eHanko stamps](https://support.docusign.com/s/document-item?bundleId=jux1643235969954&topicId=dys1578456666697.html)\nare enabled.\n"
},
"allowRemoteNotary": {
"type": "string",
"description": ""
},
"displayBetaSwitch": {
"type": "string",
"description": "Boolean that specifies whether to display a Beta switch for your app."
},
"documentRetention": {
"type": "string",
"description": "Sets a document retention period, which controls the number of days that DocuSign retains documents after they have reached a completed,declined, or voided state. When document retention is enabled for the account, the default value is `356` days."
},
"enableReportLinks": {
"type": "string",
"description": "Enables direct links to envelopes in reports for administrators in the following scopes:\n- `NoEnvelopes`\n- `AllEnvelopes`\n- `OnlyOwnEnvelopes`"
},
"enableSendToAgent": {
"type": "string",
"description": "When **true,** this account can use the Agent recipient type.\n\n**Note:** Only SysAdmin users can change this setting.\n"
},
"enableSignOnPaper": {
"type": "string",
"description": "When **true,** a sender can allow signers to use the sign on paper option.\n\n**Note:** Only Admin users can change this setting.\n"
},
"idCheckExpireDays": {
"type": "string",
"description": "The number of days before user authentication credentials expire. A value of `0` specifies that users must re-authenticate for each new session.\n\n**Note:** Only Admin users can change this setting."
},
"setRecipEmailLang": {
"type": "string",
"description": "When **true,** senders can set the email language to use for\neach recipient.\n\n**Note:** Only Admin users can change this setting.\n"
},
"socialIdRecipAuth": {
"type": "string",
"description": "When **true,**\nrecipients can use\n[social ids](https://support.docusign.com/guides/signer-authentication)\nwhen signing\n"
},
"timezoneOffsetAPI": {
"type": "string",
"description": "Specifies the time zone\nto use with the API.\n\nValid values are:\n\n- `TZ_01_AfghanistanStandardTime`\n- `TZ_02_AlaskanStandardTime`\n- `TZ_03_ArabStandardTime`\n- `TZ_04_ArabianStandardTime`\n- `TZ_05_ArabicStandardTime`\n- `TZ_06_ArgentinaStandardTime`\n- `TZ_07_AtlanticStandardTime`\n- `TZ_08_AUS_CentralStandardTime`\n- `TZ_09_AUS_EasternStandardTime`\n- `TZ_10_AzerbaijanStandardTime`\n- `TZ_11_AzoresStandardTime`\n- `TZ_12_BangladeshStandardTime`\n- `TZ_13_CanadaCentralStandardTime`\n- `TZ_14_CapeVerdeStandardTime`\n- `TZ_15_CaucasusStandardTime`\n- `TZ_16_CentralAustraliaStandardTime`\n- `TZ_17_CentralAmericaStandardTime`\n- `TZ_18_CentralAsiaStandardTime`\n- `TZ_19_CentralBrazilianStandardTime`\n- `TZ_20_CentralEuropeStandardTime`\n- `TZ_21_CentralEuropeanStandardTime`\n- `TZ_22_CentralPacificStandardTime`\n- `TZ_23_CentralStandardTime`\n- `TZ_24_CentralStandardTimeMexico`\n- `TZ_25_ChinaStandardTime`\n- `TZ_26_DatelineStandardTime`\n- `TZ_27_E_AfricaStandardTime`\n- `TZ_28_E_AustraliaStandardTime`\n- `TZ_29_E_EuropeStandardTime`\n- `TZ_30_E_SouthAmericaStandardTime`\n- `TZ_31_EasternStandardTime`\n- `TZ_32_EgyptStandardTime`\n- `TZ_33_EkaterinburgStandardTime`\n- `TZ_34_FijiStandardTime`\n- `TZ_35_FLE_StandardTime`\n- `TZ_36_GeorgianStandardTime`\n- `TZ_37_GMT_StandardTime`\n- `TZ_38_GreenlandStandardTime`\n- `TZ_39_GreenwichStandardTime`\n- `TZ_40_GTB_StandardTime`\n- `TZ_41_HawaiianStandardTime`\n- `TZ_42_IndiaStandardTime`\n- `TZ_43_IranStandardTime`\n- `TZ_44_IsraelStandardTime`\n- `TZ_45_JordanStandardTime`\n- `TZ_46_KaliningradStandardTime`\n- `TZ_47_KamchatkaStandardTime`\n- `TZ_48_KoreaStandardTime`\n- `TZ_49_MagadanStandardTime`\n- `TZ_50_MauritiusStandardTime`\n- `TZ_51_MidAtlanticStandardTime`\n- `TZ_52_MiddleEastStandardTime`\n- `TZ_53_MontevideoStandardTime`\n- `TZ_54_MoroccoStandardTime`\n- `TZ_55_MountainStandardTime`\n- `TZ_56_MountainStandardTimeMMexico`\n- `TZ_57_MyanmarStandardTime`\n- `TZ_58_N_CentralAsiaStandardTime`\n- `TZ_59_NamibiaStandardTime`\n- `TZ_60_NepalStandardTime`\n- `TZ_61_NewZealandStandardTime`\n- `TZ_62_NewfoundlandStandardTime`\n- `TZ_63_NorthAsiaEastStandardTime`\n- `TZ_64_NorthAsiaStandardTime`\n- `TZ_65_PacificSAStandardTime`\n- `TZ_66_PacificStandardTime`\n- `TZ_67_PacificStandardTimeMexico`\n- `TZ_68_PakistanStandardTime`\n- `TZ_69_ParaguayStandardTime`\n- `TZ_70_RomanceStandardTime`\n- `TZ_71_RussianStandardTime`\n- `TZ_72_SAEasternStandardTime`\n- `TZ_73_SAPacificStandardTime`\n- `TZ_74_SAWesternStandardTime`\n- `TZ_75_SamoaStandardTime`\n- `TZ_76_SE_AsiaStandardTime`\n- `TZ_77_SingaporeStandardTime`\n- `TZ_78_SouthAfricaStandardTime`\n- `TZ_79_SriLankaStandardTime`\n- `TZ_80_SyriaStandardTime`\n- `TZ_81_TaipeiStandardTime`\n- `TZ_82_TasmaniaStandardTime`\n- `TZ_83_TokyoStandardTime`\n- `TZ_84_TongaStandardTime`\n- `TZ_85_TurkeyStandardTime`\n- `TZ_86_UlaanbaatarStandardTime`\n- `TZ_87_US_EasternStandardTime`\n- `TZ_88_USMountainStandardTime`\n- `TZ_89_VenezuelaStandardTime`\n- `TZ_90_VladivostokStandardTime`\n- `TZ_91_W_AustraliaStandardTime`\n- `TZ_92_W_CentralAfricaStandardTime`\n- `TZ_93_W_EuropeStandardTime`\n- `TZ_94_WestAsiaStandardTime`\n- `TZ_95_WestPacificStandardTime`\n- `TZ_96_YakutskStandardTime`\n"
},
"validationsReport": {
"type": "string",
"description": "Valid values are:\n\n- `none`\n- `life_sciences_part11`\n"
},
"allowManagedStamps": {
"type": "string",
"description": "When **true,** [Managed Stamps](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=cex1583277417267.html) are enabled."
},
"allowOrganizations": {
"type": "string",
"description": "Boolean that specifies whether [DocuSign Admin](https://raw.githubusercontent.com) is enabled for the account."
},
"allowSigningGroups": {
"type": "string",
"description": "When **true,** the account allows signing groups. This setting is only shown in responses that list account settings. This property is read-only."
},
"allowSocialIdLogin": {
"type": "string",
"description": "Deprecated."
},
"allowValueInsights": {
"type": "string",
"description": ""
},
"disableUserSharing": {
"type": "string",
"description": "When **true,** the User Sharing feature is disabled for the account."
},
"documentVisibility": {
"type": "string",
"description": "Configures the Document Visibility feature for the account. Valid values are:\n\n- `Off`: Document Visibility is not active for the account.\n- `MustSignToViewUnlessSenderAccount`: Document Visibility is enabled for all envelopes sent from the account. Any member of the sending account can view all of the documents in an envelope.\n- `MustSignToViewUnlessSender`: Document Visibility is enabled for all envelopes sent from the account. Only the sender can view all of the documents in an envelope.\n- `SenderCanSetMustSignToViewUnlessSenderAccount`: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents within it are still visible to any member of the sending account.\nVd- `SenderCanSetMustSignToViewUnlessSender`: The sender has the option to enable Document Visibility for an envelope. When enabled for an envelope, all of the documents in the envelope are visible only to the sender.\n\n**Note:** For this configuration to take effect, `allowDocumentVisibility` must be set to **true.**"
},
"enableBccDummyLink": {
"type": "string",
"description": ""
},
"enableSendToManage": {
"type": "string",
"description": "When **true,** this account can use the Editor recipient type.\n\n**Note:** Only Admin users can change this setting.\n"
},
"envelopeSearchMode": {
"type": "string",
"description": ""
},
"exitPromptMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signatureProviders": {
"type": "array",
"items": {
"type": "string"
},
"description": "Names of electronic or digital signature providers that can be used."
},
"signerAttachConcat": {
"type": "string",
"description": "When **true,** signer attachments are added to the parent document\nthat contains the attachment.\nThe default behavior creates\na new document in the envelope for every signer attachment.\n\n**Note:** Only Admin users can change this setting.\n"
},
"tabAccountSettings": {
"$ref": "#/components/schemas/tabAccountSettings"
},
"validationsAllowed": {
"type": "string",
"description": "Boolean that specifies whether validations on recipient email domains are allowed."
},
"validationsCadence": {
"type": "string",
"description": "Valid values are:\n\n- `none`\n- `monthly`\n"
},
"validationsEnabled": {
"type": "string",
"description": "When **true,**\nenables validations.\n"
},
"accountNameMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"accountNotification": {
"$ref": "#/components/schemas/accountNotification"
},
"allowConnectOAuthUI": {
"type": "string",
"description": ""
},
"allowDelayedRouting": {
"type": "string",
"description": "\"true\" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, \"false\" otherwise."
},
"allowENoteEOriginal": {
"type": "string",
"description": "Specifies whether eNote eOriginal integration is enabled.\n"
},
"allowIDVLevel1Trial": {
"type": "string",
"description": ""
},
"allowMarkupMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowMemberTimeZone": {
"type": "string",
"description": "When **true,** account users can set their own\n[time zone settings](https://support.docusign.com/s/articles/How-do-I-modify-time-zone-settings-for-my-account).\n\n**Note:** Only Admin users can change this setting.\n"
},
"allowNonUSPhoneAuth": {
"type": "string",
"description": "Specifies whether users can use\ninternational numbers\nfor phone authentication.\n"
},
"allowOfflineSigning": {
"type": "string",
"description": "When **true,**\n[offline signing](https://support.docusign.com/articles/Offline-access-with-the-DocuSign-Mobile-App-for-iOS-iPad-iPhone-iPod-Touch)\nis enabled for the account.\n\n**Note:** Only Admin users can change this setting."
},
"allowSignerReassign": {
"type": "string",
"description": "When **true,** the recipient of an envelope sent from this account can reassign it to another person.\n\n**Note:** Only Admin users can change this setting.\n"
},
"authenticationCheck": {
"type": "string",
"description": "Sets when authentication checks are applied for recipient envelope access. This setting only applies to the following ID checks: \n\n- Phone Authentication\n- SMS Authentication\n- Knowledge-Based ID\n\nThis setting takes one of the following options: \n\n- `initial_access`: The authentication check always applies the first time a recipient accesses the documents. Recipients are not asked to authenticate again when they access the documents from the same browser on the same device. If the recipient attempts to access the documents from a different browser or a different device, the recipient must pass authentication again. Once authenticated, that recipient is not challenged again on the new device or browser. The ability for a recipient to skip authentication for documents is limited to documents sent from the same sending account.\n- `each_access`: Authentication checks apply every time a recipient attempts to access the envelope. However, you can configure the Authentication Expiration setting to allow recipients to skip authentication when they have recently passed authentication by setting a variable time frame.\n\n**Note:** Only Admin users can change this setting.\n"
},
"autoNavRuleMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"dataPopulationScope": {
"type": "string",
"description": "Specifies how data is shared for tabs with the same tabLabel. Valid values are:\n\n- `document`: Tabs in a document with the same label populate with the same data.\n- `envelope`: Tabs in all documents in the envelope with the same label populate with the same data.\n- `notset`: Use the global account setting.\n\nThis setting applies to the following tab types:\n\n- Check box\n- Company\n- Data field\n- Drop-down list\n- Full name\n- Formula\n- Note\n- Title\n\n**Note:** Only Admin users can change this setting. Changing this setting affects envelopes that have been sent but not completed."
},
"enableAdmHealthcare": {
"type": "string",
"description": "Account Level Flag that determines the availability to use ADM Healthcare fields"
},
"enableDSProMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableIDFxIntuitKBA": {
"type": "string",
"description": ""
},
"enableSocialIdLogin": {
"type": "string",
"description": "Deprecated."
},
"enableStrikeThrough": {
"type": "string",
"description": "When **true,** enables strikethrough formatting in documents."
},
"expressSendMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"hidePricingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"rsaVeridAccountName": {
"type": "string",
"description": "The RSA account name.\n\n**Note:**\nOnly Admin users can change this setting. Modifying this value may disrupt\nyour ID Check capability.\nEnsure you have the correct value before changing it.\n"
},
"sbsTransactionLevel": {
"type": "string",
"description": ""
},
"sendingTagsFontName": {
"type": "string",
"description": "The account-wide default font to be used for the tab value. Supported fonts include:\n\n- `Default`\n- `Arial`\n- `ArialNarrow`\n- `Calibri`\n- `CourierNew`\n- `Garamond`\n- `Georgia`\n- `Helvetica`\n- `LucidaConsole`\n- `MSGothic`\n- `MSMincho`\n- `OCR-A`\n- `Tahoma`\n- `TimesNewRoman`\n- `Trebuchet`\n- `Verdana`"
},
"sendingTagsFontSize": {
"type": "string",
"description": "The account-wide default font size used for the information in the tab:\n\n- `Size7`\n- `Size8`\n- `Size9`\n- `Size10`\n- `Size11`\n- `Size12`\n- `Size14`\n- `Size16`\n- `Size18`\n- `Size20`\n- `Size22`\n- `Size24`\n- `Size26`\n- `Size28`\n- `Size36`\n- `Size48`\n- `Size72`"
},
"singleSignOnEnabled": {
"type": "string",
"description": "When **true,**\nsingle sign-on (SSO) is enabled.\n"
},
"useSmartContractsV1": {
"type": "string",
"description": ""
},
"allowAutoNavSettings": {
"type": "string",
"description": " When **true,** auto-navigation can be enabled for this account.\n"
},
"allowDocGenDocuments": {
"type": "string",
"description": ""
},
"allowEnvelopeCorrect": {
"type": "string",
"description": "When **true,** the envelope correction feature is enabled.\n\n**Note:** Only Admin users can change this setting.\n"
},
"allowServerTemplates": {
"type": "string",
"description": "When **true,**\nthe account can use templates.\n"
},
"allowSignNowMetadata": {
"type": "string",
"description": "Metadata that indicates whether the `allowSignNow` property is editable.\n"
},
"allowSignatureStamps": {
"type": "string",
"description": "When **true,** Signature Stamps are enabled.\n\n**Note:** Only Admin users can change this setting."
},
"allowSigningInsights": {
"type": "string",
"description": ""
},
"disableMobileSending": {
"type": "string",
"description": "When **true,** sending from a mobile application is disabled.\n\n**Note:** Only Admin users can change this setting."
},
"emailTemplateVersion": {
"type": "string",
"description": "Specifies the version of the email templates used in an account. If new signing is selected in a member's Admin page, the user is updated to the newest version (1.1), the minimum version of email supported for the account."
},
"enablePDFAConversion": {
"type": "string",
"description": ""
},
"enableReservedDomain": {
"type": "string",
"description": "When **true,** account administrators can reserve a web domain and users. Domains are organization-specific reserved internet domains, such as `@exampledomain.com`. You can define policy settings for users of each reserved domain within your organization, export lists of domain users for audit purposes, and manage domain users.\n\n- Domains may be claimed by an organization.\n- When a domain is claimed by an organization, all users within that domain are added to the organization, even if they have trial or free accounts.\n- You can set domain controls for all users of the domain.\n- You can export information about your organization’s users that are associated with your reserved domains.\n\n**Note:** Only SysAdmin users can change this setting."
},
"enableSearchMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSignWithNotary": {
"type": "string",
"description": "When **true,** Sign with Notary functionality is enabled for the account.\n\n**Note:** Only Admin users can change this setting."
},
"enableSmartContracts": {
"type": "string",
"description": "When **true,** blockchain-based [Smart Contracts](https://www.docusign.com/products/blockchain) are enabled. The default value is **false.**"
},
"expressSendAllowTabs": {
"type": "string",
"description": "Boolean that specifies whether a member of an account can send templates without the tags being stripped out, even when the account is configured to let its users express send only (they cannot use the tagger)."
},
"idCheckExpireMinutes": {
"type": "string",
"description": "The number of minutes before user authentication credentials expire."
},
"identityVerification": {
"type": "array",
"items": {
"$ref": "#/components/schemas/accountIdentityVerificationWorkflow"
},
"description": "Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](https://raw.githubusercontent.com) method in the [IdentityVerifications](https://raw.githubusercontent.com) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)."
},
"maximumSigningGroups": {
"type": "string",
"description": "The maximum number of signing groups allowed on the account. The default value is `50`. This setting is only shown in responses that list account settings.\n\n**Note:** Only SysAdmin users can change this setting."
},
"mobileSessionTimeout": {
"type": "string",
"description": "The number of minutes of inactivity before a mobile user is automatically logged out of the system. Valid values are `1` to `120` minutes. The default value is `20` minutes.\n\n**Note:** Only Admin users can change this setting."
},
"readOnlyModeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"requireDeclineReason": {
"type": "string",
"description": "When **true,** signers who decline to sign an envelope sent from this account\nare required to provide a reason for declining.\n\n**Note:** Only Admin users can change this setting.\n"
},
"sendingTagsFontColor": {
"type": "string",
"description": "The account-wide default font color to use for the content of the tab.\n\nValid values are:\n\n- `Black`\n- `BrightBlue`\n- `BrightRed`\n- `DarkGreen`\n- `DarkRed`\n- `Gold`\n- `Green`\n- `NavyBlue`\n- `Purple`\n- `White`\n"
},
"useAccountLevelEmail": {
"type": "string",
"description": "Reserved for DocuSign.\n"
},
"useNewEnvelopeSearch": {
"type": "string",
"description": ""
},
"accountDateTimeFormat": {
"type": "string",
"description": "UTC date/time format for the account."
},
"allowAccessCodeFormat": {
"type": "string",
"description": "When **true,** the configured [Access Code Format](/docs/esign-rest-api/reference/accounts/accounts/get/#accessCodeFormat) page is enabled for account administrators.\n\n**Note:** Only Admin users can change this setting."
},
"allowAgreementActions": {
"type": "string",
"description": ""
},
"allowBulkSendMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowDelegatedSigning": {
"type": "string",
"description": ""
},
"allowInPersonMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowRecipientConnect": {
"type": "string",
"description": ""
},
"allowScheduledSending": {
"type": "string",
"description": "\"true\" if the account has permission to use the scheduled sending feature to send envelopes at a specified datetime in the future, \"false\" otherwise."
},
"allowWebFormsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowWhatsAppDelivery": {
"type": "string",
"description": ""
},
"anchorPopulationScope": {
"type": "string",
"description": "This property determines how template anchor tabs are applied.\n\nValid values are:\n\n- `document`: Anchor tabs are applied only to the document that you specify. \n- `envelope`: Anchor tabs are applied to all of the documents in the envelope associated with the template.\n\n**Note:** When you are using the `anchorPopulationScope` property with a Composite Template, the value `document` is supported only with a single server template and a single inline template.\n\n"
},
"canUseSalesforceOAuth": {
"type": "string",
"description": ""
},
"captureVoiceRecording": {
"type": "string",
"description": "Reserved for DocuSign."
},
"disableSignerCertView": {
"type": "string",
"description": "When **true,** signers cannot view certificates of completion."
},
"disableStyleSignature": {
"type": "string",
"description": "When **true,** the **Select Style** option is hidden from signers and they must draw their signature instead. "
},
"enableAutoNavMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableDSigExpressPens": {
"type": "string",
"description": ""
},
"enableInBrowserEditor": {
"type": "string",
"description": ""
},
"enablePowerFormDirect": {
"type": "string",
"description": "When **true,** enables direct PowerForms for an account. Direct PowerForms are in-session PowerForms.\n\n**Note:** Only Admin users can change this setting."
},
"faxOutEnabledMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"idCheckConfigurations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/idCheckConfiguration"
},
"description": "A list of ID check configuration objects."
},
"idCheckExpireMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"mergeMixedModeResults": {
"type": "string",
"description": ""
},
"optInMobileSigningV02": {
"type": "string",
"description": "Boolean that specifies whether to opt in for Signing v02 on Mobile Devices functionality."
},
"optOutNewPlatformSeal": {
"type": "string",
"description": "Boolean that specifies whether to allow envelope senders to opt out of using the new platform seal."
},
"sharedTemplateFolders": {
"type": "string",
"description": "Boolean that specifies whether an account can use Shared Template Folders."
},
"showTutorialsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signerCanSignOnMobile": {
"type": "string",
"description": "When **true,** recipients can sign on a mobile device.\n\n**Note:** Only Admin users can change this setting.\n"
},
"signerMustHaveAccount": {
"type": "string",
"description": "When **true,** senders can only send an envelope to a recipient\nthat has a DocuSign account.\n\n**Note:** Only Account Administrators can change this setting.\n"
},
"signerMustLoginToSign": {
"type": "string",
"description": "When **true,**\nsigners must log in to the DocuSign platform to sign an envelope.\n\n**Note:** Only Admin users can change this setting.\n"
},
"signingSessionTimeout": {
"type": "string",
"description": "The number of minutes\nthat a signing session stays\nalive without any activity.\n"
},
"useConsumerDisclosure": {
"type": "string",
"description": "When **true,** the account uses an Electronic Record and\nSignature Disclosure Statement.\n\n**Note:** Only Admin users can change this setting.\n"
},
"useMultiAppGroupsData": {
"type": "string",
"description": ""
},
"accountDefaultLanguage": {
"type": "string",
"description": ""
},
"adoptSigConfigMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowEnvelopeReporting": {
"type": "string",
"description": "Specifies whether the account has access to reports.\n"
},
"allowIDVLevel1Metadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowIDVLevel2Metadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowIDVLevel3Metadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowPaymentProcessing": {
"type": "string",
"description": "When **true,** payment processing is enabled for the account.\n\n**Note:** Only Admin users can change this setting."
},
"allowPhoneAuthOverride": {
"type": "string",
"description": "Boolean that specifies whether users can override phone authentication."
},
"allowRemindersMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSecurityAppliance": {
"type": "string",
"description": "Boolean that specifies whether a DocuSign Signature Appliance can be used with the account."
},
"allowSigningExtensions": {
"type": "string",
"description": "Boolean that specifies whether Signing and App Extensions are allowed."
},
"billingAddressMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"chromeSignatureEnabled": {
"type": "string",
"description": "Boolean that specifies whether the signers of the envelopes from this account use a signature with a DocuSign chrome around it or not."
},
"disableUploadSignature": {
"type": "string",
"description": "When **true,** signers cannot upload custom image files of their signature and initials.\n\n**Note:** Only Admin users can change this setting."
},
"draftEnvelopeRetention": {
"type": "string",
"description": ""
},
"enableAdvancedPayments": {
"type": "string",
"description": "When **true,** enables Advanced Payments for the account."
},
"enableCalculatedFields": {
"type": "string",
"description": "When **true,** calculated fields are enabled for the account. \n\n**Note:** This setting can be changed only by Admin users, and only if the account-level setting `allowExpression` is set to **true.**"
},
"enableEsignCommunities": {
"type": "string",
"description": ""
},
"enableLargeFileSupport": {
"type": "string",
"description": ""
},
"enableScheduledRelease": {
"type": "string",
"description": "When **true,** scheduled releases are enabled. The default value is **false.**"
},
"enableSearchUIMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableTransactionPoint": {
"type": "string",
"description": "Reserved for DocuSign."
},
"enableVaultingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"finishReminderMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"guidedFormsHtmlAllowed": {
"type": "string",
"description": "When **true,** HTML used to implement [Guided Forms](https://www.docusign.com/products/guided-forms) is enabled for the account."
},
"inPersonSigningEnabled": {
"type": "string",
"description": "When **true,** in-person signing is enabled for the account."
},
"sessionTimeoutMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signDateFormatMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signTimeFormatMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signerCanCreateAccount": {
"type": "string",
"description": "When **true,**\na signer can create a DocuSign account\nafter signing.\n\n**Note:** Only Admin users can change this setting.\n"
},
"startInAdvancedCorrect": {
"type": "string",
"description": "When **true,**\nwhen initiating correction of an in-flight envelope\nthe sender starts in advanced correct mode.\n"
},
"useDerivedKeysMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"advancedCorrectMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowAgentNameEmailEdit": {
"type": "string",
"description": " When **true,** an agent recipient can change the email addresses of recipients later in the signing order.\n"
},
"allowCDWithdrawMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowDocumentVisibility": {
"type": "string",
"description": "When **true,** the [Document Visibility](https://support.docusign.com/guides/ndse-user-guide-document-visibility) feature is enabled for the account.\n"
},
"allowExpressionMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSendToIntermediary": {
"type": "string",
"description": "When **true,**\nthe account admin can enable the Send to Intermediary\nfeature on the account.\n"
},
"allowSharedTabsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"attachCompletedEnvelope": {
"type": "string",
"description": "When **true,** envelope documents are included as a PDF file attachment to \"signing completed\" emails.\n\n**Note:** Only SysAdmin users can change this setting."
},
"bccEmailArchiveMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"betaSwitchConfiguration": {
"type": "string",
"description": "Reserved for DocuSign.\n"
},
"cfrUseWideImageMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"disableMultipleSessions": {
"type": "string",
"description": "When **true,** account users cannot be logged into multiple sessions at the same time.\n\n**Note:** Only Admin users can change this setting."
},
"enableAccountWideSearch": {
"type": "string",
"description": ""
},
"enableClickPlusMetaData": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enablePaymentProcessing": {
"type": "string",
"description": "When **true,** payment processing is enabled for this account.\n\n**Note:** This setting can be changed only by Admin users, and only if the account-level setting `allowPaymentProcessing` is set."
},
"enablePowerFormMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableResponsiveSigning": {
"type": "string",
"description": "When **true,** enables responsive signing."
},
"enableSMSAuthentication": {
"type": "string",
"description": "When **true,** the account can use SMS authentication.\n\n**Note:** Only Admin users can change this setting.\n"
},
"enableSignerAttachments": {
"type": "string",
"description": "When **true,** users can use the signing attachments feature to request attachments from signers.\n\n**Note:** Only Admin users can change this setting."
},
"externalDocumentSources": {
"$ref": "#/components/schemas/externalDocumentSources"
},
"hideAccountAddressInCoC": {
"type": "string",
"description": "Boolean that specifies whether to hide the account address in the Certificate of Completion."
},
"idCheckRequiredMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"inPersonIDCheckQuestion": {
"type": "string",
"description": "A text field containing the question that an in-person signing host uses to collect personal information from the recipient. The recipient's response to this question is saved and can be viewed in the certificate associated with the envelope.\n\n**Note:** Only Admin users can change this setting."
},
"inSessionSuppressEmails": {
"type": "string",
"description": "When **true,** emails are not sent to the in-session (embedded) recipients on an envelope.\n\n**Note:** Only Admin users can change this setting."
},
"maxNumberOfCustomStamps": {
"type": "string",
"description": "The maximum number of custom stamps."
},
"showLocalizedWatermarks": {
"type": "string",
"description": "Boolean that specifies whether localized watermarks are displayed."
},
"signerLoginRequirements": {
"type": "string",
"description": "Sets the login requirements for signers. Valid values are:\n\n- `login_not_required`: Signers are not required to log in.\n- `login_required_if_account_holder`: If the signer has a DocuSign account,\n they must log in to sign the document.\n- `login_required_per_session`: The sender cannot send an envelope to anyone\n who does not have a DocuSign account.\n- `login_required_per_envelope`: The sender cannot send an envelope to anyone\n who does not have a DocuSign account, and the signer must also log in for\n each envelope they will sign.\n\n\n**Note:** Only Admin users can change this setting. If you use Direct PowerForms\nor captive (embedded signers), the \"Account required\" settings are bypassed for\nthose signers. If your workflow requires that the signer have an account,\nyou should not use those methods.\n"
},
"universalSignatureOptIn": {
"type": "string",
"description": "Reserved for DocuSign.\n"
},
"allowAutoTaggingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowDocumentDisclosures": {
"type": "string",
"description": "Boolean that specifies whether disclosure documents can be included in envelopes."
},
"allowIDVPlatformMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowMergeFieldsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowPhoneAuthentication": {
"type": "string",
"description": "Boolean that specifies whether phone authentication is enabled for the account."
},
"allowSMSDeliveryMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"bulkSendMaxCopiesInBatch": {
"type": "string",
"description": ""
},
"canSelfBrandSendMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"canSelfBrandSignMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"conditionalFieldsEnabled": {
"type": "string",
"description": "When **true,** conditional fields can be used in documents.\n\n**Note:** Only Admin users can change this setting."
},
"convertPdfFieldsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"disableMobileAppMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"disableSignerHistoryView": {
"type": "string",
"description": "When **true,** signers cannot view envelope history."
},
"enableAdvancedPowerForms": {
"type": "string",
"description": "When **true,** enables advanced PowerForms for the account."
},
"enableClickwrapsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableContactSuggestions": {
"type": "string",
"description": ""
},
"enableDSigEUAdvancedPens": {
"type": "string",
"description": ""
},
"enableInboxRelevanceSort": {
"type": "string",
"description": ""
},
"enableRequireSignOnPaper": {
"type": "string",
"description": "When **true,** the account can use the `requireSignOnPaper` option.\n\n**Note:** Only Admin users can change this setting.\n"
},
"enableSMSDeliveryPrimary": {
"type": "string",
"description": ""
},
"enableSendToIntermediary": {
"type": "string",
"description": "When **true,** this account can use the Intermediary recipient type.\n\n**Note:** Only Admin users can change this setting, and only if `allowSendToIntermediary` is set.\n"
},
"enableWitnessingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enforceTlsEmailsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"externalSignaturePadType": {
"type": "string",
"description": "Specifies the signature pad type.\nValid values are:\n\n- `none`\n- `topaz`\n- `e_padv9`\n- `e_pad_integrisign`\n- `topaz_sigplusextlite`\n\n**Note:** Only Admin users can change this setting.\n"
},
"inSessionEnabledMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"optInUniversalSignatures": {
"type": "string",
"description": ""
},
"pkiSignDownloadedPDFDocs": {
"type": "string",
"description": "The policy for adding a digital certificate to downloaded, printed, and emailed documents. \n\nPossible values are: \n\n- `no_sign`\n- `no_sign_allow_user_override`\n- `yes_sign` (Specifies that PDF files downloaded from the platform are signed.)\n\n**Note:** Only Admin users can change this setting.\n"
},
"recipientsCanSignOffline": {
"type": "string",
"description": "When **true,**\nrecipients receiving envelopes from this account\ncan sign offline.\n\n**Note:** Only Admin users can change this setting.\n"
},
"setRecipSignLangMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signTimeShowAmPmMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signingUiVersionMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"simplifiedSendingEnabled": {
"type": "string",
"description": "When **true,** simplified sending is enabled for the account. The default value is **false.**"
},
"timezoneOffsetUIMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"useNewBlobForPdfMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"validationsBrandMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"waterMarkEnabledMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowDataDownloadMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowEHankoStampsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowEnvelopeCustomFields": {
"type": "string",
"description": "Specifies whether\n[envelope custom fields](https://support.docusign.com/s/document-item?bundleId=jux1643235969954&topicId=mns1578456285568.html)\nare enabled.\n"
},
"allowExternalSignaturePad": {
"type": "string",
"description": "When **true,** the account can\nconfigure and use signature pads for their recipients.\n\n**Note:** Only Admin users can change this setting.\n"
},
"allowPerformanceAnalytics": {
"type": "string",
"description": ""
},
"allowPrivateSigningGroups": {
"type": "string",
"description": "Reserved for DocuSign. This property returns the value **false** when listing account settings. This property is read-only."
},
"allowRemoteNotaryMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowResourceFileBranding": {
"type": "string",
"description": "When **true,**\nresource files can be uploaded in branding.\n"
},
"allowSigningRadioDeselect": {
"type": "string",
"description": "Boolean that specifies whether the account supports radio buttons on tabs [Radio CustomTabType](https://raw.githubusercontent.com)."
},
"bulkSendActionResendLimit": {
"type": "string",
"description": ""
},
"displayBetaSwitchMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"documentRetentionMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableAccessCodeGenerator": {
"type": "string",
"description": "When **true,** enables Access Code Generator on the account."
},
"enableReportLinksMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSendToAgentMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSequentialSigningUI": {
"type": "string",
"description": "When **true,** the account can define the routing order\nof recipients for envelopes sent by using the DocuSign application.\n\n**Note:** Only SysAdmin users can change this setting.\n"
},
"enableSignOnPaperMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSignOnPaperOverride": {
"type": "string",
"description": "When **true,** a user can override the default default account setting for the Sign on Paper option, which specifies whether signers can sign documents on paper as an option to signing electronically.\n\n**Note:** Only Admin users can change this setting."
},
"idCheckExpireDaysMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"setRecipEmailLangMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"socialIdRecipAuthMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"specifyDocumentVisibility": {
"type": "string",
"description": "When **true,** senders can specify the visibility of the documents in an envelope at the recipient level.\n"
},
"timezoneOffsetAPIMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"useSAFESignerCertificates": {
"type": "string",
"description": "When **true,**\nsigners are\nrequired to use SAFE digital signatures.\n"
},
"validationsReportMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowManagedStampsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowMultipleBrandProfiles": {
"type": "string",
"description": "Specifies whether the account supports multiple brands.\n"
},
"allowOrganizationsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSigningGroupsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSocialIdLoginMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSupplementalDocuments": {
"type": "string",
"description": "When **true,** this user can include supplemental documents."
},
"allowTransactionsWorkspace": {
"type": "string",
"description": ""
},
"allowValueInsightsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"autoProvisionSignerAccount": {
"type": "string",
"description": "Boolean that specifies whether to automatically provision a user membership in the account for accountless recipients. (Also known as Just-in-Time provisioning.)"
},
"disableUserSharingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"documentRetentionPurgeTabs": {
"type": "string",
"description": "When **true** and `documentRetention` is set, document fields and metadata are also purged after the document retention period ends. The default value is **false.**\n\n**Note:** Only Admins can change this setting."
},
"documentVisibilityMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableBccDummyLinkMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableClickPlusCustomStyle": {
"type": "string",
"description": ""
},
"enableSendToManageMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSequentialSigningAPI": {
"type": "string",
"description": "When **true,** the account can define the routing\norder of recipients for envelopes sent by using the eSignature API.\n\n**Note:** Only SysAdmin users can change this setting."
},
"envelopeIntegrationAllowed": {
"type": "string",
"description": "Shows the envelope integration rule for the account, which indicates whether custom admins can enable Connect for their accounts. Enumeration values are: \n\n- `not_allowed`\n- `full` \n\n**Note:** Only SysAdmin users can change this setting. "
},
"envelopeIntegrationEnabled": {
"type": "string",
"description": "When **true,** enables Connect for an account. Note that Connect integration requires additional configuration that must be set up for it to take effect; this switch is only the on/off control for the account.\n\n**Note:** Only Admin users can change this setting, and only when `envelopeIntegrationAllowed` is set."
},
"envelopeSearchModeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"numberOfActiveCustomStamps": {
"type": "string",
"description": "The number of active custom stamps associated with the account. DocuSign calculates this number automatically. This property is only visible to the DocuSign account manager."
},
"pdfMaxIndividualUploadSize": {
"type": "string",
"description": ""
},
"require21CFRpt11Compliance": {
"type": "string",
"description": "When **true,**\nrecipients are required\nto use a 21 CFR part 11-compliant signing experience.\n\n**Note:** Only Admin users can change this setting.\n"
},
"signatureProvidersMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signerAttachConcatMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"skipAuthCompletedEnvelopes": {
"type": "string",
"description": "When **true,**\ndo not require authentication prompt for viewing completed envelopes\n"
},
"useEnvelopeSearchMixedMode": {
"type": "string",
"description": ""
},
"validationsAllowedMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"validationsCadenceMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"validationsEnabledMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowConnectSendFinishLater": {
"type": "string",
"description": "Reserved for DocuSign."
},
"allowDelayedRoutingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowENoteEOriginalMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowExternalLinkedAccounts": {
"type": "string",
"description": ""
},
"allowIDVLevel1TrialMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowMemberTimeZoneMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowNonUSPhoneAuthMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowOcrOfEnvelopeDocuments": {
"type": "string",
"description": ""
},
"allowOfflineSigningMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSignerReassignMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSignerReassignOverride": {
"type": "string",
"description": "When **true,** an account administrator can override the ability of an envelope recipient to reassign it to another person.\n\n**Note:** Only Admin users can change this setting."
},
"allowUsersToAccessDirectory": {
"type": "string",
"description": ""
},
"authenticationCheckMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"commentEmailShowMessageText": {
"type": "string",
"description": "When **true,** the text of comments is included in email notifications when a comment is posted.\n\n**Note:** If the envelope requires additional recipient authentication, comment text is not included."
},
"consumerDisclosureFrequency": {
"type": "string",
"description": "Speficies how often to display the consumer disclosure.\n\nValid values are:\n\n- `once`: Per account, the supplemental document is displayed once only per `userId`. \n- `always`: Per envelope, the supplemental document is displayed once only per `userId`. \n- `each_access`: Per envelope, the supplemental document is displayed once only per `recipientId`.\n"
},
"dataPopulationScopeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"disableAutoTemplateMatching": {
"type": "string",
"description": ""
},
"enableAdmHealthcareMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableClickPlusCustomFields": {
"type": "string",
"description": ""
},
"enableDSigIDCheckForAESPens": {
"type": "string",
"description": ""
},
"enableIDFxIntuitKBAMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSearchServiceAzureUri": {
"type": "string",
"description": ""
},
"enableSearchSiteSpecificApi": {
"type": "string",
"description": ""
},
"enableSocialIdLoginMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableStrikeThroughMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"maximumUsersPerSigningGroup": {
"type": "string",
"description": "The maximum number of users per signing group. The default value is `50`. This setting is only shown in responses that list account settings.\n\n**Note:** Only SysAdmin users can change this setting."
},
"pdfMaxChunkedUploadPartSize": {
"type": "string",
"description": ""
},
"senderCanSignInEachLocation": {
"type": "string",
"description": "When **true,** a signer can draw their signature in each\nlocation where a sign or initial tab exists. This functionality\nis typically used for mobile signing.\n\n**Note:** Only Admin users can change this setting.\n"
},
"sendingTagsFontNameMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"sendingTagsFontSizeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"singleSignOnEnabledMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"wurflMinAllowableScreenSize": {
"type": "string",
"description": "The smallest screen allowed."
},
"advancedSearchEnableTabField": {
"type": "string",
"description": ""
},
"allowAccountMemberNameChange": {
"type": "string",
"description": "Boolean that specifies whether member names can be changed in the account."
},
"allowAgreementOrchestrations": {
"type": "string",
"description": ""
},
"allowAutoNavSettingsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowConnectUnifiedPayloadUI": {
"type": "string",
"description": ""
},
"allowDocGenDocumentsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowEnvelopeCorrectMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowEnvelopeCustodyTransfer": {
"type": "string",
"description": "Specifies whether the account is able to\nmanage rules that [transfer ownership](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=xqx1583277378404.html)\nof envelopes within the same account.\n\n\n\n"
},
"allowSendToCertifiedDelivery": {
"type": "string",
"description": "When **true,**\nthe account admin can enable the\nSend to Certified Delivery\nfeature on the account.\n"
},
"allowServerTemplatesMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSignatureStampsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSigningInsightsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"disableMobileSendingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"emailTemplateVersionMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableAgreementActionsForCLM": {
"type": "string",
"description": ""
},
"enableDSigIDVerificationPens": {
"type": "string",
"description": ""
},
"enablePDFAConversionMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableReservedDomainMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSignWithNotaryMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSmartContractsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"envelopeStampingDefaultValue": {
"type": "string",
"description": "When **true,** envelopes sent by this account automatically have the envelope ID stamped in the document margins, unless the sender selects not to have the documents stamped."
},
"expressSendAllowTabsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"idCheckExpireMinutesMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"identityVerificationMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"maximumSigningGroupsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"mobileSessionTimeoutMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"pdfMaxChunkedUploadTotalSize": {
"type": "string",
"description": ""
},
"requireDeclineReasonMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"requireSignerCertificateType": {
"type": "string",
"description": "Sets the Digital Signature certificate requirements for sending envelopes.\nValid values are:\n\n- `none`: A Digital Signature certificate is not required.\n- `docusign_express`: Signers must use a DocuSign Express certificate.\n- `docusign_personal`: Signers must use a DocuSign personal certificate.\n- `safe`\n- `open_trust`: Signers must use an OpenTrust certificate.\n"
},
"sendingTagsFontColorMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"showConditionalRoutingOnSend": {
"type": "string",
"description": "When **true,** Conditional Routing options display to senders during the sending experience."
},
"showInitialConditionalFields": {
"type": "string",
"description": "Boolean that specifies whether conditional field options are initially displayed (before a user makes entries)."
},
"useAccountLevelEmailMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"useNewEnvelopeSearchMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"useSignatureProviderPlatform": {
"type": "string",
"description": "Boolean that specifies whether the account uses the digital signature provider platform to eSign."
},
"accountDateTimeFormatMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowAccessCodeFormatMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowAgreementActionsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowDelegatedSigningMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowEnvelopePublishReporting": {
"type": "string",
"description": "When **true,** envelope publishing reporting is enabled.\n\n**Note:** Only Admin users can change this setting.\n"
},
"allowExpressSignerCertificate": {
"type": "string",
"description": "When **true,** signers are required to use Express Digital Signatures.\n\n**Note:** Only Admin users can change this setting.\n"
},
"allowInPersonElectronicNotary": {
"type": "string",
"description": "Account-level flag that determines the ability to perform In-Person Electronic Notary (IPEN) actions.\n"
},
"allowParticipantRecipientType": {
"type": "string",
"description": ""
},
"allowRecipientConnectMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowScheduledSendingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSignDocumentFromHomePage": {
"type": "string",
"description": "When **true,** recipients can sign documents from the home page.\n\n**Note:** Only Admin users can change this setting."
},
"allowWhatsAppDeliveryMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"anchorPopulationScopeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"canUseSalesforceOAuthMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"captureVoiceRecordingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"cfr21SimplifiedSigningEnabled": {
"type": "string",
"description": ""
},
"commentsAllowEnvelopeOverride": {
"type": "string",
"description": "When **true** and comments are enabled for the account, senders can disable comments for an envelope through the **Advanced Options** menu that appears during the sending process."
},
"disableSignerCertViewMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"disableStyleSignatureMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableAdvancedEnvelopesSearch": {
"type": "string",
"description": ""
},
"enableClickPlusDynamicContent": {
"type": "string",
"description": ""
},
"enableDSigExpressPensMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableIDFxPhoneAuthentication": {
"type": "string",
"description": ""
},
"enableInBrowserEditorMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enablePowerFormDirectMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSendingTagsFontSettings": {
"type": "string",
"description": "When **true,** enables fonts to be set on tags for the account."
},
"enforceTemplateNameUniqueness": {
"type": "string",
"description": "When **true,** the template name must be unique."
},
"idfxKBAAuthenticationOverride": {
"type": "string",
"description": ""
},
"linkedExternalPrimaryAccounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/linkedExternalPrimaryAccount"
},
"description": ""
},
"mergeMixedModeResultsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"optInMobileSigningV02Metadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"requireExternalUserManagement": {
"type": "string",
"description": "When **true,** the account requires external management of users.\n\n**Note:** Only Admin users can change this setting.\n"
},
"senderMustAuthenticateSigning": {
"type": "string",
"description": "When **true,** a sender who is also a recipient of an envelope\nmust follow the authentication requirements for the envelope.\n\n**Note:** Only Admin users can change this setting.\n"
},
"sharedTemplateFoldersMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signerCanSignOnMobileMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signerMustHaveAccountMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signerMustLoginToSignMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signingSessionTimeoutMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"supplementalDocumentsMustRead": {
"type": "string",
"description": "When **true,** account users must both view and accept supplemental documents when signing."
},
"supplementalDocumentsMustView": {
"type": "string",
"description": "When **true,** account users must view supplemental documents when signing."
},
"useConsumerDisclosureMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"useMultiAppGroupsDataMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"accountDefaultLanguageMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowAccountManagementGranular": {
"type": "string",
"description": "When **true,** the account can be managed on a per-user basis.\n\n**Note:** Only Admin users can change this setting."
},
"allowEnvelopeReportingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowMultipleSignerAttachments": {
"type": "string",
"description": "When **true,** recipients can\nupload multiple signer attachments with a single attachment.\n\n**Note:** Only Admin users can change this setting."
},
"allowOrganizationSsoManagement": {
"type": "string",
"description": ""
},
"allowPaymentProcessingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowPhoneAuthOverrideMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSecurityApplianceMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSigningExtensionsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"chromeSignatureEnabledMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"disableMobilePushNotifications": {
"type": "string",
"description": "When **true,** push notifications are disabled for the account.\n\n**Note:** Only Admin users can change this setting."
},
"disableUploadSignatureMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"documentConversionRestrictions": {
"type": "string",
"description": "Sets the account document upload restriction for non-account administrators. Valid values are:\n\n- `no_restrictions`: There are no restrictions on the type of documents that can be uploaded.\n- `allow_pdf_only`: Non-administrators can only upload PDF files.\n- `no_upload`: Non-administrators cannot upload files.\n\n**Note:** Only Admin users can change this setting.\n"
},
"draftEnvelopeRetentionMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableAdvancedPaymentsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableAgreementActionsForESign": {
"type": "string",
"description": ""
},
"enableCalculatedFieldsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableEsignCommunitiesMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableLargeFileSupportMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableScheduledReleaseMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSigningExtensionComments": {
"type": "string",
"description": "When **true,** enables comments for the account so that signers and recipients can make and respond to comments in documents belonging to the envelopes that they are sent."
},
"enableTransactionPointMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"guidedFormsHtmlAllowedMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"ignoreErrorIfAnchorTabNotFound": {
"type": "string",
"description": "Reserved for DocuSign."
},
"inPersonSigningEnabledMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"isConnectDocumentFieldsEnabled": {
"type": "string",
"description": ""
},
"sendToCertifiedDeliveryEnabled": {
"type": "string",
"description": "When true,\nthe account can use the\ncertified deliveries recipient type.\n"
},
"signerCanCreateAccountMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"startInAdvancedCorrectMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"suppressCertificateEnforcement": {
"type": "string",
"description": "Boolean that specifies whether or not API calls require a x509 cert in the header of the call."
},
"writeReminderToEnvelopeHistory": {
"type": "string",
"description": "When **true,**\nsent reminders are included in the envelope history."
},
"allowAgentNameEmailEditMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowConnectHttpListenerConfigs": {
"type": "string",
"description": "Boolean that specifies whether a Connect configuration can use HTTP listeners."
},
"allowConsumerDisclosureOverride": {
"type": "string",
"description": "When **true,**\nthe account has the ability to change the\n[Consumer Disclosure](https://support.docusign.com/s/document-item?bundleId=pik1583277475390&topicId=aqg1583277336549.html)\nsetting.\n"
},
"allowDocumentVisibilityMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowDocumentsOnSignedEnvelopes": {
"type": "string",
"description": "Boolean that specifies whether notifications can include the envelope's signed document."
},
"allowOpenTrustSignerCertificate": {
"type": "string",
"description": "When **true,** senders can use OpenTrust signer certificates.\n\n**Note:** Only Admin users can change this setting."
},
"allowSendToIntermediaryMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowThirdPartyElectronicNotary": {
"type": "string",
"description": "Account level flag that determines the availability to perform Third Party Notary (3PN) actions."
},
"attachCompletedEnvelopeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"betaSwitchConfigurationMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"checkForMultipleAdminsOnAccount": {
"type": "string",
"description": ""
},
"disableMultipleSessionsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableAccountWideSearchMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableCombinedPDFDownloadForSBS": {
"type": "string",
"description": ""
},
"enableEnvelopeStampingByDSAdmin": {
"type": "string",
"description": "When **true,** enables the DocuSign administrator to control envelope stamping for an account (placement of the `envelopeId`)."
},
"enablePaymentProcessingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableRecipientDomainValidation": {
"type": "string",
"description": "Reserved for DocuSign."
},
"enableResponsiveSigningMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSMSAuthenticationMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSignerAttachmentsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"guidedFormsHtmlConversionPolicy": {
"type": "string",
"description": ""
},
"hideAccountAddressInCoCMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"idfxPhoneAuthenticationOverride": {
"type": "string",
"description": ""
},
"inPersonIDCheckQuestionMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"inSessionSuppressEmailsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"showLocalizedWatermarksMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signerLoginRequirementsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"supplementalDocumentsMustAccept": {
"type": "string",
"description": "When **true,** account users must accept supplemental documents when signing."
},
"allowDocumentDisclosuresMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowExtendedSendingResourceFile": {
"type": "string",
"description": "Boolean that specifies whether resource files can be used for extended sending."
},
"allowIDVForEUQualifiedSignatures": {
"type": "string",
"description": ""
},
"allowOrganizationDocusignMonitor": {
"type": "string",
"description": ""
},
"allowPhoneAuthenticationMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"conditionalFieldsEnabledMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"disableSignerHistoryViewMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableAdvancedPowerFormsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableContactSuggestionsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableDSigEUAdvancedPensMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableInboxRelevanceSortMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableRequireSignOnPaperMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSendToIntermediaryMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"externalSignaturePadTypeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"hasRecipientConnectClaimedDomain": {
"type": "string",
"description": ""
},
"pkiSignDownloadedPDFDocsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"recipientsCanSignOfflineMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"selfSignedRecipientEmailDocument": {
"type": "string",
"description": "Sets how self-signed documents are presented to the email recipients.\nValid values are:\n\n- `include_pdf`: A PDF of the completed document is attached to the email.\n- `include_link`: A secure link to the self-signed documents is included\n in the email.\n\n**Note:** Only Admin users can change this setting.\n"
},
"sendLockoutRecipientNotification": {
"type": "string",
"description": ""
},
"simplifiedSendingEnabledMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowEnvelopeCustomFieldsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowExternalSignaturePadMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowPerformanceAnalyticsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowPrivateSigningGroupsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowResourceFileBrandingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSetEmbeddedRecipientStartURL": {
"type": "string",
"description": ""
},
"allowSigningRadioDeselectMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableAccessCodeGeneratorMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableClickPlusConditionalContent": {
"type": "string",
"description": ""
},
"enableDSigIDCheckRemoteForQESPens": {
"type": "string",
"description": ""
},
"enableSequentialSigningUIMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSignOnPaperOverrideMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"specifyDocumentVisibilityMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"useSAFESignerCertificatesMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"AllowConnectIdentityVerificationUI": {
"type": "string",
"description": ""
},
"allowMultipleBrandProfilesMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowOrganizationToUseRemoteNotary": {
"type": "string",
"description": ""
},
"allowSupplementalDocumentsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowTransactionsWorkspaceMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowTransactionsWorkspaceOriginal": {
"type": "string",
"description": ""
},
"anchorTagVersionedPlacementEnabled": {
"type": "string",
"description": "Reserved for DocuSign.\n"
},
"autoProvisionSignerAccountMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableClickPlusCustomStyleMetaData": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSequentialSigningAPIMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"envelopeIntegrationAllowedMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"envelopeIntegrationEnabledMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"pdfMaxIndividualUploadSizeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"require21CFRpt11ComplianceMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signerShowSecureFieldInitialValues": {
"type": "string",
"description": "When **true,** the initial values of all SecureFields are written\nto the document when it is sent.\n\n**Note:** Only Admin users can change this setting.\n"
},
"skipAuthCompletedEnvelopesMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"useConsumerDisclosureWithinAccount": {
"type": "string",
"description": "When **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement."
},
"useEnvelopeSearchMixedModeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"advancedSearchEnableTemplateIdField": {
"type": "string",
"description": ""
},
"allowConnectSendFinishLaterMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowExternalLinkedAccountsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowOcrOfEnvelopeDocumentsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSafeBioPharmaSignerCertificate": {
"type": "string",
"description": "When **true,**\naccount administrators can\nspecify that signers are\nrequired to use SAFE-BioPharma digital signatures.\n\n**Note:** Only Admin users can change this setting.\n"
},
"allowSignerReassignOverrideMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowUsersToAccessDirectoryMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"commentEmailShowMessageTextMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"consumerDisclosureFrequencyMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"disableAutoTemplateMatchingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableClickPlusCustomFieldsMetaData": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableDSigIDCheckForAESPensMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableDSigIDCheckInPersonForQESPens": {
"type": "string",
"description": ""
},
"enableDSigIDVerificationPremierPens": {
"type": "string",
"description": ""
},
"enableESignAPIHourlyLimitManagement": {
"type": "string",
"description": ""
},
"enableSearchServiceAzureUriMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSearchSiteSpecificApiMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSigningExtensionConversations": {
"type": "string",
"description": "When **true,** enables conversation functionality."
},
"maximumUsersPerSigningGroupMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"optOutAutoNavTextAndTabColorUpdates": {
"type": "string",
"description": "Boolean that allows envelope senders to opt out of the recipient signing auto-navigation feature and opt out of updating tab font color."
},
"pdfMaxChunkedUploadPartSizeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"senderCanSignInEachLocationMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"showCompleteDialogInEmbeddedSession": {
"type": "string",
"description": "Boolean that specifies whether complete dialogs are displayed directly within an application in embedded signing sessions."
},
"signDateTimeAccountLanguageOverride": {
"type": "string",
"description": ""
},
"signDateTimeAccountTimezoneOverride": {
"type": "string",
"description": ""
},
"useDocuSignExpressSignerCertificate": {
"type": "string",
"description": "When **true,**\nsigners\nare required to use Express Digital Signatures.\n"
},
"wurflMinAllowableScreenSizeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"advancedSearchEnableTabFieldMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowAccountMemberNameChangeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowAgreementOrchestrationsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowEnvelopeCustodyTransferMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowOrganizationDocusignMonitorFree": {
"type": "string",
"description": ""
},
"allowSendToCertifiedDeliveryMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"bulkSendMaxUnprocessedEnvelopesCount": {
"type": "string",
"description": ""
},
"defaultToAdvancedEnvelopesFilterForm": {
"type": "string",
"description": ""
},
"enableAgreementActionsForCLMMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableDSigIDVerificationPensMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableEnvelopeStampingByAccountAdmin": {
"type": "string",
"description": "When **true,** enables the account administrator\nto control envelope stamping for an account\n(stamping the `envelopeId` in the document margins).\n\n**Note:** This setting can be changed only\nby Admin users, and only if the account-level\nsetting `enableEnvelopeStampingByDSAdmin` is set to **true.**"
},
"enableRecipientMayProvidePhoneNumber": {
"type": "string",
"description": ""
},
"enableSigningOrderSettingsForAccount": {
"type": "string",
"description": "When **true,** switches Signing Order to On by default for new envelopes."
},
"envelopeStampingDefaultValueMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"pdfMaxChunkedUploadTotalSizeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"requireSignerCertificateTypeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"showConditionalRoutingOnSendMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"showInitialConditionalFieldsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signerAttachCertificateToEnvelopePDF": {
"type": "string",
"description": "When **true,**\nthe Certificate of Completion is included in the PDF of the envelope documents\nwhen it is downloaded.\n\n**Note:** Only Admin users can change this setting.\n"
},
"useSignatureProviderPlatformMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"advancedSearchEnableTemplateNameField": {
"type": "string",
"description": ""
},
"allowEditingEnvelopesOnBehalfOfOthers": {
"type": "string",
"description": ""
},
"allowEnvelopePublishReportingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowExpressSignerCertificateMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowInPersonElectronicNotaryMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowOrganizationDomainUserManagement": {
"type": "string",
"description": ""
},
"allowParticipantRecipientTypeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSendingEnvelopesOnBehalfOfOthers": {
"type": "string",
"description": ""
},
"allowSignDocumentFromHomePageMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"cfr21SimplifiedSigningEnabledMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"commentsAllowEnvelopeOverrideMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableAdvancedEnvelopesSearchMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableClickPlusDynamicContentMetaData": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableEnforceTlsEmailsSettingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableIDFxAccountlessSMSAuthForPart11": {
"type": "string",
"description": ""
},
"enableIDFxPhoneAuthenticationMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSendingTagsFontSettingsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableWebFormsSeparateUserPermissions": {
"type": "string",
"description": ""
},
"enforceTemplateNameUniquenessMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"idfxKBAAuthenticationOverrideMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"optOutNewPlatformSealPlatformMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"recipientSigningAutoNavigationControl": {
"type": "string",
"description": "When **true,** recipients receiving envelopes from this account can override auto-navigation functionality.\n\n**Note:** Only Admin users can change this setting.\n"
},
"requireExternalUserManagementMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"senderMustAuthenticateSigningMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"supplementalDocumentsMustReadMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"supplementalDocumentsMustViewMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowAccountManagementGranularMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowManagingEnvelopesOnBehalfOfOthers": {
"type": "string",
"description": ""
},
"allowMultipleSignerAttachmentsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowOrganizationSsoManagementMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"disableMobilePushNotificationsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"documentConversionRestrictionsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"dss_SIGN_29182_SlideUpBar_RadminOption": {
"type": "string",
"description": ""
},
"enableAgreementActionsForESignMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableCommentsHistoryDownloadInSigning": {
"type": "string",
"description": ""
},
"enableIdfxPhoneAuthSignatureAuthStatus": {
"type": "string",
"description": ""
},
"enableSigningExtensionCommentsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"sendToCertifiedDeliveryEnabledMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"suppressCertificateEnforcementMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"useNewEnvelopeSearchOnlyWithSearchTerm": {
"type": "string",
"description": ""
},
"writeReminderToEnvelopeHistoryMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowConsumerDisclosureOverrideMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowDocumentsOnSignedEnvelopesMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowOpenTrustSignerCertificateMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowThirdPartyElectronicNotaryMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"checkForMultipleAdminsOnAccountMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableEnvelopeStampingByDSAdminMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableKeyTermsSuggestionsByDocumentType": {
"type": "string",
"description": ""
},
"enableRecipientDomainValidationMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSMSDeliveryAdditionalNotification": {
"type": "string",
"description": ""
},
"guidedFormsHtmlConversionPolicyMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"idfxPhoneAuthenticationOverrideMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"phoneAuthRecipientMayProvidePhoneNumber": {
"type": "string",
"description": "When **true,** senders can allow recipients to provide a phone number for the Phone Authentication process.\n\n**Note:** Only Admin users can change this setting."
},
"signerInSessionUseEnvelopeCompleteEmail": {
"type": "string",
"description": "When **true,** an \"envelope complete\" email is sent to an in-session\n(embedded) or offline signer after DocuSign processes the envelope\nif in-session emails are not suppressed.\n\n**Note:** Only Admin users can change this setting.\n"
},
"supplementalDocumentsMustAcceptMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowAdvancedRecipientRoutingConditional": {
"type": "string",
"description": "When **true,** [Conditional Routing](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=aqm1578456487908.html) is enabled for the account as part of DocuSign's Advanced Recipient Routing feature."
},
"allowExtendedSendingResourceFileMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowIDVForEUQualifiedSignaturesMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowOrganizationDocusignMonitorMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableCustomerSatisfactionMetricTracking": {
"type": "string",
"description": "When **true,** enables customer satisfaction metric tracking for the account."
},
"selfSignedRecipientEmailDocumentMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"sendLockoutRecipientNotificationMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSetEmbeddedRecipientStartURLMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableClickPlusConditionalContentMetaData": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableDSigIDCheckRemoteForQESPensMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableInboxRelevanceSortForRecentAccounts": {
"type": "string",
"description": ""
},
"enableParticipantRecipientSettingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"EnvelopeLimitsTotalDocumentSizeAllowedInMB": {
"type": "string",
"description": ""
},
"allowOrganizationToUseRemoteNotaryMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowTransactionsWorkspaceOriginalMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"anchorTagVersionedPlacementMetadataEnabled": {
"$ref": "#/components/schemas/settingsMetadata"
},
"disablePurgeNotificationsForSenderMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signerShowSecureFieldInitialValuesMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"useConsumerDisclosureWithinAccountMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"advancedSearchEnableTemplateIdFieldMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSafeBioPharmaSignerCertificateMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableDSigIDCheckInPersonForQESPensMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableDSigIDVerificationPremierPensMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableESignAPIHourlyLimitManagementMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSigningExtensionConversationsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"optOutAutoNavTextAndTabColorUpdatesMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"showCompleteDialogInEmbeddedSessionMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signDateTimeAccountLanguageOverrideMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"signDateTimeAccountTimezoneOverrideMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"useDocuSignExpressSignerCertificateMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowOrganizationDocusignMonitorFreeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"defaultToAdvancedEnvelopesFilterFormMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableEnvelopeStampingByAccountAdminMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableInboxBrowseViewsPoweredByElasticSearch": {
"type": "string",
"description": ""
},
"enableRecipientMayProvidePhoneNumberMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSigningOrderSettingsForAccountMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"selfSignedRecipientEmailDocumentUserOverride": {
"type": "string",
"description": "When **true,** the `selfSignedRecipientEmailDocument` user setting\ncan be set for an individual user.\nThe user setting overrides the account setting.\n\n**Note:** Only Admin users can change this account setting.\n"
},
"signerAttachCertificateToEnvelopePDFMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"advancedSearchEnableTemplateNameFieldMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowEditingEnvelopesOnBehalfOfOthersMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowOrganizationDomainUserManagementMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowSendingEnvelopesOnBehalfOfOthersMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableIDFxAccountlessSMSAuthForPart11Metadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableWebFormsSeparateUserPermissionsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"ignoreErrorIfAnchorTabNotFoundMetadataEnabled": {
"$ref": "#/components/schemas/settingsMetadata"
},
"recipientSigningAutoNavigationControlMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowManagingEnvelopesOnBehalfOfOthersMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowOrganizationToUseInPersonElectronicNotary": {
"type": "string",
"description": "Organization-level flag that determines the ability to perform In-Person Electronic Notary (IPEN) actions.\n"
},
"enableCommentsHistoryDownloadInSigningMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableIdfxPhoneAuthSignatureAuthStatusMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"useNewEnvelopeSearchOnlyWhenSearchingAfterDate": {
"type": "string",
"description": ""
},
"useNewEnvelopeSearchOnlyWithSearchTermMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableKeyTermsSuggestionsByDocumentTypeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableSMSDeliveryAdditionalNotificationMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"phoneAuthRecipientMayProvidePhoneNumberMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"showMaskedFieldsWhenDownloadingDocumentAsSender": {
"type": "string",
"description": ""
},
"signerInSessionUseEnvelopeCompleteEmailMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowAdvancedRecipientRoutingConditionalMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowOrganizationToUseThirdPartyElectronicNotary": {
"type": "string",
"description": "Org level flag that determines the availability to perform Third Party Notary (3PN) actions."
},
"enableCustomerSatisfactionMetricTrackingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabled": {
"type": "string",
"description": ""
},
"dss_SIGN_28411_EnableLeavePagePrompt_RadminOption": {
"type": "string",
"description": ""
},
"enableInboxRelevanceSortForRecentAccountsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"EnvelopeLimitsTotalDocumentSizeAllowedInMBMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"dss_EnableProvisioningPenConfiguration_RadminOption": {
"type": "string",
"description": ""
},
"dss_EnableSignatureTypeCustomTagRadmin_RadminOption": {
"type": "string",
"description": ""
},
"enableInboxBrowseViewsPoweredByElasticSearchMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"selfSignedRecipientEmailDocumentUserOverrideMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowOrganizationToUseInPersonElectronicNotaryMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"useNewEnvelopeSearchOnlyWhenSearchingAfterDateMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"showMaskedFieldsWhenDownloadingDocumentAsSenderMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowOrganizationToUseThirdPartyElectronicNotaryMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"EnvelopeLimitsTotalDocumentSizeAllowedInMBEnabledMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
}
},
"description": "Contains account settings information. Used in requests to set property values. Used in responses to report property values.",
"x-ms-summary": "Contains account settings information. Used in requests to set property values. Used in responses to report property values.",
"x-ds-definition-name": "accountSettingsInformation"
}
accountSharedAccess
{
"type": "object",
"properties": {
"nextUri": {
"type": "string",
"description": "The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. "
},
"accountId": {
"type": "string",
"description": "The account ID associated with the envelope."
},
"endPosition": {
"type": "string",
"description": "The last index position in the result set. "
},
"previousUri": {
"type": "string",
"description": "The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. "
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"sharedAccess": {
"type": "array",
"items": {
"$ref": "#/components/schemas/memberSharedItems"
},
"description": "A list of shared access information of envelope and templates for the users specified in the request."
},
"totalSetSize": {
"type": "string",
"description": "The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`."
},
"resultSetSize": {
"type": "string",
"description": "The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`."
},
"startPosition": {
"type": "string",
"description": "The starting index position of the current result set."
}
},
"description": "Contains shared access information.",
"x-ms-summary": "Contains shared access information.",
"x-ds-definition-name": "accountSharedAccess"
}
accountSignature
{
"type": "object",
"properties": {
"nrdsId": {
"type": "string",
"description": "The National Association of Realtors (NAR) membership ID for a user who is a realtor."
},
"status": {
"type": "string",
"description": "Indicates the envelope status. Valid values are:\n\n* sent - The envelope is sent to the recipients. \n* created - The envelope is saved as a draft and can be modified and sent later."
},
"imageType": {
"type": "string",
"description": "Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`"
},
"isDefault": {
"type": "string",
"description": "Boolean that specifies whether the signature is the default signature for the user."
},
"stampType": {
"type": "string",
"description": "The type of stamp. Valid values are:\n\n- `signature`: A signature image. This is the default value.\n- `stamp`: A stamp image.\n- null"
},
"externalID": {
"type": "string",
"description": "Optionally specify an external identifier for the user's signature."
},
"nrdsStatus": {
"type": "string",
"description": "The realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are:\n\n- `Active`\n- `Inactive`\n- `Terminate`\n- `Provisional`\n- `Deceased`\n- `Suspend`\n- `Unknown`"
},
"customField": {
"type": "string",
"description": ""
},
"imageBase64": {
"type": "string",
"description": ""
},
"signatureId": {
"type": "string",
"description": "Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID."
},
"stampFormat": {
"type": "string",
"description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. "
},
"stampSizeMM": {
"type": "string",
"description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"nrdsLastName": {
"type": "string",
"description": "The realtor's last name."
},
"phoneticName": {
"type": "string",
"description": "The phonetic spelling of the `signatureName`."
},
"signatureFont": {
"type": "string",
"description": "The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`\n"
},
"signatureName": {
"type": "string",
"description": "Specifies the user's signature name."
},
"signatureType": {
"type": "string",
"description": "Specifies the type of signature."
},
"stampImageUri": {
"type": "string",
"description": "The URI for retrieving the image of the user's stamp."
},
"signatureUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signatureUser"
},
"description": ""
},
"adoptedDateTime": {
"type": "string",
"description": "The UTC date and time when the user adopted the signature."
},
"createdDateTime": {
"type": "string",
"description": "The UTC DateTime when the item was created."
},
"signatureGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signatureGroup"
},
"description": ""
},
"signatureRights": {
"type": "string",
"description": "The rights that the user has to the signature. Valid values are:\n\n- `none`\n- `read`\n- `admin`"
},
"initialsImageUri": {
"type": "string",
"description": "The URI for retrieving the image of the user's initials."
},
"signatureImageUri": {
"type": "string",
"description": "An endpoint URI that you can use to retrieve the user's signature image."
},
"signatureInitials": {
"type": "string",
"description": "Specifies the user's signature in initials format."
},
"initials150ImageId": {
"type": "string",
"description": "The ID of the user's initials image."
},
"dateStampProperties": {
"$ref": "#/components/schemas/dateStampProperties"
},
"signature150ImageId": {
"type": "string",
"description": "The ID of the user's signature image."
},
"lastModifiedDateTime": {
"type": "string",
"description": "The date and time that the item was last modified."
},
"disallowUserResizeStamp": {
"type": "string",
"description": "When **true,** users may not resize the stamp."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountSignature"
}
accountSignatureDefinition
{
"type": "object",
"properties": {
"nrdsId": {
"type": "string",
"description": "The National Association of Realtors (NAR) membership ID for a user who is a realtor."
},
"imageType": {
"type": "string",
"description": "Specificies the type of image. Valid values:\n\n- `stamp_image`\n- `signature_image`\n- `initials_image`"
},
"isDefault": {
"type": "string",
"description": "Boolean that specifies whether the signature is the default signature for the user."
},
"externalID": {
"type": "string",
"description": "Optionally specify an external identifier for the user's signature."
},
"signatureId": {
"type": "string",
"description": "Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as \"&\", \"<\", \">\") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID."
},
"stampFormat": {
"type": "string",
"description": "The format of a stamp. Valid values are:\n\n- `NameHanko`: The stamp represents only the signer's name.\n- `NameDateHanko`: The stamp represents the signer's name and the date. "
},
"stampSizeMM": {
"type": "string",
"description": "The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents."
},
"nrdsLastName": {
"type": "string",
"description": "The realtor's last name."
},
"phoneticName": {
"type": "string",
"description": "The phonetic spelling of the `signatureName`."
},
"signatureFont": {
"type": "string",
"description": "The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`.\n\n- `\"1_DocuSign\"`\n- `\"2_DocuSign\"`\n- `\"3_DocuSign\"`\n- `\"4_DocuSign\"`\n- `\"5_DocuSign\"`\n- `\"6_DocuSign\"`\n- `\"7_DocuSign\"`\n- `\"8_DocuSign\"`\n- `\"Mistral\"`\n- `\"Rage Italic\"`\n"
},
"signatureName": {
"type": "string",
"description": "Specifies the user's signature name."
},
"signatureType": {
"type": "string",
"description": "Specifies the type of signature."
},
"signatureUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signatureUserDef"
},
"description": ""
},
"signatureGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signatureGroupDef"
},
"description": ""
},
"signatureInitials": {
"type": "string",
"description": "Specifies the user's signature in initials format."
},
"dateStampProperties": {
"$ref": "#/components/schemas/dateStampProperties"
},
"disallowUserResizeStamp": {
"type": "string",
"description": "When **true,** users may not resize the stamp."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountSignatureDefinition"
}
accountSignatureProvider
{
"type": "object",
"properties": {
"priority": {
"type": "string",
"description": "Reserved for DocuSign."
},
"isRequired": {
"type": "string",
"description": "Reserved for DocuSign."
},
"signatureProviderId": {
"type": "string",
"description": "Reserved for DocuSign."
},
"signatureProviderName": {
"type": "string",
"description": "The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](https://raw.githubusercontent.com). You can also retrieve the list by using the [AccountSignatureProviders: List](https://raw.githubusercontent.com) method.\n\nExample: `universalsignaturepen_default`\n\n"
},
"signatureProviderDisplayName": {
"type": "string",
"description": "Reserved for DocuSign."
},
"signatureProviderOptionsMetadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/accountSignatureProviderOption"
},
"description": "Reserved for DocuSign."
},
"signatureProviderRequiredOptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/signatureProviderRequiredOption"
},
"description": "Reserved for DocuSign."
}
},
"description": "Contains information about the signature provider associated with the Identity Verification workflow.\nIf empty, then this specific workflow is not intended for signers.\n",
"x-ms-summary": "Contains information about the signature provider associated with the Identity Verification workflow.\nIf empty, then this specific workflow is not intended for signers.\n",
"x-ds-definition-name": "accountSignatureProvider"
}
accountSignatureProviderOption
{
"type": "object",
"properties": {
"signatureProviderOptionId": {
"type": "string",
"description": "Reserved for DocuSign."
},
"signatureProviderOptionName": {
"type": "string",
"description": "Reserved for DocuSign."
},
"signatureProviderOptionDisplayName": {
"type": "string",
"description": "Reserved for DocuSign."
}
},
"description": "Reserved for DocuSign.",
"x-ms-summary": "Reserved for DocuSign.",
"x-ds-definition-name": "accountSignatureProviderOption"
}
accountSignatureProviders
{
"type": "object",
"properties": {
"signatureProviders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/accountSignatureProvider"
},
"description": "Names of electronic or digital signature providers that can be used."
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountSignatureProviders"
}
accountSignaturesInformation
{
"type": "object",
"properties": {
"accountSignatures": {
"type": "array",
"items": {
"$ref": "#/components/schemas/accountSignature"
},
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "accountSignaturesInformation"
}
accountUISettings
{
"type": "object",
"properties": {
"askAnAdmin": {
"$ref": "#/components/schemas/askAnAdmin"
},
"adminMessage": {
"$ref": "#/components/schemas/adminMessage"
},
"hideUseATemplate": {
"type": "string",
"description": "When **true,** the **Templates** menu is hidden from account users who are not Admins. The default value is **false.**"
},
"enableAdminMessage": {
"type": "string",
"description": ""
},
"hideSendAnEnvelope": {
"type": "string",
"description": ""
},
"clickwrapSchemaVersion": {
"type": "string",
"description": ""
},
"shouldRedactAccessCode": {
"type": "string",
"description": ""
},
"enableLegacySendflowLink": {
"type": "string",
"description": ""
},
"hideUseATemplateMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"removeEnvelopeForwarding": {
"type": "string",
"description": ""
},
"hasExternalLinkedAccounts": {
"type": "string",
"description": ""
},
"hideUseATemplateInPrepare": {
"type": "string",
"description": ""
},
"enableAdminMessageMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableEnvelopeCopyWithData": {
"type": "string",
"description": ""
},
"hideSendAnEnvelopeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowUsersToEditSharedAccess": {
"type": "string",
"description": ""
},
"enableEasySignTemplateUpload": {
"type": "string",
"description": ""
},
"uploadNewImageToSignOrInitial": {
"type": "string",
"description": ""
},
"clickwrapSchemaVersionMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"shouldRedactAccessCodeMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"orderBasedRecipientIdGeneration": {
"type": "string",
"description": ""
},
"enableLegacySendflowLinkMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"removeEnvelopeForwardingMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"hasExternalLinkedAccountsMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"hideUseATemplateInPrepareMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableEnvelopeCopyWithDataMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"allowUsersToEditSharedAccessMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableEasySignTemplateUploadMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"uploadNewImageToSignOrInitialMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableEasySignCanUseMultiTemplateApply": {
"type": "string",
"description": ""
},
"orderBasedRecipientIdGenerationMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
},
"enableEasySignCanUseMultiTemplateApplyMetadata": {
"$ref": "#/components/schemas/settingsMetadata"
}
},
"description": "An object that defines the options that are available to non-administrators in the UI.",
"x-ms-summary": "An object that defines the options that are available to non-administrators in the UI.",
"x-ds-definition-name": "accountUISettings"
}
addOn
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A unique ID for the Salesforce object."
},
"name": {
"type": "string",
"description": "Reserved for DocuSign."
},
"active": {
"type": "string",
"description": "Reserved for DocuSign."
},
"addOnId": {
"type": "string",
"description": "Reserved for DocuSign."
}
},
"description": "Contains information about add ons.",
"x-ms-summary": "Contains information about add ons.",
"x-ds-definition-name": "addOn"
}
addressInformation
{
"type": "object",
"properties": {
"fax": {
"type": "string",
"description": "A fax number associated with the address, if one is available."
},
"city": {
"type": "string",
"description": "The user's city. Maximum length: 40 characters."
},
"phone": {
"type": "string",
"description": "A phone number associated with the address."
},
"country": {
"type": "string",
"description": "The user's country. Maximum length: 50 characters."
},
"address1": {
"type": "string",
"description": "The first line of the user's address.\nMaximum length: 100 characters."
},
"address2": {
"type": "string",
"description": "The second line of the user's address.\nMaximum length: 100 characters."
},
"zipPlus4": {
"type": "string",
"description": ""
},
"postalCode": {
"type": "string",
"description": "The user's postal code. Maximum length: 20 characters."
},
"stateOrProvince": {
"type": "string",
"description": "The user's state or province. Maximum length: 40 characters."
}
},
"description": "Contains address information.",
"x-ms-summary": "Contains address information.",
"x-ds-definition-name": "addressInformation"
}
addressInformationInput
{
"type": "object",
"properties": {
"displayLevelCode": {
"type": "string",
"description": "Specifies the display level for the recipient. Valid values are:\n* `ReadOnly`\n* `Editable`\n* `DoNotDisplay`"
},
"receiveInResponse": {
"type": "string",
"description": "A Boolean value that specifies whether the information must be returned in the response."
},
"addressInformation": {
"$ref": "#/components/schemas/addressInformation"
}
},
"description": "Contains address input information.",
"x-ms-summary": "Contains address input information.",
"x-ds-definition-name": "addressInformationInput"
}
adminMessage
{
"type": "object",
"properties": {
"baseMessage": {
"type": "string",
"description": ""
},
"moreInformation": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "adminMessage"
}
agent
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The full legal name of the recipient. Maximum Length: 100 characters.\n\n**Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set."
},
"note": {
"type": "string",
"description": "A note sent to the recipient in the signing email.\nThis note is unique to this recipient.\nIn the user interface,\nit appears near the upper left corner\nof the document\non the signing screen.\n\nMaximum Length: 1000 characters.\n"
},
"email": {
"type": "string",
"description": "The email ID of the agent. Notification of the document to sign is sent to this email id. \n\nMaximum length: 100 characters. "
},
"status": {
"type": "string",
"description": "The recipient's status. This property is read-only. \n\nValid values:\n\n- `autoresponded`: The recipient's email system auto-responded to the email from DocuSign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account.\n- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.\n- `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`).\n- `declined`: The recipient declined to sign the documents in the envelope.\n- `delivered`: The recipient has viewed the documents in an envelope through the DocuSign signing website. This is not an email delivery of the documents in an envelope.\n- `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step.\n- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.\n- `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`."
},
"userId": {
"type": "string",
"description": "The ID of the user to access.\n\n**Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings."
},
"fullName": {
"type": "string",
"description": "Reserved for DocuSign."
},
"lastName": {
"type": "string",
"description": "The recipient's last name."
},
"roleName": {
"type": "string",
"description": "Optional element. Specifies the role name associated with the recipient.<br/><br/>This property is required when you are working with template recipients."
},
"faxNumber": {
"type": "string",
"description": "Reserved for DocuSign."
},
"firstName": {
"type": "string",
"description": "The recipient's first name. Maximum Length: 50 characters."
},
"accessCode": {
"type": "string",
"description": "If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. \n\nMaximum Length: 50 characters and it must conform to the account's access code format setting.\n\nIf blank, but the signer `accessCode` property is set in the envelope, then that value is used.\n\nIf blank and the signer `accessCode` property is not set, then the access code is not required."
},
"statusCode": {
"type": "string",
"description": "The code associated with the recipient's status. This property is read-only."
},
"phoneNumber": {
"$ref": "#/components/schemas/recipientPhoneNumber"
},
"recipientId": {
"type": "string",
"description": "A local reference used to map\nrecipients to other objects, such as specific\ndocument tabs.\n\nA `recipientId` must be\neither an integer or a GUID,\nand the `recipientId` must be\nunique within an envelope.\n\nFor example, many envelopes assign the first recipient\na `recipientId` of `1`."
},
"clientUserId": {
"type": "string",
"description": "Specifies whether the recipient is embedded or remote. \n\nIf the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing.\n\nIf the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending.\n\n**Note:** This property is not returned by the [listStatusChanges](https://raw.githubusercontent.com) endpoint.\n\nMaximum length: 100 characters. \n"
},
"customFields": {
"type": "array",
"items": {
"type": "string"
},
"description": "An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters."
},
"designatorId": {
"type": "string",
"description": "Reserved for DocuSign."
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"nameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"noteMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"routingOrder": {
"type": "string",
"description": "Specifies the routing order of the recipient in the envelope. "
},
"sentDateTime": {
"type": "string",
"description": "The UTC DateTime when the envelope was sent. This property is read-only."
},
"emailMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientType": {
"type": "string",
"description": "The recipient type, as specified by the following values:\n- `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order.\n- `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order.\n- `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents.\n- `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients.\n- `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer.\n- `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order.\n- `seal`: Electronic seal recipients represent legal entities.\n- `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope.\n- `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope."
},
"totalTabCount": {
"type": "string",
"description": "The total number of tabs in the documents. This property is read-only."
},
"completedCount": {
"type": "string",
"description": "Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only."
},
"declinedReason": {
"type": "string",
"description": "The reason the recipient declined the document. This property is read-only."
},
"deliveryMethod": {
"type": "string",
"description": "The delivery method. One of:\n\n- `email`\n- `fax`\n- `SMS`\n- `WhatsApp`\n- `offline`\n\nThe `SMS` and `WhatsApp` delivery methods\nare limited to `signer`, `carbonCopy`, and `certifiedDelivery`\nrecipients.\n\n**Related topics**\n\n- [Using SMS delivery with the eSignature API][smsconcept]\n- [How to request a signature by SMS delivery][howto]\n\n[smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/\n[howto]: /docs/esign-rest-api/how-to/request-signature-sms/"
},
"signedDateTime": {
"type": "string",
"description": "Reserved for DocuSign."
},
"signingGroupId": {
"type": "string",
"description": "The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).\n"
},
"suppressEmails": {
"type": "string",
"description": "When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"requireIdLookup": {
"type": "string",
"description": "When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. "
},
"declinedDateTime": {
"type": "string",
"description": "The date and time the recipient declined the document. This property is read-only."
},
"designatorIdGuid": {
"type": "string",
"description": "Reserved for DocuSign."
},
"fullNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lastNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupName": {
"type": "string",
"description": "Optional. The name of the signing group. \n\nMaximum Length: 100 characters. "
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"deliveredDateTime": {
"type": "string",
"description": "The date and time that the envelope was delivered to the recipient. This property is read-only."
},
"emailNotification": {
"$ref": "#/components/schemas/recipientEmailNotification"
},
"excludedDocuments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this.\n\nWhen enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent."
},
"faxNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"firstNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/userInfo"
},
"description": "A complex type that contains information about users in the signing group."
},
"smsAuthentication": {
"$ref": "#/components/schemas/recipientSMSAuthentication"
},
"accessCodeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"consentDetailsList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/consentDetails"
},
"description": ""
},
"documentVisibility": {
"type": "array",
"items": {
"$ref": "#/components/schemas/documentVisibility"
},
"description": "A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true.**"
},
"autoRespondedReason": {
"type": "string",
"description": "Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only.\n"
},
"bulkSendV2Recipient": {
"type": "string",
"description": ""
},
"phoneAuthentication": {
"$ref": "#/components/schemas/recipientPhoneAuthentication"
},
"addAccessCodeToEmail": {
"type": "string",
"description": "Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient."
},
"identityVerification": {
"$ref": "#/components/schemas/recipientIdentityVerification"
},
"recipientAttachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientAttachment"
},
"description": "Reserved for DocuSign."
},
"routingOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"socialAuthentications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/socialAuthentication"
},
"description": "Deprecated."
},
"deliveryMethodMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"signingGroupIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"additionalNotifications": {
"type": "array",
"items": {
"$ref": "#/components/schemas/recipientAdditionalNotification"
},
"description": "An array of additional notification objects."
},
"idCheckInformationInput": {
"$ref": "#/components/schemas/idCheckInformationInput"
},
"requireIdLookupMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"idCheckConfigurationName": {
"type": "string",
"description": "The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are:\n\n- `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object.\n- `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object.\n- `ID Check $`: The recipient must answer detailed security questions. \n\n**Example:** Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node."
},
"recipientFeatureMetadata": {
"type": "array",
"items": {
"$ref": "#/components/schemas/featureAvailableMetadata"
},
"description": "Metadata about the features that are supported for the recipient type. This property is read-only."
},
"embeddedRecipientStartURL": {
"type": "string",
"description": "Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. \n\nWhen `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner.\n\nIt is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. DocuSign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient.\n\nIf the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. \n\n*Example*: \n\n`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` "
},
"lockedRecipientSmsEditable": {
"type": "string",
"description": "Reserved for DocuSign."
},
"emailRecipientPostSigningURL": {
"type": "string",
"description": ""
},
"recipientAuthenticationStatus": {
"$ref": "#/components/schemas/authenticationStatus"
},
"idCheckConfigurationNameMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"lockedRecipientPhoneAuthEditable": {
"type": "string",
"description": "Reserved for DocuSign."
},
"allowSystemOverrideForLockedRecipient": {
"type": "string",
"description": "When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock."
},
"inheritEmailNotificationConfiguration": {
"type": "string",
"description": "When **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. "
}
},
"description": "Contains information about an agent recipient. An agent is a recipient who can add name and email information for recipients that appear after the agent in routing order.",
"x-ms-summary": "Contains information about an agent recipient. An agent is a recipient who can add name and email information for recipients that appear after the agent in routing order.",
"x-ds-definition-name": "agent"
}
apiRequestLog
{
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "The status of the API request."
},
"description": {
"type": "string",
"description": "The API endpoint that was called."
},
"requestLogId": {
"type": "string",
"description": "The ID of the log entry."
},
"createdDateTime": {
"type": "string",
"description": "The UTC DateTime when the item was created."
}
},
"description": "Contains API request log information.",
"x-ms-summary": "Contains API request log information.",
"x-ds-definition-name": "apiRequestLog"
}
apiRequestLogsResult
{
"type": "object",
"properties": {
"apiRequestLogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/apiRequestLog"
},
"description": "Reserved for DocuSign."
}
},
"description": "Contains information about multiple API request logs.",
"x-ms-summary": "Contains information about multiple API request logs.",
"x-ds-definition-name": "apiRequestLogsResult"
}
appStoreProduct
{
"type": "object",
"properties": {
"productId": {
"type": "string",
"description": "The Product ID from the AppStore."
},
"marketPlace": {
"type": "string",
"description": ""
}
},
"description": "Contains information about an APP store product.",
"x-ms-summary": "Contains information about an APP store product.",
"x-ds-definition-name": "appStoreProduct"
}
appStoreReceipt
{
"type": "object",
"properties": {
"productId": {
"type": "string",
"description": "The Product ID from the AppStore."
},
"receiptData": {
"type": "string",
"description": "Reserved for DocuSign."
},
"downgradeProductId": {
"type": "string",
"description": ""
},
"isDowngradeCancellation": {
"type": "string",
"description": ""
}
},
"description": "Contains information about an APP store receipt.",
"x-ms-summary": "Contains information about an APP store receipt.",
"x-ds-definition-name": "appStoreReceipt"
}
approve
{
"type": "object",
"properties": {
"bold": {
"type": "string",
"description": "When **true,** the information in the tab is bold."
},
"font": {
"type": "string",
"description": "The font to be used for the tab value. Supported fonts include:\n\n- Default\n- Arial\n- ArialNarrow\n- Calibri\n- CourierNew\n- Garamond\n- Georgia\n- Helvetica\n- LucidaConsole\n- MSGothic\n- MSMincho\n- OCR-A\n- Tahoma\n- TimesNewRoman\n- Trebuchet\n- Verdana\n"
},
"tabId": {
"type": "string",
"description": "The unique identifier for the tab."
},
"width": {
"type": "string",
"description": "The width of the tab in pixels.\nMust be an integer."
},
"height": {
"type": "string",
"description": "The height of the tab in pixels.\nMust be an integer."
},
"italic": {
"type": "string",
"description": "When **true,** the information in the tab is italic."
},
"source": {
"type": "string",
"description": "Reserved for DocuSign."
},
"status": {
"type": "string",
"description": "The status of the tab. Possible values are:\n\n- `active`: The tab is active, but the recipient has not yet interacted with it.\n- `signed`: The recipient signed the tab.\n- `declined`: The recipient declined the envelope.\n- `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`)."
},
"caption": {
"type": "string",
"description": ""
},
"tabType": {
"type": "string",
"description": "Indicates the type of tab (for example, `signHere` or `initialHere`)."
},
"tooltip": {
"type": "string",
"description": "**Note:** Approve tabs never display this tooltip in the signing interface.\n\nAlthough you can technically set a value via the API for this tab,\nit will not be displayed to the recipient.\n"
},
"fontSize": {
"type": "string",
"description": "The font size used for the information in the tab. Possible values are:\n\n- Size7\n- Size8\n- Size9\n- Size10\n- Size11\n- Size12\n- Size14\n- Size16\n- Size18\n- Size20\n- Size22\n- Size24\n- Size26\n- Size28\n- Size36\n- Size48\n- Size72"
},
"tabLabel": {
"type": "string",
"description": "The label associated with the tab. This value may be an empty string.\nIf no value is provided, the tab type is used as the value.\n\nMaximum Length: 500 characters.\n"
},
"tabOrder": {
"type": "string",
"description": "A positive integer that sets the order the tab is navigated to during signing.\n\nTabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used."
},
"fontColor": {
"type": "string",
"description": "The font color to use for the information in the tab. Possible values are: \n\n- Black\n- BrightBlue\n- BrightRed\n- DarkGreen\n- DarkRed\n- Gold\n- Green\n- NavyBlue\n- Purple\n- White\n"
},
"formOrder": {
"type": "string",
"description": "An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block."
},
"underline": {
"type": "string",
"description": "When **true,** the information in the tab is underlined."
},
"xPosition": {
"type": "string",
"description": "This property indicates the horizontal offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"yPosition": {
"type": "string",
"description": "This property indicates the vertical offset of the object on the page.\nDocuSign uses 72 DPI when determining position.\nRequired. Must be an integer. May be zero.\n\nTo improve the tab's position on the document,\nDocuSign recommends\nadjusting `xPosition`\nand `yPosition`\ncoordinates\nby (-3, -2)\n"
},
"buttonText": {
"type": "string",
"description": " Specifies the approval text that displays in the tab. "
},
"documentId": {
"type": "string",
"description": "Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute."
},
"mergeField": {
"$ref": "#/components/schemas/mergeField"
},
"pageNumber": {
"type": "string",
"description": "Specifies the page number on which the tab is located. For supplemental documents, this value must be `1`.\n"
},
"anchorUnits": {
"type": "string",
"description": "Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:\n\n- `pixels` (default)\n- `inches`\n- `mms`\n- `cms`\n"
},
"customTabId": {
"type": "string",
"description": "The DocuSign-generated custom tab ID for the custom tab to be applied. You can only use this when adding new tabs for a recipient. When used, the new tab inherits all of the properties of the custom tab."
},
"recipientId": {
"type": "string",
"description": "The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object.\n"
},
"anchorString": {
"type": "string",
"description": "Specifies the string to find in the document and use as the basis for tab placement."
},
"boldMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"errorDetails": {
"$ref": "#/components/schemas/errorDetails"
},
"fontMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"localePolicy": {
"$ref": "#/components/schemas/localePolicyTab"
},
"anchorXOffset": {
"type": "string",
"description": "Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"anchorYOffset": {
"type": "string",
"description": "Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.\n"
},
"formPageLabel": {
"type": "string",
"description": "A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience."
},
"mergeFieldXml": {
"type": "string",
"description": "Reserved for DocuSign."
},
"tabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"widthMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageNumber": {
"type": "string",
"description": "An integer specifying the order in which to present the guided form pages."
},
"heightMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"italicMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"statusMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabels": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property.\n\nTo associate this tab with a tab group, add the tab group's `groupLabel` to this array."
},
"templateLocked": {
"type": "string",
"description": "When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. "
},
"captionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuid": {
"type": "string",
"description": "The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only."
},
"tabTypeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"toolTipMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"fontSizeMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateRequired": {
"type": "string",
"description": "When **true,** the sender may not remove the recipient. Used only when working with template recipients."
},
"fontColorMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formOrderMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"underlineMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"xPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"yPositionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"buttonTextMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"documentIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"pageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorCaseSensitive": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.**\n\nFor example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/"
},
"anchorUnitsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"customTabIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWord": {
"type": "string",
"description": "When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.**\n\nFor example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.\n\nThis functionality uses the following rules:\n\n- Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:\n\n $~><|^+=\n\n For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`\n\n- Strings embedded in other strings are ignored during the matching process.\n\n- In words that have dashes, the parts separated by dashes are treated as distinct words.\n\n Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.**\n\n- Letters with accent marks are treated as distinct characters from their unaccented counterparts.\n\n- For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.\n\n Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.\n\n- Unlike punctuation, numbers are not ignored when finding anchor words.\n\n Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).\n\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorStringMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorXOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorYOffsetMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"formPageLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabel": {
"type": "string",
"description": "For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility."
},
"conditionalParentValue": {
"type": "string",
"description": "For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active.\n"
},
"formPageNumberMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"tabGroupLabelsMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"templateLockedMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"recipientIdGuidMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresent": {
"type": "string",
"description": "When **true,** this tab is ignored if the `anchorString` is not found in the document."
},
"smartContractInformation": {
"$ref": "#/components/schemas/smartContractInformation"
},
"templateRequiredMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorHorizontalAlignment": {
"type": "string",
"description": "This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :\n\n- `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.\n- `right`: Aligns the tab’s left side with the last character of the matching anchor word.\n\n**Note:** You can only specify the value of this property in POST requests.\n\n[AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/\n"
},
"anchorTabProcessorVersion": {
"type": "string",
"description": "Reserved for DocuSign."
},
"anchorCaseSensitiveMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorMatchWholeWordMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentLabelMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"conditionalParentValueMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorIgnoreIfNotPresentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharacters": {
"type": "string",
"description": "When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases.\n\nFirst, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, <code>Docu Sign</code> will not match.\n\nSecond, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then <code>Docu Sign</code> will match.\n\nThe default value is **true.**\n"
},
"anchorHorizontalAlignmentMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorTabProcessorVersionMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
},
"anchorAllowWhiteSpaceInCharactersMetadata": {
"$ref": "#/components/schemas/propertyMetadata"
}
},
"description": "A tab that allows the recipient to approve documents\nwithout placing a signature or initials on the\ndocument.\n",
"x-ms-summary": "A tab that allows the recipient to approve documents\nwithout placing a signature or initials on the\ndocument.\n",
"x-ds-definition-name": "approve"
}
askAnAdmin
{
"type": "object",
"properties": {
"name": {
"type": "string",
"description": ""
},
"email": {
"type": "string",
"description": ""
},
"phone": {
"type": "string",
"description": ""
},
"message": {
"type": "string",
"description": ""
}
},
"description": "",
"x-ms-summary": "",
"x-ds-definition-name": "askAnAdmin"
}