DocuSign: Esignature schemas (part 35)
23 DocuSign schemas with complete fields and constraints.
← Esignature operations · All schemas
Updates recipients in a template — request body — body witnesses item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex type containing information about a witness recipient. Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. |
accessCode | string | Optional | If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. |
accessCodeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `accessCode` property is editable. This property is read-only. |
addAccessCodeToEmail | string | Optional | Optional. When **true,** the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. |
additionalNotifications | array | Optional | An array of additional notification objects. |
additionalNotifications[] | Model | Each item | Expand Deletes recipients from a template — response body — agents item additional Notifications item |
agentCanEditEmail | string | Optional | Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account. |
agentCanEditName | string | Optional | Optional element. When **true,** the agents recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account. |
allowSystemOverrideForLockedRecipient | string | Optional | When **true,** if the recipient is locked on a template, advanced recipient routing can override the lock. |
autoNavigation | string | Optional | When **true,** autonavigation is set for the recipient. |
autoRespondedReason | string | Optional | Error message provided by the destination email system. This field is only provided if the email notification to the recipient fails to send. This property is read-only. |
bulkRecipientsUri | string | Optional | Reserved for Docusign. |
bulkSendV2Recipient | string | Optional | |
canSignOffline | string | Optional | When **true,** specifies that the signer can perform the signing ceremony offline. |
clientUserId | string | Optional | Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. If the `clientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true,** an error is generated on sending. **Note:** This property is not returned by the [listStatusChanges](/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/) endpoint. Maximum length: 100 characters. |
completedCount | string | Optional | Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. This property is read-only. |
consentDetailsList | array | Optional | |
consentDetailsList[] | Model | Each item | Expand Deletes recipients from a template — response body — agents item consent Details List item |
creationReason | string | Optional | The reason why the recipient was created (for example, `sender`). This property is read-only. |
customFields | array | Optional | An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each customField string can be a maximum of 100 characters. |
customFields[] | string | Each item | |
declinedDateTime | string | Optional | The date and time the recipient declined the document. This property is read-only. |
declinedReason | string | Optional | The reason the recipient declined the document. This property is read-only. |
defaultRecipient | string | Optional | When **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. |
delegatedBy | Model | Optional | Expand Deletes recipients from a template — response body — signers item delegated By |
delegatedTo | array | Optional | |
delegatedTo[] | Model | Each item | Expand Deletes recipients from a template — response body — signers item delegated By |
deliveredDateTime | string | Optional | The date and time that the envelope was delivered to the recipient. This property is read-only. |
deliveryMethod | string | Optional | The delivery method. One of: - `email` - `fax` - `SMS` - `WhatsApp` - `offline` The `SMS` and `WhatsApp` delivery methods are limited to `signer`, `carbonCopy`, and `certifiedDelivery` recipients. **Related topics** - [Using SMS delivery with the eSignature API][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 | Model | Optional | Expand Updates a template document — response body — name Metadata Reserved for Docusign. |
designatorId | string | Optional | Reserved for Docusign. |
designatorIdGuid | string | Optional | Reserved for Docusign. |
documentTemplateId | string | Optional | |
documentVisibility | array | Optional | A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true.** |
documentVisibility[] | Model | Each item | Expand Updates document visibility for recipients — response body — document Visibility item |
email | string | Optional | The recipient's email address. |
emailMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `email` property is editable. This property is read-only. |
emailNotification | Model | Optional | Expand Deletes recipients from a template — response body — seals item email Notification This optional property allows you to set a specific email subject and body for this recipient's notification email. **Note:** If you use this property, you _must_ provide a value for the `supportedLanguage` sub-property. You can set the `emailNotification` property separately for each recipient. If you set the value only for certain recipients, the other recipients are assigned the values from the top-level `emailSubject` and `emailBlurb`. |
emailRecipientPostSigningURL | string | Optional | |
embeddedRecipientStartURL | string | Optional | Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from Docusign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through Docusign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. When `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at Docusign. The signing or viewing action is initiated by the Docusign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation launched by a partner. It is important to understand that in a typical embedded workflow, the authentication of an embedded recipient is the responsibility of the sending application. Docusign expects that senders will follow their own processes for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process is initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process, bypassing the sending application and any authentication steps the sending application would use. In this case, Docusign recommends that you use one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: `envelopeId`, `recipientId`, `recipientName`, `recipientEmail`, and `customFields`. The `customFields` property must be set for the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
excludedDocuments | array | Optional | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. |
excludedDocuments[] | string | Each item | |
faxNumber | string | Optional | Reserved for Docusign. |
faxNumberMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Reserved for Docusign. |
firstName | string | Optional | The recipient's first name. Maximum Length: 50 characters. |
firstNameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `firstName` property is editable. This property is read-only. |
fullName | string | Optional | Reserved for Docusign. |
fullNameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Reserved for Docusign. |
idCheckConfigurationName | string | Optional | The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. **Example:** Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. |
idCheckConfigurationNameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only. |
idCheckInformationInput | Model | Optional | Expand Deletes recipients from a template — response body — seals item id Check Information Input An object that contains input information related to a recipient ID check. |
identityVerification | Model | Optional | Expand Deletes recipients from a template — response body — seals item identity Verification Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>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. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=kzp1578456318101.html) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). |
inheritEmailNotificationConfiguration | string | Optional | When **true** and the envelope recipient creates a Docusign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. |
isBulkRecipient | string | Optional | Reserved for Docusign. |
isBulkRecipientMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Reserved for Docusign. |
lastName | string | Optional | The recipient's last name. |
lastNameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `lastName` property is editable. This property is read-only. |
lockedRecipientPhoneAuthEditable | string | Optional | Reserved for Docusign. |
lockedRecipientSmsEditable | string | Optional | Reserved for Docusign. |
name | string | Optional | The full legal name of the recipient. Maximum Length: 100 characters. **Note:** You must always set a value for this property in requests, even if `firstName` and `lastName` are set. |
nameMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `name` property is editable. This property is read-only. |
notaryId | string | Optional | |
notarySignerEmailSent | string | Optional | |
note | string | Optional | A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. |
noteMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `note` property is editable. This property is read-only. |
offlineAttributes | Model | Optional | Expand Deletes recipients from a template — response body — signers item offline Attributes Reserved for Docusign. |
phoneAuthentication | Model | Optional | Expand Deletes recipients from a template — response body — seals item phone Authentication When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for Docusign. * `validateRecipProvidedNumber`: Reserved for Docusign. |
phoneNumber | Model | Optional | Expand Deletes recipients from a template — response body — agents item phone Number Describes the recipient phone number. |
proofFile | Model | Optional | Expand Deletes recipients from a template — response body — seals item proof File The proof file of the recipient. |
recipientAttachments | array | Optional | Reserved for Docusign. |
recipientAttachments[] | Model | Each item | Expand Deletes recipients from a template — response body — seals item recipient Attachments item |
recipientAuthenticationStatus | Model | Optional | Expand Deletes recipients from a template — response body — seals item recipient Authentication Status Information about the recipient's authentication status. This property is read-only. |
recipientFeatureMetadata | array | Optional | Metadata about the features that are supported for the recipient type. This property is read-only. |
recipientFeatureMetadata[] | Model | Each item | Expand Deletes recipients from a template — response body — seals item recipient Feature Metadata item |
recipientId | string | Optional | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |
recipientIdGuid | string | Optional | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. This property is read-only. |
recipientSignatureProviders | array | Optional | The default signature provider is the Docusign Electronic signature system. This parameter is used to specify one or more Standards Based Signature (digital signature) providers for the signer to use. [More information.](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/) |
recipientSignatureProviders[] | Model | Each item | Expand Deletes recipients from a template — response body — seals item recipient Signature Providers item |
recipientSuppliesTabs | string | Optional | When **true,** specifies that the recipient creates the tabs. |
recipientType | string | Optional | The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are Docusign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. |
recipientTypeMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `recipientType` property is editable. This property is read-only. |
requireIdLookup | string | Optional | When **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. |
requireIdLookupMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only. |
requireSignOnPaper | string | Optional | When **true,** the signer must print, sign, and upload or fax the signed documents to Docusign. |
requireSignerCertificate | string | Optional | By default, Docusign signers create electronic signatures. This field can be used to require the signer to use a SAFE-BioPharma digital certificate for signing. This parameter should only be used to select a SAFE-BioPharma certificate. New integrations should use the `recipientSignatureProviders` parameter for other types of digital certificates. Set this parameter to `safe` to use a SAFE-BioPharma certificate. The signer must be enrolled in the SAFE program to sign with a SAFE certificate. |
requireUploadSignature | string | Optional | When **true,** the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal Docusign account. |
roleName | string | Optional | Optional element. Specifies the role name associated with the recipient.<br/><br/>This property is required when you are working with template recipients. |
routingOrder | string | Optional | Specifies the routing order of the recipient in the envelope. |
routingOrderMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `routingOrder` property is editable. This property is read-only. |
sentDateTime | string | Optional | The UTC DateTime when the envelope was sent. This property is read-only. |
signInEachLocation | string | Optional | When **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). |
signInEachLocationMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only. |
signatureInfo | Model | Optional | Expand Deletes recipients from a template — response body — signers item signature Info Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. |
signedDateTime | string | Optional | Reserved for Docusign. |
signingGroupId | string | Optional | The ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html). |
signingGroupIdMetadata | Model | Optional | Expand Updates a template document — response body — name Metadata Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only. |
signingGroupName | string | Optional | Optional. The name of the signing group. Maximum Length: 100 characters. |
signingGroupType | string | Optional | |
signingGroupUsers | array | Optional | A complex type that contains information about users in the signing group. |
signingGroupUsers[] | Model | Each item | Expand Gets a specific template associated with a specified account — response body — owner |
smsAuthentication | Model | Optional | Expand Deletes recipients from a template — response body — seals item sms Authentication When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. |
socialAuthentications | array | Optional | Deprecated. |
socialAuthentications[] | Model | Each item | Expand Deletes recipients from a template — response body — seals item social Authentications item |
status | string | Optional | The recipient's status. This property is read-only. Valid values: - `autoresponded`: The recipient's email system auto-responded to the email from Docusign. This status is used in the web console to inform senders about the bounced-back email. This recipient status is only used if **Send-on-behalf-of** is turned off for the account. - `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope. - `created`: The recipient is in a draft state. This value is only associated with draft envelopes (envelopes that have a status of `created`). - `declined`: The recipient declined to sign the documents in the envelope. - `delivered`: The recipient has viewed the documents in an envelope through the Docusign signing website. This is not an email delivery of the documents in an envelope. - `faxPending`: The recipient has finished signing and the system is waiting for a fax attachment from the recipient before completing their signing step. - `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope. - `signed`: The recipient has completed (signed) all required tags in an envelope. This is a temporary state during processing, after which the recipient's status automatically switches to `completed`. |
statusCode | string | Optional | The code associated with the recipient's status. This property is read-only. |
suppressEmails | string | Optional | When **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox. |
tabs | Model | Optional | Expand Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — request body — body A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. |
templateLocked | string | Optional | When **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
templateRequired | string | Optional | When **true,** the sender may not remove the recipient. Used only when working with template recipients. |
totalTabCount | string | Optional | The total number of tabs in the documents. This property is read-only. |
userId | string | Optional | The ID of the user to access. **Note:** Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings. |
webFormRecipientViewId | string | Optional | |
witnessFor | string | Optional | The `recipientId` of the person or party for whom the recipient is a witness. |
witnessForGuid | string | Optional | Not used. Use the `witnessFor` property instead. |
Referenced models: Deletes recipients from a template — response body — seals item recipient Authentication Status, Deletes recipients from a template — response body — agents item consent Details List item, Deletes recipients from a template — response body — signers item delegated By, Updates document visibility for recipients — response body — document Visibility item, Locks a template — response body — error Details, Deletes recipients from a template — response body — seals item recipient Feature Metadata item, Deletes recipients from a template — response body — seals item id Check Information Input, Deletes recipients from a template — response body — signers item offline Attributes, Updates a template document — response body — name Metadata, Deletes recipients from a template — response body — agents item additional Notifications item, Deletes recipients from a template — response body — seals item recipient Attachments item, Deletes recipients from a template — response body — seals item email Notification, Deletes recipients from a template — response body — seals item identity Verification, Deletes recipients from a template — response body — seals item phone Authentication, Deletes recipients from a template — response body — agents item phone Number, Deletes recipients from a template — response body — seals item proof File, Deletes recipients from a template — response body — seals item sms Authentication, Deletes recipients from a template — response body — signers item signature Info, Deletes recipients from a template — response body — seals item recipient Signature Providers item, Deletes recipients from a template — response body — seals item social Authentications item, Gets a specific template associated with a specified account — response body — owner, Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — request body — body
Updates recipients in a template — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This is the response that the API returns after you update recipients. |
recipientUpdateResults | array | Optional | An array of `recipientUpdateResults` objects that contain details about the recipients. |
recipientUpdateResults[] | Model | Each item | Expand Updates an existing template — response body — recipient Update Results item |
Referenced models: Updates an existing template — response body — recipient Update Results item
Updates sender fields for an envelope — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object maps the document generation fields to their values. |
docGenFormFields | array | Optional | A list of `docGenFormFields` objects. |
docGenFormFields[] | Model | Each item | Expand Returns sender fields for an envelope — response body — doc Gen Form Fields item |
Referenced models: Returns sender fields for an envelope — response body — doc Gen Form Fields item
Updates the Electronic Record and Signature Disclosure for an account — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about consumer disclosures. |
accountEsignId | string | Optional | The GUID of the account associated with the consumer disclosure. |
allowCDWithdraw | string | Optional | When **true,** indicates that the customer can withdraw their consent to the consumer disclosure when they decline to sign documents. If these recipients sign documents sent to them from your account in the future, they will be required to agree to the terms in the disclosure. The default value is **false.** **Note:** Only Admin users can change this setting. |
allowCDWithdrawMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `allowCDWithdraw` property is editable. |
changeEmail | string | Optional | If the customer needs to change their email address, this is the email address to which they should the change request. Maximum length: 100 characters. |
changeEmailOther | string | Optional | Other information about the requirements for the user to change their email address. Maximum length: 255 characters. Example: `We do not require any other information from you to change your email address.` |
companyName | string | Optional | Specifies the company name used in the disclosure. The default value is the account name. However, if your account uses signing brands that specify a company name, you can substitute the brand's company name by setting the `useBrand` property to **true.** Whenever an envelope is sent from the account that uses a signing brand with a specified `companyName`, that value is used in email notifications and in the signing experience. **Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. You must also set the value of the `useBrand` property to **true.** |
companyPhone | string | Optional | The phone number of the company associated with the consumer disclosure, as a free-formatted string. |
copyCostPerPage | string | Optional | The cost per page if the customer requests paper copies. Example: `0.0000` |
copyFeeCollectionMethod | string | Optional | Specifies the fee collection method for cases in which the customer requires paper copies of the document. Maximum length: 255 characters. Example: `We will bill you for any fees at that time, if any.` |
copyRequestEmail | string | Optional | The email address to which the customer should send a request for copies of a document. Maximum length: 100 characters. |
custom | string | Optional | When **true,** indicates that the consumer disclosure is a custom disclosure. The default is **false.** |
enableEsign | string | Optional | When **true** (default), indicates that eSign is enabled. |
esignAgreement | string | Optional | The final, assembled text of the Electronic Record and Signature Disclosure that includes the appropriate `companyName` and other specifics. It also includes the HTML tags used for formatting. |
esignText | string | Optional | The template for the Electronic Record and Signature Disclosure, which contains placeholders for information such as the `companyName`. It also includes the HTML tags used for formatting. **Note:** If you are switching to or updating a custom disclosure, you can edit both the text and the HTML formatting. |
languageCode | string | Optional | The code for the language version of the disclosure. The following languages are supported: - Arabic (`ar`) - Bulgarian (`bg`) - Czech (`cs`) - Chinese Simplified (`zh_CN`) - Chinese Traditional (`zh_TW`) - Croatian (`hr`) - Danish (`da`) - Dutch (`nl`) - English US (`en`) - English UK (`en_GB`) - Estonian (`et`) - Farsi (`fa`) - Finnish (`fi`) - French (`fr`) - French Canadian (`fr_CA`) - German (`de`) - Greek (`el`) - Hebrew (`he`) - Hindi (`hi`) - Hungarian (`hu`) - Bahasa Indonesian (`id`) - Italian (`it`) - Japanese (`ja`) - Korean (`ko`) - Latvian (`lv`) - Lithuanian (`lt`) - Bahasa Melayu (`ms`) - Norwegian (`no`) - Polish (`pl`) - Portuguese (`pt`) - Portuguese Brazil (`pt_BR`) - Romanian (`ro`) - Russian (`ru`) - Serbian (`sr`) - Slovak (`sk`) - Slovenian (`sl`) - Spanish (`es`) - Spanish Latin America (`es_MX`) - Swedish (`sv`) - Thai (`th`) - Turkish (`tr`) - Ukrainian (`uk`) - Vietnamese (`vi`) Additionally, you can automatically detect the browser language being used by the viewer and display the disclosure in that language by setting the value to `browser`. |
mustAgreeToEsign | string | Optional | When **true,** the recipient must agree to the consumer disclosure. The value of this property is read-only. It is calculated based on the account setting `consumerDisclosureFrequency` and the user's actions. |
pdfId | string | Optional | **Deprecated.** The `pdfId` property in the consumer_disclosure PUT request is deprecated. For security reasons going forward, any value provided in the request packet must be ignored. |
useBrand | string | Optional | When **true,** specifies that the company name in the signing brand is used for the disclosure. Whenever an envelope is sent from the account that uses a signing brand with a specified company name, that value is used in email notifications and in the signing experience. When **false** (default), or if the signing brand does not specify a company name, the account name is used instead. **Note:** This substitution only works if you use the default legal disclosure or if you apply the `companyName` to the merge fields in a custom ERSD. |
useConsumerDisclosureWithinAccount | string | Optional | When **true,** specifies that recipients in the same account as the sender must agree to eSign an Electronic Record and Signature Disclosure Statement. |
useConsumerDisclosureWithinAccountMetadata | Model | Optional | Expand Gets the user account settings for a specified user — response body — locale Metadata Metadata that indicates whether the `useConsumerDisclosureWithinAccount` property is editable. |
withdrawAddressLine1 | string | Optional | Contains the first address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. |
withdrawAddressLine2 | string | Optional | Contains the second address line of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. |
withdrawByEmail | string | Optional | When **true** (default), indicates that the customer can withdraw consent by email. |
withdrawByMail | string | Optional | When **true,** indicates that the customer can withdraw consent by postal mail. The default is **false.** |
withdrawByPhone | string | Optional | When **true,** indicates that the customer can withdraw consent by phone. The default is **false.** |
withdrawCity | string | Optional | Contains the city of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 50 characters. |
withdrawConsequences | string | Optional | Text indicating the consequences of withdrawing consent. Maximum length: 255 characters. |
withdrawEmail | string | Optional | Contains the email address to which a customer can send a consent withdrawal notification. Maximum length: 100 characters. |
withdrawOther | string | Optional | Contains any other information needed to withdraw consent. Maximum length: 255 characters. Example: `We do not need any other information from you to withdraw consent.` |
withdrawPhone | string | Optional | Contains the phone number that a customer can call to register consent withdrawal notification as a free-formatted string. Maximum length: 20 characters. |
withdrawPostalCode | string | Optional | Contains the postal code of the postal address to which a customer can send a consent withdrawal notification. Maximum length: 20 characters. |
withdrawState | string | Optional | Contains the state of the postal address to which a customer can send a consent withdrawal notification. Example: `PA` |
Referenced models: Gets the user account settings for a specified user — response body — locale Metadata
Updates the delayed routing rules for a template's workflow step — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that specifies the delayed routing settings for the workflow step. |
resumeDate | string | Optional | The ISO 8601 timestamp of when the envelope is scheduled to be sent to the recipients associated with the workflow step. This property is `null` if the workflow step has not been initiated. This property is read-only. |
rules | array | Optional | User-specified rules indicating how and when the envelope should sent for the workflow step and its associated recipients. Only one rule may be specified. |
rules[] | Model | Each item | Expand Updates the scheduled sending rules for an envelope's workflow — response body — rules item |
status | string | Optional | Status of the delayed routing step. Valid values: * `pending`: The workflow step has not been reached and the delay has not been initiated. * `started`: The workflow step has begun and the delay is in progress. The envelope has not yet been sent to the workflow step's recipients. * `completed`: The delay has elapsed and the envelope has been sent to the workflow step's recipients. This property is read-only. |
Referenced models: Updates the scheduled sending rules for an envelope's workflow — response body — rules item
Updates the name of a bulk send batch — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
batchName | string | Optional | The new name of the bulk send batch. This property is required. The maximum length of the string is 500 characters. |
Updates the name of a bulk send batch — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Result of `getBulkSendBatchStatus` |
action | string | Optional | |
actionStatus | string | Optional | |
batchId | string | Optional | The batch ID. |
batchName | string | Optional | The batch name. |
batchSize | string | Optional | The number of of bulk envelopes submitted in the current batch |
bulkErrors | array | Optional | An array of error statuses. |
bulkErrors[] | Model | Each item | Expand Updates the name of a bulk send batch — response body — bulk Errors item |
envelopeIdOrTemplateId | string | Optional | The ID of the draft envelope or template that was used to create the batch. |
envelopesInfo | Model | Optional | Expand Updates the name of a bulk send batch — response body — envelopes Info |
envelopesUri | string | Optional | The URI to get all envelopes sent in the batch. |
failed | string | Optional | The number of envelopes that failed to process or send. |
mailingListId | string | Optional | The ID of the mailing list used to create the batch. |
mailingListName | string | Optional | |
ownerUserId | string | Optional | |
queued | string | Optional | The number of envelopes waiting in pending queue |
resendsRemaining | string | Optional | |
senderUserId | string | Optional | The ID of the sender. |
sent | string | Optional | The number of envelopes sent successfully. |
submittedDate | string | Optional | The timestamp of when the batch was submitted in ISO 8601 format. |
Referenced models: Updates the name of a bulk send batch — response body — envelopes Info, Updates the name of a bulk send batch — response body — bulk Errors item
Updates the name of a bulk send batch — response body — bulk Errors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single bulk send error report. |
created | string | Optional | The timestamp of when the error occurred in ISO 8601 format. |
envelopeId | string | Optional | The envelope ID of the envelope status that failed to post. |
errorMessage | string | Optional | The error message generated during processing, if any. |
recipientEmails | array | Optional | An array of email addresses for the failed bulk envelope. Recipient email/info of the failed bulk envelope. |
recipientEmails[] | string | Each item |
Updates the name of a bulk send batch — response body — envelopes Info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
authoritativeCopy | string | Optional | When **true,** marks all of the documents in the envelope as authoritative copies. **Note:** You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to **true** at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to **false.** |
completed | string | Optional | |
correct | string | Optional | |
created | string | Optional | The UTC DateTime when the workspace user authorization was created. |
declined | string | Optional | |
deleted | string | Optional | |
delivered | string | Optional | |
digitalSignaturesPending | string | Optional | |
sent | string | Optional | The number of entries with a status of `sent`. |
signed | string | Optional | |
timedOut | string | Optional | |
transferCompleted | string | Optional | |
voided | string | Optional |
Updates the notification structure for an existing template — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expirations | Model | Optional | Expand Gets envelope notification information — response body — expirations A complex element that specifies the expiration settings for the envelope. |
password | string | Optional | The user's password. This property is used only when adding a new user via a [Users: create](/docs/esign-rest-api/reference/users/users/create/) request. The value must conform to the password rules defined in the account [Security Settings](https://apps-d.docusign.com/admin/authenticate?goTo=securityInfo). This property is not returned by `GET` requests and cannot be updated via `PUT` requests. |
reminders | Model | Optional | Expand Gets envelope notification information — response body — reminders A complex element that specifies reminder settings for the envelope. |
useAccountDefaults | string | Optional | When **true,** the account default notification settings are used for the envelope, overriding the reminders and expirations settings. When **false,** the reminders and expirations settings specified in this request are used. The default value is **false.** |
Referenced models: Gets envelope notification information — response body — expirations, Gets envelope notification information — response body — reminders
Updates the scheduled sending rules for an envelope's workflow — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A complex element that specifies the scheduled sending settings for the envelope. |
bulkListId | string | Optional | The ID of the bulk list. Set this optional value to use scheduled sending with a bulk send operation. |
resumeDate | string | Optional | The timestamp of when the envelope is scheduled to be sent in ISO 8601 format. This property is read-only. |
rules | array | Optional | User-specified rules indicating how and when the envelope should be scheduled for sending. Only one rule may be specified. |
rules[] | Model | Each item | Expand Updates the scheduled sending rules for an envelope's workflow — response body — rules item |
status | string | Optional | Status of the scheduled sending job. Valid values: * `pending`: The envelope has not yet been sent and the scheduled sending delay has not been initiated. * `started`: The sender has initiated the sending process. The delay has not elapsed, so the envelope has not yet been sent to the first recipient. * `completed`: The delay has elapsed and the envelope has been sent to the first recipient. This property is read-only. |
Referenced models: Updates the scheduled sending rules for an envelope's workflow — response body — rules item
Updates the scheduled sending rules for an envelope's workflow — response body — rules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A user-specified object that describes the envelope delay. To indicate a relative delay, use `delay`. To indicate the exact datetime the envelope should be sent, use `resumeDate`. Only one of the two properties can be used. |
delay | string | Optional | A string timespan representing the duration of the sending delay. The timespan is in the format `d.hh:mm:ss` where `d` is the number of days, `hh` is the number of hours (measured on a 24-hour clock), `mm` is minutes, and `ss` is seconds. The maximum delay is 30 days. |
resumeDate | string | Optional | An ISO 8601 formatted datetime string indicating the date and time that the envelope will be sent. The specified datetime must occur in the future. It must not exceed 30 days from the time that the request is made. |
Updates the tabs for document — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients. |
approveTabs | array | Optional | 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/ |
approveTabs[] | Model | Each item | Expand Returns tabs on a template — response body — approve Tabs item |
checkboxTabs | array | Optional | 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/ |
checkboxTabs[] | Model | Each item | Expand Returns tabs on a template — response body — checkbox Tabs item |
commentThreadTabs | array | Optional | An array of tabs that represents a collection of comments in a comment thread. For example, if a recipient has questions about the content of a document, they can add a comment to the document and control who else can see the comment. This value can't be set. |
commentThreadTabs[] | Model | Each item | Expand Returns tabs on a template — response body — comment Thread Tabs item |
commissionCountyTabs | array | Optional | 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/ |
commissionCountyTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission County Tabs item |
commissionExpirationTabs | array | Optional | A list of [Commission Expiration tabs][tabref]. A Commission Expiration tab displays the expiration date of a notary's commission. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionExpirationTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission Expiration Tabs item |
commissionNumberTabs | array | Optional | A list of [Commission Number tabs][tabref]. A Commission Number tab displays a notary's commission number. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [tabref]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionNumberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission Number Tabs item |
commissionStateTabs | array | Optional | A list of [Commission State tabs][cc]. A Commission County tab displays the state in which a notary's commission was granted. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. The tab's value can be edited by the recipient. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
commissionStateTabs[] | Model | Each item | Expand Returns tabs on a template — response body — commission State Tabs item |
companyTabs | array | Optional | A list of [Company tabs][company]. A Company tab displays a field for the name of the recipient's company. This value can't be set. [company]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_company |
companyTabs[] | Model | Each item | Expand Returns tabs on a template — response body — company Tabs item |
dateSignedTabs | array | Optional | A list of [Date Signed tabs][dateSigned]. A Date Signed tab displays the date that the recipient signed the document. This value can't be set. [dateSigned]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
dateSignedTabs[] | Model | Each item | Expand Returns tabs on a template — response body — date Signed Tabs item |
dateTabs | array | Optional | A list of [Date tabs][date]. A Date tab enables the recipient to enter a date. This value can't be set. The tooltip for this tab recommends the date format MM/DD/YYYY, but several other date formats are also accepted. The system retains the format that the recipient enters. **Note:** If you need to enforce a specific date format, Docusign recommends that you use a Text tab with a validation pattern and validation message. [date]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
dateTabs[] | Model | Each item | Expand Returns tabs on a template — response body — date Tabs item |
declineTabs | array | Optional | A list of [Decline tabs][decline]. A Decline tab enables the recipient to decline the envelope. If the recipient clicks the tab during the signing process, the envelope is voided. The value of this tab can't be set. [decline]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
declineTabs[] | Model | Each item | Expand Returns tabs on a template — response body — decline Tabs item |
drawTabs | array | Optional | A list of Draw Tabs. A Draw Tab allows the recipient to add a free-form drawing to the document. |
drawTabs[] | Model | Each item | Expand Returns tabs on a template — response body — draw Tabs item |
emailAddressTabs | array | Optional | A list of [Email Address tabs][emailAddress]. An Email Address tab displays the recipient's email as entered in the recipient information. This value can't be set. [emailAddress]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
emailAddressTabs[] | Model | Each item | Expand Returns tabs on a template — response body — email Address Tabs item |
emailTabs | array | Optional | A list of [Email tabs][email]. An Email tab enables the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. This value can be set. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. [email]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
emailTabs[] | Model | Each item | Expand Returns tabs on a template — response body — email Tabs item |
envelopeIdTabs | array | Optional | A list of [Envelope ID tabs][envelopeId]. An Envelope ID tab displays the envelope ID. Recipients cannot enter or change the information in this tab. This value can't be set. [envelopeId]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#response201_envelopeid |
envelopeIdTabs[] | Model | Each item | Expand Returns tabs on a template — response body — envelope Id Tabs item |
firstNameTabs | array | Optional | A list of [First Name tabs][firstName]. A First Name tab displays the recipient's first name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. [firstName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/#parameters_firstname |
firstNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — first Name Tabs item |
formulaTabs | array | Optional | A list of [Formula tabs][formulaTab]. The value of a Formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the Formula tab calculates and displays the result. This value can be set. The `formula` property of the tab contains the references to the underlying tabs. To learn more about formulas, see [Calculated Fields][calculatedfields]. If a Formula tab contains a `paymentDetails` property, the tab is considered a payment item. To learn more about payments, see [Requesting Payments Along with Signatures][paymentguide]. [calculatedfields]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=crs1578456361259.html [paymentguide]: https://support.docusign.com/s/document-item?bundleId=juu1573854950452&topicId=fyw1573854935374.html [formulaTab]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
formulaTabs[] | Model | Each item | Expand Returns tabs on a template — response body — formula Tabs item |
fullNameTabs | array | Optional | A list of [Full Name tabs][fullName]. A Full Name tab displays the recipient's full name. This value can't be set. [fullName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
fullNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — full Name Tabs item |
initialHereTabs | array | Optional | A list of [Initial Here tabs][initialHere]. This type of tab enables the recipient to initial the document. May be optional. This value can't be set. [initialHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
initialHereTabs[] | Model | Each item | Expand Returns tabs on a template — response body — initial Here Tabs item |
lastNameTabs | array | Optional | A list of [Last Name tabs][lastName]. A Last Name tab displays the recipient's last name. The system automatically populates this field by splitting the name in the recipient information on spaces. This value can't be set. [lastName]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
lastNameTabs[] | Model | Each item | Expand Returns tabs on a template — response body — last Name Tabs item |
listTabs | array | Optional | An array of List tabs. A List tab enables the recipient to choose from a list of options. You specify the options in the `listItems` property. This value can't be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
listTabs[] | Model | Each item | Expand Returns tabs on a template — response body — list Tabs item |
notarizeTabs | array | Optional | A list of [Notarize tabs][notarize]. A Notarize tab alerts notary recipients that they must take action on the page. This value can be set. **Note:** Only one notarize tab can appear on a page. [notarize]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
notarizeTabs[] | Model | Each item | Expand Returns tabs on a template — response body — notarize Tabs item |
notarySealTabs | array | Optional | A list of Notary Seal tabs. A Notary Seal tab enables the recipient to notarize a document. This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. [notary]: /docs/notary-api/ |
notarySealTabs[] | Model | Each item | Expand Returns tabs on a template — response body — notary Seal Tabs item |
noteTabs | array | Optional | A list of [Note tabs][note]. A Note tab displays additional information to the recipient in the form of a note. This value can be set. [note]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
noteTabs[] | Model | Each item | Expand Returns tabs on a template — response body — note Tabs item |
numberTabs | array | Optional | A list of Number tabs. Number tabs validate that the entered value is a number. They do not support advanced validation or display options. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about number tabs see [Features of numberTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numbertabs). [number]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
numberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — number Tabs item |
numericalTabs | array | Optional | A list of numerical tabs. Numerical tabs provide robust display and validation features, including formatting for different regions and currencies, and minimum and maximum value validation. To learn more about the different forms of number tabs, see [Number fields](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/) in the Concepts guide. For specific information about numerical tabs see [Features of numericalTabs](/docs/esign-rest-api/esign101/concepts/tabs/number-fields/#features-of-numericaltabs). |
numericalTabs[] | Model | Each item | Expand Returns tabs on a template — response body — numerical Tabs item |
phoneNumberTabs | array | Optional | A list of [Phone Number tabs][cc]. A Phone Number tab enables a recipient to enter a phone number. **Note:** This tab can only be assigned to a remote notary recipient using [Docusign Notary][notary]. [cc]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ [notary]: /docs/notary-api/ |
phoneNumberTabs[] | Model | Each item | Expand Returns tabs on a template — response body — phone Number Tabs item |
polyLineOverlayTabs | array | Optional | This type of tab enables the recipient to strike through document text. This value can't be set. |
polyLineOverlayTabs[] | Model | Each item | Expand Returns tabs on a template — response body — poly Line Overlay Tabs item |
prefillTabs | Model | Optional | Expand Returns tabs on a template — response body — prefill Tabs Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/s/document-item?bundleId=gbo1643332197980&topicId=nwo1611173513994.html [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields |
radioGroupTabs | array | Optional | A list of [Radio Group tabs][radioGroup]. A Radio Group tab places a group of radio buttons on a document. The `radios` property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set. [radioGroup]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
radioGroupTabs[] | Model | Each item | Expand Returns tabs on a template — response body — radio Group Tabs item |
signHereTabs | array | Optional | A list of [Sign Here tabs][signHere]. This type of tab enables the recipient to sign a document. May be optional. This value can't be set. [signHere]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
signHereTabs[] | Model | Each item | Expand Returns tabs on a template — response body — sign Here Tabs item |
signerAttachmentTabs | array | Optional | A list of [Signer Attachment tabs][signerAttachment]. This type of tab enables the recipient to attach supporting documents to an envelope. This value can't be set. [signerAttachment]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
signerAttachmentTabs[] | Model | Each item | Expand Returns tabs on a template — response body — signer Attachment Tabs item |
smartSectionTabs | array | Optional | A list of [Smart Section](https://www.docusign.com/blog/dsdev-deep-dive-responsive-smart-sections) tabs. Smart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality. **Note:** Smart Sections are a premium feature. Responsive signing must also be enabled for your account. |
smartSectionTabs[] | Model | Each item | Expand Deletes tabs from a template — request body — body smart Section Tabs item |
ssnTabs | array | Optional | A list of [SSN tabs][ssn]. An SSN tab contains a one-line field that enables the recipient to enter a Social Security Number (SSN) with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. This value can be set. [ssn]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
ssnTabs[] | Model | Each item | Expand Returns tabs on a template — response body — ssn Tabs item |
tabGroups | array | Optional | An array of `tabGroup` items. To associate a tab with a tab group, add the tab group's `groupLabel` to the tab's `tabGroupLabels` array. |
tabGroups[] | Model | Each item | Expand Returns tabs on a template — response body — tab Groups item |
textTabs | array | Optional | A list of Text tabs. A text tab enables the recipient to enter free text. This value can be set. Find descriptions of all tab types in the [EnvelopeRecipientTabs Resource][ert]. [ert]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
textTabs[] | Model | Each item | Expand Returns tabs on a template — response body — text Tabs item |
titleTabs | array | Optional | A list of [Title tabs][title]. A Title tab displays the recipient's title. This value can't be set. [title]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
titleTabs[] | Model | Each item | Expand Returns tabs on a template — response body — title Tabs item |
viewTabs | array | Optional | A list of [View tabs][view]. A View tab is used with an Approve tab to handle supplemental documents. This value can be set. [view]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
viewTabs[] | Model | Each item | Expand Returns tabs on a template — response body — view Tabs item |
zipTabs | array | Optional | A list of [Zip tabs][zip]. A Zip tab enables the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits ( in ZIP+4 format), and can be entered with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. This value can be set. [zip]: /docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/ |
zipTabs[] | Model | Each item | Expand Returns tabs on a template — response body — zip Tabs item |
Referenced models: Returns tabs on a template — response body — approve Tabs item, Returns tabs on a template — response body — checkbox Tabs item, Returns tabs on a template — response body — comment Thread Tabs item, Returns tabs on a template — response body — commission County Tabs item, Returns tabs on a template — response body — commission Expiration Tabs item, Returns tabs on a template — response body — commission Number Tabs item, Returns tabs on a template — response body — commission State Tabs item, Returns tabs on a template — response body — company Tabs item, Returns tabs on a template — response body — date Tabs item, Returns tabs on a template — response body — date Signed Tabs item, Returns tabs on a template — response body — decline Tabs item, Returns tabs on a template — response body — draw Tabs item, Returns tabs on a template — response body — email Tabs item, Returns tabs on a template — response body — email Address Tabs item, Returns tabs on a template — response body — envelope Id Tabs item, Returns tabs on a template — response body — first Name Tabs item, Returns tabs on a template — response body — formula Tabs item, Returns tabs on a template — response body — full Name Tabs item, Returns tabs on a template — response body — initial Here Tabs item, Returns tabs on a template — response body — last Name Tabs item, Returns tabs on a template — response body — list Tabs item, Returns tabs on a template — response body — notarize Tabs item, Returns tabs on a template — response body — notary Seal Tabs item, Returns tabs on a template — response body — note Tabs item, Returns tabs on a template — response body — number Tabs item, Returns tabs on a template — response body — numerical Tabs item, Returns tabs on a template — response body — phone Number Tabs item, Returns tabs on a template — response body — poly Line Overlay Tabs item, Returns tabs on a template — response body — prefill Tabs, Returns tabs on a template — response body — radio Group Tabs item, Returns tabs on a template — response body — sign Here Tabs item, Returns tabs on a template — response body — signer Attachment Tabs item, Returns tabs on a template — response body — ssn Tabs item, Returns tabs on a template — response body — tab Groups item, Returns tabs on a template — response body — text Tabs item, Returns tabs on a template — response body — title Tabs item, Returns tabs on a template — response body — view Tabs item, Returns tabs on a template — response body — zip Tabs item, Deletes tabs from a template — request body — body smart Section Tabs item
Updates the user signature for a specified user — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dateStampProperties | Model | Optional | Expand Deletes the image for a stamp — response body — date Stamp Properties Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle. |
disallowUserResizeStamp | string | Optional | When **true,** users may not resize the stamp. |
externalID | string | Optional | Optionally specify an external identifier for the user's signature. |
imageType | string | Optional | Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image` |
isDefault | string | Optional | Boolean that specifies whether the signature is the default signature for the user. |
nrdsId | string | Optional | The National Association of Realtors (NAR) membership ID for a user who is a realtor. |
nrdsLastName | string | Optional | The realtor's last name. |
phoneticName | string | Optional | The phonetic spelling of the `signatureName`. |
signatureFont | string | Optional | The font type to use for the signature if the signature is not drawn. The following font styles are supported. The quotes are to indicate that these values are strings, not `enums`. - `"1_DocuSign"` - `"2_DocuSign"` - `"3_DocuSign"` - `"4_DocuSign"` - `"5_DocuSign"` - `"6_DocuSign"` - `"7_DocuSign"` - `"8_DocuSign"` - `"Mistral"` - `"Rage Italic"` |
signatureId | string | Optional | Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as "&", "<", ">") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. |
signatureInitials | string | Optional | Specifies the user's signature in initials format. |
signatureName | string | Optional | Specifies the user's signature name. |
signatureType | string | Optional | Specifies the type of signature. |
stampFormat | string | Optional | The format of a stamp. Valid values are: - `NameHanko`: The stamp represents only the signer's name. - `NameDateHanko`: The stamp represents the signer's name and the date. |
stampSizeMM | string | Optional | The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents. |
Referenced models: Deletes the image for a stamp — response body — date Stamp Properties
Updates the user signature for a specified user — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
adoptedDateTime | string | Optional | The date and time the user adopted their signature. |
createdDateTime | string | Optional | The UTC DateTime when the item was created. |
customField | string | Optional | |
dateStampProperties | Model | Optional | Expand Deletes the image for a stamp — response body — date Stamp Properties Specifies the area in which a date stamp is placed. This parameter uses pixel positioning to draw a rectangle at the center of the stamp area. The stamp is superimposed on top of this central area. This property contains the following information about the central rectangle: - `DateAreaX`: The X axis position of the top-left corner. - `DateAreaY`: The Y axis position of the top-left corner. - `DateAreaWidth`: The width of the rectangle. - `DateAreaHeight`: The height of the rectangle. |
disallowUserResizeStamp | string | Optional | When **true,** users may not resize the stamp. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
externalID | string | Optional | Optionally specify an external identifier for the user's signature. |
imageBase64 | string | Optional | A Base64-encoded representation of the signature image. |
imageType | string | Optional | Specificies the type of image. Valid values: - `stamp_image` - `signature_image` - `initials_image` |
initials150ImageId | string | Optional | The ID of the user's initials image. |
initialsImageUri | string | Optional | The URI for retrieving the image of the user's initials. |
isDefault | string | Optional | Boolean that specifies whether the signature is the default signature for the user. |
lastModifiedDateTime | string | Optional | The date and time that the item was last modified. |
nrdsId | string | Optional | The National Association of Realtors (NAR) membership ID for a user who is a realtor. |
nrdsLastName | string | Optional | The realtor's last name. |
nrdsStatus | string | Optional | The realtor's NAR membership status. The value `active` verifies that the user is a current NAR member. Valid values are: - `Active` - `Inactive` - `Terminate` - `Provisional` - `Deceased` - `Suspend` - `Unknown` |
phoneticName | string | Optional | The phonetic spelling of the `signatureName`. |
signature150ImageId | string | Optional | The ID of the user's signature image. |
signatureFont | string | Optional | The font type for the signature, if the signature is not drawn. The supported font types are: "7_DocuSign", "1_DocuSign", "6_DocuSign", "8_DocuSign", "3_DocuSign", "Mistral", "4_DocuSign", "2_DocuSign", "5_DocuSign", "Rage Italic" |
signatureId | string | Optional | Specifies the signature ID associated with the signature name. You can use the signature ID in the URI in place of the signature name, and the value stored in the `signatureName` property in the body is used. This allows the use of special characters (such as "&", "<", ">") in a the signature name. Note that with each update to signatures, the returned signature ID might change, so the caller will need to trigger off the signature name to get the new signature ID. |
signatureImageUri | string | Optional | An endpoint URI that you can use to retrieve the user's signature image. |
signatureInitials | string | Optional | The initials associated with the signature. |
signatureName | string | Optional | Specifies the user's signature name. |
signatureRights | string | Optional | The rights that the user has to the signature. Valid values are: - `none` - `read` - `admin` |
signatureType | string | Optional | Specifies the type of signature. |
stampFormat | string | Optional | The format of a stamp. Valid values are: - `NameHanko`: The stamp represents only the signer's name. - `NameDateHanko`: The stamp represents the signer's name and the date. |
stampImageUri | string | Optional | The URI for retrieving the image of the user's stamp. |
stampSizeMM | string | Optional | The physical height of the stamp image (in millimeters) that the stamp vendor recommends for displaying the image in PDF documents. |
stampType | string | Optional | The type of stamp. Valid values are: - `signature`: A signature image. This is the default value. - `stamp`: A stamp image. - null |
status | string | Optional | Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. |
Referenced models: Deletes the image for a stamp — response body — date Stamp Properties, Locks a template — response body — error Details
esignature:Envelopes Shares Get Envelopes Share — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
agentUser | Model | Optional | Expand esignature:Envelopes Shares Get Envelopes Share — response body — agent User |
createdTimestamp | string | Optional | |
envelopeId | string | Optional | The envelope's GUID. Example: `93be49ab-xxxx-xxxx-xxxx-f752070d71ec` |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
modifiedTimestamp | string | Optional | |
permission | string | Optional | |
senderInfo | Model | Optional | Expand esignature:Envelopes Shares Get Envelopes Share — response body — agent User |
shareId | string | Optional | |
subject | string | Optional |
Referenced models: esignature:Envelopes Shares Get Envelopes Share — response body — agent User, Locks a template — response body — error Details
esignature:Envelopes Shares Get Envelopes Share — response body — agent User
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accountId | string | Optional | The account ID. |
email | string | Optional | The email address of the authorization user. |
name | string | Optional | The name of the authorization user. |
userId | string | Optional | The ID of the authorization user. |
esignature:Envelopes Shares Get Envelopes Shares — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
shares | array | Optional | |
shares[] | Model | Each item | Expand esignature:Envelopes Shares Get Envelopes Share — response body |
Referenced models: esignature:Envelopes Shares Get Envelopes Share — response body
esignature:Envelopes Shares Put Envelopes Share — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
customMessage | string | Optional | |
permission | string | Optional |
esignature:Envelopes Shares Put Envelopes Shares — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
shares | array | Optional | |
shares[] | Model | Each item | Expand esignature:Envelopes Shares Put Envelopes Shares — request body — body shares item |
Referenced models: esignature:Envelopes Shares Put Envelopes Shares — request body — body shares item
esignature:Envelopes Shares Put Envelopes Shares — request body — body shares item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
agentUser | Model | Optional | Expand esignature:Envelopes Shares Get Envelopes Share — response body — agent User |
customMessage | string | Optional | |
permission | string | Optional |
Referenced models: esignature:Envelopes Shares Get Envelopes Share — response body — agent User
esignature:Templates Put Templates — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
templates | array | Optional | An array of `templateSummary` objects that contain information about templates. |
templates[] | Model | Each item | Expand esignature:Templates Put Templates — response body — templates item |
Referenced models: esignature:Templates Put Templates — response body — templates item
esignature:Templates Put Templates — response body — templates item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
autoMatch | string | Optional | By default, templates that have been used within the last 60 days are included in auto-matching. By explicitly setting `autoMatch`, you can permanently include or exclude the template in auto matching. When **true** the template is included in auto-matching regardless of when it was last used. When **false** the template is never included in auto-matching. |
errorDetails | Model | Optional | Expand Locks a template — response body — error Details This object describes errors that occur. It is only valid for responses and ignored in requests. |
templateId | string | Optional | The ID of the template. |
Referenced models: Locks a template — response body — error Details