> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL. > > Documentation indexes by section: > - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt > - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt > - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt > - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt > > Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth > Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks > > OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json > MCP server: https://docusign.docs.buildwithfern.com/_mcp/server # Change status of multiple envelope transfer rules PUT https://demo.docusign.net/restapi/v2.1/accounts/{accountId}/envelopes/transfer_rules Content-Type: application/json This method changes the status for one or more envelope transfer rules based on the `envelopeTransferRuleId`s in the request body. You use this method to change whether or not the rules are enabled. **Note:** You cannot change any other information about the envelope transfer rule. Only Administrators can update envelope transfer rules. In addition, to use envelope transfer rules, the **Transfer Custody** feature must be enabled for your account. Reference: https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopetransferrules/update ## Authentication - `Authorization` header (required) (prefixed with ` Bearer `) — OAuth 2.0 access token (JWT or auth-code grant). Sent as `Authorization: Bearer ` on every request except `GET /v2.1` and `GET /service_information`, which are public discovery endpoints. ## Servers - `https://demo.docusign.net/restapi` (Demo, default) - `https://www.docusign.net/restapi` (Production) ## Request ### Path parameters - `accountId` (string, required) — The external account number (int) or account ID Guid. ### Body (application/json) This endpoint expects an envelopeTransferRuleInformation. - `endPosition` (string, optional) — The last index position in the result set. - `envelopeTransferRules` (list of envelopeTransferRule, optional) — Contains information about a specific envelope transfer rule. - `nextUri` (string, optional) — The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - `previousUri` (string, optional) — The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - `resultSetSize` (string, optional) — 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` (string, optional) — The starting index position of the current result set. - `totalSetSize` (string, optional) — The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. ## Response ### 200 Successful response. - `endPosition` (string, optional) — The last index position in the result set. - `envelopeTransferRules` (list of envelopeTransferRule, optional) — Contains information about a specific envelope transfer rule. - `nextUri` (string, optional) — The URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search. - `previousUri` (string, optional) — The URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search. - `resultSetSize` (string, optional) — 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` (string, optional) — The starting index position of the current result set. - `totalSetSize` (string, optional) — The total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`. ## Errors ### 400 Bad Request Error Error encountered. - `errorCode` (string, optional) — The code associated with the error condition. - `message` (string, optional) — A brief message describing the error condition. ## Types ### envelopeTransferRule This object contains details about an envelope transfer rule. - `carbonCopyOriginalOwner` (string, optional) — When `true`, the original owner is added as a carbon copy recipient after envelope transfer. The default value is `false`. - `enabled` (string, optional) — When `true`, the envelope transfer rule is active. - `envelopeTransferRuleId` (string, optional) — The ID of the envelope transfer rule. The system generates this ID when the rule is first created. - `eventType` (string, optional) — The type of envelope event that triggers the transfer. Valid values are: - `sent` - `beforeSent` - `completed` - `fromGroup` (group, optional) — This object contains information about a group. - `fromUser` (userInformation, optional) — User information. - `modifiedDate` (string, optional) — The UTC DateTime when the envelope transfer rule was last modified. This property is read-only. - `modifiedUser` (userInformation, optional) — User information. - `toFolder` (folder, optional) — This object contains details about a folder. - `toUser` (userInformation, optional) — User information. ### group This object contains information about a group. - `accessType` (string, optional) - `dsGroupId` (string, optional) — Reserved for Docusign. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `groupId` (string, optional) — The Docusign group ID for the group. This is a read-only property. - `groupName` (string, optional) — The name of the group. - `groupType` (string, optional) — The group type. - `isManagedByScim` (boolean, optional) - `lastModifiedOn` (string, optional) - `permissionProfileId` (string, optional) — This field is deprecated. - `userGroupType` (string, optional) - `users` (list of userInfo, optional) — A list of the users in the group. This property is not used by [Groups: list](/docs/esign-rest-api/reference/usergroups/groups/list/). To get a list of users see [GroupUsers: list](/docs/esign-rest-api/reference/usergroups/groupusers/list/) - `usersCount` (string, optional) — The total number of users in the group. ### userInformation User information. - `activationAccessCode` (string, optional) — Access code provided to the user to activate the account. - `company` (string, optional) — The name of the user's company. - `connectConfigurations` (list of connectUserObject, optional) — Object representing the user's custom Connect configuration. - `countryCode` (string, optional) — The two-letter code for the user's country. - `createdDateTime` (string, optional) — The UTC DateTime when the item was created. - `customSettings` (list of nameValue, optional) — The name/value pair information for the user custom setting. - `defaultAccountId` (string, optional) — The default account ID associated with the user. - `email` (string, optional) — The user's email address. This property cannot be updated via `PUT` requests. - `enableConnectForUser` (string, optional) — Boolean value that specifies whether the user is enabled for updates from Docusign Connect. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters. - `forgottenPasswordInfo` (forgottenPasswordInformation, optional) — A complex element that has up to four Question/Answer pairs for forgotten password information. - `groupList` (list of group, optional) — A list of the group information for groups to add the user to. Use [UserGroups: listGroups](/docs/esign-rest-api/reference/usergroups/groups/list/) to get information about groups. When setting a user's group, only the `groupId` is required. - `hasRemoteNotary` (boolean, optional) - `homeAddress` (addressInformation, optional) — Contains address information. - `initialsImageUri` (string, optional) — The URI for retrieving the image of the user's initials. - `isAdmin` (string, optional) — When **true,** the user is an administrator. - `isAlternateAdmin` (string, optional) — When **true,** the user is an alternate administrator. This user is not an administrator but will be set as such if all administrator memberships are closed. - `isManagedByScim` (string, optional) - `isMembershipManagedByScim` (string, optional) - `isNAREnabled` (string, optional) — When **true,** National Association of Realtors (NAR) signature logos are enabled for the user. - `jobTitle` (string, optional) — The user's job title. - `lastLogin` (string, optional) — This property has been deprecated. - `lastName` (string, optional) — The user's last name. Maximum Length: 50 characters. - `licenseStatus` (string, optional) — If successful this value will be "Assigned" If there was an error, this value will be "Failed. Please try again later." - `licenseType` (string, optional) — The user’s assigned license type. Only available for IAM plans. Must be one of the following values: - `Full - Enterprise`: Full license type available for customers who purchase the IAM Enterprise plan; includes access to sending envelopes, Agreement Manager, and Workflow Builder. - `Full - Professional`: Full license type available for customers who purchase the IAM Professional plan; includes access to sending envelopes, Agreement Manager, and Workflow Builder. - `Full - Standard`: Full license type available for customers who purchase the IAM Standard plan; includes access to sending envelopes, Agreement Manager, and Workflow Builder. - `Full - Sales`: Full license type available for customers who purchase the IAM Sales plan; includes access to sending envelopes, Agreement Manager, and Workflow Builder. - `Full - CX`: Full license type available for customers who purchase the IAM Sales plan; includes access to sending envelopes and Workflow Builder. - `Free`: Free license type available for all IAM customers; includes access to viewing the user’s own agreements and signing. - `licenseTypes` (list of string, optional) - `loginStatus` (string, optional) — Boolean value that indicates whether the user is currently logged in or not. - `middleName` (string, optional) — The user's middle name. Limit: 50 characters. - `password` (string, optional) — The user's password. This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo). This property is not returned by `GET` requests and cannot be updated via `PUT` requests. - `passwordExpiration` (string, optional) — If password expiration is enabled, the date-time when the user's password expires. - `permissionProfileId` (string, optional) — The ID of the permission profile. Use [AccountPermissionProfiles: list](/docs/esign-rest-api/reference/accounts/accountpermissionprofiles/list/) to get a list of permission profiles and their IDs. You can also download a CSV file of all permission profiles and their IDs from the **Settings > Permission Profiles** page of your eSignature account page. - `permissionProfileName` (string, optional) — The name of the account permission profile. Example: `Account Administrator` - `profileImageUri` (string, optional) — The URL for retrieving the user's profile image. - `sendActivationEmail` (string, optional) — 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](/docs/admin-api/how-to/create-active-user/). You can also use this field to resend the activation email to a user who is not yet active by setting this field to the `"send"`. - `sendActivationOnInvalidLogin` (string, optional) — When **true,** specifies that an additional activation email be sent if user's log on fails before the account is activated. - `signatureImageUri` (string, optional) — An endpoint URI that you can use to retrieve the user's signature image. - `subscribe` (string, optional) - `suffixName` (string, optional) — The suffix for the user's name, such as Jr, IV, PhD, etc. Limit: 50 characters. - `title` (string, optional) — The title of the user. - `uri` (string, optional) — A URI containing the user ID. - `userAddedToAccountDateTime` (string, optional) — The date and time that the user was added to the account. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `userName` (string, optional) — The name of the user. - `userProfileLastModifiedDate` (string, optional) — The date and time that the user's profile was last modified. - `userSettings` (userSettingsInformation, optional) — Properties that configure the settings for a user. Some elements of this object have a `metadata` property, which includes the following: - `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`) - `uiHint`: Internally used to build UIs (can be `available` or `hidden`) - `options`: The values supported for this setting (not all settings have this element) - `userStatus` (string, optional) — Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` - `userType` (string, optional) — The type of user, for example `CompanyUser`. - `workAddress` (addressInformation, optional) — Contains address information. ### folder This object contains details about a folder. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `filter` (filter, optional) — Use this object to create a filtered view of the items in a folder. - `folderId` (string, optional) — The ID of the folder. - `folderItems` (list of folderItem_v2, optional) — A list of envelopes and templates that the folder contains. - `folders` (list of folder, optional) — A collection of folder objects returned in a response. - `hasAccess` (string, optional) — When **true,** the current user has access to the folder. - `hasSubFolders` (string, optional) — When **true,** the folder has subfolders. - `itemCount` (string, optional) — The number of items in the folder. - `name` (string, optional) — The name of the folder. - `owner` (userInfo, optional) - `parentFolderId` (string, optional) — The ID of the parent folder, or the special value `root` for the root folder. - `parentFolderUri` (string, optional) — The URI of the parent folder. - `subFolderCount` (string, optional) — The number of subfolders. - `type` (string, optional) — The type of folder. Possible values include: - `draft` - `inbox` - `normal` (a system-generated folder) - `recyclebin` - `sentitems` - `custom` (a custom folder created by a user) - `uri` (string, optional) — The URI for the folder. ### errorDetails This object describes errors that occur. It is only valid for responses, and ignored in requests. - `errorCode` (string, optional) — The code associated with the error condition. - `message` (string, optional) — A brief message describing the error condition. ### userInfo - `accountId` (string, optional) — The account ID associated with the envelope. - `accountName` (string, optional) — The name on the account. - `activationAccessCode` (string, optional) — Access code provided to the user to activate the account. - `email` (string, optional) — The user's email address. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `ipAddress` (string, optional) - `loginStatus` (string, optional) — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` (string, optional) — The user's membership ID. - `sendActivationEmail` (string, optional) — 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](/docs/admin-api/how-to/create-active-user/). - `uri` (string, optional) — A URI containing the user ID. - `userId` (string, optional) — The ID of the user to access. - `userName` (string, optional) — The name of the user. - `userStatus` (string, optional) — Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` - `userType` (string, optional) — The type of user, for example `CompanyUser`. ### connectUserObject - `configurationtype` (string, optional) — The type of custom Connect configuration being accessed. - `connectId` (string, optional) — The ID of the custom Connect configuration being accessed. - `enabled` (string, optional) — Boolean value that indicates whether the custom Connect configuration is enabled or not. - `hasAccess` (string, optional) - `senderSearchableItems` (list of string, optional) ### nameValue A name-value pair that describes an item and provides a value for the item. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `name` (string, optional) — The name of the item. - `originalValue` (string, optional) — The initial value of the item. - `value` (string, optional) — The current value of the item. ### forgottenPasswordInformation A complex element that has up to four Question/Answer pairs for forgotten password information. - `forgottenPasswordAnswer1` (string, optional) — The answer to the first forgotten password challenge question. - `forgottenPasswordAnswer2` (string, optional) — The answer to the second forgotten password challenge question. - `forgottenPasswordAnswer3` (string, optional) — The answer to the third forgotten password challenge question. - `forgottenPasswordAnswer4` (string, optional) — The answer to the fourth forgotten password challenge question. - `forgottenPasswordQuestion1` (string, optional) — The first challenge question presented to a user who has forgotten their password. - `forgottenPasswordQuestion2` (string, optional) — The second challenge question presented to a user who has forgotten their password. - `forgottenPasswordQuestion3` (string, optional) — The third challenge question presented to a user who has forgotten their password. - `forgottenPasswordQuestion4` (string, optional) — The fourth challenge question presented to a user who has forgotten their password. ### addressInformation Contains address information. - `address1` (string, optional) — The first line of the user's address. Maximum length: 100 characters. - `address2` (string, optional) — The second line of the user's address. Maximum length: 100 characters. - `city` (string, optional) — The user's city. Maximum length: 40 characters. - `country` (string, optional) — The user's country. Maximum length: 50 characters. - `fax` (string, optional) — A Fax number associated with the address if one is available. - `phone` (string, optional) — A phone number associated with the address. - `postalCode` (string, optional) — The user's postal code. Maximum length: 20 characters. - `stateOrProvince` (string, optional) — The user's state or province. Maximum length: 40 characters. - `zipPlus4` (string, optional) ### userSettingsInformation Properties that configure the settings for a user. Some elements of this object have a `metadata` property, which includes the following: - `rights`: The calling users permissions to edit this setting (can be `editable` or `read_only`) - `uiHint`: Internally used to build UIs (can be `available` or `hidden`) - `options`: The values supported for this setting (not all settings have this element) - `accountAgreementsAccessType` (string, optional) — Reserved for Docusign. - `accountAgreementsAccessTypeMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `accountManagementGranular` (userAccountManagementGranularInformation, optional) — Describes which account management capabilities a user has. - `adminOnly` (string, optional) — Reserved for Docusign. - `adminOnlyMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `allowAccessToAllAccountAgreements` (string, optional) - `allowAccessToAllAccountAgreementsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `allowAutoTagging` (string, optional) — When **true,** the API returns suggested tabs for documents for this user. - `allowedDocumentTemplateLibraryAccess` (string, optional) - `allowedDocumentTemplateLibraryAccessMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `allowedOrchestrationAccess` (string, optional) - `allowedOrchestrationAccessMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `allowEnvelopeTransferTo` (string, optional) — When **true,** this user can participate in envelope transfers on the account. - `allowEnvelopeTransferToMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `allowEsealRecipients` (string, optional) — When **true,** this user can create [electronic seal recipients](/docs/esign-rest-api/reference/envelopes/enveloperecipients/#seal-recipient). - `allowEsealRecipientsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `allowPowerFormsAdminToAccessAllPowerFormEnvelope` (string, optional) — When **true** and this user is an administrator, they can view all of the envelopes generated from PowerForms. The default value is **false.** - `allowPowerFormsAdminToAccessAllPowerFormEnvelopeMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `allowRecipientLanguageSelection` (string, optional) — When **true,** this user can set the language used in the standard email format for a recipient when creating an envelope. - `allowRecipientLanguageSelectionMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `allowSendOnBehalfOf` (string, optional) — When **true,** this user can send envelopes "on behalf of" other users through the API. - `allowSendOnBehalfOfMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `allowSupplementalDocuments` (string, optional) — When **true,** this user can include supplemental documents. - `allowSupplementalDocumentsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `allowTransactions` (string, optional) - `allowTransactionsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `anchorTagVersionedPlacementEnabled` (string, optional) — Reserved for Docusign. - `apiAccountWideAccess` (string, optional) — When **true,** indicates that this user can send envelope-specific API requests on the account. - `apiAccountWideAccessMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `apiCanExportAC` (string, optional) — When **true,** this user can export authoritative copy for the account. - `apiCanExportACMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `bulkSend` (string, optional) — When **true,** this user can use the bulk send feature for the account. - `bulkSendMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canBulkUploadAgreements` (string, optional) — Reserved for Docusign. - `canBulkUploadAgreementsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canChargeAccount` (string, optional) — Reserved for Docusign. - `canChargeAccountMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canCreateTransaction` (string, optional) - `canCreateTransactionMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canDeleteDocumentsInTransaction` (string, optional) - `canDeleteDocumentsInTransactionMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canDeleteTransaction` (string, optional) - `canDeleteTransactionMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canEditSharedAddressbook` (string, optional) — When true, this user can edit the shared address book for the account. - `canEditSharedAddressbookMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canLockEnvelopes` (string, optional) — Reserved for Docusign. - `canLockEnvelopesMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageAccount` (string, optional) — When **true,** this user is an administrator for the account. - `canManageAccountMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageAgreementParties` (string, optional) - `canManageAgreementPartiesMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageDistributor` (string, optional) — Reserved for Docusign. - `canManageDistributorMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageTemplates` (string, optional) — When **true,** this user can manage templates for the account. - `canManageTemplatesMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canSendAPIRequests` (string, optional) — When **true,** this user can send API requests on the account. - `canSendAPIRequestsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canSendEnvelope` (string, optional) — When **true,** this user can send envelopes on the account. - `canSendEnvelopeMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canSendEnvelopesViaSMS` (string, optional) - `canSendEnvelopesViaSMSMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canSignEnvelope` (string, optional) — When **true,** this user can sign envelopes. - `canSignEnvelopeMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canUseScratchpad` (string, optional) — When **true,** this user can use a scratchpad to edit information. - `canUseScratchpadMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canUseSmartContracts` (string, optional) — Reserved for Docusign. - `canUseSmartContractsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `disableDocumentUpload` (string, optional) — When **true,** this user is prohibited from uploading documents during sending. - `disableDocumentUploadMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `disableOtherActions` (string, optional) — When **true,** this user can access the **Other Actions** menu. - `disableOtherActionsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `enableDSPro` (string, optional) — Reserved for Docusign. - `enableDSProMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `enableKeyTermsSuggestionsByDocumentType` (string, optional) - `enableKeyTermsSuggestionsByDocumentTypeMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `enableSequentialSigningAPI` (string, optional) — When **true,** the account can define the routing order of recipients for envelopes sent by using the eSignature API. **Note:** Only SysAdmin users can change this setting. - `enableSequentialSigningAPIMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `enableSequentialSigningUI` (string, optional) — When **true,** the account can define the routing order of recipients for envelopes sent by using the Docusign application. **Note:** Only SysAdmin users can change this setting. - `enableSequentialSigningUIMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `enableSignerAttachments` (string, optional) — When **true,** this user can use the signing attachments feature. - `enableSignerAttachmentsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `enableSignOnPaperOverride` (string, optional) — 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. **Note:** Only Admin users can change this setting. - `enableSignOnPaperOverrideMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `enableTransactionPoint` (string, optional) — Reserved for Docusign. - `enableTransactionPointMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `enableVaulting` (string, optional) — When **true,** Vaulting is enabled for the account. - `enableVaultingMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `expressSendOnly` (string, optional) — When **false,** this user can apply tabs to documents during the sending experience. - `isManagedByScim` (string, optional) - `isManagedByScimMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `isMembershipManagedByScim` (string, optional) - `isMembershipManagedByScimMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `isMembershipRedacted` (string, optional) - `isMembershipRedactedMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `isUserRedacted` (string, optional) - `isUserRedactedMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `locale` (string, optional) — The user's locale code. Valid values are: - `zh_CN` - `zh_TW` - `nl` - `en` - `fr` - `de` - `it` - `ja` - `ko` - `pt` - `pt_BR` - `ru` - `es` - `localeMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `localePolicy` (localePolicy, optional) - `manageClickwrapsMode` (string, optional) — When **true,** this user can create and manage [Clickwraps](/docs/click-api/). - `manageClickwrapsModeMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `modifiedBy` (string, optional) — The user ID (GUID) of the user who last modified this user record. This property is read-only. - `modifiedByMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `modifiedDate` (string, optional) — The date on which this user record was last modified. - `modifiedDateMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `modifiedPage` (string, optional) — Note referencing the page that modified this user record. - `modifiedPageMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `newSendUI` (string, optional) — Reserved for Docusign. - `newSendUIMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `powerFormMode` (string, optional) — Indicates the Power Form mode setting for the user: - `none` - `admin` - `user` - `powerFormModeMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `recipientViewedNotification` (string, optional) — When **true,** this user receives notifications when envelopes are viewed. - `recipientViewedNotificationMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `redactAtMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `redactMembershipAt` (string, optional) - `sealIdentifiers` (list of sealIdentifier, optional) — Information about the seals associated with this user. - `selfSignedRecipientEmailDocument` (string, optional) — Sets how self-signed documents are presented to the email recipients. Valid values are: - `include_pdf`: A PDF of the completed document is attached to the email. - `include_link`: A secure link to the self-signed documents is included in the email. **Note:** Only Admin users can change this setting. - `selfSignedRecipientEmailDocumentMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `senderEmailNotifications` (senderEmailNotifications, optional) — Contains the settings for the email notifications that senders receive about the envelopes that they send. - `signerEmailNotifications` (signerEmailNotifications, optional) — An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from Docusign. The user inherits the default account email notification settings when the user is created. - `supplementalDocumentIncludeInDownload` (string, optional) — When **true,** this user gets supplemental documents when downloading documents. - `supplementalDocumentsMustAccept` (string, optional) — When **true,** this user must accept supplemental documents. - `supplementalDocumentsMustAcceptMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `supplementalDocumentsMustRead` (string, optional) — When **true,** this user must both view and accept supplemental documents. - `supplementalDocumentsMustReadMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `supplementalDocumentsMustView` (string, optional) — When **true,** this user must view supplemental documents. - `supplementalDocumentsMustViewMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `templateActiveCreation` (string, optional) — When **true,** a new template is created each time the user sends an envelope. - `templateActiveCreationMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `templateApplyNotify` (string, optional) — When **true,** the system notifies this user before applying a matching template. - `templateApplyNotifyMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `templateAutoMatching` (string, optional) — When **true,** the system automatically applies a matching template to a document if only one template matches. If there are multiple matches, it displays a list of matches to select from. - `templateAutoMatchingMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `templateMatchingSensitivity` (string, optional) — Percentage used when matching templates. - `templateMatchingSensitivityMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `templatePageLevelMatching` (string, optional) — When **true,** users see template matching functionality. - `templatePageLevelMatchingMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `timezoneDST` (string, optional) — When true, daylight savings time is in effect for this user's time zone. - `timezoneDSTMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `timezoneMask` (string, optional) — The custom DateTime format setting for this user. - `timezoneMaskMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `timezoneOffset` (string, optional) — The timezone offset for the user. Valid values: - `tz_01_afghanistan` - `tz_02_alaskan` - `tz_03_arab` - `tz_04_arabian` - `tz_05_arabic` - `tz_06_argentina` - `tz_07_atlantic` - `tz_08_aus_central` - `tz_09_aus_eastern` - `tz_10_azerbaijan` - `tz_11_azores` - `tz_12_bangladesh` - `tz_13_canada_central` - `tz_14_cape_verde` - `tz_15_caucasus` - `tz_16_central_australia` - `tz_17_central_america` - `tz_18_central_asia` - `tz_19_central_brazilian` - `tz_20_central_europe` - `tz_21_central_european` - `tz_22_central_pacific` - `tz_23_central` - `tz_24_central_mexico` - `tz_25_china` - `tz_26_dateline` - `tz_27_east_africa` - `tz_28_east_australia` - `tz_29_east_europe` - `tz_30_east_south_america` - `tz_31_eastern` - `tz_32_egypt` - `tz_33_ekaterinburg` - `tz_34_fiji` - `tz_35_fli` - `tz_36_georgian` - `tz_37_gmt` - `tz_38_greenland` - `tz_39_greenwich` - `tz_40_gtb` - `tz_41_hawaiian` - `tz_42_india` - `tz_43_iran` - `tz_44_israel` - `tz_45_jordan` - `tz_46_kaliningrad` - `tz_47_kamchatka` - `tz_48_korea` - `tz_49_magadan` - `tz_50_mauritius` - `tz_51_mid_atlantic` - `tz_52_middle_east` - `tz_53_montevideo` - `tz_54_morocco` - `tz_55_mountain` - `tz_56_mountain_mexico` - `tz_57_myanmar` - `tz_58_north_central_asia` - `tz_59_namibia` - `tz_60_nepal` - `tz_61_new_zealand` - `tz_62_new_foundland` - `tz_63_north_asia_east` - `tz_64_north_asia` - `tz_65_pacific_sa` - `tz_66_pacific` - `tz_67_pacific_mexico` - `tz_68_pakistan` - `tz_69_paraguay` - `tz_70_romance` - `tz_71_russian` - `tz_72_sa_eastern` - `tz_73_sa_pacific` - `tz_74_sa_western` - `tz_75_samoa` - `tz_76_se_asia` - `tz_77_singapore` - `tz_78_south_africa` - `tz_79_sriLanka` - `tz_80_syria` - `tz_81_taipei` - `tz_82_tasmania` - `tz_83_tokyo` - `tz_84_tonga` - `tz_85_turkey` - `tz_86_ulaanbaatar` - `tz_87_us_eastern` - `tz_88_us_mountain` - `tz_89_venezuela` - `tz_90_vladivostok` - `tz_91_west_australia` - `tz_92_west_central_africa` - `tz_93_west_europe` - `tz_94_west_asia` - `tz_95_west_pacific` - `tz_96_yakutsk` - `timezoneOffsetMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `timezoneSendingPref` (string, optional) — Reserved for Docusign. - `timezoneSendingPrefMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `timezoneSigningPref` (string, optional) — Reserved for Docusign. - `timezoneSigningPrefMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `transactionPointSiteNameURL` (string, optional) — Reserved for Docusign. - `transactionPointSiteNameURLMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `transactionPointUserName` (string, optional) — Reserved for Docusign. - `transactionPointUserNameMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `vaultingMode` (string, optional) — Indicates the specified Vaulting mode: - `none` - `estored` - `electronic_original` - `vaultingModeMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `webForms` (string, optional) - `webFormsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. ### filter Use this object to create a filtered view of the items in a folder. - `actionRequired` (string, optional) — When **true,** the current user needs to take action on the item. - `expires` (string, optional) — The number of days a sent envelope remains active before it expires. - `folderIds` (string, optional) — Filters for any combination of folder IDs and folder types. The possible folder types are: - `awaiting_my_signature` - `completed` - `draft` - `drafts` - `expiring_soon` - `inbox` - `out_for_signature` - `recyclebin` - `sentitems` - `waiting_for_others` - `fromDateTime` (string, optional) — The UTC DateTime of the beginning of a date range. If no value is provided, the default search is the previous 30 days. - `isTemplate` (string, optional) — When **true,** the item is a template. - `order` (string, optional) — The order in which to sort the results. Valid values are: - `asc`: Ascending order. - `desc`: Descending order. - `orderBy` (string, optional) — The field used to sort the results. Example: `Created` - `searchTarget` (string, optional) — Reserved for Docusign. - `searchText` (string, optional) — A free text search field for searching across the items in a folder. The search looks for the text that you enter in the recipient names and emails, envelope custom fields, sender name, and subject. - `status` (string, optional) — The status of the envelope. By default, all statuses are returned. For details, see [Envelope Status Code Descriptions](/docs/esign-rest-api/esign101/rules-and-limits/responses/). - `toDateTime` (string, optional) — The UTC DateTime of the end of a date range. If no value is provided, the default search is to the current date. ### folderItem_v2 Information about folder item results. - `completedDateTime` (string, optional) — If the item is an envelope, this is the UTC DateTime when the envelope was completed. - `createdDateTime` (string, optional) — The UTC DateTime when the item was created. - `envelopeId` (string, optional) — If the item is an envelope, this is the ID of the envelope. - `envelopeUri` (string, optional) — If the item is an envelope, this is the URI for retrieving it. - `expireDateTime` (string, optional) — The date and time the envelope is set to expire. - `folderId` (string, optional) — The ID of the folder. - `folderUri` (string, optional) — If the item is a subfolder, this is the URI for retrieving it. - `is21CFRPart11` (string, optional) — When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). - `lastModifiedDateTime` (string, optional) — The date and time that the item was last modified. - `ownerName` (string, optional) — The name of the user who owns the folder. - `recipients` (recipients, optional) — Specifies the envelope recipients. - `recipientsUri` (string, optional) — Contains a URI for an endpoint that you can use to retrieve the recipients. - `senderCompany` (string, optional) — The name of the sender's company. - `senderEmail` (string, optional) — The sender's email address. - `senderName` (string, optional) — The sender's name. - `senderUserId` (string, optional) — The sender's id. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `subject` (string, optional) — The subject of the envelope. - `templateId` (string, optional) — The unique identifier of the template. If this is not provided, DocuSign will generate a value. - `templateUri` (string, optional) — The URI for retrieving the template. ### settingsMetadata Metadata that indicates whether a property is editable and describes setting-specific options. - `is21CFRPart11` (string, optional) — When **true,** indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). - `options` (list of string, optional) — An array of option strings supported by this setting. - `rights` (string, optional) — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `uiHint` (string, optional) — Reserved for Docusign. - `uiOrder` (string, optional) — Reserved for Docusign. - `uiType` (string, optional) — Reserved for Docusign. ### userAccountManagementGranularInformation Describes which account management capabilities a user has. - `canManageAccountSecuritySettings` (string, optional) — **True** if the user can manage account security settings. - `canManageAccountSecuritySettingsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageAccountSettings` (string, optional) — **True** if the user can manage account settings. - `canManageAccountSettingsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageAdmins` (string, optional) — **True** if the user can manage administrators. - `canManageAdminsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageConnect` (string, optional) - `canManageConnectMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageDocumentRetention` (string, optional) - `canManageDocumentRetentionMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageEnvelopeTransfer` (string, optional) - `canManageEnvelopeTransferMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageGroupsButNotUsers` (string, optional) - `canManageGroupsButNotUsersMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageJointAgreements` (string, optional) - `canManageJointAgreementsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageReporting` (string, optional) — **True** if the user can manage reporting. - `canManageReportingMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageSharing` (string, optional) — **True** if the user can manage sharing. - `canManageSharingMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageSigningGroups` (string, optional) — **True** if the user can manage signing groups. - `canManageSigningGroupsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageStamps` (string, optional) - `canManageStampsMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canManageUsers` (string, optional) — **True** if the user can manage users. - `canManageUsersMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canViewOnlyAccountAdminPages` (string, optional) - `canViewOnlyAccountAdminPagesMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `canViewUsers` (string, optional) ### localePolicy - `addressFormat` (string, optional) — Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw` - `addressFormatMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `allowRegion` (string, optional) - `calendarType` (string, optional) — Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist` - `calendarTypeMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `cultureName` (string, optional) — The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. - `cultureNameMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `currencyCode` (string, optional) — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. - `currencyCodeMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `currencyNegativeFormat` (string, optional) — Determines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default` `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar` `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89` `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89` `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89` `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym` `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar` `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym` `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89` `$-1'234'567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89` `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567` `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89` `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar` `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89` `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89` `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89` `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89` `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89` `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym` `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym` `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar` `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar` `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym` `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89` `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar` `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar` `($ 1'234'567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar` `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar` `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar` `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar` `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar` `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar` `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar` `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar` `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar` `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567` `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89` `-$ 1'234'567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89` `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567` `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567` `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89` `$ -1'234'567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89` `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89` `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym` `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89` `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym` `-123'456'789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus` `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89` `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar` `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89` `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89` `-$123 456 789,00` - `currencyNegativeFormatMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `currencyPositiveFormat` (string, optional) — Determines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default` Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89` `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89` `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym` `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym` `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89` `$ 1'234'567.89` - `CSym_1_Comma_234_Comma_567` `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89` `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89` `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89` `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym` `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89` `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89` `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym` `1 234 567,89$` - `CSym_1_Period_234_Period_567` `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym` `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89` `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89` `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym` `123'456'789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89` `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym` `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89` `$123 456 789,00` (en-ZA, es-CR) - `currencyPositiveFormatMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `customDateFormat` (string, optional) - `customSignDateFormat` (string, optional) - `customSignTimeFormat` (string, optional) - `customTimeFormat` (string, optional) - `dateFormat` (string, optional) — Specifies the date format. Valid values: - `default` used the UI's - `longformat` use the UI's long format - `dd_mm_yy` dd-MM-yy - `dd_mmm_yy` dd-MMM-yy - `dd_mm_yyyy` dd-MM-yyyy - `dd_mmm_yyyy` dd-MMM-yyyy - `ddmmmmyyyy` dd MMMM yyyy - `ddmmyyyy` dd/MM/yyyy - `ddmmyyyy_de` dd.MM.yyyy - `dmyyyy` d/M/yyyy - `d_m_yyyy` d-M-yyyy - `mmmd_yyyy` MMM d, yyyy - `mmm_dd_yyyy` MMM-dd-yyyy - `mmmmd_yyyy` MMMM d, yyyy - `mm_dd_yyyy` MM-dd-yyyy - `mdyyyy` M/d/yyyy - `yyyy_mmm_dd` yyyy-MMM-dd - `yyyy_mm_dd` yyyy-MM-dd - `yyyymmdd` yyyy/MM/dd - `yyyymd` yyyy/M/d - `custom` Customer set own value - `mmddyyyy` MM/dd/yyyy - `mmddyy` MM/dd/yy - `yyyy_mmmm_d` yyyy MMMM d - `dateFormatMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `effectiveAddressFormat` (string, optional) - `effectiveCalendarType` (string, optional) - `effectiveCurrencyCode` (string, optional) - `effectiveCurrencyNegativeFormat` (string, optional) - `effectiveCurrencyPositiveFormat` (string, optional) - `effectiveCustomDateFormat` (string, optional) - `effectiveCustomTimeFormat` (string, optional) - `effectiveDateFormat` (string, optional) - `effectiveInitialFormat` (string, optional) - `effectiveNameFormat` (string, optional) - `effectiveTimeFormat` (string, optional) - `effectiveTimeZone` (string, optional) - `initialFormat` (string, optional) — When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for "William Henry Gates". - `first1last1` "WG" - `last2` "GA" - `first2` "WI" - `last2_cjk` first two characters from last name in CJK characters. - `initialFormatMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `nameFormat` (string, optional) — Describes how names are displayed. Valid values: - `first_middle_last` William Henry Gates - `full` Mr William Henry Gates III - `last_first` Gates William - `lastfirst` GatesWilliam - `last_first_cjk` Gates William only with CJK characters - `lastfirst_cjk` GatesWilliam only with CJK characters - `nameFormatMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `signDateFormat` (string, optional) — The format for the signature date. Valid values are: - `d/M/yyyy` - `dd-MM-yy` - `dd-MMM-yy` - `dd-MM-yyyy` - `dd.MM.yyyy` - `dd-MMM-yyyy` - `dd MMMM yyyy` - `M/d/yyyy` - `MM-dd-yyyy` - `MM/dd/yyyy` - `MM/dd/yy` - `MMM-dd-yyyy` - `MMM d, yyyy` - `MMMM d, yyyy` - `yyyy-MM-dd` - `yyyy-MMM-dd` - `yyyy/MM/dd` - `yyyy MMMM d` **Note:** Only Admin users can change this setting. - `signDateFormatMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `signTimeFormat` (string, optional) — The format for the signature time. Valid values are: - `none` - `HH:mm` - `h:mm` - `HH:mm:ss` - `h:mm:ss` - `signTimeFormatMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `timeFormat` (string, optional) — Specifies the time format. Valid values: - `none` None - `hh_mm` hh:mm - `hhmm` HH:mm - `hhmmss` HH:mm:ss - `hhmmsstt` HH:mm:ss tt - `hhmmtt` HH:mm tt - `hmm` h:mm - `hmmss` h:mm:ss - `hmmsstt` h:mm:ss tt - `hmmtt` h:mm tt - `custom` Customer-set format - `timeFormatMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. - `timeZone` (string, optional) — Specifies the time zone. Valid values: - `TZ_01_AfghanistanStandardTime` - `TZ_02_AlaskanStandardTime` - `TZ_03_ArabStandardTime` - `TZ_04_ArabianStandardTime` - `TZ_05_ArabicStandardTime` - `TZ_06_ArgentinaStandardTime` - `TZ_07_AtlanticStandardTime` - `TZ_08_AUS_CentralStandardTime` - `TZ_09_AUS_EasternStandardTime` - `TZ_10_AzerbaijanStandardTime` - `TZ_11_AzoresStandardTime` - `TZ_12_BangladeshStandardTime` - `TZ_13_CanadaCentralStandardTime` - `TZ_14_CapeVerdeStandardTime` - `TZ_15_CaucasusStandardTime` - `TZ_16_CentralAustraliaStandardTime` - `TZ_17_CentralAmericaStandardTime` - `TZ_18_CentralAsiaStandardTime` - `TZ_19_CentralBrazilianStandardTime` - `TZ_20_CentralEuropeStandardTime` - `TZ_21_CentralEuropeanStandardTime` - `TZ_22_CentralPacificStandardTime` - `TZ_23_CentralStandardTime` - `TZ_24_CentralStandardTimeMexico` - `TZ_25_ChinaStandardTime` - `TZ_26_DatelineStandardTime` - `TZ_27_E_AfricaStandardTime` - `TZ_28_E_AustraliaStandardTime` - `TZ_29_E_EuropeStandardTime` - `TZ_30_E_SouthAmericaStandardTime` - `TZ_31_EasternStandardTime` - `TZ_32_EgyptStandardTime` - `TZ_33_EkaterinburgStandardTime` - `TZ_34_FijiStandardTime` - `TZ_35_FLE_StandardTime` - `TZ_36_GeorgianStandardTime` - `TZ_37_GMT_StandardTime` - `TZ_38_GreenlandStandardTime` - `TZ_39_GreenwichStandardTime` - `TZ_40_GTB_StandardTime` - `TZ_41_HawaiianStandardTime` - `TZ_42_IndiaStandardTime` - `TZ_43_IranStandardTime` - `TZ_44_IsraelStandardTime` - `TZ_45_JordanStandardTime` - `TZ_46_KaliningradStandardTime` - `TZ_47_KamchatkaStandardTime` - `TZ_48_KoreaStandardTime` - `TZ_49_MagadanStandardTime` - `TZ_50_MauritiusStandardTime` - `TZ_51_MidAtlanticStandardTime` - `TZ_52_MiddleEastStandardTime` - `TZ_53_MontevideoStandardTime` - `TZ_54_MoroccoStandardTime` - `TZ_55_MountainStandardTime` - `TZ_56_MountainStandardTimeMMexico` - `TZ_57_MyanmarStandardTime` - `TZ_58_N_CentralAsiaStandardTime` - `TZ_59_NamibiaStandardTime` - `TZ_60_NepalStandardTime` - `TZ_61_NewZealandStandardTime` - `TZ_62_NewfoundlandStandardTime` - `TZ_63_NorthAsiaEastStandardTime` - `TZ_64_NorthAsiaStandardTime` - `TZ_65_PacificSAStandardTime` - `TZ_66_PacificStandardTime` - `TZ_67_PacificStandardTimeMexico` - `TZ_68_PakistanStandardTime` - `TZ_69_ParaguayStandardTime` - `TZ_70_RomanceStandardTime` - `TZ_71_RussianStandardTime` - `TZ_72_SAEasternStandardTime` - `TZ_73_SAPacificStandardTime` - `TZ_74_SAWesternStandardTime` - `TZ_75_SamoaStandardTime` - `TZ_76_SE_AsiaStandardTime` - `TZ_77_SingaporeStandardTime` - `TZ_78_SouthAfricaStandardTime` - `TZ_79_SriLankaStandardTime` - `TZ_80_SyriaStandardTime` - `TZ_81_TaipeiStandardTime` - `TZ_82_TasmaniaStandardTime` - `TZ_83_TokyoStandardTime` - `TZ_84_TongaStandardTime` - `TZ_85_TurkeyStandardTime` - `TZ_86_UlaanbaatarStandardTime` - `TZ_87_US_EasternStandardTime` - `TZ_88_USMountainStandardTime` - `TZ_89_VenezuelaStandardTime` - `TZ_90_VladivostokStandardTime` - `TZ_91_W_AustraliaStandardTime` - `TZ_92_W_CentralAfricaStandardTime` - `TZ_93_W_EuropeStandardTime` - `TZ_94_WestAsiaStandardTime` - `TZ_95_WestPacificStandardTime` - `TZ_96_YakutskStandardTime` - `timeZoneMetadata` (settingsMetadata, optional) — Metadata that indicates whether a property is editable and describes setting-specific options. ### sealIdentifier - `sealDisplayName` (string, optional) — The user-friendly display name for a seal. - `sealName` (string, optional) — The name of a seal. ### senderEmailNotifications Contains the settings for the email notifications that senders receive about the envelopes that they send. - `changedSigner` (string, optional) — When **true,** the sender receives an email notification if the signer changes. - `clickwrapResponsesLimitNotificationEmail` (string, optional) - `commentsOnlyPrivateAndMention` (string, optional) — When **true,** the user receives only comments that mention their own user name. - `commentsReceiveAll` (string, optional) — When **true,** the user receives all comments. - `deliveryFailed` (string, optional) — When **true,** the sender receives an email notification if envelope delivery fails. - `envelopeComplete` (string, optional) — When **true,** the user receives an email notification when the envelope has been completed. - `offlineSigningFailed` (string, optional) — When **true,** the user receives an email notification if offline signing failed. - `powerformResponsesLimitNotificationEmail` (string, optional) - `purgeDocuments` (string, optional) — When **true,** the user receives an email notification when a document purge occurs. - `recipientViewed` (string, optional) — When **true,** the sender receives notification that a recipient viewed the envelope. - `senderEnvelopeDeclined` (string, optional) — When **true,** the sender receives notification that the envelope was declined. - `withdrawnConsent` (string, optional) — When **true,** the user receives an email notification if consent is withdrawn. ### signerEmailNotifications An array of email notifications that specifies the email the user receives when they are a recipient. When the specific email notification is set to true, the user receives those types of email notifications from Docusign. The user inherits the default account email notification settings when the user is created. - `agentNotification` (string, optional) — When **true,** the user receives agent notification emails. - `carbonCopyNotification` (string, optional) — When **true,** the user receives notifications of carbon copy deliveries. - `certifiedDeliveryNotification` (string, optional) — When **true,** the user receives notifications of certified deliveries. - `commentsOnlyPrivateAndMention` (string, optional) — When **true,** the user receives only comments that mention their own user name. - `commentsReceiveAll` (string, optional) — When **true,** the user receives all comments. - `documentMarkupActivation` (string, optional) — When **true,** the user receives notification that document markup has been activated. - `envelopeActivation` (string, optional) — When **true,** the user receives notification that the envelope has been activated. - `envelopeComplete` (string, optional) — When **true,** the user receives an email notification when the envelope has been completed. - `envelopeCorrected` (string, optional) — When **true,** the user receives notification that the envelope has been corrected. - `envelopeDeclined` (string, optional) — When **true,** the user receives notification that the envelope has been declined. - `envelopeVoided` (string, optional) — When **true,** the user receives notification that the envelope has been voided. - `faxReceived` (string, optional) — Reserved for Docusign. - `offlineSigningFailed` (string, optional) — When **true,** the user receives an email notification if offline signing failed. - `purgeDocuments` (string, optional) — When **true,** the user receives an email notification when a document purge occurs. - `reassignedSigner` (string, optional) — When **true,** the user receives notification that the envelope has been reassigned. - `whenSigningGroupMember` (string, optional) — When **true,** the user receives notification that he or she is a member of the signing group. ### recipients Specifies the envelope recipients. - `agents` (list of agent, optional) — A list of agent recipients assigned to the documents. - `authorizedSignatories` (list of authorizedSignatory, optional) - `carbonCopies` (list of carbonCopy, optional) — A list of carbon copy recipients assigned to the documents. - `certifiedDeliveries` (list of certifiedDelivery, optional) — A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents. - `currentRoutingOrder` (string, optional) — The routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions. - `editors` (list of editor, optional) — A list of users who can edit the envelope. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `inPersonSigners` (list of inPersonSigner, optional) — Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected. - `intermediaries` (list of intermediary, optional) — Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added). - `notaries` (list of notaryRecipient, optional) — A list of notary recipients on the envelope. - `notaryWitnesses` (list of notaryWitness, optional) - `participants` (list of participant, optional) - `recipientCount` (string, optional) — The number of recipients in the envelope. - `seals` (list of sealSign, optional) — A list of electronic seals to apply to documents. - `signers` (list of signer, optional) — A list of signers on the envelope. - `witnesses` (list of witness, optional) — A list of signers who act as witnesses on the envelope. ### agent 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. - `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — 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. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — 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. - `bulkSendV2Recipient` (string, optional) - `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If 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. If 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — 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. - `consentDetailsList` (list of consentDetails, optional) - `customFields` (list of string, optional) — 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. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) — 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.** - `email` (string, optional) — The email ID of the agent. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailRecipientPostSigningURL` (string, optional) - `embeddedRecipientStartURL` (string, optional) — 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. When `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. It 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. If 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. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `excludedDocuments` (list of string, optional) — 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. When 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. - `faxNumber` (string, optional) — Reserved for Docusign. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — 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: - `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. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — 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. - `lastName` (string, optional) — The recipient's last name. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The full legal name of the recipient. Maximum Length: 100 characters. **Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `note` (string, optional) — A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `recipientIdGuid` (string, optional) — 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. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `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. - `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. - `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. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group. - `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `socialAuthentications` (list of socialAuthentication, optional) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `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. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `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. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `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`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` (string, optional) — The total number of tabs in the documents. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### authorizedSignatory - `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. - `additionalNotifications` (list of recipientAdditionalNotification, optional) - `agentCanEditEmail` (string, optional) - `agentCanEditName` (string, optional) - `allowSystemOverrideForLockedRecipient` (string, optional) - `autoNavigation` (string, optional) - `autoRespondedReason` (string, optional) - `bulkRecipientsUri` (string, optional) — Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. - `bulkSendV2Recipient` (string, optional) - `canSignOffline` (string, optional) — When set to **true**, specifies that the signer can perform the signing ceremony offline. - `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if 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.ng. Maximum length: 100 characters. - `completedCount` (string, optional) - `consentDetailsList` (list of consentDetails, optional) - `creationReason` (string, optional) - `customFields` (list of string, optional) — 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. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. - `declinedReason` (string, optional) — The reason the recipient declined the document. - `defaultRecipient` (string, optional) - `delegatedBy` (delegationInfo, optional) - `delegatedTo` (list of delegationInfo, optional) - `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only. - `deliveryMethod` (string, optional) — Reserved: For DocuSign use only. - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) - `designatorIdGuid` (string, optional) - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) - `email` (string, optional) - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailRecipientPostSigningURL` (string, optional) - `embeddedRecipientStartURL` (string, optional) — 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. If set to `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 that is launched by any partner. It is important to remember 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 process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in 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. If 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 fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `excludedDocuments` (list of string, optional) — 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. When 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. - `faxNumber` (string, optional) — Reserved: - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and 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 '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — When set to **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. - `isBulkRecipient` (string, optional) - `isBulkRecipientMetadata` (propertyMetadata, optional) — Metadata about a property. - `lastName` (string, optional) - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) - `lockedRecipientSmsEditable` (string, optional) - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `notaryId` (string, optional) - `notarySignerEmailSent` (string, optional) - `note` (string, optional) — Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `offlineAttributes` (offlineAttributes, optional) — Reserved for Docusign. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved: - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `recipientIdGuid` (string, optional) - `recipientSignatureProviders` (list of recipientSignatureProvider, optional) - `recipientSuppliesTabs` (string, optional) - `recipientType` (string, optional) - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireSignerCertificate` (string, optional) - `requireSignOnPaper` (string, optional) - `requireUploadSignature` (string, optional) - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient.This is required when working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The date and time the envelope was sent. - `signatureInfo` (recipientSignatureInformation, optional) — Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. - `signedDateTime` (string, optional) — Reserved: For DocuSign use only. - `signInEachLocation` (string, optional) — When set to **true**, specifies that the signer must sign in all locations. - `signInEachLocationMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupId` (string, optional) — When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — The display name for the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group. - `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `socialAuthentications` (list of socialAuthentication, optional) — Lists the social ID type that can be used for recipient authentication. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusCode` (string, optional) - `suppressEmails` (string, optional) - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` (string, optional) - `userId` (string, optional) - `webFormRecipientViewId` (string, optional) ### carbonCopy Contains information about a carbon copy recipient. Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. - `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — 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. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `agentCanEditEmail` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. - `agentCanEditName` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — 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. - `bulkSendV2Recipient` (string, optional) - `clientUserId` (string, optional) — Not applicable for Carbon Copy recipients. - `completedCount` (string, optional) — 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. - `consentDetailsList` (list of consentDetails, optional) - `customFields` (list of string, optional) — 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. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) — 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.** - `email` (string, optional) — The recipient's email address. Notification of the document to sign is sent to this email address. Maximum length: 100 characters. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailRecipientPostSigningURL` (string, optional) - `embeddedRecipientStartURL` (string, optional) — 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. When `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. It 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. If 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. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `excludedDocuments` (list of string, optional) — 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. When 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. - `faxNumber` (string, optional) — Reserved for Docusign. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — 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: - `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. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — 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. - `lastName` (string, optional) — The recipient's last name. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `linkedAccountConfigurationId` (string, optional) - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The full legal name of the recipient. Maximum Length: 100 characters. **Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `note` (string, optional) — A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `recipientIdGuid` (string, optional) — 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. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `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. - `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. - `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. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group. - `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `socialAuthentications` (list of socialAuthentication, optional) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `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. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `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. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `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`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` (string, optional) — The total number of tabs in the documents. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### certifiedDelivery Contains information about a certified delivery recipient. Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents. - `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — 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. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `agentCanEditEmail` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. - `agentCanEditName` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — 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. - `bulkSendV2Recipient` (string, optional) - `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If 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. If 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — 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. - `consentDetailsList` (list of consentDetails, optional) - `customFields` (list of string, optional) — 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. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) — 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.** - `email` (string, optional) — The recipient's email address. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailRecipientPostSigningURL` (string, optional) - `embeddedRecipientStartURL` (string, optional) — 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. When `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. It 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. If 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. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `excludedDocuments` (list of string, optional) — 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. When 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. - `faxNumber` (string, optional) — Reserved for Docusign. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — 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: - `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. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — 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. - `lastName` (string, optional) — The recipient's last name. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The full legal name of the recipient. Maximum Length: 100 characters. **Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `note` (string, optional) — A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `recipientIdGuid` (string, optional) — 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. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `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. - `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. - `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. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group. - `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `socialAuthentications` (list of socialAuthentication, optional) — Deprecated. - `status` (string, optional) — The status of the recipient. This property is read-only. Valid values: - `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. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `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. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `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`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` (string, optional) — The total number of tabs in the documents. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### editor A complex type defining the management and access rights of a recipient assigned as an editor on the envelope. Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and text tabs for the remaining recipients. - `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — 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. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — 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. - `bulkSendV2Recipient` (string, optional) - `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If 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. If 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — 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. - `consentDetailsList` (list of consentDetails, optional) - `customFields` (list of string, optional) — 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. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) — 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.** - `email` (string, optional) — The recipient's email address. Notification of the document to sign is sent to this email address. Maximum length: 100 characters. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailRecipientPostSigningURL` (string, optional) - `embeddedRecipientStartURL` (string, optional) — 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. When `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. It 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. If 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. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `faxNumber` (string, optional) — Reserved for Docusign. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — 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: - `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. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — 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. - `lastName` (string, optional) — The recipient's last name. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The full legal name of the recipient. Maximum Length: 100 characters. **Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `note` (string, optional) — A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `recipientIdGuid` (string, optional) — 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. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `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. - `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. - `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. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group. - `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `socialAuthentications` (list of socialAuthentication, optional) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `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. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `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. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `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`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` (string, optional) — The total number of tabs in the documents. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### inPersonSigner Contains information about an in-person recipient. This is a Docusign user, acting as a Signing Host, who is in the same physical location as the signer. To learn about the fields used for the eNotary feature, see the [EnvelopeRecipients resource](/docs/esign-rest-api/reference/envelopes/enveloperecipients/#in-person-signer-recipient). - `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — 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. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoNavigation` (string, optional) — When **true,** autonavigation is set for the recipient. - `autoRespondedReason` (string, optional) — 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. - `bulkSendV2Recipient` (string, optional) - `canSignOffline` (string, optional) — When **true,** specifies that the signer can perform the signing ceremony offline. - `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If 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. If 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — Indicates the number of times that the recipient has been through a signing completion. If this number is greater than `0` for a signing group, only the user who previously completed may sign again. - `creationReason` (string, optional) — The reason why the recipient was created (for example, `sender`). This property is read-only. - `customFields` (list of string, optional) — 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. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `defaultRecipient` (string, optional) — When **true,** this is the default recipient for the envelope. This option is used when creating an envelope from a template. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) — 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.** - `email` (string, optional) — The signer's email address in an eNotary flow. Use only when `inPersonSigningType` is `notary`. For regular in-person-signer flow, use `signerEmail` instead. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `embeddedRecipientStartURL` (string, optional) — 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. When `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. It 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. If 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. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `excludedDocuments` (list of string, optional) — 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. When 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. - `faxNumber` (string, optional) — Reserved for Docusign. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `hostEmail` (string, optional) — The email address of the signing host. This is the Docusign user that is hosting the in-person signing session. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `email` instead. Maximum Length: 100 characters. - `hostEmailMetadata` (propertyMetadata, optional) — Metadata about a property. - `hostName` (string, optional) — The name of the signing host. This is the Docusign user that is hosting the in-person signing session. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `name` instead. Maximum Length: 100 characters. - `hostNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — 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: - `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. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — 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. - `inPersonSigningType` (string, optional) — Specifies whether the envelope uses the eNotary feature. Valid values: - `inPersonSigner`: The envelope uses the normal in-person signing flow. - `notary`: The envelope uses the eNotary in-person signing flow. - `inPersonSigningTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The signer's full legal name in an eNotary flow. Required when `inPersonSigningType` is `notary`. For a regular in-person-signer flow, use `signerName` instead. Maximum Length: 100 characters. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `notaryHost` (notaryHost, optional) — This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`. It describes information about the notary host. The following information is required when using the eNotary in-person signing flow: * `name`: Specifies the notary's full legal name. * `email`: Specifies the notary's email address. * `recipientId`: A unique ID number for the notary signing host. - `notaryId` (string, optional) - `note` (string, optional) — A note sent to the in-person signer in the signing email. This note is visible only to this recipient. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `offlineAttributes` (offlineAttributes, optional) — Reserved for Docusign. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `recipientIdGuid` (string, optional) — 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. - `recipientSignatureProviders` (list of recipientSignatureProvider, optional) — The default signature provider is the Docusign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) - `recipientSuppliesTabs` (string, optional) — When **true,** specifies that the recipient creates the tabs. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `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. - `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. - `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. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireSignerCertificate` (string, optional) — By default, Docusign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing. This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. Set this parameter to `safe` to use a SAFE-BioPharma certificate. The signer must be enrolled in the SAFE program to sign with a SAFE certificate. - `requireSignOnPaper` (string, optional) — When **true,** the signer must print, sign, and upload or fax the signed documents to Docusign. - `requireUploadSignature` (string, optional) — When **true,** the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal Docusign account. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signatureInfo` (recipientSignatureInformation, optional) — Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signerEmail` (string, optional) — The in-person signer's email address. Required when `inPersonSigningType` is `inPersonSigner`. For eNotary flow, use `email` instead. Maximum Length: 100 characters. - `signerEmailMetadata` (propertyMetadata, optional) — Metadata about a property. - `signerFirstName` (string, optional) — The signer's first name. - `signerFirstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `signerLastName` (string, optional) — The signer's last name. - `signerLastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `signerName` (string, optional) — Required. The full legal name of a signer for the envelope. Maximum Length: 100 characters. - `signerNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `signInEachLocation` (string, optional) — When **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). - `signInEachLocationMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupId` (string, optional) — Not applicable. You cannot use a signing group for an in-person signer. - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Not applicable. - `signingGroupType` (string, optional) - `signingGroupUsers` (list of userInfo, optional) — Not applicable. - `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `socialAuthentications` (list of socialAuthentication, optional) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `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. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `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. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `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`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` (string, optional) — The total number of tabs in the documents. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### intermediary Contains information about an intermediary recipient. An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added. - `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — 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. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — 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. - `bulkSendV2Recipient` (string, optional) - `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If 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. If 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — 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. - `consentDetailsList` (list of consentDetails, optional) - `customFields` (list of string, optional) — 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. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) — 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.** - `email` (string, optional) — The recipient's email address. Notification of the document to sign is sent to this email address. Maximum length: 100 characters. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailRecipientPostSigningURL` (string, optional) - `embeddedRecipientStartURL` (string, optional) — 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. When `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. It 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. If 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. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `excludedDocuments` (list of string, optional) — 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. When 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. - `faxNumber` (string, optional) — Reserved for Docusign. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — 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: - `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. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — 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. - `lastName` (string, optional) — The recipient's last name. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The full legal name of the recipient. Maximum Length: 100 characters. **Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `note` (string, optional) — A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `recipientIdGuid` (string, optional) — 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. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `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. - `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. - `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. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group. - `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `socialAuthentications` (list of socialAuthentication, optional) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `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. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `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. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `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`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` (string, optional) — The total number of tabs in the documents. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### notaryRecipient - `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — 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. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `agentCanEditEmail` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. - `agentCanEditName` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoNavigation` (string, optional) — When **true,** autonavigation is set for the recipient. - `autoRespondedReason` (string, optional) — 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. - `bulkRecipientsUri` (string, optional) — Reserved for Docusign. - `bulkSendV2Recipient` (string, optional) - `canNotaryCorrectEnvelope` (string, optional) - `canSignOffline` (string, optional) — When **true,** specifies that the signer can perform the signing ceremony offline. - `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If 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. If 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — 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. - `consentDetailsList` (list of consentDetails, optional) - `creationReason` (string, optional) — The reason why the item was created. - `customFields` (list of string, optional) — 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. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `defaultRecipient` (string, optional) — When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. - `delegatedBy` (delegationInfo, optional) - `delegatedTo` (list of delegationInfo, optional) - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) — 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.** - `email` (string, optional) — The recipient's email address. Notification of the document to sign is sent to this email address. Maximum length: 100 characters. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailRecipientPostSigningURL` (string, optional) - `embeddedRecipientStartURL` (string, optional) — 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. When `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. It 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. If 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. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `excludedDocuments` (list of string, optional) — 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. When 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. - `faxNumber` (string, optional) — Reserved for Docusign. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — 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: - `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. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — 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. - `isBulkRecipient` (string, optional) — Reserved for Docusign. - `isBulkRecipientMetadata` (propertyMetadata, optional) — Metadata about a property. - `lastName` (string, optional) — The user's last name. Maximum Length: 50 characters. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `liveOakStartURL` (string, optional) — URL that directs the recipient to LiveOak to complete the remote online notarization process. This property is read-only. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The full legal name of the recipient. Maximum length: 100 characters. Note: You must always set a value for this property in requests, even if `firstName` and `lastName` are set. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `notaryId` (string, optional) — Not applicable to Notary tab. - `notarySignerEmailSent` (string, optional) - `notarySigners` (list of string, optional) — An array of strings that correspond to the `recipientId` of each signer in the notary group. This property is read-only. - `notarySourceType` (string, optional) — Valid values: - `firstparty`: Set this value if using the [remote online notary](/docs/notary-api/how-to/send-signature-request-notary-group/) (RON) feature. - `thirdparty`: Set this value if using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature. - `notaryThirdPartyPartner` (string, optional) — Set this value to `onenotary` if using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature. - `notaryType` (string, optional) — Set this value to `remote` if using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature. - `note` (string, optional) — A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `offlineAttributes` (offlineAttributes, optional) — Reserved for Docusign. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `recipientIdGuid` (string, optional) — 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. - `recipientSignatureProviders` (list of recipientSignatureProvider, optional) — The default signature provider is the Docusign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) - `recipientSuppliesTabs` (string, optional) — When **true,** specifies that the recipient creates the tabs. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `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. - `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. - `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. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireSignerCertificate` (string, optional) — By default, Docusign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing. This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. Set this parameter to `safe` to use a SAFE-BioPharma certificate. The signer must be enrolled in the SAFE program to sign with a SAFE certificate. - `requireSignOnPaper` (string, optional) — When **true,** the signer must print, sign, and upload or fax the signed documents to Docusign. - `requireUploadSignature` (string, optional) — When **true,** the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal Docusign account. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signatureInfo` (recipientSignatureInformation, optional) — Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signInEachLocation` (string, optional) — When **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). - `signInEachLocationMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group. - `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `socialAuthentications` (list of socialAuthentication, optional) — Deprecated. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusCode` (string, optional) — Reserved for Docusign. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` (string, optional) — The total number of tabs in the documents. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### notaryWitness - `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. - `additionalNotifications` (list of recipientAdditionalNotification, optional) - `agentCanEditEmail` (string, optional) - `agentCanEditName` (string, optional) - `allowSystemOverrideForLockedRecipient` (string, optional) - `autoNavigation` (string, optional) - `autoRespondedReason` (string, optional) - `bulkRecipientsUri` (string, optional) — Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. - `bulkSendV2Recipient` (string, optional) - `canSignOffline` (string, optional) — When set to **true**, specifies that the signer can perform the signing ceremony offline. - `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if 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.ng. Maximum length: 100 characters. - `completedCount` (string, optional) - `consentDetailsList` (list of consentDetails, optional) - `creationReason` (string, optional) - `customFields` (list of string, optional) — 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. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. - `declinedReason` (string, optional) — The reason the recipient declined the document. - `defaultRecipient` (string, optional) - `delegatedBy` (delegationInfo, optional) - `delegatedTo` (list of delegationInfo, optional) - `deliveredDateTime` (string, optional) — Reserved: For DocuSign use only. - `deliveryMethod` (string, optional) — Reserved: For DocuSign use only. - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) - `designatorIdGuid` (string, optional) - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) - `email` (string, optional) - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailRecipientPostSigningURL` (string, optional) - `embeddedRecipientStartURL` (string, optional) — 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. If set to `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 that is launched by any partner. It is important to remember 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 process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in 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. If 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 fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `excludedDocuments` (list of string, optional) — 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. When 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. - `faxNumber` (string, optional) — Reserved: - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and 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 '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — When set to **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. - `isBulkRecipient` (string, optional) - `isBulkRecipientMetadata` (propertyMetadata, optional) — Metadata about a property. - `lastName` (string, optional) - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) - `lockedRecipientSmsEditable` (string, optional) - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `notaryId` (string, optional) - `notarySignerEmailSent` (string, optional) - `note` (string, optional) — Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `offlineAttributes` (offlineAttributes, optional) — Reserved for Docusign. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved: - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `recipientIdGuid` (string, optional) - `recipientSignatureProviders` (list of recipientSignatureProvider, optional) - `recipientSuppliesTabs` (string, optional) - `recipientType` (string, optional) - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireSignerCertificate` (string, optional) - `requireSignOnPaper` (string, optional) - `requireUploadSignature` (string, optional) - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient.This is required when working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The date and time the envelope was sent. - `signatureInfo` (recipientSignatureInformation, optional) — Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. - `signedDateTime` (string, optional) — Reserved: For DocuSign use only. - `signInEachLocation` (string, optional) — When set to **true**, specifies that the signer must sign in all locations. - `signInEachLocationMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupId` (string, optional) — When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — The display name for the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group. - `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `socialAuthentications` (list of socialAuthentication, optional) — Lists the social ID type that can be used for recipient authentication. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusCode` (string, optional) - `suppressEmails` (string, optional) - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` (string, optional) - `type` (string, optional) - `userId` (string, optional) - `webFormRecipientViewId` (string, optional) - `witnessFor` (string, optional) - `witnessForGuid` (string, optional) ### participant - `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — 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. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — 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. - `bulkSendV2Recipient` (string, optional) - `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If 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. If 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — 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. - `consentDetailsList` (list of consentDetails, optional) - `customFields` (list of string, optional) — An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each string can be a maximum of 100 characters. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) — 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.** - `email` (string, optional) - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailRecipientPostSigningURL` (string, optional) - `embeddedRecipientStartURL` (string, optional) — 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. When `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. It 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. If 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. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `faxNumber` (string, optional) — Reserved for Docusign. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The user's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — 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: - `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. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — 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. - `lastName` (string, optional) — The user's last name. Maximum Length: 50 characters. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `note` (string, optional) — A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `participateFor` (string, optional) - `participateForGuid` (string, optional) - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `recipientIdGuid` (string, optional) — 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. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `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. - `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. - `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. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group. - `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `socialAuthentications` (list of socialAuthentication, optional) — Deprecated. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusCode` (string, optional) — Reserved for Docusign. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` (string, optional) — The total number of tabs in the documents. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### sealSign Specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow. Example: ```text "recipients": { "seals": [ { "recipientId": "1", "routingOrder" : 1, "recipientSignatureProviders": [ { "sealName": "52e9d968-xxxx-xxxx-xxxx-4682bc45c106" } ] } ] }, . . . ``` For more information about Electronic Seals, see [Apply Electronic Seals to Your Documents](https://support.docusign.com/s/document-item?bundleId=xcm1643837555908\&topicId=isl1578456577247.html). - `accessCode` (string, optional) — Not applicable. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — Not applicable. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — 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. - `bulkSendV2Recipient` (string, optional) - `clientUserId` (string, optional) — Not applicable. - `completedCount` (string, optional) — Not applicable. - `customFields` (list of string, optional) — Not applicable. - `declinedDateTime` (string, optional) — Not applicable. - `declinedReason` (string, optional) — Not applicable. - `deliveredDateTime` (string, optional) — Not applicable. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) — Not applicable. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `embeddedRecipientStartURL` (string, optional) — Not applicable. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `faxNumber` (string, optional) — Reserved for Docusign. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — Not applicable. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — Not applicable. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) — Not applicable. - `note` (string, optional) — Not applicable. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Not applicable. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `recipientIdGuid` (string, optional) — 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. - `recipientSignatureProviders` (list of recipientSignatureProvider, optional) — (Required) Indicates which electronic seal to apply on documents when creating an envelope. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `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. - `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. - `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. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — Not applicable. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — (Optional, default: 1) Specifies the routing order of the electronic seal in the envelope. The routing order assigned to your electronic seal cannot be shared with another recipient. It is recommended that you set a routing order for your electronic seals. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — Not applicable. - `signedDateTime` (string, optional) — Not applicable. - `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `socialAuthentications` (list of socialAuthentication, optional) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `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. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `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. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `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`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — Not applicable. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` (string, optional) — Not applicable. - `userId` (string, optional) — Not applicable. - `webFormRecipientViewId` (string, optional) ### signer A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document. - `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — 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. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `agentCanEditEmail` (string, optional) — Optional element. When **true,** the agent recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. - `agentCanEditName` (string, optional) — Optional. When **true,** the agent recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoNavigation` (string, optional) — When **true,** autonavigation is set for the recipient. - `autoRespondedReason` (string, optional) — 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. - `bulkRecipientsUri` (string, optional) — Reserved for Docusign. - `bulkSendV2Recipient` (string, optional) - `canSignOffline` (string, optional) — When **true,** specifies that the signer can perform the signing ceremony offline. - `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If 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. If 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — 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. - `consentDetailsList` (list of consentDetails, optional) - `creationReason` (string, optional) — The reason why the item was created. - `customFields` (list of string, optional) — 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 recipient may be assigned a maximum of 3 custom fields, and each customField string can be a maximum of 100 characters. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `defaultRecipient` (string, optional) — When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. - `delegatedBy` (delegationInfo, optional) - `delegatedTo` (list of delegationInfo, optional) - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) — 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.** - `email` (string, optional) — The recipient's email address. The system sends notifications about the documents to sign to this address. Maximum length: 100 characters. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailRecipientPostSigningURL` (string, optional) - `embeddedRecipientStartURL` (string, optional) — 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. When `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. It 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. If 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. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `excludedDocuments` (list of string, optional) — Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account to use this. When 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. - `faxNumber` (string, optional) — Reserved for Docusign. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — 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: - `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. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — 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. - `isBulkRecipient` (string, optional) — When **true,** this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. Note that when this is true the email and name for the recipient becomes [bulk@recipient.com](mailto:bulk@recipient.com) and "Bulk Recipient". These fields can not be changed for the bulk recipient. - `isBulkRecipientMetadata` (propertyMetadata, optional) — Metadata about a property. - `lastName` (string, optional) — The recipient's last name. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The full legal name of the recipient. Maximum Length: 100 characters. **Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `notaryId` (string, optional) — The `recipientId` of the notary for this signer. - `notarySignerEmailSent` (string, optional) - `note` (string, optional) — A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `offlineAttributes` (offlineAttributes, optional) — Reserved for Docusign. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `recipientIdGuid` (string, optional) — 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. - `recipientSignatureProviders` (list of recipientSignatureProvider, optional) — The default signature provider is the Docusign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) - `recipientSuppliesTabs` (string, optional) — When **true,** specifies that the recipient creates the tabs. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `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. - `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. - `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. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireSignerCertificate` (string, optional) — Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. Valid values: - `docusign_express`: Requires a Docusign Express certificate. - `safe`: Requires a SAFE-BioPharma certificate. - `open_trust`: Requires an OpenTrust certificate. **Important:** There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information. - `requireSignOnPaper` (string, optional) — When **true,** the signer must print, sign, and upload or fax the signed documents to Docusign. - `requireUploadSignature` (string, optional) — When **true,** the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal Docusign account. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signatureInfo` (recipientSignatureInformation, optional) — Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signInEachLocation` (string, optional) — When **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). - `signInEachLocationMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group. - `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `socialAuthentications` (list of socialAuthentication, optional) — Deprecated. - `status` (string, optional) — Specifies the status of the recipient at the time of the request. This property is read-only. Possible values are: - `created`: The recipient is in a draft state. This is only associated with draft envelopes (envelopes with a created status). - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `delivered`: The recipient has viewed the documents in an envelope through the Docusign signing web site. This is not an email delivery of the documents in an envelope. - `signed`; The recipient has completed (performed all required interactions, such as signing or entering data) all required tags in an envelope. This is a temporary state during processing, after which the recipient is automatically moved to completed. - `declined`: The recipient declined to sign the documents in the envelope. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `faxpending`: The recipient has finished signing and the system is waiting a fax attachment by the recipient before completing their signing step. - `autoresponded`: The recipient's email system auto-responded to the email from Docusign. This status is used by the Docusign webapp (also known as the Docusign console) to inform senders about the auto-responded email. - `statusCode` (string, optional) — Reserved for Docusign. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` (string, optional) — The total number of tabs in the documents. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### witness A complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — 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. - `additionalNotifications` (list of recipientAdditionalNotification, optional) — An array of additional notification objects. - `agentCanEditEmail` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. - `agentCanEditName` (string, optional) — Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoNavigation` (string, optional) — When **true,** autonavigation is set for the recipient. - `autoRespondedReason` (string, optional) — 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. - `bulkRecipientsUri` (string, optional) — Reserved for Docusign. - `bulkSendV2Recipient` (string, optional) - `canSignOffline` (string, optional) — When **true,** specifies that the signer can perform the signing ceremony offline. - `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If 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. If 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — 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. - `consentDetailsList` (list of consentDetails, optional) - `creationReason` (string, optional) — The reason why the recipient was created (for example, `sender`). This property is read-only. - `customFields` (list of string, optional) — 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. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `defaultRecipient` (string, optional) — When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. - `delegatedBy` (delegationInfo, optional) - `delegatedTo` (list of delegationInfo, optional) - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) — 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.** - `email` (string, optional) — The recipient's email address. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailRecipientPostSigningURL` (string, optional) - `embeddedRecipientStartURL` (string, optional) — 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. When `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. It 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. If 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. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `excludedDocuments` (list of string, optional) — 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. When 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. - `faxNumber` (string, optional) — Reserved for Docusign. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `firstName` (string, optional) — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `fullName` (string, optional) — Reserved for Docusign. - `fullNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckConfigurationName` (string, optional) — 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: - `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. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — 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. - `isBulkRecipient` (string, optional) — Reserved for Docusign. - `isBulkRecipientMetadata` (propertyMetadata, optional) — Metadata about a property. - `lastName` (string, optional) — The recipient's last name. - `lastNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The full legal name of the recipient. Maximum Length: 100 characters. **Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `notaryId` (string, optional) - `notarySignerEmailSent` (string, optional) - `note` (string, optional) — A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `offlineAttributes` (offlineAttributes, optional) — Reserved for Docusign. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `recipientIdGuid` (string, optional) — 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. - `recipientSignatureProviders` (list of recipientSignatureProvider, optional) — The default signature provider is the Docusign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) - `recipientSuppliesTabs` (string, optional) — When **true,** specifies that the recipient creates the tabs. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `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. - `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. - `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. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireSignerCertificate` (string, optional) — By default, Docusign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing. This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. Set this parameter to `safe` to use a SAFE-BioPharma certificate. The signer must be enrolled in the SAFE program to sign with a SAFE certificate. - `requireSignOnPaper` (string, optional) — When **true,** the signer must print, sign, and upload or fax the signed documents to Docusign. - `requireUploadSignature` (string, optional) — When **true,** the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal Docusign account. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signatureInfo` (recipientSignatureInformation, optional) — Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signInEachLocation` (string, optional) — When **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). - `signInEachLocationMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` (string, optional) - `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group. - `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `socialAuthentications` (list of socialAuthentication, optional) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `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. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `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. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `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`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` (string, optional) — The total number of tabs in the documents. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) - `witnessFor` (string, optional) — The `recipientId` of the person or party for whom the recipient is a witness. - `witnessForGuid` (string, optional) — Not used. Use the `witnessFor` property instead. ### propertyMetadata Metadata about a property. - `options` (list of string, optional) — An array of option strings supported by this setting. - `rights` (string, optional) — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` ### recipientAdditionalNotification Describes an additional notification method. - `phoneNumber` (recipientPhoneNumber, optional) — Describes the recipient phone number. - `secondaryDeliveryMethod` (string, optional) — The secondary delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `secondaryDeliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `secondaryDeliveryStatus` (string, optional) — The status of the delivery. This property is read-only. One of: - `autoresponded` - `optedout` - `limitreached` ### consentDetails - `consentKey` (string, optional) - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `signerConsentStatus` (string, optional) ### documentVisibility This object configures a recipient's read/write access to a document. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `recipientId` (string, optional) — The ID of the recipient to whom the document visibility setting is applied. This value should match the `recipientId` defined in the recipient object. - `rights` (string, optional) — Indicates whether the document is editable: - `editable` - `read_only` - `visible` (string, optional) — When **true,** the document is visible to the recipient. ### recipientEmailNotification Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailBody` (string, optional) — The body of the email message. - `emailBodyMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailSubject` (string, optional) — The subject line for the email notification. - `emailSubjectMetadata` (propertyMetadata, optional) — Metadata about a property. - `supportedLanguage` (string, optional) — The language to use for the standard email format and signing view for a recipient. For example, this setting determines the language of the recipient's email notification message. It also determines the language used for buttons and tabs in both the email notification and the signing experience. **Note:** This setting affects only Docusign standard text. Any custom text that you enter for the `emailBody` and `emailSubject` of the notification is not translated, and appears exactly as you enter it. To retrieve the possible values, use the [Accounts::listSupportedLanguages](/docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/) method. - `supportedLanguageMetadata` (propertyMetadata, optional) — Metadata about a property. ### idCheckInformationInput A complex element that contains input information related to a recipient ID check. - `addressInformationInput` (addressInformationInput, optional) — Contains address input information. - `dobInformationInput` (dobInformationInput, optional) — Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse - `ssn4InformationInput` (ssn4InformationInput, optional) - `ssn9InformationInput` (ssn9InformationInput, optional) ### recipientIdentityVerification Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `hasAutoAttachedRiskAssessment` (string, optional) - `inputOptions` (list of recipientIdentityInputOption, optional) - `workflowId` (string, optional) — ID of the Identity Verification worklow used to verify recipients' identity. This ID must match one of the [workflowId](/docs/esign-rest-api/reference/accounts/identityverifications/list/) available to your account. - `workflowIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `workflowLabel` (string, optional) ### recipientPhoneAuthentication A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `recipMayProvideNumber` (string, optional) — Boolean. When **true,** the recipient can supply a phone number their choice. - `recipMayProvideNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recordVoicePrint` (string, optional) — Reserved for Docusign. - `recordVoicePrintMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderProvidedNumbers` (list of string, optional) — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` (propertyMetadata, optional) — Metadata about a property. - `validateRecipProvidedNumber` (string, optional) — Reserved for Docusign. - `validateRecipProvidedNumberMetadata` (propertyMetadata, optional) — Metadata about a property. ### recipientPhoneNumber Describes the recipient phone number. - `countryCode` (string, optional) — The numeric country calling code for `number`. For example, the country calling code for the US and Canada is `1`, for the UK: `44`, Do not include the `+` symbol. - `countryCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `number` (string, optional) — The telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters. Do not include the `countryCode`. For US, Canada, and other [North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`. - `numberMetadata` (propertyMetadata, optional) — Metadata about a property. ### recipientProofFile The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `hasIdentityAttempts` (string, optional) - `isInProofFile` (string, optional) — Indicates whether a proof file is available for this recipient. ### recipientAttachment - `attachmentId` (string, optional) — The unique identifier for the attachment. - `attachmentType` (string, optional) — Specifies the type of the attachment for the recipient. Possible values are: - `.htm` - `.xml` - `data` (string, optional) — A Base64-encoded representation of the attachment that is used to upload and download the file. File attachments may be up to 50 MB in size. - `label` (string, optional) — An optional label for the attachment. - `name` (string, optional) — The name of the attachment. - `remoteUrl` (string, optional) — The URL of a previously staged chunked upload. Using a chunked upload enables you to stage a large, chunkable temp file. You then use the `remoteUrl` property to reference the chunked upload as the content in attachment and document-related requests. The `remoteUrl` property cannot be used for downloads. ### authenticationStatus A complex element that contains information about a user's authentication status. - `accessCodeResult` (eventResult, optional) — Information about the result of an event. - `ageVerifyResult` (eventResult, optional) — Information about the result of an event. - `anySocialIDResult` (eventResult, optional) — Information about the result of an event. - `facebookResult` (eventResult, optional) — Information about the result of an event. - `googleResult` (eventResult, optional) — Information about the result of an event. - `identityVerificationResult` (eventResult, optional) — Information about the result of an event. - `idLookupResult` (eventResult, optional) — Information about the result of an event. - `idQuestionsResult` (eventResult, optional) — Information about the result of an event. - `linkedinResult` (eventResult, optional) — Information about the result of an event. - `liveIDResult` (eventResult, optional) — Information about the result of an event. - `ofacResult` (eventResult, optional) — Information about the result of an event. - `openIDResult` (eventResult, optional) — Information about the result of an event. - `phoneAuthResult` (eventResult, optional) — Information about the result of an event. - `salesforceResult` (eventResult, optional) — Information about the result of an event. - `signatureProviderResult` (eventResult, optional) — Information about the result of an event. - `smsAuthResult` (eventResult, optional) — Information about the result of an event. - `sTANPinResult` (eventResult, optional) — Information about the result of an event. - `twitterResult` (eventResult, optional) — Information about the result of an event. - `yahooResult` (eventResult, optional) — Information about the result of an event. ### featureAvailableMetadata - `availabilty` (string, optional) - `featureName` (string, optional) ### recipientSMSAuthentication Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `senderProvidedNumbers` (list of string, optional) — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` (propertyMetadata, optional) — Metadata about a property. ### socialAuthentication - `authentication` (string, optional) — Reserved for Docusign. ### delegationInfo - `email` (string, optional) - `name` (string, optional) - `userAuthorizationId` (string, optional) - `userId` (string, optional) ### offlineAttributes Reserved for Docusign. - `accountEsignId` (string, optional) — Reserved for Docusign. - `deviceModel` (string, optional) — Reserved for Docusign. - `deviceName` (string, optional) — Reserved for Docusign. - `gpsLatitude` (string, optional) — Reserved for Docusign. - `gpsLongitude` (string, optional) — Reserved for Docusign. - `offlineSigningHash` (string, optional) — Reserved for Docusign. ### recipientSignatureProvider An Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/). - `sealDocumentsWithTabsOnly` (string, optional) — By default, electronic seals apply on all documents in an envelope. If any of the documents has a `signHere` tab, then a visual representation of the electronic seal will show up in the final document. If not, the electronic seal will be visible in the metadata but not in the content of the document. To apply electronic seals on specific documents only, you must enable the `sealDocumentsWithTabsOnly` parameter. In this case, Electronic Seal applies only on documents that have `signHere` tabs set for the Electronic Seal recipient. Other documents won't be sealed. If using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature, set this value to `false` for the notary recipient, and set it to `false` or omit it for the signer recipient. - `sealName` (string, optional) — Indicates the name of the electronic seal to apply on documents. - `signatureProviderName` (string, optional) — The name of an Electronic or Standards Based Signature (digital signature) provider for the signer to use. For details, see [the current provider list](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/). You can also retrieve the list by using the [AccountSignatureProviders: List](/docs/esign-rest-api/reference/accounts/accountsignatureproviders/list/) method. Example: `universalsignaturepen_default` If using the [Notary On-Demand](/docs/notary-api/notary101/notary-on-demand/) feature, set this value to `ds_authority_idv` for the notary recipient, and set it to `universalsignaturepen_imageonly` or omit it for the signer recipient. - `signatureProviderNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `signatureProviderOptions` (recipientSignatureProviderOptions, optional) — Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) ### recipientSignatureInformation Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. - `fontStyle` (string, optional) — 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`. - `"1_DocuSign"` - `"2_DocuSign"` - `"3_DocuSign"` - `"4_DocuSign"` - `"5_DocuSign"` - `"6_DocuSign"` - `"7_DocuSign"` - `"8_DocuSign"` - `"Mistral"` - `"Rage Italic"` - `signatureInitials` (string, optional) — Specifies the user's signature in initials format. - `signatureName` (string, optional) — Specifies the user's signature name. ### tabs Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `approveTabs` (list of approve, optional) — A list of [Approve tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Approve tab enables the recipient to approve documents without placing a signature or initials on the document. If the recipient clicks the tab during the signing process, the recipient is considered to have signed the document. No information is shown on the document of the approval, but it is recorded as a signature in the envelope history. The value of an approve tab can't be set. - `checkboxTabs` (list of checkbox, optional) — A list of [Checkbox tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. - `commentThreadTabs` (list of commentThread, optional) — An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set. - `commissionCountyTabs` (list of commissionCounty, optional) — A list of [Commission County tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission County tab displays the county of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `commissionExpirationTabs` (list of commissionExpiration, optional) — A list of [Commission Expiration tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `commissionNumberTabs` (list of commissionNumber, optional) — A list of [Commission Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `commissionStateTabs` (list of commissionState, optional) — A list of [Commission State tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). The tab's value can be edited by the recipient. - `companyTabs` (list of company, optional) — A list of [Company tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company). A Company tab displays a field for the name of the recipient's company. This value can't be set. - `dateSignedTabs` (list of dateSigned, optional) — A list of [Date Signed tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Date Signed tab displays the date that the recipient signed the document. This value can't be set. - `dateTabs` (list of date, optional) — A list of [Date tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters. **Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message. - `declineTabs` (list of decline, optional) — A list of [Decline tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set. - `drawTabs` (list of draw, optional) — A list of Draw Tabs. A Draw Tab allows the recipient to add a free-form drawing to the document. - `emailAddressTabs` (list of emailAddress, optional) — A list of [Email Address tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set. - `emailTabs` (list of email, optional) — A list of [Email tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Email tab enables the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. This value can be set. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. - `envelopeIdTabs` (list of envelopeId, optional) — A list of [Envelope ID tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid). An Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set. - `firstNameTabs` (list of firstName, optional) — A list of [First Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname). A First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. - `formulaTabs` (list of formulaTab, optional) — A list of [Formula tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). The value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set. The `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html). If a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures](https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html). - `fullNameTabs` (list of fullName, optional) — A list of [Full Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Full Name tab displays the recipient's full name. This value can't be set. - `initialHereTabs` (list of initialHere, optional) — A list of [Initial Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to initial the document. May be optional. This value can't be set. - `lastNameTabs` (list of lastName, optional) — A list of [Last Name tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. - `listTabs` (list of list, optional) — An array of List tabs. A List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). - `notarizeTabs` (list of notarize, optional) — A list of [Notarize tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Notarize tab alerts notary recipients that they must take action on the page. This value can be set. **Note:** Only one notarize tab can appear on a page. - `notarySealTabs` (list of notarySeal, optional) — A list of Notary Seal tabs. A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). - `noteTabs` (list of note, optional) — A list of [Note tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Note tab displays additional information to the recipient in the form of a note. This value can be set. - `numberTabs` (list of number, optional) — A list of Number tabs. Number tabs validate that the entered value is a number. They do not support advanced validation or display options. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about number tabs see [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs). - `numericalTabs` (list of numerical, optional) — A list of numerical tabs. Numerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about numerical tabs see [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs). - `phoneNumberTabs` (list of phoneNumber, optional) — A list of [Phone Number tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Phone Number tab enables a recipient to enter a phone number. **Note:** This tab can only be assigned to a remote notary recipient using [Docusign Notary](/docs/notary-api/). - `polyLineOverlayTabs` (list of polyLineOverlay, optional) — This type of tab enables the recipient to strike through document text. This value can't be set. - `prefillTabs` (prefillTabs, optional) — Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. Only the following tab types can be prefill tabs: - text - check boxes - radio buttons [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields - `radioGroupTabs` (list of radioGroup, optional) — A list of [Radio Group tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. - `signerAttachmentTabs` (list of signerAttachment, optional) — A list of [Signer Attachment tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set. - `signHereTabs` (list of signHere, optional) — A list of [Sign Here tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). This type of tab enables the recipient to sign a document. May be optional. This value can't be set. - `smartSectionTabs` (list of smartSection, optional) — A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs. Smart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality. **Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account. - `ssnTabs` (list of ssn, optional) — A list of [SSN tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. - `tabGroups` (list of tabGroup, optional) — An array of `tabGroup` items. To associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array. - `textTabs` (list of text, optional) — A list of Text tabs. A text tab enables the recipient to enter free text. This value can be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). - `titleTabs` (list of title, optional) — A list of [Title tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Title tab displays the recipient's title. This value can't be set. - `viewTabs` (list of view, optional) — A list of [View tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A View tab is used with an Approve tab to handle supplemental documents. This value can be set. - `zipTabs` (list of zip, optional) — A list of [Zip tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. ### notaryHost This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`. It describes information about the notary host. The following information is required when using the eNotary in-person signing flow: * `name`: Specifies the notary's full legal name. * `email`: Specifies the notary's email address. * `recipientId`: A unique ID number for the notary signing host. - `accessCode` (string, optional) — If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. - `accessCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `addAccessCodeToEmail` (string, optional) — 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. - `allowSystemOverrideForLockedRecipient` (string, optional) — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` (string, optional) — 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. - `bulkSendV2Recipient` (string, optional) - `clientUserId` (string, optional) — Specifies whether the recipient is embedded or remote. If 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. If 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. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. - `completedCount` (string, optional) — 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. - `customFields` (list of string, optional) — 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. - `declinedDateTime` (string, optional) — The date and time the recipient declined the document. This property is read-only. - `declinedReason` (string, optional) — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` (string, optional) — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` (string, optional) — The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API](/docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/) - [How to request a signature by SMS or WhatsApp delivery](/docs/esign-rest-api/how-to/request-signature-sms-whatsapp/) - `deliveryMethodMetadata` (propertyMetadata, optional) — Metadata about a property. - `designatorId` (string, optional) — Reserved for Docusign. - `designatorIdGuid` (string, optional) — Reserved for Docusign. - `documentTemplateId` (string, optional) - `documentVisibility` (list of documentVisibility, optional) — 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.** - `email` (string, optional) — The notary's email address. Maximum Length: 100 characters. - `emailMetadata` (propertyMetadata, optional) — Metadata about a property. - `emailNotification` (recipientEmailNotification, optional) — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `embeddedRecipientStartURL` (string, optional) — 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. When `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. It 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. If 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. _Example_: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `faxNumber` (string, optional) — Reserved for Docusign. - `faxNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `hostRecipientId` (string, optional) — The host recipient ID. - `idCheckConfigurationName` (string, optional) — 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: - `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. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **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. - `idCheckConfigurationNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `idCheckInformationInput` (idCheckInformationInput, optional) — A complex element that contains input information related to a recipient ID check. - `identityVerification` (recipientIdentityVerification, optional) — Specifies ID Verification applied on an envelope by workflow ID. See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. - `inheritEmailNotificationConfiguration` (string, optional) — 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. - `lockedRecipientPhoneAuthEditable` (string, optional) — Reserved for Docusign. - `lockedRecipientSmsEditable` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The notary's full legal name. Maximum Length: 100 characters. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `note` (string, optional) — A note sent to the notary in the signing email. This note is visible only to this notary. Maximum Length: 1000 characters. - `noteMetadata` (propertyMetadata, optional) — Metadata about a property. - `phoneAuthentication` (recipientPhoneAuthentication, optional) — A complex type that contains the elements: - `recipMayProvideNumber`: A Boolean value that specifies whether the recipient can use the phone number of their choice. - `senderProvidedNumbers`: A list of phone numbers that the recipient can use. - `recordVoicePrint`: Reserved for Docusign. - `validateRecipProvidedNumber`: Reserved for Docusign. - `proofFile` (recipientProofFile, optional) — The proof file of the recipient. [ID Evidence](/docs/idevidence-api/) uses proof files to store the identification data that recipients submit when verifying their ID with [ID Verification](/docs/esign-rest-api/esign101/concepts/documents/) - `recipientAttachments` (list of recipientAttachment, optional) — Reserved for Docusign. - `recipientAuthenticationStatus` (authenticationStatus, optional) — A complex element that contains information about a user's authentication status. - `recipientFeatureMetadata` (list of featureAvailableMetadata, optional) — Metadata about the features that are supported for the recipient type. This property is read-only. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `recipientIdGuid` (string, optional) — 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. - `recipientType` (string, optional) — The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `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. - `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. - `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. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. - `recipientTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireIdLookup` (string, optional) — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` (propertyMetadata, optional) — Metadata about a property. - `roleName` (string, optional) — Optional element. Specifies the role name associated with the recipient. This property is required when you are working with template recipients. - `routingOrder` (string, optional) — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `sentDateTime` (string, optional) — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` (string, optional) — Reserved for Docusign. - `signingGroupId` (string, optional) — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupUsers` (list of userInfo, optional) — A complex type that contains information about users in the signing group. - `smsAuthentication` (recipientSMSAuthentication, optional) — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `socialAuthentications` (list of socialAuthentication, optional) — Deprecated. - `status` (string, optional) — The recipient's status. This property is read-only. Valid values: - `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. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `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. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `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`. - `statusCode` (string, optional) — The code associated with the recipient's status. This property is read-only. - `suppressEmails` (string, optional) — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` (tabs, optional) — Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` (string, optional) — The total number of tabs in the documents. This property is read-only. - `userId` (string, optional) — The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. - `webFormRecipientViewId` (string, optional) ### addressInformationInput Contains address input information. - `addressInformation` (addressInformation, optional) — Contains address information. - `displayLevelCode` (string, optional) — Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay - `receiveInResponse` (string, optional) — A Boolean value that specifies whether the information must be returned in the response. ### dobInformationInput Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse - `dateOfBirth` (string, optional) — Specifies the recipient's date, month, and year of birth. - `displayLevelCode` (string, optional) — Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay - `receiveInResponse` (string, optional) — A Boolean value that specifies whether the information must be returned in the response. ### ssn4InformationInput - `displayLevelCode` (string, optional) — Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay - `receiveInResponse` (string, optional) — A Boolean value that specifies whether the information must be returned in the response. - `ssn4` (string, optional) — The last four digits of the recipient's Social Security Number (SSN). ### ssn9InformationInput - `displayLevelCode` (string, optional) — Specifies the display level for the recipient. Valid values are: * ReadOnly * Editable * DoNotDisplay - `ssn9` (string, optional) — The recipient's full Social Security Number (SSN). ### recipientIdentityInputOption - `name` (string, optional) - `phoneNumberList` (list of recipientIdentityPhoneNumber, optional) - `stringValue` (string, optional) - `valueType` (string, optional) ### eventResult Information about the result of an event. - `eventTimestamp` (string, optional) — Date/time of the event. - `failureDescription` (string, optional) — Reason for failure, if the event failed. - `status` (string, optional) — Event status. - `vendorFailureStatusCode` (string, optional) — Failure status code, if the event failed. ### recipientSignatureProviderOptions Option settings for the signature provider. Different providers require or use different options. [The current provider list and the options they require.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) - `cpfNumber` (string, optional) — Reserved for Docusign. - `cpfNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `oneTimePassword` (string, optional) — A pre-shared secret that the signer must enter to complete the signing process. Eg last six digits of the signer's government ID or Social Security number. Or a newly created pre-shared secret for the transaction. Note: some signature providers may require an exact (case-sensitive) match if alphabetic characters are included in the field. - `oneTimePasswordMetadata` (propertyMetadata, optional) — Metadata about a property. - `signerRole` (string, optional) — The role or capacity of the signing recipient. Examples: Manager, Approver, etc. - `signerRoleMetadata` (propertyMetadata, optional) — Metadata about a property. - `sms` (string, optional) — The mobile phone number used to send the recipient an access code for the signing ceremony. Format: a string starting with +, then the country code followed by the full mobile phone number without any spaces or special characters. Omit leading zeroes before a city code. Examples: +14155551234, +97235551234, +33505551234. - `smsMetadata` (propertyMetadata, optional) — Metadata about a property. ### approve A tab that allows the recipient to approve documents without placing a signature or initials on the document. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `buttonText` (string, optional) — Specifies the approval text that displays in the tab. - `buttonTextMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The Docusign-generated custom tab ID for the custom tab to be applied. You can only use this when adding new tabs for a recipient. When used, the new tab inherits all of the properties of the custom tab. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — **Note:** Approve tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### checkbox A tab that allows the recipient to select a yes/no (on/off) option. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The Docusign-generated custom tab ID for the custom tab to apply. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — This property does not apply to `checkbox` tabs. To require users to check at least one, or at most some number of checkboxes, associate the checkbox tabs with a [`tabGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups). Then set the following `tabGroup` properties: - [`maximumAllowed`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_maximumallowed) - [`minimumRequired`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_minimumrequired) - [`groupRule`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_grouprule) specifies how the other two properties are interpreted. You can find an example at [Stack Overflow](https://stackoverflow.com/questions/58209376/checkbox-validation-using-docusign-rest-api/58210277#58210277). - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `selected` (string, optional) — When **true,** the checkbox is selected. - `selectedMetadata` (propertyMetadata, optional) — Metadata about a property. - `selectedOriginal` (string, optional) - `selectedOriginalMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-7, -6) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commentThread - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `comments` (list of comment, optional) — An array of comment tabs that contain information about users' comments on documents. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `threadId` (string, optional) — The unique identifier for the comment thread. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commissionCounty A Commission County tab displays the county of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](/docs/notary-api/). - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commissionExpiration A Commission Expiration tab displays the expiration date of a notary's commission. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary](/docs/notary-api/). - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commissionNumber A Commission Number tab displays a notary's commission number. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### commissionState A Commission State tab displays the state in which a notary's commission was granted. The tab is populated with the notary's commission information, but the recipient can also edit the value when notarizing. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### company A tab that displays the recipient's company name. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### dateSigned A tab that displays the date that the recipient signed the document. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `timestampStandardized` (string, optional) - `tooltip` (string, optional) — **Note:** Date Signed tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### date A tab that allows the recipient to enter a date. Date tabs are one-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a validation pattern and a validation message to enforce the format. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### decline A tab that allows the recipient the option of declining an envelope. If the recipient clicks the tab during the signing process, the envelope is voided. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `buttonText` (string, optional) — Specifies the decline text displayed in the tab. - `buttonTextMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `declineReason` (string, optional) — The reason the recipient declined the document. - `declineReasonMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — **Note:** Decline tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### draw A tab that allows the recipient to add a free-form drawing to the document. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `allowSignerUpload` (string, optional) — When **true,** the recipient can upload an image to use as the background of the drawing field. The default value is **false.** - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `useBackgroundAsCanvas` (string, optional) - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### emailAddress A tab that displays the recipient's email as entered in the recipient information. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The Docusign-generated custom tab ID for the custom tab to be applied. This property can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — **Note:** Email Address tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### email A tab that allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### envelopeId A tab that displays the envelope ID. **Note:** The eSignature API uses the name `envelopeId` two ways: - As a _property_ of type `string` used to identify an envelope by its GUID. - As an _object_ used to represent an envelope tab that displays the envelope's GUID. - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### firstName A tab that displays the recipient's first name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### formulaTab The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result. The `formula` property of the tab contains the references to the underlying tabs. See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. If a formula tab contains a `paymentDetails` property, the tab is considered a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extendPaymentConfiguration` (extendPaymentConfiguration, optional) - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `formula` (string, optional) — Contains the formula for calculating the value of this tab. Use a tab's `tabLabel`, enclosed in brackets, to refer to it. For example, you want to present the total cost of two items, tax included. The cost of each item is stored in number tabs labeled Item1 and Item2. The tax rate is in a number tab labeled TaxRate. The formula string for this property would be: `([Item1] + [Item2]) * (1 + [TaxRate])` See [Calculated Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) in the Docusign Support Center to learn more about formulas. Maximum Length: 2000 characters - `formulaMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `hidden` (string, optional) — If this is a regular formula (no `paymentDetails` property is present): - **true:** The tab is hidden. - **false:** The tab is shown. If the formula is payment item (a `paymentDetails` property is present): - **true:** The tab is displayed as a payment. - **false:** The tab is displayed as a regular formula. - `hiddenMetadata` (propertyMetadata, optional) — Metadata about a property. - `isPaymentAmount` (string, optional) — When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. - `isPaymentAmountMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `paymentDetails` (paymentDetails, optional) — When a formula tab has a `paymentDetails` property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `roundDecimalPlaces` (string, optional) — The number of decimal places to round to. - `roundDecimalPlacesMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+35, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+35, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### fullName A tab that displays the recipient's full name. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### initialHere A tab that allows the recipient to initial the document. May be optional. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `handDrawRequired` (string, optional) — When set to `true`, requires a hand-drawn initial by the signer. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `optional` (string, optional) — When **true,** the recipient does not need to complete this tab to complete the signing process. - `optionalMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `scaleValue` (string, optional) — Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size. - `scaleValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -7) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+2, -7) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### lastName A tab that displays the recipient's last name. This tab takes the recipient's name as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OcrA (OCR-A) - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### list This tab offers a list of options to choose from. The `listItems` property contains a list of [`listItem`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/) objects to specify the selectable options. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `listItems` (list of listItem, optional) — The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four] Maximum Length of listItems: 2048 characters. Maximum Length of items in the list: 100 characters. - `listSelectedValue` (string, optional) — The value in the list that is selected by default. - `listSelectedValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — The value to use when the item is selected. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### notarize A tab that alerts notary recipients that they must take action on the page. Only one notarize tab can appear on a page. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### notarySeal A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `scaleValue` (string, optional) — Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size. - `scaleValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### note A tab that displays additional information, in the form of a note, for the recipient. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — **Note:** Note tabs never display this tooltip in the signing interface. Although you can technically set a value via the API for this tab, it will not be displayed to the recipient. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### number Number tabs validate that the entered value is a number. They do not support advanced validation or display options. See [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) to learn more about this tab type. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `formula` (string, optional) — Contains the formula for calculating the value of this tab. Use a tab's `tabLabel`, enclosed in brackets, to refer to it. For example, you want to present the total cost of two items, tax included. The cost of each item is stored in number tabs labeled Item1 and Item2. The tax rate is in a number tab labeled TaxRate. The formula string for this property would be: `([Item1] + [Item2]) * (1 + [TaxRate])` See [Calculated Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) in the Docusign Support Center to learn more about formulas. Maximum Length: 2000 characters - `formulaMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `isPaymentAmount` (string, optional) — When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. - `isPaymentAmountMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### numerical Numerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. See [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) to learn more about this tab type. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This ID must refer to an existing document. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxNumericalValue` (string, optional) — The maximum value that the numerical tab can take on. The largest value allowed, and the default if not specified, is `999999999.99` - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `minNumericalValue` (string, optional) — The minimum value that the numerical tab can take on. The smallest value allowed, and the default if not specified, is `-999999999.99` - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `numericalValue` (string, optional) — The raw numerical value of the tab. For example, if the locale policy is `en-US` and the `numericalValue` is `-1234.56`, the `value` property will contain the string `"($ 1,234.56)"`. - `originalNumericalValue` (string, optional) — The original value of the tab. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationType` (string, optional) — Specifies how numerical data is validated. Valid values: - `number` - `currency` - `value` (string, optional) — The `numericalValue` of the tab displayed according to its locale policy. For example, if the locale policy is `en-US` and the `numericalValue` is `-1234.56`, this property will contain the string `"($ 1,234.56)"`. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### phoneNumber A Phone Number tab enables a recipient to enter a phone number. **Note:** This tab can only be assigned to a remote notary recipient using [DocuSign Notary][notary]. [notary]: /docs/notary-api/ - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### polyLineOverlay This tab enables users to strike through the text of a document. The tab is implemented as a line represented as a pair of x and y coordinates. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `graphicsContext` (graphicsContext, optional) - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `overlayType` (string, optional) — The type of overlay to use. The API currently supports only the `outline` overlay type. - `overlayTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `polyLines` (list of polyLine, optional) — An array of `polyLine` objects that contain x- and y-coordinates representing the locations of the lines. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** indicates that the tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### prefillTabs Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. Only the following tab types can be prefill tabs: - text - check boxes - radio buttons [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields - `checkboxTabs` (list of checkbox, optional) — A list of [Checkbox tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. - `dateTabs` (list of date, optional) — A list of [Date tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters. **Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message. - `emailTabs` (list of email, optional) — A list of [Email tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An Email tab enables the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. This value can be set. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. - `numberTabs` (list of number, optional) — A list of Number tabs. Number tabs validate that the entered value is a number. They do not support advanced validation or display options. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about number tabs see [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs). - `radioGroupTabs` (list of radioGroup, optional) — A list of [Radio Group tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. - `senderCompanyTabs` (list of senderCompany, optional) - `senderNameTabs` (list of senderName, optional) - `ssnTabs` (list of ssn, optional) — A list of [SSN tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). An SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. - `tabGroups` (list of tabGroup, optional) — An array of `tabGroup` items. To associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array. - `textTabs` (list of text, optional) — A list of Text tabs. A text tab enables the recipient to enter free text. This value can be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). - `zipTabs` (list of zip, optional) — A list of [Zip tabs](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/). A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. ### radioGroup This group tab is used to place radio buttons on a document. The `radios` property contains a list of [`radio`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) objects associated with the group. Only one radio button can be selected in a group. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `groupName` (string, optional) — The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. - `groupNameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `radios` (list of radio, optional) — Specifies the locations and status for radio buttons that are grouped together. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `source` (string, optional) - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `tooltipMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. ### signerAttachment A tab that allows the recipient to attach supporting documents to an envelope. - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `handDrawRequired` (string, optional) — Reserved for Docusign. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `optional` (string, optional) — When **true,** the recipient does not need to complete this tab to complete the signing process. - `optionalMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `scaleValue` (string, optional) — Sets the size of the tab. This field accepts values from `0.5` to `1.0`, where `1.0` represents full size and `0.5` is 50% of full size. - `scaleValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+0, -24) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+0, -24) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### signHere A tab that allows the recipient to sign a document. May be optional. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `handDrawRequired` (string, optional) — When set to `true`, requires a hand-drawn signature by the signer. - `height` (string, optional) — Not applicable to Sign Here tab. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `isSealSignTab` (string, optional) — When **true,** the tab contains a visual representation for an electronic seal in a document. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `optional` (string, optional) — When **true,** the recipient does not need to complete this tab to complete the signing process. - `optionalMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `scaleValue` (string, optional) — Scales the size of the tab. This field accepts values from 0.5 to 2.0, where 0.5 is half the normal size, 1.0 is normal size, and 2.0 is twice the normal size. - `scaleValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `stamp` (stamp, optional) - `stampType` (string, optional) — The type of stamp. Valid values are: - `signature`: A signature image. This is the default value. - `stamp`: A stamp image. - null - `stampTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — Not applicable to Sign Here tab. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+1, -7) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (+1, -7) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### smartSection - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `caseSensitive` (boolean, optional) — When **true,** the `startAnchor` and `endAnchor` for the Smart Section must match both the case and the content of the strings in the HTML. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `displaySettings` (smartSectionDisplaySettings, optional) — These properties define how a Smart Section displays. A Smart Section is a type of display section. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `endAnchor` (string, optional) — Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default. **Note:** A start anchor, an end anchor, or both are required. - `endPosition` (smartSectionAnchorPosition, optional) - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `overlayType` (string, optional) — The type of overlay to draw on the document. The following overlay types are supported: - `line` - `outline` - `overlayTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `removeEndAnchor` (boolean, optional) — When **true,** removes the end anchor string for the Smart Section from the HTML, preventing it from displaying. - `removeStartAnchor` (boolean, optional) — When **true,** removes the start anchor string for the Smart Section from the HTML, preventing it from displaying. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `startAnchor` (string, optional) — Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default. **Note:** A start anchor, an end anchor, or both are required. - `startPosition` (smartSectionAnchorPosition, optional) - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### ssn A one-line field that allows the recipient to enter a Social Security Number. The SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### tabGroup - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `groupLabel` (string, optional) — A unique identifier for a tab group. To assign a tab to the `tabGroup`, you assign the `TabGroupLabel` to the `tab.TabGroupLabels` array. - `groupLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `groupRule` (string, optional) — Specifies how `maximumAllowed` and `minimumRequired` are interpreted when selecting tabs in a `tabGroup`. Possible values are: - `SelectAtLeast` - `SelectAtMost` - `SelectExactly` - `SelectARange` - `groupRuleMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `maximumAllowed` (string, optional) — The maximum number of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation. - `maximumAllowedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `minimumRequired` (string, optional) — The minimum number of of tabs within the `tabGroup` that should be checked, populated, or signed. This property is used for validation. - `minimumRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab group will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabScope` (string, optional) — The scope of the tab group. Possible values are: - `document` - `envelope` (default) - `tabScopeMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### text A tab that allows the recipient to enter any type of text. - `agreementAttribute` (string, optional) — When the completed envelope is ingested into Docusign Navigator, the value of this tab is copied to one of the following agreement attributes: - `AutomaticRenewal`: whether the agreement renews automatically (`true`/`false`) - `ContactEmail`: the contact’s email address - `ContactName`: the contact’s name - `ContractValue`: the monetary value of the contract - `EffectiveDate`: the contract’s effective date - `ExpirationDate`: the contract’s expiration date - `Party`: one of the parties to the agreement - `RenewalNoticePeriod`: the renewal notice period for the contract - `RenewalTerm`: the renewal term for the contract - `agreementAttributeLocked` (string, optional) — When set to `true`, this setting prevents the Docusign web app from allowing the user to modify the agreement attribute. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) — A description of the tab that can match the original document caption or describe its intent. When a Web Form is generated from a template this value will be used as the caption of the field shown on the form. - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `formula` (string, optional) — Contains the formula for calculating the value of this tab. Use a tab's `tabLabel`, enclosed in brackets, to refer to it. For example, you want to present the total cost of two items, tax included. The cost of each item is stored in number tabs labeled Item1 and Item2. The tax rate is in a number tab labeled TaxRate. The formula string for this property would be: `([Item1] + [Item2]) * (1 + [TaxRate])` See [Calculated Fields](https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html) in the Docusign Support Center to learn more about formulas. Maximum Length: 2000 characters - `formulaMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `isPaymentAmount` (string, optional) — When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. - `isPaymentAmountMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — The `shared` and `shareToRecipients` properties work together to define signing behavior. If `"shared": "true"`, it overrides `shareToRecipients`, and the tab is shared with all recipients. In mixed cases, the API prioritizes `"shared": "true"` for all recipients, or `"shared": "false"` for specified recipients. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — The value of the text tab. Maximum length: 4000 bytes. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### title A tab that displays the recipient's title. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### view This tab is used with the Approve tab to handle supplemental documents. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `buttonText` (string, optional) — The text to display on the button. - `buttonTextMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — The ID of the recipient to whom the tab will be assigned. This value should match the `recipientId` defined in the recipient object. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the recipient must click the **View** button for the supporting document prior to completing the signing process. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requiredRead` (string, optional) — When **true,** the recipient must read through the document. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### zip A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. - `agreementAttribute` (string, optional) — N/A - do not use - `agreementAttributeLocked` (string, optional) — N/A - do not use - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `concealValueOnDocument` (string, optional) — When **true,** the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign console. The information on the downloaded document remains masked by asterisks. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. - `concealValueOnDocumentMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `disableAutoSize` (string, optional) — When **true,** disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. - `disableAutoSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `maxLength` (string, optional) — An optional value that describes the maximum length of the property when the property is a string. - `maxLengthMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) — The name of the tab. For example, `Sign Here` or `Initial Here`. If the `tooltip` attribute is not set, this value will be displayed as the custom tooltip text. - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `originalValue` (string, optional) — The initial value of the tab. - `originalValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — A local reference used to map recipients to other objects, such as specific document tabs. A `recipientId` must be either an integer or a GUID, and the `recipientId` must be unique within an envelope. For example, many envelopes assign the first recipient a `recipientId` of `1`. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireAll` (string, optional) — When **true** and shared is true, information must be entered in this field to complete the envelope. - `requireAllMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `requireInitialOnSharedChange` (string, optional) — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` (propertyMetadata, optional) — Metadata about a property. - `senderRequired` (string, optional) — When **true,** the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. - `senderRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `shared` (string, optional) — When **true,** this custom tab is shared. - `sharedMetadata` (propertyMetadata, optional) — Metadata about a property. - `shareToRecipients` (string, optional) — Reserved for Docusign. - `shareToRecipientsMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — The status of the tab. Possible values are: - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `useDash4` (string, optional) — When **true,** ZIP+4 format is used. - `useDash4Metadata` (propertyMetadata, optional) — Metadata about a property. - `validationMessage` (string, optional) — The message displayed if the custom tab fails input validation (either custom of embedded). - `validationMessageMetadata` (propertyMetadata, optional) — Metadata about a property. - `validationPattern` (string, optional) — A regular expression used to validate input for the tab. - `validationPatternMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. To improve the tab's position on the document, Docusign recommends adjusting `xPosition` and `yPosition` coordinates by (-3, -2) - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### recipientIdentityPhoneNumber - `countryCode` (string, optional) — The numeric country calling code for the phone number. For example, the country calling code for the US and Canada is 1. For the UK, the country calling code is 44. Do not include the + symbol. - `countryCodeLock` (string, optional) - `countryCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `extension` (string, optional) — The telephone extension, if any. - `extensionMetadata` (propertyMetadata, optional) — Metadata about a property. - `number` (string, optional) — The telephone number. Use only the digits `0`-`9`. Remove any non-numeric characters. Do not include the `countryCode`. For US, Canada, and other [North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) countries, do not include a leading `1` or `0`. - `numberMetadata` (propertyMetadata, optional) — Metadata about a property. ### connectedObjectDetails - `recordId` (string, optional) ### extensionData - `actionContract` (string, optional) — The template that defines the action in an extension app. - `actionInputKey` (string, optional) — A key that represents the input data required for verification. The value of this property determines the actual data type to be verified. The supported values are: - `countryCode` - `phoneNumber` - `street1` - `locality` - `subdivision` - `email` - `firstName` - `lastName` - `vin` - `ssn` - `countryOrRegion` - `fein` - `businessName` - `postalCode` - `accountNumber` - `accountType` - `routingNumber` - `dateOfBirth` - `stateOfRegistration` - `countryOfRegistration` - `actionName` (string, optional) — The name of an action used in an extension app. - `applicationId` (string, optional) — The unique ID of an extension app. - `applicationName` (string, optional) — The name of an extension app. - `connectedFieldsData` (connectedData, optional) - `connectionInstances` (list of connectionInstance, optional) — An object containing data that identifies an extension app's connection to the connected field. - `extensionContract` (string, optional) — The template that defines the extension in an extension app. This corresponds to the extension template value in the extension app's manifest file. - `extensionGroupId` (string, optional) — The unique ID of the group of extensions within an extension app. - `extensionName` (string, optional) — The name of the extension used in an extension app. - `extensionPolicy` (string, optional) — An envelope or account-level configuration that determines a document's signing policy. Set this to property value to `mustVerifyToSign` to require that this text tab must be validated by an extension app before the envelope can be completed. - `publisherName` (string, optional) — The name of the extension app publisher. - `requiredForExtension` (string, optional) — A boolean value that indicates whether a field must pass verification before a signer can sign a document. ### localePolicyTab Allows you to customize locale settings. - `addressFormat` (string, optional) — Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw` - `calendarType` (string, optional) — Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist` - `cultureName` (string, optional) — The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. - `currencyCode` (string, optional) — The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. Supported formats: - `AED` - `AFN` - `ALL` - `AMD` - `ANG` - `AOA` - `ARS` - `AUD` - `AWG` - `AZN` - `BAM` - `BBD` - `BDT` - `BGN` - `BHD` - `BIF` - `BMD` - `BND` - `BOB` - `BOV` - `BRL` - `BSD` - `BTN` - `BWP` - `BYN` - `BYR` - `BZD` - `CAD` - `CDF` - `CHE` - `CHF` - `CHW` - `CLF` - `CLP` - `CNY` - `COP` - `COU` - `CRC` - `CUC` - `CUP` - `CVE` - `CZK` - `DJF` - `DKK` - `DOP` - `DZD` - `EGP` - `ERN` - `ETB` - `EUR` - `FJD` - `FKP` - `GBP` - `GEL` - `GHS` - `GIP` - `GMD` - `GNF` - `GTQ` - `GYD` - `HKD` - `HNL` - `HRK` - `HTG` - `HUF` - `IDR` - `ILS` - `INR` - `IQD` - `IRR` - `ISK` - `JMD` - `JOD` - `JPY` - `KES` - `KGS` - `KHR` - `KMF` - `KPW` - `KRW` - `KWD` - `KYD` - `KZT` - `LAK` - `LBP` - `LKR` - `LRD` - `LSL` - `LYD` - `MAD` - `MDL` - `MGA` - `MKD` - `MMK` - `MNT` - `MOP` - `MRO` - `MUR` - `MVR` - `MWK` - `MXN` - `MXV` - `MYR` - `MZN` - `NAD` - `NGN` - `NIO` - `NOK` - `NPR` - `NZD` - `OMR` - `PAB` - `PEN` - `PGK` - `PHP` - `PKR` - `PLN` - `PYG` - `QAR` - `RON` - `RSD` - `RUB` - `RWF` - `SAR` - `SBD` - `SCR` - `SDG` - `SEK` - `SGD` - `SHP` - `SLL` - `SOS` - `SRD` - `SSP` - `STD` - `SVC` - `SYP` - `SZL` - `THB` - `TJS` - `TMT` - `TND` - `TOP` - `TRY` - `TTD` - `TWD` - `TZS` - `UAH` - `UGX` - `USD` - `USN` - `UYI` - `UYU` - `UZS` - `VEF` - `VND` - `VUV` - `WST` - `XAF` - `XAG` - `XAU` - `XBA` - `XBB` - `XBC` - `XBD` - `XCD` - `XDR` - `XOF` - `XPD` - `XPF` - `XPT` - `XSU` - `XTS` - `XUA` - `XXX` - `YER` - `ZAR` - `ZMW` - `ZWL` - `currencyNegativeFormat` (string, optional) — Determines how negative currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default` `0` - `OPar_CSym_1_Comma_234_Comma_567_Period_89_CPar` `($1,234,567.89)` - `Minus_CSym_1_Comma_234_Comma_567_Period_89` `-$1,234,567.89` - `Minus_CSym_Space_1_Period_234_Period_567_Comma_89` `-$ 1.234.567,89` - `CSym_Space_Minus_1_Period_234_Period_567_Comma_89` `$ -1.234.567,89` - `Minus_1_Period_234_Period_567_Comma_89_Space_CSym` `-1.234.567,89 $` - `OPar_1_Space_234_Space_567_Comma_89_Space_CSym_CPar` `(1 234 567,89 $)` - `Minus_1_Space_234_Space_567_Comma_89_Space_CSym` `-1 234 567,89 $` - `CSym_Minus_1_Quote_234_Quote_567_Period_89` `$-1'234'567.89` - `Minus_CSym_1_Period_234_Period_567_Comma_89` `-$1.234.567,89` - `Minus_CSym_1_Comma_234_Comma_567` `-$1,234,567` - `Minus_CSym_12_Comma_34_Comma_567_Period_89` `-$12,34,567.89` - `OPar_CSym_Space_1234_Comma_567_Period_89_CPar` `($ 1234,567.89)` - `CSym_Space_Minus_12_Comma_34_Comma_567_Period_89` `$ -12,34,567.89` - `CSym_Minus_12_Comma_34_Comma_567_Period_89` `$-1,234,567.89` - `CSym_Space_Minus_1_Space_234_Space_567_Comma_89` `$ -1 234 567,89` - `CSym_Space_Minus_1_Space_234_Space_567_Period_89` `$ -1 234 567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Comma_89` `-$ 1 234 567,89` - `Minus_1_Space_234_Space_567_Comma_89_CSym` `-1 234 567,89$` - `Minus_1_Space_234_Space_567_Period_89_Space_CSym` `-1 234 567.89 $` - `OPar_CSym_1_Period_234_Period_567_CPar` `(1.234.567)` - `OPar_CSym_1_Comma_234_Comma_567_CPar` `($1,234,567)` - `Minus_1_Comma_234_Comma_567_Period_89_Space_CSym` `-1,234,567.89 $` - `Minus_CSym_Space_1_Comma_234_Comma_567_Period_89` `-$ 1,234,567.89` - `OPar_CSym_Space_1_Period_234_Period_567_Comma_89_CPar` `($ 1.234.567,89)` - `OPar_CSym_Space_1_Quote_234_Quote_567_Period_89_CPar` `($ 1'234'567.89)` - `OPar_CSym_Space_1_Space_234_Space_567_Comma_89_CPar` `($ 1 234 567,89)` - `OPar_CSym_Space_1_Space_234_Space_567_Period_89_CPar` `($ 1 234 567.89)` - `OPar_CSym_12_Comma_34_Comma_567_Period_89_CPar` `($12,34,567.89)` - `OPar_CSym_Space_12_Comma_34_Comma_567_Period_89_CPar` `($ 12,34,567.89)` - `OPar_1_Comma_234_Comma_567_Period_89_Space_CSym_CPar` `(1,234,567.89 $)` - `OPar_1_Period_234_Period_567_Comma_89_Space_CSym_CPar` `(1.234.567,89 $)` - `OPar_1_Space_234_Space_567_Comma_89_CSym_CPar` `(1 234 567,89$)` - `OPar_1_Space_234_Space_567_Period_89_Space_CSym_CPar` `(1 234 567.89 $)` - `OPar_CSym_Space_1_Comma_234_Comma_567_Period_89_CPar` `($ 1,234,567.89)` - `Minus_CSym_1_Period_234_Period_567` `-$ 1.234.567` - `Minus_CSym_Space_1_Quote_234_Quote_567_Period_89` `-$ 1'234'567.89` - `Minus_CSym_Space_1_Space_234_Space_567_Period_89` `-$ 1 234 567.89` - `CSym_Minus_1_Comma_234_Comma_567` `$-1,234,567` - `CSym_Minus_1_Period_234_Period_567` `$-1.234.567` - `CSym_Space_Minus_1_Quote_234_Quote_567_Period_89` `$ -1'234'567.89` - `CSym_Space_Minus_1_Comma_234_Comma_567_Period_89` `$ -1,234,567.89` - `Minus_CSym_Space_12_Comma_34_Comma_567_Period_89` `-$ 12,34,567.89` - `Minus_1_Period_234_Period_567_Space_CSym` `-123.456.789 $` - `CSym_Minus_1_Space_234_Space_567_Comma_89` `$-123 456 789,00` - `Minus_1_Quote_234_Quote_567_Period_89_Space_CSym` `-123'456'789.00 $` - `CSym_1_Comma_234_Comma_567_Period_89_Minus` `$123,456,789.00-` - `CSym_Minus_1_Period_234_Period_567_Comma_89` `$-123.456.789,00` - `OPar_CSym_1_Period_234_Period_567_Comma_89_CPar` `($123.456.789,00)` - `Minus_CSym_1234_Comma_567_Period_89` `-$123456,789.00` - `Minus_CSym_1_Space_234_Space_567_Comma_89` `-$123 456 789,00` - `currencyPositiveFormat` (string, optional) — Determines how positive currency values are displayed. In most cases, you should not need to change this value. See [Explicitly define formatting](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#explicitly-define-formatting). Valid values: - `Default` Uses the current locale. - `CSym_1_Comma_234_Comma_567_Period_89` `$1,234,567.89` - `CSym_Space_1_Period_234_Period_567_Comma_89` `$ 1.234.567,89` - `Leading_1_Period_234_Period_567_Comma_89_Space_CSym` `1.234.567,89 $` - `Leading_1_Space_234_Space_567_Comma_89_Space_CSym` `1 234 567,89 $` - `CSym_Space_1_Quote_234_Quote_567_Period_89` `$ 1'234'567.89` - `CSym_1_Comma_234_Comma_567` `$1,234,567` - `CSym_Space_12_Comma_34_Comma_567_Period_89` `$ 12,34,567.89` - `CSym_12_Comma_34_Comma_567_Period_89` `$12,34,567.89` - `CSym_Space_1234_Comma_567_Period_89` `$ 1234,567.89` - `Leading_1_Space_234_Space_567_Period_89_Space_CSym` `1 234 567.89 $` - `CSym_Space_1_Space_234_Space_567_Comma_89` `$ 1 234 567,89` - `CSym_Space_1_Space_234_Space_567_Period_89` `$ 1 234 567.89` - `Leading_1_Space_234_Space_567_Comma_89_CSym` `1 234 567,89$` - `CSym_1_Period_234_Period_567` `$1.234.567` - `Leading_1_Comma_234_Comma_567_Period_89_Space_CSym` `1,234,567. $` (New Armenian) - `CSym_Space_1_Comma_234_Comma_567_Period_89` `$ 1,234,567.89` (Persian) - `CSym_1_Period_234_Period_567_Comma_89` `$123.456.789,00` (es-CO) - `Leading_1_Quote_234_Quote_567_Period_89_Space_CSym` `123'456'789.00 $` (fr-ch) - `CSym_1234_Comma_567_Period_89` `$123456,789.00` (es-PR) - `Leading_1_Period_234_Period_567_Space_CSym` `123.456.789 $` - `CSym_1_Space_234_Space_567_Comma_89` `$123 456 789,00` (en-ZA, es-CR) - `customDateFormat` (string, optional) - `customTimeFormat` (string, optional) - `dateFormat` (string, optional) — Specifies the date format. Valid values: - `default` used the UI's - `longformat` use the UI's long format - `dd_mm_yy` dd-MM-yy - `dd_mmm_yy` dd-MMM-yy - `dd_mm_yyyy` dd-MM-yyyy - `dd_mmm_yyyy` dd-MMM-yyyy - `ddmmmmyyyy` dd MMMM yyyy - `ddmmyyyy` dd/MM/yyyy - `ddmmyyyy_de` dd.MM.yyyy - `dmyyyy` d/M/yyyy - `d_m_yyyy` d-M-yyyy - `mmmd_yyyy` MMM d, yyyy - `mmm_dd_yyyy` MMM-dd-yyyy - `mmmmd_yyyy` MMMM d, yyyy - `mm_dd_yyyy` MM-dd-yyyy - `mdyyyy` M/d/yyyy - `yyyy_mmm_dd` yyyy-MMM-dd - `yyyy_mm_dd` yyyy-MM-dd - `yyyymmdd` yyyy/MM/dd - `yyyymd` yyyy/M/d - `custom` Customer set own value - `mmddyyyy` MM/dd/yyyy - `mmddyy` MM/dd/yy - `yyyy_mmmm_d` yyyy MMMM d - `initialFormat` (string, optional) — When a user is required to enter their initials, this property specifies how initials are rendered. The examples show the initials for "William Henry Gates". - `first1last1` "WG" - `last2` "GA" - `first2` "WI" - `last2_cjk` first two characters from last name in CJK characters. - `nameFormat` (string, optional) — Describes how names are displayed. Valid values: - `first_middle_last` William Henry Gates - `full` Mr William Henry Gates III - `last_first` Gates William - `lastfirst` GatesWilliam - `last_first_cjk` Gates William only with CJK characters - `lastfirst_cjk` GatesWilliam only with CJK characters - `timeFormat` (string, optional) — Specifies the time format. Valid values: - `none` None - `hh_mm` hh:mm - `hhmm` HH:mm - `hhmmss` HH:mm:ss - `hhmmsstt` HH:mm:ss tt - `hhmmtt` HH:mm tt - `hmm` h:mm - `hmmss` h:mm:ss - `hmmsstt` h:mm:ss tt - `hmmtt` h:mm tt - `custom` Customer-set format - `timeZone` (string, optional) — Specifies the time zone. Valid values: - `TZ_01_AfghanistanStandardTime` - `TZ_02_AlaskanStandardTime` - `TZ_03_ArabStandardTime` - `TZ_04_ArabianStandardTime` - `TZ_05_ArabicStandardTime` - `TZ_06_ArgentinaStandardTime` - `TZ_07_AtlanticStandardTime` - `TZ_08_AUS_CentralStandardTime` - `TZ_09_AUS_EasternStandardTime` - `TZ_10_AzerbaijanStandardTime` - `TZ_11_AzoresStandardTime` - `TZ_12_BangladeshStandardTime` - `TZ_13_CanadaCentralStandardTime` - `TZ_14_CapeVerdeStandardTime` - `TZ_15_CaucasusStandardTime` - `TZ_16_CentralAustraliaStandardTime` - `TZ_17_CentralAmericaStandardTime` - `TZ_18_CentralAsiaStandardTime` - `TZ_19_CentralBrazilianStandardTime` - `TZ_20_CentralEuropeStandardTime` - `TZ_21_CentralEuropeanStandardTime` - `TZ_22_CentralPacificStandardTime` - `TZ_23_CentralStandardTime` - `TZ_24_CentralStandardTimeMexico` - `TZ_25_ChinaStandardTime` - `TZ_26_DatelineStandardTime` - `TZ_27_E_AfricaStandardTime` - `TZ_28_E_AustraliaStandardTime` - `TZ_29_E_EuropeStandardTime` - `TZ_30_E_SouthAmericaStandardTime` - `TZ_31_EasternStandardTime` - `TZ_32_EgyptStandardTime` - `TZ_33_EkaterinburgStandardTime` - `TZ_34_FijiStandardTime` - `TZ_35_FLE_StandardTime` - `TZ_36_GeorgianStandardTime` - `TZ_37_GMT_StandardTime` - `TZ_38_GreenlandStandardTime` - `TZ_39_GreenwichStandardTime` - `TZ_40_GTB_StandardTime` - `TZ_41_HawaiianStandardTime` - `TZ_42_IndiaStandardTime` - `TZ_43_IranStandardTime` - `TZ_44_IsraelStandardTime` - `TZ_45_JordanStandardTime` - `TZ_46_KaliningradStandardTime` - `TZ_47_KamchatkaStandardTime` - `TZ_48_KoreaStandardTime` - `TZ_49_MagadanStandardTime` - `TZ_50_MauritiusStandardTime` - `TZ_51_MidAtlanticStandardTime` - `TZ_52_MiddleEastStandardTime` - `TZ_53_MontevideoStandardTime` - `TZ_54_MoroccoStandardTime` - `TZ_55_MountainStandardTime` - `TZ_56_MountainStandardTimeMMexico` - `TZ_57_MyanmarStandardTime` - `TZ_58_N_CentralAsiaStandardTime` - `TZ_59_NamibiaStandardTime` - `TZ_60_NepalStandardTime` - `TZ_61_NewZealandStandardTime` - `TZ_62_NewfoundlandStandardTime` - `TZ_63_NorthAsiaEastStandardTime` - `TZ_64_NorthAsiaStandardTime` - `TZ_65_PacificSAStandardTime` - `TZ_66_PacificStandardTime` - `TZ_67_PacificStandardTimeMexico` - `TZ_68_PakistanStandardTime` - `TZ_69_ParaguayStandardTime` - `TZ_70_RomanceStandardTime` - `TZ_71_RussianStandardTime` - `TZ_72_SAEasternStandardTime` - `TZ_73_SAPacificStandardTime` - `TZ_74_SAWesternStandardTime` - `TZ_75_SamoaStandardTime` - `TZ_76_SE_AsiaStandardTime` - `TZ_77_SingaporeStandardTime` - `TZ_78_SouthAfricaStandardTime` - `TZ_79_SriLankaStandardTime` - `TZ_80_SyriaStandardTime` - `TZ_81_TaipeiStandardTime` - `TZ_82_TasmaniaStandardTime` - `TZ_83_TokyoStandardTime` - `TZ_84_TongaStandardTime` - `TZ_85_TurkeyStandardTime` - `TZ_86_UlaanbaatarStandardTime` - `TZ_87_US_EasternStandardTime` - `TZ_88_USMountainStandardTime` - `TZ_89_VenezuelaStandardTime` - `TZ_90_VladivostokStandardTime` - `TZ_91_W_AustraliaStandardTime` - `TZ_92_W_CentralAfricaStandardTime` - `TZ_93_W_EuropeStandardTime` - `TZ_94_WestAsiaStandardTime` - `TZ_95_WestPacificStandardTime` - `TZ_96_YakutskStandardTime` - `useLongCurrencyFormat` (string, optional) — When **true,** use the long currency format for the locale. ### mergeField Contains information for transferring values between Salesforce data fields and Docusign tabs. - `allowSenderToEdit` (string, optional) — When **true,** the sender can modify the value of the `mergeField` tab during the sending process. - `allowSenderToEditMetadata` (propertyMetadata, optional) — Metadata about a property. - `configurationType` (string, optional) — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. - `configurationTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `path` (string, optional) — Sets the object associated with the custom tab. Currently this is the Salesforce Object. - `pathExtended` (list of pathExtendedElement, optional) — Reserved for Docusign. - `pathExtendedMetadata` (propertyMetadata, optional) — Metadata about a property. - `pathMetadata` (propertyMetadata, optional) — Metadata about a property. - `row` (string, optional) — Specifies the row number in a Salesforce table that the merge field value corresponds to. - `rowMetadata` (propertyMetadata, optional) — Metadata about a property. - `writeBack` (string, optional) — When **true,** data entered into the merge field during Signing will update the mapped Salesforce field. - `writeBackMetadata` (propertyMetadata, optional) — Metadata about a property. ### smartContractInformation - `code` (string, optional) — Reserved for Docusign. - `uri` (string, optional) — Reserved for Docusign. ### comment - `envelopeId` (string, optional) — The Guid of the envelope the comment thread belongs to. - `hmac` (string, optional) — Reserved for Docusign. - `id` (string, optional) — The unique identifier for the comment. - `mentions` (list of string, optional) — An array of userIds that are mentioned directly in the body of a comment. - `read` (boolean, optional) — When **true,** indicates that the comment was read. - `sentByEmail` (string, optional) — The email address of the user who created the comment. - `sentByFullName` (string, optional) — The full name of the user who created the comment. - `sentByImageId` (string, optional) — Reserved for Docusign. - `sentByInitials` (string, optional) — The initials of the user who created the comment. - `sentByRecipientId` (string, optional) — The recipient ID of the user who created the comment. - `sentByUserId` (string, optional) — The user ID of the user who created the comment. - `signingGroupId` (string, optional) — The ID of the signing group that can view the comment or that created the comment. - `signingGroupName` (string, optional) — Optional. The name of the signing group. Maximum Length: 100 characters. - `subject` (string, optional) — The subject of the envelope. - `tabId` (string, optional) — The unique identifier for the tab that represents the comment thread. - `text` (string, optional) — The content of the comment, as UTF-8 text. Maximum Length: 500 characters. **Note:** The maximum size allowed for the entire message body is 32 KB. - `threadId` (string, optional) — The unique identifier for the comment thread. - `threadOriginatorId` (string, optional) — The userId of the user who created the thread. - `timestamp` (string, optional) — The time the comment was created. - `timeStampFormatted` (string, optional) — The time the comment was created, formatted according to the format of the user who created the comment. - `visibleTo` (list of string, optional) — The user IDs of the users that the comment is visible to. ### extendPaymentConfiguration - `appId` (string, optional) - `connectionInstanceId` (string, optional) - `currency` (string, optional) - `durationEnd` (string, optional) - `durationStart` (string, optional) - `lineItems` (list of extendPaymentLineItem, optional) - `paymentDueDays` (string, optional) - `paymentMethods` (list of string, optional) - `paymentMode` (string, optional) - `tabRole` (string, optional) ### paymentDetails When a formula tab has a `paymentDetails` property, the formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures - `allowedPaymentMethods` (list of string, optional) — An array of accepted payment methods: - `CreditCard` - `ApplePay` - `AndroidPay` - `BankAccount` For example, if you only accept credit cards and ACH transfers, you would set this property to: `'["BankAccount", "CreditCard"]'` Do not specify `BankAccount` (ACH) if you are also using in-person signing. - `chargeId` (string, optional) — The GUID set by the payment gateway (such as Stripe) that identifies a transaction. The `chargeId` is created when authorizing a payment and must be referenced when completing a payment. - `currencyCode` (string, optional) — Specifies the three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the payment. Supported currencies are: - AUD: Australian dollar - CAD: Canadian dollar - EUR: Euro - GBP: Great Britain pound - USD: United States dollar Specifying any other ISO 4217 code for payments is an error. - `currencyCodeMetadata` (propertyMetadata, optional) — Metadata about a property. - `customerId` (string, optional) — The customer ID. - `customMetadata` (string, optional) — This is a sender-defined field that passes any extra metadata about the payment that will show up in the Authorize.net transaction under **Description** in the merchant gateway portal. The custom metadata will be recorded in downloaded Authorize.net reports. The following example shows what the **Description** field of the transaction will look like: `, ` - `customMetadataRequired` (boolean, optional) — A sender-defined field that specifies whether custom metadata is required for the transaction. When **true,** custom metadata is required. This property only applies if you are using an Authorize.net payment gateway account. - `gatewayAccountId` (string, optional) — A GUID that identifies the payment gateway connected to the sender's Docusign account. There is no public API for connecting payment gateway accounts You must connect and manage payment gateway accounts through the Docusign Admin console and through your chosen payment gateway. You can get the gateway account ID in the Payments section of the Docusign Admin console. - `gatewayAccountIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `gatewayDisplayName` (string, optional) — Display name of the gateway connected to sender's Docusign account. Possible values are: Stripe, Braintree, Authorize.Net, CyberSource, Zuora, Elavon. - `gatewayName` (string, optional) — Name of the gateway connected to sender's Docusign account. Possible values are: - `Stripe` - `Braintree` - `AuthorizeDotNet` - `CyberSource` - `Zuora` - `Elavon` - `lineItems` (list of paymentLineItem, optional) — A payment formula can have one or more line items that provide detail about individual items in a payment request. The list of line items are returned as metadata to the payment gateway. - `paymentOption` (string, optional) — This property specifies how the signer's collected payment details will be used. Valid values: - `authorize`: The payment details will be used to collect payment. This is the default value. - `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway. - `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment. - `paymentSourceId` (string, optional) — The payment source ID. - `signerValues` (paymentSignerValues, optional) - `status` (string, optional) — This read-only property describes the status of a payment. - `new` This is a new payment request. The envelope has been created, but no payment authorizations have been made. - `auth_complete` A recipient has entered their credit card information, but the envelope has not been completed. The card has not been charged. - `payment_complete` The recipient's card has been charged. - `payment_capture_failed` Final charge failed. This can happen when too much time passes between authorizing the payment and completing the document. - `future_payment_saved` The recipient's payment method has been saved to the sender's payment gateway. - `subGatewayName` (string, optional) - `total` (money, optional) — Describes information about the `total` of a payment. ### listItem One of the selectable items in the `listItems` property of a [`list`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/) tab. - `selected` (string, optional) — When **true,** indicates that this item is the default selection shown to a signer. Only one selection can be set as the default. - `selectedMetadata` (propertyMetadata, optional) — Metadata about a property. - `text` (string, optional) — Specifies the text that is shown in the dropdown list. - `textMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value that is used when the list item is selected. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. ### graphicsContext - `fillColor` (string, optional) — The fill color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). - `lineColor` (string, optional) — The line color to use for the overlay. Colors are typically specified by their RGB hex values, but you can also use a [friendly CSS color name](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). - `lineWeight` (string, optional) — The line weight or thickness to use for the overlay. ### polyLine - `x1` (string, optional) - `x2` (string, optional) - `y1` (string, optional) - `y2` (string, optional) ### senderCompany - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### senderName - `agreementAttribute` (string, optional) - `agreementAttributeLocked` (string, optional) - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentLabel` (string, optional) — For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `conditionalParentValue` (string, optional) — For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. - `conditionalParentValueMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `customTabId` (string, optional) — The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. - `customTabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `documentId` (string, optional) — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `formOrder` (string, optional) — An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. - `formOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageLabel` (string, optional) — A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. - `formPageLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `formPageNumber` (string, optional) — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `height` (string, optional) — The height of the tab in pixels. Must be an integer. - `heightMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `localePolicy` (localePolicyTab, optional) — Allows you to customize locale settings. - `mergeField` (mergeField, optional) — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `name` (string, optional) - `nameMetadata` (propertyMetadata, optional) — Metadata about a property. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientId` (string, optional) — Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. - `recipientIdGuid` (string, optional) — The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. - `recipientIdGuidMetadata` (propertyMetadata, optional) — Metadata about a property. - `recipientIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `smartContractInformation` (smartContractInformation, optional) - `source` (string, optional) — Reserved for Docusign. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabGroupLabels` (list of string, optional) — An array of tab groups that this tab belongs to. Tab groups are identified by their `groupLabel` property. To associate this tab with a tab group, add the tab group's `groupLabel` to this array. - `tabGroupLabelsMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabLabel` (string, optional) — The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value. Maximum Length: 500 characters. - `tabLabelMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabType` (string, optional) — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateLocked` (string, optional) — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `templateRequired` (string, optional) — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `tooltip` (string, optional) — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `warningDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `width` (string, optional) — The width of the tab in pixels. Must be an integer. - `widthMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### radio One of the selectable radio buttons in the `radios` property of a [`radioGroup`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) tab. - `anchorAllowWhiteSpaceInCharacters` (string, optional) — When **true,** the text string in the document may have extra whitespace and still match the anchor string. This occurs in two cases. First, it matches if the document string has a single extra whitespace character following a non-whitespace character in the anchor string. For example, if the anchor string is `DocuSign`, then `Docu Sign` will match. However, `Docu Sign` will not match. Second, it matches if the document string has one or more extra whitespace characters following a whitespace character in the anchor string. For example, if the anchor string is `Docu Sign`, then `Docu Sign` will match. The default value is **true.** - `anchorAllowWhiteSpaceInCharactersMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorCaseSensitive` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** For example, when set to **true,** if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When **false,** `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorCaseSensitiveMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorHorizontalAlignment` (string, optional) — This property controls how [anchor tabs](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) are aligned in relation to the anchor text. Possible values are : - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word. **Note:** You can only specify the value of this property in POST requests. - `anchorHorizontalAlignmentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorIgnoreIfNotPresent` (string, optional) — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorMatchWholeWord` (string, optional) — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab](/docs/esign-rest-api/esign101/concepts/tabs/auto-place/) to be created. The default value is **false.** For example, when set to **true,** if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When **false,** if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match. This functionality uses the following rules: - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters: $~><|^+= For example, the `anchorString` `water` will match on the string `Fetch a pail of water.` - Strings embedded in other strings are ignored during the matching process. - In words that have dashes, the parts separated by dashes are treated as distinct words. Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true.** - Letters with accent marks are treated as distinct characters from their unaccented counterparts. - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them. Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`. - Unlike punctuation, numbers are not ignored when finding anchor words. Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value). **Note:** You can only specify the value of this property in POST requests. - `anchorMatchWholeWordMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorString` (string, optional) — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabProcessorVersion` (string, optional) — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorTabScope` (string, optional) - `anchorUnits` (string, optional) — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorXOffset` (string, optional) — Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorXOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `anchorYOffset` (string, optional) — Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. - `anchorYOffsetMetadata` (propertyMetadata, optional) — Metadata about a property. - `bold` (string, optional) — When **true,** the information in the tab is bold. - `boldMetadata` (propertyMetadata, optional) — Metadata about a property. - `caption` (string, optional) - `captionMetadata` (propertyMetadata, optional) — Metadata about a property. - `connectedObjectDetails` (connectedObjectDetails, optional) - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `extensionData` (extensionData, optional) - `font` (string, optional) — The font to be used for the tab value. Supported fonts include: - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana - `fontColor` (string, optional) — The font color to use for the information in the tab. Possible values are: - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White - `fontColorMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontMetadata` (propertyMetadata, optional) — Metadata about a property. - `fontSize` (string, optional) — The font size used for the information in the tab. Possible values are: - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 - `fontSizeMetadata` (propertyMetadata, optional) — Metadata about a property. - `italic` (string, optional) — When **true,** the information in the tab is italic. - `italicMetadata` (propertyMetadata, optional) — Metadata about a property. - `locked` (string, optional) — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` (propertyMetadata, optional) — Metadata about a property. - `mergeFieldXml` (string, optional) — Reserved for Docusign. - `pageNumber` (string, optional) — Specifies the page number on which the tab is located. Must be 1 for supplemental documents. - `pageNumberMetadata` (propertyMetadata, optional) — Metadata about a property. - `required` (string, optional) — When **true,** the signer is required to fill out this tab. - `requiredMetadata` (propertyMetadata, optional) — Metadata about a property. - `selected` (string, optional) — When **true,** the radio button is selected. - `selectedMetadata` (propertyMetadata, optional) — Metadata about a property. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. - `statusMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabFullyQualifiedPath` (string, optional) - `tabId` (string, optional) — The unique identifier for the tab. - `tabIdMetadata` (propertyMetadata, optional) — Metadata about a property. - `tabOrder` (string, optional) — A positive integer that sets the order the tab is navigated to during signing. Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. - `tabOrderMetadata` (propertyMetadata, optional) — Metadata about a property. - `underline` (string, optional) — When **true,** the information in the tab is underlined. - `underlineMetadata` (propertyMetadata, optional) — Metadata about a property. - `value` (string, optional) — Specifies the value of the tab. - `valueMetadata` (propertyMetadata, optional) — Metadata about a property. - `xPosition` (string, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `xPositionMetadata` (propertyMetadata, optional) — Metadata about a property. - `yPosition` (string, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPositionMetadata` (propertyMetadata, optional) — Metadata about a property. ### stamp - `adoptedDateTime` (string, optional) — The UTC date and time when the user adopted the signature. - `createdDateTime` (string, optional) — The UTC DateTime when the item was created. - `customField` (string, optional) - `dateStampProperties` (dateStampProperties, optional) — Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle. - `disallowUserResizeStamp` (string, optional) — When **true,** users may not resize the stamp. - `errorDetails` (errorDetails, optional) — This object describes errors that occur. It is only valid for responses, and ignored in requests. - `externalID` (string, optional) — Optionally specify an external identifier for the user's signature. - `imageBase64` (string, optional) - `imageType` (string, optional) — Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image` - `lastModifiedDateTime` (string, optional) — The date and time that the item was last modified. - `phoneticName` (string, optional) — The phonetic spelling of the `signatureName`. - `signatureName` (string, optional) — Specifies the user's signature name. - `stampFormat` (string, optional) — The format of a stamp. Valid values are: - `NameHanko`: The stamp represents only the signer's name. - `NameDateHanko`: The stamp represents the signer's name and the date. - `stampImageUri` (string, optional) — The URI for retrieving the image of the user's stamp. - `stampSizeMM` (string, optional) — The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents. - `status` (string, optional) — Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. ### smartSectionDisplaySettings These properties define how a Smart Section displays. A Smart Section is a type of display section. - `cellStyle` (string, optional) — Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of `responsive_table` or `responsive_table_single_column` types. - `collapsibleSettings` (smartSectionCollapsibleDisplaySettings, optional) - `display` (string, optional) — Indicates the display type. Must be one of the following enum values: - **inline:** Leaves the HTML where it is in the document. This allows for adding a label or presenting on a separate page. - **collapsible:** The HTML in the section may be expanded or collapsed. By default, the section is expanded. - **collapsed:** The HTML in the section may be expanded or collapsed. By default, the section is collapsed. - **responsive_table:** Converts the section into a responsive table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions. - **responsive_table_single_column:** Converts the section into a responsive, single-column table. Note that this style is applied only on HTML tables that fall within the `startAnchor` and `endAnchor` positions. The table is converted to a single column in which each column becomes a row and is stacked. - **print_only:** Prevents this portion of the HTML from displaying in the responsive signing view. - `displayLabel` (string, optional) — The label to add to this display section in the signing page. - `displayOrder` (integer, optional) — The position on the page where the display section appears. - `displayPageNumber` (integer, optional) — The number of the page on which the display section appears. - `hideLabelWhenOpened` (boolean, optional) — When **true,** the `displayLabel` is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the `display` property is `collapsed`. - `inlineOuterStyle` (string, optional) — Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the `display` property is `inline`. - `labelWhenOpened` (string, optional) — The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the `display` property is `collapsed`. - `preLabel` (string, optional) — Enables you to add descriptive text that appears before a collapsed section or continue button. - `scrollToTopWhenOpened` (boolean, optional) — When **true** and the section is expanded, the position of the section-close control scrolls to the top of the screen. This property is only valid when the value of the `display` property is `collapsed`. - `tableStyle` (string, optional) — Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the `display` property is `responsive_table` or `responsive_table_single_column`. ### smartSectionAnchorPosition - `pageNumber` (integer, optional) — Specifies the page number on which the tab is located. - `xPosition` (double, optional) — This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. - `yPosition` (double, optional) — This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. Must be an integer. May be zero. ### connectedData - `propertyName` (string, optional) — An identifier describing input data for a connected field. - `supportedOperation` (string, optional) — The type of operation used to verify a connected field. - `supportedUri` (string, optional) — The URI used to verify a connected field. - `typeName` (string, optional) — The name of the verification type used in a connected field. - `typeSystemNamespace` (string, optional) — The type of operation used during verification. ### connectionInstance - `connectionKey` (string, optional) — A key used to identify the connection instance of an extension app. - `connectionValue` (string, optional) — The GUID value that identifies the connection instance of an extension app. ### pathExtendedElement - `name` (string, optional) - `type` (string, optional) — The type of this tab. Values are: - `Approve` - `CheckBox` - `Company` - `Date` - `DateSigned` - `Decline` - `Email` - `EmailAddress` - `EnvelopeId` - `FirstName` - `Formula` - `FullName` - `InitialHere` - `InitialHereOptional` - `LastName` - `List` - `Note` - `Number` - `Radio` - `SignerAttachment` - `SignHere` - `SignHereOptional` - `Ssn` - `Text` - `Title` - `Zip5` - `Zip5Dash4` - `typeName` (string, optional) ### extendPaymentLineItem - `amountReference` (string, optional) - `description` (string, optional) - `name` (string, optional) - `priceId` (string, optional) - `productId` (string, optional) - `quantity` (string, optional) - `type` (string, optional) - `unitAmount` (string, optional) ### paymentLineItem A line item describes details about an individual line item in a payment request. - `amountReference` (string, optional) — This is a the `tabLabel` that specifies the amount paid for the line items. - `description` (string, optional) — A sender-defined description of the line item. - `itemCode` (string, optional) — This is the sender-defined SKU, inventory number, or other item code for the line item. - `name` (string, optional) — This is a sender-defined product name, service name, or other designation for the line item. ### paymentSignerValues - `paymentOption` (string, optional) — This property specifies how the signer's collected payment details will be used. Valid values: - `authorize`: The payment details will be used to collect payment. This is the default value. - `save`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway. - `save_and_authorize`: The signer's payment method (credit card or bank account) will be saved to the sender's payment gateway and will also be used to collect payment. ### money Describes information about the `total` of a payment. - `amountInBaseUnit` (string, optional) — The total payment amount in the currency's base unit. For example, for USD the base currency is one cent. - `currency` (string, optional) — The three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the payment. For example: - AUD Australian dollar - CAD Canadian dollar - EUR Euro - GBP Great Britain pound - USD United States dollar This is a read-only property. - `displayAmount` (string, optional) — The payment amount as displayed in the `currency`. For example, if the payment amount is USD 12.59, the `amountInBaseUnit` is 1259 (cents), and the displayed amount is `$12.59 USD`. This is a read-only property. ### dateStampProperties Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle. - `dateAreaHeight` (string, optional) — The height of the rectangle. - `dateAreaWidth` (string, optional) — The width of the rectangle. - `dateAreaX` (string, optional) — The X axis position of the top-left corner. - `dateAreaY` (string, optional) — The Y axis position of the top-left corner. ### smartSectionCollapsibleDisplaySettings - `arrowClosed` (string, optional) — Indicates the direction of the disclosure arrow when the collapsible section is in the closed state. One of the following: - `up`: In the closed state, the disclosure arrow points up. - `down`: In the closed state, the disclosure arrow points down. - `left`: In the closed state, the disclosure arrow points left. - `right`: In the closed state, the disclosure arrow points right. - `arrowColor` (string, optional) — A CSS color value (such as `#DCF851`) that indicates the color of the arrow. - `arrowLocation` (string, optional) — The location of the arrow relative to the collapsible section's label. Possible values are: - `right` (default) - `left` - `arrowOpen` (string, optional) — Indicates the direction of the disclosure arrow when the collapsible section is in the open state. One of the following: - `up`: In the open state, the disclosure arrow points up. - `down`: In the open state, the disclosure arrow points down. - `left`: In the open state, the disclosure arrow points left. - `right`: In the open state, the disclosure arrow points right. - `arrowSize` (string, optional) — Indicates the size of the collapsible arrows. Possible values are: - `small` - `large` (default) - `arrowStyle` (string, optional) — The name of the CSS style to be used on collapsible arrow section. - `containerStyle` (string, optional) — The name of the CSS style to be used for the collapsible container. - `labelStyle` (string, optional) — The name of the CSS style to be used for the collapsible container's label. - `onlyArrowIsClickable` (boolean, optional) — When **true,** only the arrow is clickable to expand or collapse the section. When **false** (the default), both the label and the arrow are clickable. If no arrow is used, this setting is ignored. - `outerLabelAndArrowStyle` (string, optional) — The name of the CSS style to be used for the collapsible container's outer label and arrow style. ## Examples **Request** ```json { "endPosition": "sample string 1", "envelopeTransferRules": [ { "carbonCopyOriginalOwner": "sample string 1", "enabled": "sample string 2", "envelopeTransferRuleId": "sample string 3", "eventType": "sample string 4", "fromGroup": { "accessType": "sample string 1", "dsGroupId": "sample string 2", "errorDetails": { "errorCode": "sample string 1", "message": "sample string 2" }, "groupId": "sample string 3", "groupName": "sample string 4", "groupType": "sample string 5", "isManagedByScim": true, "lastModifiedOn": "sample string 6", "permissionProfileId": "sample string 7", "userGroupType": "sample string 8", "users": [ { "accountId": "sample string 1", "accountName": "sample string 2", "activationAccessCode": "sample string 3", "email": "sample string 4", "ipAddress": "sample string 5", "loginStatus": "sample string 6", "membershipId": "sample string 7", "sendActivationEmail": "sample string 8", "uri": "sample string 9", "userId": "sample string 10", "userName": "sample string 11", "userStatus": "sample string 12", "userType": "sample string 13" } ], "usersCount": "sample string 9" }, "fromUser": { "activationAccessCode": "sample string 1", "company": "sample string 2", "connectConfigurations": [ { "configurationtype": "sample string 1", "connectId": "sample string 2", "enabled": "sample string 3", "hasAccess": "sample string 4", "senderSearchableItems": [ "sample string 1" ] } ], "countryCode": "sample string 3", "createdDateTime": "sample string 4", "customSettings": [ { "name": "sample string 1", "originalValue": "sample string 2", "value": "sample string 3" } ], "defaultAccountId": "sample string 5", "email": "sample string 6", "enableConnectForUser": "sample string 7", "firstName": "sample string 8", "forgottenPasswordInfo": { "forgottenPasswordAnswer1": "sample string 1", "forgottenPasswordAnswer2": "sample string 2", "forgottenPasswordAnswer3": "sample string 3", "forgottenPasswordAnswer4": "sample string 4", "forgottenPasswordQuestion1": "sample string 5", "forgottenPasswordQuestion2": "sample string 6", "forgottenPasswordQuestion3": "sample string 7", "forgottenPasswordQuestion4": "sample string 8" }, "groupList": [ {} ], "hasRemoteNotary": true, "homeAddress": { "address1": "sample string 1", "address2": "sample string 2", "city": "sample string 3", "country": "sample string 4", "fax": "sample string 5", "phone": "sample string 6", "postalCode": "sample string 7", "stateOrProvince": "sample string 8", "zipPlus4": "sample string 9" }, "initialsImageUri": "sample string 9", "isAdmin": "sample string 10", "isAlternateAdmin": "sample string 11", "isManagedByScim": "sample string 12", "isMembershipManagedByScim": "sample string 13", "isNAREnabled": "sample string 14", "jobTitle": "sample string 15", "lastLogin": "sample string 16", "lastName": "sample string 17", "licenseStatus": "sample string 18", "licenseType": "sample string 19", "licenseTypes": [ "sample string 1" ], "loginStatus": "sample string 20", "middleName": "sample string 21", "password": "sample string 22", "passwordExpiration": "sample string 23", "permissionProfileId": "sample string 24", "permissionProfileName": "sample string 25", "profileImageUri": "sample string 26", "sendActivationEmail": "sample string 27", "sendActivationOnInvalidLogin": "sample string 28", "signatureImageUri": "sample string 29", "subscribe": "sample string 30", "suffixName": "sample string 31", "title": "sample string 32", "uri": "sample string 33", "userAddedToAccountDateTime": "sample string 34", "userId": "sample string 35", "userName": "sample string 36", "userProfileLastModifiedDate": "sample string 37", "userSettings": { "accountAgreementsAccessType": "sample string 1", "adminOnly": "sample string 2", "allowAccessToAllAccountAgreements": "sample string 3", "allowAutoTagging": "sample string 4", "allowedDocumentTemplateLibraryAccess": "sample string 5", "allowedOrchestrationAccess": "sample string 6", "allowEnvelopeTransferTo": "sample string 7", "allowEsealRecipients": "sample string 8", "allowPowerFormsAdminToAccessAllPowerFormEnvelope": "sample string 9", "allowRecipientLanguageSelection": "sample string 10", "allowSendOnBehalfOf": "sample string 11", "allowSupplementalDocuments": "sample string 12", "allowTransactions": "sample string 13", "anchorTagVersionedPlacementEnabled": "sample string 14", "apiAccountWideAccess": "sample string 15", "apiCanExportAC": "sample string 16", "bulkSend": "sample string 17", "canBulkUploadAgreements": "sample string 18", "canChargeAccount": "sample string 19", "canCreateTransaction": "sample string 20", "canDeleteDocumentsInTransaction": "sample string 21", "canDeleteTransaction": "sample string 22", "canEditSharedAddressbook": "sample string 23", "canLockEnvelopes": "sample string 24", "canManageAccount": "sample string 25", "canManageAgreementParties": "sample string 26", "canManageDistributor": "sample string 27", "canManageTemplates": "sample string 28", "canSendAPIRequests": "sample string 29", "canSendEnvelope": "sample string 30", "canSendEnvelopesViaSMS": "sample string 31", "canSignEnvelope": "sample string 32", "canUseScratchpad": "sample string 33", "canUseSmartContracts": "sample string 34", "disableDocumentUpload": "sample string 35", "disableOtherActions": "sample string 36", "enableDSPro": "sample string 37", "enableKeyTermsSuggestionsByDocumentType": "sample string 38", "enableSequentialSigningAPI": "sample string 39", "enableSequentialSigningUI": "sample string 40", "enableSignerAttachments": "sample string 41", "enableSignOnPaperOverride": "sample string 42", "enableTransactionPoint": "sample string 43", "enableVaulting": "sample string 44", "expressSendOnly": "sample string 45", "isManagedByScim": "sample string 46", "isMembershipManagedByScim": "sample string 47", "isMembershipRedacted": "sample string 48", "isUserRedacted": "sample string 49", "locale": "sample string 50", "manageClickwrapsMode": "sample string 51", "modifiedBy": "sample string 52", "modifiedDate": "sample string 53", "modifiedPage": "sample string 54", "newSendUI": "sample string 55", "powerFormMode": "sample string 56", "recipientViewedNotification": "sample string 57", "redactMembershipAt": "sample string 58", "sealIdentifiers": [ {} ], "selfSignedRecipientEmailDocument": "sample string 59", "supplementalDocumentIncludeInDownload": "sample string 60", "supplementalDocumentsMustAccept": "sample string 61", "supplementalDocumentsMustRead": "sample string 62", "supplementalDocumentsMustView": "sample string 63", "templateActiveCreation": "sample string 64", "templateApplyNotify": "sample string 65", "templateAutoMatching": "sample string 66", "templateMatchingSensitivity": "sample string 67", "templatePageLevelMatching": "sample string 68", "timezoneDST": "sample string 69", "timezoneMask": "sample string 70", "timezoneOffset": "sample string 71", "timezoneSendingPref": "sample string 72", "timezoneSigningPref": "sample string 73", "transactionPointSiteNameURL": "sample string 74", "transactionPointUserName": "sample string 75", "vaultingMode": "sample string 76", "webForms": "sample string 77" }, "userStatus": "sample string 38", "userType": "sample string 39" }, "modifiedDate": "sample string 5", "toFolder": { "filter": { "actionRequired": "sample string 1", "expires": "sample string 2", "folderIds": "sample string 3", "fromDateTime": "sample string 4", "isTemplate": "sample string 5", "order": "sample string 6", "orderBy": "sample string 7", "searchTarget": "sample string 8", "searchText": "sample string 9", "status": "sample string 10", "toDateTime": "sample string 11" }, "folderId": "sample string 1", "folderItems": [ { "completedDateTime": "sample string 1", "createdDateTime": "sample string 2", "envelopeId": "sample string 3", "envelopeUri": "sample string 4", "expireDateTime": "sample string 5", "folderId": "sample string 6", "folderUri": "sample string 7", "is21CFRPart11": "sample string 8", "lastModifiedDateTime": "sample string 9", "ownerName": "sample string 10", "recipientsUri": "sample string 11", "senderCompany": "sample string 12", "senderEmail": "sample string 13", "senderName": "sample string 14", "senderUserId": "sample string 15", "sentDateTime": "sample string 16", "status": "sample string 17", "subject": "sample string 18", "templateId": "sample string 19", "templateUri": "sample string 20" } ], "folders": [ {} ], "hasAccess": "sample string 2", "hasSubFolders": "sample string 3", "itemCount": "sample string 4", "name": "sample string 5", "parentFolderId": "sample string 6", "parentFolderUri": "sample string 7", "subFolderCount": "sample string 8", "type": "sample string 9", "uri": "sample string 10" } } ], "nextUri": "sample string 2", "previousUri": "sample string 3", "resultSetSize": "sample string 4", "startPosition": "sample string 5", "totalSetSize": "sample string 6" } ``` **Response** ```json { "endPosition": "sample string 1", "envelopeTransferRules": [ { "carbonCopyOriginalOwner": "sample string 1", "enabled": "sample string 2", "envelopeTransferRuleId": "sample string 3", "eventType": "sample string 4", "fromGroup": { "accessType": "sample string 1", "dsGroupId": "sample string 2", "errorDetails": { "errorCode": "sample string 1", "message": "sample string 2" }, "groupId": "sample string 3", "groupName": "sample string 4", "groupType": "sample string 5", "isManagedByScim": true, "lastModifiedOn": "sample string 6", "permissionProfileId": "sample string 7", "userGroupType": "sample string 8", "users": [ { "accountId": "sample string 1", "accountName": "sample string 2", "activationAccessCode": "sample string 3", "email": "sample string 4", "ipAddress": "sample string 5", "loginStatus": "sample string 6", "membershipId": "sample string 7", "sendActivationEmail": "sample string 8", "uri": "sample string 9", "userId": "sample string 10", "userName": "sample string 11", "userStatus": "sample string 12", "userType": "sample string 13" } ], "usersCount": "sample string 9" }, "fromUser": { "activationAccessCode": "sample string 1", "company": "sample string 2", "connectConfigurations": [ { "configurationtype": "sample string 1", "connectId": "sample string 2", "enabled": "sample string 3", "hasAccess": "sample string 4", "senderSearchableItems": [ "sample string 1" ] } ], "countryCode": "sample string 3", "createdDateTime": "sample string 4", "customSettings": [ { "name": "sample string 1", "originalValue": "sample string 2", "value": "sample string 3" } ], "defaultAccountId": "sample string 5", "email": "sample string 6", "enableConnectForUser": "sample string 7", "firstName": "sample string 8", "forgottenPasswordInfo": { "forgottenPasswordAnswer1": "sample string 1", "forgottenPasswordAnswer2": "sample string 2", "forgottenPasswordAnswer3": "sample string 3", "forgottenPasswordAnswer4": "sample string 4", "forgottenPasswordQuestion1": "sample string 5", "forgottenPasswordQuestion2": "sample string 6", "forgottenPasswordQuestion3": "sample string 7", "forgottenPasswordQuestion4": "sample string 8" }, "groupList": [ {} ], "hasRemoteNotary": true, "homeAddress": { "address1": "sample string 1", "address2": "sample string 2", "city": "sample string 3", "country": "sample string 4", "fax": "sample string 5", "phone": "sample string 6", "postalCode": "sample string 7", "stateOrProvince": "sample string 8", "zipPlus4": "sample string 9" }, "initialsImageUri": "sample string 9", "isAdmin": "sample string 10", "isAlternateAdmin": "sample string 11", "isManagedByScim": "sample string 12", "isMembershipManagedByScim": "sample string 13", "isNAREnabled": "sample string 14", "jobTitle": "sample string 15", "lastLogin": "sample string 16", "lastName": "sample string 17", "licenseStatus": "sample string 18", "licenseType": "sample string 19", "licenseTypes": [ "sample string 1" ], "loginStatus": "sample string 20", "middleName": "sample string 21", "password": "sample string 22", "passwordExpiration": "sample string 23", "permissionProfileId": "sample string 24", "permissionProfileName": "sample string 25", "profileImageUri": "sample string 26", "sendActivationEmail": "sample string 27", "sendActivationOnInvalidLogin": "sample string 28", "signatureImageUri": "sample string 29", "subscribe": "sample string 30", "suffixName": "sample string 31", "title": "sample string 32", "uri": "sample string 33", "userAddedToAccountDateTime": "sample string 34", "userId": "sample string 35", "userName": "sample string 36", "userProfileLastModifiedDate": "sample string 37", "userSettings": { "accountAgreementsAccessType": "sample string 1", "adminOnly": "sample string 2", "allowAccessToAllAccountAgreements": "sample string 3", "allowAutoTagging": "sample string 4", "allowedDocumentTemplateLibraryAccess": "sample string 5", "allowedOrchestrationAccess": "sample string 6", "allowEnvelopeTransferTo": "sample string 7", "allowEsealRecipients": "sample string 8", "allowPowerFormsAdminToAccessAllPowerFormEnvelope": "sample string 9", "allowRecipientLanguageSelection": "sample string 10", "allowSendOnBehalfOf": "sample string 11", "allowSupplementalDocuments": "sample string 12", "allowTransactions": "sample string 13", "anchorTagVersionedPlacementEnabled": "sample string 14", "apiAccountWideAccess": "sample string 15", "apiCanExportAC": "sample string 16", "bulkSend": "sample string 17", "canBulkUploadAgreements": "sample string 18", "canChargeAccount": "sample string 19", "canCreateTransaction": "sample string 20", "canDeleteDocumentsInTransaction": "sample string 21", "canDeleteTransaction": "sample string 22", "canEditSharedAddressbook": "sample string 23", "canLockEnvelopes": "sample string 24", "canManageAccount": "sample string 25", "canManageAgreementParties": "sample string 26", "canManageDistributor": "sample string 27", "canManageTemplates": "sample string 28", "canSendAPIRequests": "sample string 29", "canSendEnvelope": "sample string 30", "canSendEnvelopesViaSMS": "sample string 31", "canSignEnvelope": "sample string 32", "canUseScratchpad": "sample string 33", "canUseSmartContracts": "sample string 34", "disableDocumentUpload": "sample string 35", "disableOtherActions": "sample string 36", "enableDSPro": "sample string 37", "enableKeyTermsSuggestionsByDocumentType": "sample string 38", "enableSequentialSigningAPI": "sample string 39", "enableSequentialSigningUI": "sample string 40", "enableSignerAttachments": "sample string 41", "enableSignOnPaperOverride": "sample string 42", "enableTransactionPoint": "sample string 43", "enableVaulting": "sample string 44", "expressSendOnly": "sample string 45", "isManagedByScim": "sample string 46", "isMembershipManagedByScim": "sample string 47", "isMembershipRedacted": "sample string 48", "isUserRedacted": "sample string 49", "locale": "sample string 50", "manageClickwrapsMode": "sample string 51", "modifiedBy": "sample string 52", "modifiedDate": "sample string 53", "modifiedPage": "sample string 54", "newSendUI": "sample string 55", "powerFormMode": "sample string 56", "recipientViewedNotification": "sample string 57", "redactMembershipAt": "sample string 58", "sealIdentifiers": [ {} ], "selfSignedRecipientEmailDocument": "sample string 59", "supplementalDocumentIncludeInDownload": "sample string 60", "supplementalDocumentsMustAccept": "sample string 61", "supplementalDocumentsMustRead": "sample string 62", "supplementalDocumentsMustView": "sample string 63", "templateActiveCreation": "sample string 64", "templateApplyNotify": "sample string 65", "templateAutoMatching": "sample string 66", "templateMatchingSensitivity": "sample string 67", "templatePageLevelMatching": "sample string 68", "timezoneDST": "sample string 69", "timezoneMask": "sample string 70", "timezoneOffset": "sample string 71", "timezoneSendingPref": "sample string 72", "timezoneSigningPref": "sample string 73", "transactionPointSiteNameURL": "sample string 74", "transactionPointUserName": "sample string 75", "vaultingMode": "sample string 76", "webForms": "sample string 77" }, "userStatus": "sample string 38", "userType": "sample string 39" }, "modifiedDate": "sample string 5", "toFolder": { "filter": { "actionRequired": "sample string 1", "expires": "sample string 2", "folderIds": "sample string 3", "fromDateTime": "sample string 4", "isTemplate": "sample string 5", "order": "sample string 6", "orderBy": "sample string 7", "searchTarget": "sample string 8", "searchText": "sample string 9", "status": "sample string 10", "toDateTime": "sample string 11" }, "folderId": "sample string 1", "folderItems": [ { "completedDateTime": "sample string 1", "createdDateTime": "sample string 2", "envelopeId": "sample string 3", "envelopeUri": "sample string 4", "expireDateTime": "sample string 5", "folderId": "sample string 6", "folderUri": "sample string 7", "is21CFRPart11": "sample string 8", "lastModifiedDateTime": "sample string 9", "ownerName": "sample string 10", "recipientsUri": "sample string 11", "senderCompany": "sample string 12", "senderEmail": "sample string 13", "senderName": "sample string 14", "senderUserId": "sample string 15", "sentDateTime": "sample string 16", "status": "sample string 17", "subject": "sample string 18", "templateId": "sample string 19", "templateUri": "sample string 20" } ], "folders": [ {} ], "hasAccess": "sample string 2", "hasSubFolders": "sample string 3", "itemCount": "sample string 4", "name": "sample string 5", "parentFolderId": "sample string 6", "parentFolderUri": "sample string 7", "subFolderCount": "sample string 8", "type": "sample string 9", "uri": "sample string 10" } } ], "nextUri": "sample string 2", "previousUri": "sample string 3", "resultSetSize": "sample string 4", "startPosition": "sample string 5", "totalSetSize": "sample string 6" } ```