--- title: "Updates recipients in a draft envelope or corrects recipient information for an in-process envelope." method: PUT path: "/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients" tags: ["EnvelopeRecipients"] --- # Updates recipients in a draft envelope or corrects recipient information for an in-process envelope. `PUT /v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients` Updates the recipients of a draft envelope or corrects recipient information for an in-process envelope. If you send information for a recipient that does not already exist in a draft envelope, the recipient is added to the envelope (similar to the [EnvelopeRecipients: Create][EnvelopeRecipients-create] method). You can also use this method to resend an envelope to a recipient by using the `resend_envelope` option. **Updating Sent Envelopes** After an envelope has been sent, you can edit only the following properties: - `accessCode` - `agentCanEditName` - `agentCanEditEmail` - `customFields` - `deliveryMethod` - `documentVisibility` - `email` (If you provide an email address in this method, it will be treated as a new email address, even if it is exactly the same as the current address. Do not provide an email address if you do not want a correction email sent.) - `emailNotification` - `idCheckConfigurationName` - `identityVerification` - `name` - `note` - `phoneAuthentication` - `recipientType` (For this to work, you must also change the recipient object to match the recipient type.) - `requireIdLookup` - `routingOrder` - `signingGroupId` (You can change this ID to switch to a different signing group and its corresponding set of recipients.) - `smsAuthentication` - `suppressEmails` - `userName` If the recipient has signed, but the envelope is still active, the method will return success, but the `recipientUpdateResults` property in the response will include an error that the recipient could not be updated: ``` { "recipientUpdateResults": [ { "recipientId": "999", "errorDetails": { "errorCode": "RECIPIENT_UPDATE_FAILED", "message": "The recipient could not be updated. Recipient not in state that allows correction." } } ] } ``` If the envelope is completed, and you try to change a recipient's address, the method will fail with this error: ``` { "errorCode": "ENVELOPE_INVALID_STATUS", "message": "Invalid envelope status. Envelope status is not one of: Created, Sent, Delivered, Correct." } ``` **Note:** This method works on recipients only. To add recipient tabs, use methods from the [EnvelopeRecipientTabs][recipientTabs] resource. For example, this request body will add a recipient (`astanton@example.com`) but **NOT** the Sign Here recipient tab. ```json { "signers": [ { "email": "astanton@example.com", "name": "Anne Stanton", "recipientId": "1", // THIS WILL NOT WORK "tabs": { "signHereTabs": [ { "anchorString": "below", "tooltip": "please sign here3" }, . . . ] } } ] } ``` [EnvelopeRecipients-create]: /docs/esign-rest-api/reference/envelopes/enveloperecipients/create/ [recipientTabs]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ ## Path parameters - `accountId` string, required - `envelopeId` string, required ## Query parameters - `combine_same_order_recipients` string - `offline_signing` string - `resend_envelope` string ## Request body - EnvelopeRecipients — Envelope recipients - `agents` Agent[] — A list of agent recipients assigned to the documents. - `accessCode` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `addAccessCodeToEmail` string — 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` RecipientAdditionalNotification[] — An array of additional notification objects. - `phoneNumber` RecipientPhoneNumber — Describes the recipient phone number. - `countryCode` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `number` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `secondaryDeliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `secondaryDeliveryMethodMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `secondaryDeliveryStatus` string — The status of the delivery. This property is read-only. One of: - `autoresponded` - `optedout` - `limitreached` - `allowSystemOverrideForLockedRecipient` string — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoRespondedReason` string — 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 - `clientUserId` string — 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 — 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` ConsentDetails[] - `consentKey` string - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `signerConsentStatus` string - `customFields` string[] — 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 — The date and time the recipient declined the document. This property is read-only. - `declinedReason` string — The reason the recipient declined the document. This property is read-only. - `deliveredDateTime` string — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `deliveryMethodMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `designatorId` string — Reserved for Docusign. - `designatorIdGuid` string — Reserved for Docusign. - `documentTemplateId` string - `documentVisibility` DocumentVisibility[] — 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.** - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `recipientId` string — 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 — Indicates whether the document is editable: - `editable` - `read_only` - `visible` string — When **true,** the document is visible to the recipient. - `email` string — The email ID of the agent. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. - `emailMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `emailNotification` RecipientEmailNotification — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailBody` string — The body of the email message. - `emailBodyMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `emailSubject` string — The subject line for the email notification. - `emailSubjectMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `supportedLanguage` string — 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][ListLang] method. [ListLang]: /docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/ - `supportedLanguageMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `emailRecipientPostSigningURL` string - `embeddedRecipientStartURL` string — 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 — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `excludedDocuments` string[] — 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 — Reserved for Docusign. - `faxNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `firstName` string — The recipient's first name. Maximum Length: 50 characters. - `firstNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fullName` string — Reserved for Docusign. - `fullNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckConfigurationName` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckInformationInput` IdCheckInformationInput — A complex element that contains input information related to a recipient ID check. - `addressInformationInput` AddressInformationInput — Contains address input information. - `addressInformation` AddressInformation — Contains address information. - `address1` string — The first line of the user's address. Maximum length: 100 characters. - `address2` string — The second line of the user's address. Maximum length: 100 characters. - `city` string — The user's city. Maximum length: 40 characters. - `country` string — The user's country. Maximum length: 50 characters. - `fax` string — A fax number associated with the address, if one is available. - `phone` string — A phone number associated with the address. - `postalCode` string — The user's postal code. Maximum length: 20 characters. - `stateOrProvince` string — The user's state or province. Maximum length: 40 characters. - `zipPlus4` string - `displayLevelCode` string — Specifies the display level for the recipient. Valid values are: * `ReadOnly` * `Editable` * `DoNotDisplay` - `receiveInResponse` string — A Boolean value that specifies whether the information must be returned in the response. - `dobInformationInput` DobInformationInput — Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse - `dateOfBirth` string — Specifies the recipient's date, month, and year of birth. - `displayLevelCode` string — Specifies the display level for the recipient. Valid values are: * `ReadOnly` * `Editable` * `DoNotDisplay` - `receiveInResponse` string — A Boolean value that specifies whether the information must be returned in the response. - `ssn4InformationInput` Ssn4InformationInput - `displayLevelCode` string — Specifies the display level for the recipient. Valid values are: * `ReadOnly` * `Editable` * `DoNotDisplay` - `receiveInResponse` string — A Boolean value that specifies whether the information must be returned in the response. - `ssn4` string — The last four digits of the recipient's Social Security Number (SSN). - `ssn9InformationInput` Ssn9InformationInput - `displayLevelCode` string — Specifies the display level for the recipient. Valid values are: * `ReadOnly` * `Editable` * `DoNotDisplay` - `ssn9` string — The recipient's full Social Security Number (SSN). - `identityVerification` 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/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. - `inputOptions` RecipientIdentityInputOption[] - `name` string - `phoneNumberList` RecipientIdentityPhoneNumber[] - `countryCode` string — 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 - `countryCodeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `extension` string — The telephone extension, if any. - `extensionMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `number` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `stringValue` string - `valueType` string - `workflowId` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `workflowLabel` string - `inheritEmailNotificationConfiguration` string — 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 — The recipient's last name. - `lastNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `lockedRecipientPhoneAuthEditable` string — Reserved for Docusign. - `lockedRecipientSmsEditable` string — Reserved for Docusign. - `name` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `note` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `phoneAuthentication` 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 — Boolean. When **true,** the recipient can supply a phone number their choice. - `recipMayProvideNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `recordVoicePrint` string — Reserved for Docusign. - `recordVoicePrintMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `senderProvidedNumbers` string[] — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `validateRecipProvidedNumber` string — Reserved for Docusign. - `validateRecipProvidedNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `phoneNumber` RecipientPhoneNumber — Describes the recipient phone number. - `countryCode` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `number` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `proofFile` 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 - `isInProofFile` string — Indicates whether a proof file is available for this recipient. - `recipientAttachments` RecipientAttachment[] — Reserved for Docusign. - `attachmentId` string — The unique identifier for the attachment. - `attachmentType` string — Specifies the type of the attachment for the recipient. Possible values are: - `.htm` - `.xml` - `data` string — 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 — An optional label for the attachment. - `name` string — The name of the attachment. - `remoteUrl` string — 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. - `recipientAuthenticationStatus` AuthenticationStatus — A complex element that contains information about a user's authentication status. - `accessCodeResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `ageVerifyResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `anySocialIDResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `facebookResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `googleResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `identityVerificationResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `idLookupResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `idQuestionsResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `linkedinResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `liveIDResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `ofacResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `openIDResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `phoneAuthResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `salesforceResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `signatureProviderResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `smsAuthResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `sTANPinResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `twitterResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `yahooResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `recipientFeatureMetadata` FeatureAvailableMetadata[] — Metadata about the features that are supported for the recipient type. This property is read-only. - `availabilty` string - `featureName` string - `recipientId` string — 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 — 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 — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `requireIdLookup` string — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `roleName` string — Optional element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. - `routingOrder` string — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `sentDateTime` string — The UTC DateTime when the envelope was sent. This property is read-only. - `signedDateTime` string — Reserved for Docusign. - `signingGroupId` string — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). - `signingGroupIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `signingGroupName` string — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` string - `signingGroupUsers` UserInfo[] — A complex type that contains information about users in the signing group. - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — 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 — A URI containing the user ID. - `userId` string — The ID of the user to access. - `userName` string — The name of the user. - `userStatus` string — Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` - `userType` string — The type of user, for example `CompanyUser`. - `smsAuthentication` RecipientSMSAuthentication — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `senderProvidedNumbers` string[] — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `socialAuthentications` SocialAuthentication[] — Deprecated. - `authentication` string — Reserved for Docusign. - `status` string — 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 — The code associated with the recipient's status. This property is read-only. - `suppressEmails` string — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `totalTabCount` string — The total number of tabs in the documents. This property is read-only. - `userId` string — 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 - `authorizedSignatories` AuthorizedSignatory[] - `accessCode` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `addAccessCodeToEmail` string — 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` RecipientAdditionalNotification[] — An array of additional notification objects. - `phoneNumber` RecipientPhoneNumber — Describes the recipient phone number. - `countryCode` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `number` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `secondaryDeliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `secondaryDeliveryMethodMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `secondaryDeliveryStatus` string — The status of the delivery. This property is read-only. One of: - `autoresponded` - `optedout` - `limitreached` - `agentCanEditEmail` string — 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 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 — When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. - `autoNavigation` string — When **true,** autonavigation is set for the recipient. - `autoRespondedReason` string — 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 — Reserved for Docusign. - `bulkSendV2Recipient` string - `canSignOffline` string — When **true,** specifies that the signer can perform the signing ceremony offline. - `clientUserId` string — 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 — 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` ConsentDetails[] - `consentKey` string - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `signerConsentStatus` string - `creationReason` string — The reason why the item was created. - `customFields` string[] — An optional array of strings that enables 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 — The date and time the recipient declined the document. This property is read-only. - `declinedReason` string — The reason the recipient declined the document. This property is read-only. - `defaultRecipient` string — When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. - `delegatedBy` DelegationInfo - `email` string - `name` string - `userAuthorizationId` string - `userId` string — 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. - `delegatedTo` DelegationInfo[] - `email` string - `name` string - `userAuthorizationId` string - `userId` string — 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. - `deliveredDateTime` string — The date and time that the envelope was delivered to the recipient. This property is read-only. - `deliveryMethod` string — 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][smsconcept] - [How to request a signature by SMS or WhatsApp delivery][howto] [smsconcept]: /docs/esign-rest-api/esign101/concepts/sms-delivery/using-sms-esignature/ [howto]: /docs/esign-rest-api/how-to/request-signature-sms-whatsapp/ - `deliveryMethodMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `designatorId` string — Reserved for Docusign. - `designatorIdGuid` string — Reserved for Docusign. - `documentTemplateId` string - `documentVisibility` DocumentVisibility[] — 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.** - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `recipientId` string — 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 — Indicates whether the document is editable: - `editable` - `read_only` - `visible` string — When **true,** the document is visible to the recipient. - `email` string - `emailMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `emailNotification` RecipientEmailNotification — Sets custom email subject and email body for individual recipients. **Note:** You must explicitly set `supportedLanguage` if you use this feature. - `emailBody` string — The body of the email message. - `emailBodyMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `emailSubject` string — The subject line for the email notification. - `emailSubjectMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `supportedLanguage` string — 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][ListLang] method. [ListLang]: /docs/esign-rest-api/reference/accounts/accounts/listsupportedlanguages/ - `supportedLanguageMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `emailRecipientPostSigningURL` string - `embeddedRecipientStartURL` string — 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 — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `excludedDocuments` string[] — 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 — Reserved for Docusign. - `faxNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `firstName` string — The user's first name. Maximum Length: 50 characters. - `firstNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fullName` string — Reserved for Docusign. - `fullNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckConfigurationName` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `idCheckInformationInput` IdCheckInformationInput — A complex element that contains input information related to a recipient ID check. - `addressInformationInput` AddressInformationInput — Contains address input information. - `addressInformation` AddressInformation — Contains address information. - `address1` string — The first line of the user's address. Maximum length: 100 characters. - `address2` string — The second line of the user's address. Maximum length: 100 characters. - `city` string — The user's city. Maximum length: 40 characters. - `country` string — The user's country. Maximum length: 50 characters. - `fax` string — A fax number associated with the address, if one is available. - `phone` string — A phone number associated with the address. - `postalCode` string — The user's postal code. Maximum length: 20 characters. - `stateOrProvince` string — The user's state or province. Maximum length: 40 characters. - `zipPlus4` string - `displayLevelCode` string — Specifies the display level for the recipient. Valid values are: * `ReadOnly` * `Editable` * `DoNotDisplay` - `receiveInResponse` string — A Boolean value that specifies whether the information must be returned in the response. - `dobInformationInput` DobInformationInput — Complex type containing: * dateOfBirth * displayLevelCode * receiveInResponse - `dateOfBirth` string — Specifies the recipient's date, month, and year of birth. - `displayLevelCode` string — Specifies the display level for the recipient. Valid values are: * `ReadOnly` * `Editable` * `DoNotDisplay` - `receiveInResponse` string — A Boolean value that specifies whether the information must be returned in the response. - `ssn4InformationInput` Ssn4InformationInput - `displayLevelCode` string — Specifies the display level for the recipient. Valid values are: * `ReadOnly` * `Editable` * `DoNotDisplay` - `receiveInResponse` string — A Boolean value that specifies whether the information must be returned in the response. - `ssn4` string — The last four digits of the recipient's Social Security Number (SSN). - `ssn9InformationInput` Ssn9InformationInput - `displayLevelCode` string — Specifies the display level for the recipient. Valid values are: * `ReadOnly` * `Editable` * `DoNotDisplay` - `ssn9` string — The recipient's full Social Security Number (SSN). - `identityVerification` 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/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. - `inputOptions` RecipientIdentityInputOption[] - `name` string - `phoneNumberList` RecipientIdentityPhoneNumber[] - `countryCode` string — 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 - `countryCodeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `extension` string — The telephone extension, if any. - `extensionMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `number` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `stringValue` string - `valueType` string - `workflowId` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `workflowLabel` string - `inheritEmailNotificationConfiguration` string — 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 — Reserved for Docusign. - `isBulkRecipientMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `lastName` string — The user's last name. Maximum Length: 50 characters. - `lastNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `lockedRecipientPhoneAuthEditable` string — Reserved for Docusign. - `lockedRecipientSmsEditable` string — Reserved for Docusign. - `name` string - `nameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `notaryId` string - `notarySignerEmailSent` string - `note` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `offlineAttributes` OfflineAttributes — Reserved for Docusign. - `accountEsignId` string — Reserved for Docusign. - `deviceModel` string — Reserved for Docusign. - `deviceName` string — Reserved for Docusign. - `gpsLatitude` string — Reserved for Docusign. - `gpsLongitude` string — Reserved for Docusign. - `offlineSigningHash` string — Reserved for Docusign. - `phoneAuthentication` 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 — Boolean. When **true,** the recipient can supply a phone number their choice. - `recipMayProvideNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `recordVoicePrint` string — Reserved for Docusign. - `recordVoicePrintMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `senderProvidedNumbers` string[] — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `validateRecipProvidedNumber` string — Reserved for Docusign. - `validateRecipProvidedNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `phoneNumber` RecipientPhoneNumber — Describes the recipient phone number. - `countryCode` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `number` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `proofFile` 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 - `isInProofFile` string — Indicates whether a proof file is available for this recipient. - `recipientAttachments` RecipientAttachment[] — Reserved for Docusign. - `attachmentId` string — The unique identifier for the attachment. - `attachmentType` string — Specifies the type of the attachment for the recipient. Possible values are: - `.htm` - `.xml` - `data` string — 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 — An optional label for the attachment. - `name` string — The name of the attachment. - `remoteUrl` string — 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. - `recipientAuthenticationStatus` AuthenticationStatus — A complex element that contains information about a user's authentication status. - `accessCodeResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `ageVerifyResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `anySocialIDResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `facebookResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `googleResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `identityVerificationResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `idLookupResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `idQuestionsResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `linkedinResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `liveIDResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `ofacResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `openIDResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `phoneAuthResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `salesforceResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `signatureProviderResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `smsAuthResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `sTANPinResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `twitterResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `yahooResult` EventResult — Information about the result of an event. - `eventTimestamp` string — Date/time of the event. - `failureDescription` string — Reason for failure, if the event failed. - `status` string — Event status. - `vendorFailureStatusCode` string — Failure status code, if the event failed. - `recipientFeatureMetadata` FeatureAvailableMetadata[] — Metadata about the features that are supported for the recipient type. This property is read-only. - `availabilty` string - `featureName` string - `recipientId` string — 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 — 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` RecipientSignatureProvider[] — 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/) - `sealDocumentsWithTabsOnly` string — 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. - `sealName` string — Indicates the name of the electronic seal to apply on documents. - `signatureProviderName` string — 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` - `signatureProviderNameMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `signatureProviderOptions` 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 — Reserved for Docusign. - `cpfNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `oneTimePassword` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `signerRole` string — The role or capacity of the signing recipient. Examples: Manager, Approver, etc. - `signerRoleMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `sms` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `recipientSuppliesTabs` string — When **true,** specifies that the recipient creates the tabs. - `recipientType` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `requireIdLookup` string — When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. - `requireIdLookupMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `requireSignerCertificate` string — 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 — When **true,** the signer must print, sign, and upload or fax the signed documents to Docusign. - `requireUploadSignature` string — 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 element. Specifies the role name associated with the recipient.

This property is required when you are working with template recipients. - `routingOrder` string — Specifies the routing order of the recipient in the envelope. - `routingOrderMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `sentDateTime` string — The UTC DateTime when the envelope was sent. This property is read-only. - `signatureInfo` 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 — 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 — Specifies the user's signature in initials format. - `signatureName` string — Specifies the user's signature name. - `signedDateTime` string — Reserved for Docusign. - `signInEachLocation` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `signingGroupId` string — The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). **Note:** When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, Docusign recommends that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change t he default action of Needs to Sign to a different value, such as Receives a Copy. - `signingGroupIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `signingGroupName` string — Optional. The name of the signing group. Maximum Length: 100 characters. - `signingGroupType` string - `signingGroupUsers` UserInfo[] — A complex type that contains information about users in the signing group. - `accountId` string — The account ID associated with the envelope. - `accountName` string — The name on the account. - `activationAccessCode` string — Access code provided to the user to activate the account. - `email` string — The user's email address. - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `ipAddress` string - `loginStatus` string — When **true,** indicates that the user is logged in. This is a read-only property. - `membershipId` string — The user's membership ID. - `sendActivationEmail` string — 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 — A URI containing the user ID. - `userId` string — The ID of the user to access. - `userName` string — The name of the user. - `userStatus` string — Status of the user's account. One of: - `ActivationRequired` - `ActivationSent` - `Active` - `Closed` - `Disabled` - `userType` string — The type of user, for example `CompanyUser`. - `smsAuthentication` RecipientSMSAuthentication — Contains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication. - `senderProvidedNumbers` string[] — An array containing a list of phone numbers that the recipient can use for SMS text authentication. - `senderProvidedNumbersMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `socialAuthentications` SocialAuthentication[] — Deprecated. - `authentication` string — Reserved for Docusign. - `status` string — The status of the item. - `statusCode` string — Reserved for Docusign. - `suppressEmails` string — When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. - `tabs` EnvelopeRecipientTabs — All of the tabs associated with a recipient. Each property is a list of a type of tab. - `approveTabs` Approve[] — A list of [Approve tabs][approve]. 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. [approve]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - `agreementAttribute` string - `agreementAttributeLocked` string - `anchorAllowWhiteSpaceInCharacters` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorCaseSensitive` string — This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** 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. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ - `anchorCaseSensitiveMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorHorizontalAlignment` string — This property controls how [anchor tabs][AnchorTabs] 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. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ - `anchorHorizontalAlignmentMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorIgnoreIfNotPresent` string — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorMatchWholeWord` string — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** 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. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ - `anchorMatchWholeWordMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorString` string — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorTabProcessorVersion` string — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorTabScope` string - `anchorUnits` string — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorXOffset` string — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorXOffsetMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorYOffset` string — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffsetMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `bold` string — When **true,** the information in the tab is bold. - `boldMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `buttonText` string — Specifies the approval text that displays in the tab. - `buttonTextMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `caption` string - `captionMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `conditionalParentLabel` string — For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `conditionalParentValue` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `connectedObjectDetails` ConnectedObjectDetails - `recordId` string - `customTabId` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `extensionData` ExtensionData - `actionContract` string - `actionInputKey` string - `actionName` string - `applicationId` string - `applicationName` string - `connectedFieldsData` ConnectedData - `propertyName` string - `supportedOperation` string - `supportedUri` string - `typeName` string - `typeSystemNamespace` string - `connectionInstances` ConnectionInstance[] - `connectionKey` string - `connectionValue` string - `extensionContract` string - `extensionGroupId` string - `extensionName` string - `extensionPolicy` string - `publisherName` string - `requiredForExtension` string - `font` string — 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 — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fontMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fontSize` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `formOrder` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `formPageLabel` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `formPageNumber` string — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `height` string — The height of the tab in pixels. Must be an integer. - `heightMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `italic` string — When **true,** the information in the tab is italic. - `italicMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `localePolicy` LocalePolicyTab — Allows you to customize locale settings. - `addressFormat` string — Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw` - `calendarType` string — Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist` - `cultureName` string — The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. - `currencyCode` string — 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 — 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 — 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 - `customTimeFormat` string - `dateFormat` string — 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 — 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 — 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 — 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 — 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 — When **true,** use the long currency format for the locale. - `mergeField` MergeField — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `allowSenderToEdit` string — When **true,** the sender can modify the value of the `mergeField` tab during the sending process. - `allowSenderToEditMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `configurationType` string — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. - `configurationTypeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `path` string — Sets the object associated with the custom tab. Currently this is the Salesforce Object. - `pathExtended` PathExtendedElement[] — Reserved for Docusign. - `name` string - `type` string — 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 - `pathExtendedMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `pathMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `row` string — Specifies the row number in a Salesforce table that the merge field value corresponds to. - `rowMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `writeBack` string — When **true,** data entered into the merge field during Signing will update the mapped Salesforce field. - `writeBackMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `mergeFieldXml` string — Reserved for Docusign. - `pageNumber` string — Specifies the page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `recipientId` string — 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 — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `recipientIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `smartContractInformation` SmartContractInformation - `code` string — Reserved for Docusign. - `uri` string — Reserved for Docusign. - `source` string — Reserved for Docusign. - `status` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabFullyQualifiedPath` string - `tabGroupLabels` string[] — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabId` string — The unique identifier for the tab. - `tabIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabLabel` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabOrder` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabType` string — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tooltip` string — **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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `underline` string — When **true,** the information in the tab is underlined. - `underlineMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `warningDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `width` string — The width of the tab in pixels. Must be an integer. - `widthMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `xPosition` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `yPosition` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `checkboxTabs` Checkbox[] — A list of [Checkbox tabs][checkbox]. A Checkbox tab enables the recipient to select a yes/no (on/off) option. This value can be set. [checkbox]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ - `agreementAttribute` string - `agreementAttributeLocked` string - `anchorAllowWhiteSpaceInCharacters` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorCaseSensitive` string — This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** 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. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ - `anchorCaseSensitiveMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorHorizontalAlignment` string — This property controls how [anchor tabs][AnchorTabs] 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. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ - `anchorHorizontalAlignmentMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorIgnoreIfNotPresent` string — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorMatchWholeWord` string — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** 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. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ - `anchorMatchWholeWordMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorString` string — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorTabProcessorVersion` string — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorTabScope` string - `anchorUnits` string — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorXOffset` string — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorXOffsetMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorYOffset` string — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffsetMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `bold` string — When **true,** the information in the tab is bold. - `boldMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `caption` string - `captionMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `conditionalParentLabel` string — For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `conditionalParentValue` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `connectedObjectDetails` ConnectedObjectDetails - `recordId` string - `customTabId` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `extensionData` ExtensionData - `actionContract` string - `actionInputKey` string - `actionName` string - `applicationId` string - `applicationName` string - `connectedFieldsData` ConnectedData - `propertyName` string - `supportedOperation` string - `supportedUri` string - `typeName` string - `typeSystemNamespace` string - `connectionInstances` ConnectionInstance[] - `connectionKey` string - `connectionValue` string - `extensionContract` string - `extensionGroupId` string - `extensionName` string - `extensionPolicy` string - `publisherName` string - `requiredForExtension` string - `font` string — 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 — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fontMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fontSize` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `formOrder` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `formPageLabel` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `formPageNumber` string — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `height` string — The height of the tab in pixels. Must be an integer. - `heightMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `italic` string — When **true,** the information in the tab is italic. - `italicMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `locked` string — When **true,** the signer cannot change the data of the custom tab. - `lockedMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `mergeField` MergeField — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `allowSenderToEdit` string — When **true,** the sender can modify the value of the `mergeField` tab during the sending process. - `allowSenderToEditMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `configurationType` string — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. - `configurationTypeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `path` string — Sets the object associated with the custom tab. Currently this is the Salesforce Object. - `pathExtended` PathExtendedElement[] — Reserved for Docusign. - `name` string - `type` string — 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 - `pathExtendedMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `pathMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `row` string — Specifies the row number in a Salesforce table that the merge field value corresponds to. - `rowMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `writeBack` string — When **true,** data entered into the merge field during Signing will update the mapped Salesforce field. - `writeBackMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `mergeFieldXml` string — Reserved for Docusign. - `name` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `pageNumber` string — The page number on which the tab is located. For supplemental documents, this value must be `1`. - `pageNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `recipientId` string — 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 — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `recipientIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `required` string — 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`][tabGroup]. Then set the following `tabGroup` properties: - [`maximumAllowed`][maximumAllowed] - [`minimumRequired`][minimumRequired] - [`groupRule`][groupRule] specifies how the other two properties are interpreted. You can find an example at [Stack Overflow][so]. [so]: https://stackoverflow.com/questions/58209376/checkbox-validation-using-docusign-rest-api/58210277#58210277 [tabGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups [groupRule]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#definition__enveloperecipienttabs_tabgroups_grouprule [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 - `requiredMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `requireInitialOnSharedChange` string — Optional element for field markup. When **true,** the signer is required to initial when they modify a shared field. - `requireInitialOnSharedChangeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `selected` string — When **true,** the checkbox is selected. - `selectedMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `selectedOriginal` string - `selectedOriginalMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `shared` string — When **true,** this tab is shared. - `sharedMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `shareToRecipients` string — Reserved for Docusign. - `shareToRecipientsMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `smartContractInformation` SmartContractInformation - `code` string — Reserved for Docusign. - `uri` string — Reserved for Docusign. - `source` string — Reserved for Docusign. - `status` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabFullyQualifiedPath` string - `tabGroupLabels` string[] — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabId` string — The unique identifier for the tab. - `tabIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabLabel` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabOrder` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabType` string — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tooltip` string — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `underline` string — When **true,** the information in the tab is underlined. - `underlineMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `warningDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `width` string — The width of the tab in pixels. Must be an integer. - `widthMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `xPosition` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `yPosition` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `commentThreadTabs` CommentThread[] — 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. - `agreementAttribute` string - `agreementAttributeLocked` string - `anchorAllowWhiteSpaceInCharacters` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorCaseSensitive` string — This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** 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. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ - `anchorCaseSensitiveMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorHorizontalAlignment` string — This property controls how [anchor tabs][AnchorTabs] 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. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ - `anchorHorizontalAlignmentMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorIgnoreIfNotPresent` string — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorMatchWholeWord` string — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** 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. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ - `anchorMatchWholeWordMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorString` string — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorTabProcessorVersion` string — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorTabScope` string - `anchorUnits` string — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorXOffset` string — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorXOffsetMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorYOffset` string — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffsetMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `bold` string — When **true,** the information in the tab is bold. - `boldMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `caption` string - `captionMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `comments` Comment[] — An array of comment tabs that contain information about users' comments on documents. - `envelopeId` string — The Guid of the envelope the comment thread belongs to. - `hmac` string — Reserved for Docusign. - `id` string — The unique identifier for the comment. - `mentions` string[] — An array of userIds that are mentioned directly in the body of a comment. - `read` boolean — When **true,** indicates that the comment was read. - `sentByEmail` string — The email address of the user who created the comment. - `sentByFullName` string — The full name of the user who created the comment. - `sentByImageId` string — Reserved for Docusign. - `sentByInitials` string — The initials of the user who created the comment. - `sentByRecipientId` string — The recipient ID of the user who created the comment. - `sentByUserId` string — The user ID of the user who created the comment. - `signingGroupId` string — The ID of the signing group that can view the comment or that created the comment. - `signingGroupName` string — Optional. The name of the signing group. Maximum Length: 100 characters. - `subject` string — The subject of the envelope. - `tabId` string — The unique identifier for the tab that represents the comment thread. - `text` string — 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 — The unique identifier for the comment thread. - `threadOriginatorId` string — The userId of the user who created the thread. - `timestamp` string — The time the comment was created. - `timeStampFormatted` string — The time the comment was created, formatted according to the format of the user who created the comment. - `visibleTo` string[] — The user IDs of the users that the comment is visible to. - `conditionalParentLabel` string — For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `conditionalParentValue` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `connectedObjectDetails` ConnectedObjectDetails - `recordId` string - `customTabId` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `extensionData` ExtensionData - `actionContract` string - `actionInputKey` string - `actionName` string - `applicationId` string - `applicationName` string - `connectedFieldsData` ConnectedData - `propertyName` string - `supportedOperation` string - `supportedUri` string - `typeName` string - `typeSystemNamespace` string - `connectionInstances` ConnectionInstance[] - `connectionKey` string - `connectionValue` string - `extensionContract` string - `extensionGroupId` string - `extensionName` string - `extensionPolicy` string - `publisherName` string - `requiredForExtension` string - `font` string — 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 — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fontMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fontSize` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `formOrder` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `formPageLabel` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `formPageNumber` string — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `height` string — The height of the tab in pixels. Must be an integer. - `heightMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `italic` string — When **true,** the information in the tab is italic. - `italicMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `localePolicy` LocalePolicyTab — Allows you to customize locale settings. - `addressFormat` string — Specifies the address format. Valid values: - `en_us` - `ja_jp` - `zh_cn_tw` - `calendarType` string — Specifies the type of calendar. Valid values: - `gregorian` - `japanese` - `buddhist` - `cultureName` string — The two letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. - `currencyCode` string — 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 — 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 — 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 - `customTimeFormat` string - `dateFormat` string — 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 — 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 — 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 — 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 — 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 — When **true,** use the long currency format for the locale. - `mergeField` MergeField — Contains information for transferring values between Salesforce data fields and Docusign tabs. - `allowSenderToEdit` string — When **true,** the sender can modify the value of the `mergeField` tab during the sending process. - `allowSenderToEditMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `configurationType` string — If you are using merge fields, this property specifies the type of the merge field. The only supported value is `salesforce`. - `configurationTypeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `path` string — Sets the object associated with the custom tab. Currently this is the Salesforce Object. - `pathExtended` PathExtendedElement[] — Reserved for Docusign. - `name` string - `type` string — 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 - `pathExtendedMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `pathMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `row` string — Specifies the row number in a Salesforce table that the merge field value corresponds to. - `rowMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `writeBack` string — When **true,** data entered into the merge field during Signing will update the mapped Salesforce field. - `writeBackMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `mergeFieldXml` string — Reserved for Docusign. - `pageNumber` string — Specifies the page number on which the tab is located. - `pageNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `recipientId` string — 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 — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `recipientIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `smartContractInformation` SmartContractInformation - `code` string — Reserved for Docusign. - `uri` string — Reserved for Docusign. - `source` string — Reserved for Docusign. - `status` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabFullyQualifiedPath` string - `tabGroupLabels` string[] — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabId` string — The unique identifier for the tab. - `tabIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabLabel` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabOrder` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `tabType` string — Indicates the type of tab (for example, `signHere` or `initialHere`). - `tabTypeMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `templateLocked` string — When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. - `templateLockedMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `templateRequired` string — When **true,** the sender may not remove the recipient. Used only when working with template recipients. - `templateRequiredMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `threadId` string — The unique identifier for the comment thread. - `tooltip` string — The text of a tooltip that appears when a user hovers over a form field or tab. - `toolTipMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `underline` string — When **true,** the information in the tab is underlined. - `underlineMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `warningDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `width` string — The width of the tab in pixels. Must be an integer. - `widthMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `xPosition` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `yPosition` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `commissionCountyTabs` CommissionCounty[] — A list of [Commission County tabs][cc]. 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][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ - `agreementAttribute` string - `agreementAttributeLocked` string - `anchorAllowWhiteSpaceInCharacters` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorCaseSensitive` string — This property controls how [anchor tabs][AnchorTabs] are placed. When **true,** the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false.** 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. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ - `anchorCaseSensitiveMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorHorizontalAlignment` string — This property controls how [anchor tabs][AnchorTabs] 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. [AnchorTabs]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ - `anchorHorizontalAlignmentMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorIgnoreIfNotPresent` string — When **true,** this tab is ignored if the `anchorString` is not found in the document. - `anchorIgnoreIfNotPresentMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorMatchWholeWord` string — When **true,** the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false.** 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. [AnchorTab]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ - `anchorMatchWholeWordMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorString` string — Specifies the string to find in the document and use as the basis for tab placement. - `anchorStringMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorTabProcessorVersion` string — Reserved for Docusign. - `anchorTabProcessorVersionMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorTabScope` string - `anchorUnits` string — Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are: - `pixels` (default) - `inches` - `mms` - `cms` - `anchorUnitsMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorXOffset` string — Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorXOffsetMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `anchorYOffset` string — Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`. - `anchorYOffsetMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `bold` string — When **true,** the information in the tab is bold. - `boldMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `caption` string - `captionMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `concealValueOnDocument` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `conditionalParentLabel` string — For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. - `conditionalParentLabelMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `conditionalParentValue` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `connectedObjectDetails` ConnectedObjectDetails - `recordId` string - `customTabId` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `disableAutoSize` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `documentId` string — Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. - `documentIdMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `errorDetails` ErrorDetails — This object describes errors that occur. It is only valid for responses and ignored in requests. - `errorCode` string — The code associated with the error condition. - `message` string — A brief message describing the error condition. - `extensionData` ExtensionData - `actionContract` string - `actionInputKey` string - `actionName` string - `applicationId` string - `applicationName` string - `connectedFieldsData` ConnectedData - `propertyName` string - `supportedOperation` string - `supportedUri` string - `typeName` string - `typeSystemNamespace` string - `connectionInstances` ConnectionInstance[] - `connectionKey` string - `connectionValue` string - `extensionContract` string - `extensionGroupId` string - `extensionName` string - `extensionPolicy` string - `publisherName` string - `requiredForExtension` string - `font` string — 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 — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fontMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `fontSize` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `formOrder` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `formPageLabel` string — 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 — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `formPageNumber` string — An integer specifying the order in which to present the guided form pages. - `formPageNumberMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `height` string — The height of the tab in pixels. Must be an integer. - `heightMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `italic` string — When **true,** the information in the tab is italic. - `italicMetadata` PropertyMetadata — Metadata about a property. - `options` string[] — An array of option strings supported by this setting. - `rights` string — Indicates whether the property is editable. Valid values are: - `editable` - `read_only` - `localePolicy` LocalePolicyTab — Allows you to customize locale settings. - … truncated; see the full OpenAPI document linked below ## Response `200` Successful response. ## Other responses - `400` — Error encountered. --- [API](https://skmtc.net/docusign/apis/docusign-esignature-rest-api.md) · [All operations](https://skmtc.net/docusign/apis/docusign-esignature-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/docusign/docusign-esignature-rest-api/revisions/77f1998c313d/schema)