Skip to content

DocuSign: Esignature schemas (part 17)

27 DocuSign schemas with complete fields and constraints.

← Esignature operations · All schemas

Deletes recipients from a template — response body — seals item

FieldTypePresenceDescription and constraints
$objectRootSpecifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow.

Example:

```json
"recipients": {
"seals": [
{
"recipientId": "1",
"routingOrder" : 1,
"recipientSignatureProviders": [
{
"sealName": "52e9d968-xxxx-xxxx-xxxx-4682bc45c106"
}
]
}
]
},
.
.
.
```
For more information about Electronic Seals, see [Apply Electronic Seals to Your Documents](https://support.docusign.com/s/document-item?bundleId=xcm1643837555908&topicId=isl1578456577247.html).
accessCodestringOptionalNot applicable.
accessCodeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Not applicable.
addAccessCodeToEmailstringOptionalNot applicable.
allowSystemOverrideForLockedRecipientstringOptionalWhen **true,** if the recipient is locked on a template, advanced recipient routing can override the lock.
autoRespondedReasonstringOptionalError 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.
bulkSendV2RecipientstringOptional
clientUserIdstringOptionalNot applicable.
completedCountstringOptionalNot applicable.
customFieldsarrayOptionalNot applicable.
customFields[]stringEach item
declinedDateTimestringOptionalNot applicable.
declinedReasonstringOptionalNot applicable.
deliveredDateTimestringOptionalNot applicable.
deliveryMethodstringOptionalThe 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/
deliveryMethodMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
designatorIdstringOptionalReserved for Docusign.
designatorIdGuidstringOptionalReserved for Docusign.
documentTemplateIdstringOptional
documentVisibilityarrayOptionalNot applicable.
documentVisibility[]ModelEach itemExpand Updates document visibility for recipients — response body — document Visibility item
emailNotificationModelOptionalExpand Deletes recipients from a template — response body — seals item email Notification
Not applicable.
embeddedRecipientStartURLstringOptionalNot applicable.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
faxNumberstringOptionalReserved for Docusign.
faxNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
idCheckConfigurationNamestringOptionalNot applicable.
idCheckConfigurationNameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Not applicable.
idCheckInformationInputModelOptionalExpand Deletes recipients from a template — response body — seals item id Check Information Input
Not applicable.
identityVerificationModelOptionalExpand 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).
inheritEmailNotificationConfigurationstringOptionalNot applicable.
lockedRecipientPhoneAuthEditablestringOptionalReserved for Docusign.
lockedRecipientSmsEditablestringOptionalReserved for Docusign.
namestringOptionalNot applicable.
notestringOptionalNot applicable.
noteMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Not applicable.
phoneAuthenticationModelOptionalExpand Deletes recipients from a template — response body — seals item phone Authentication
Not applicable.
proofFileModelOptionalExpand Deletes recipients from a template — response body — seals item proof File
The proof file of the recipient.
recipientAttachmentsarrayOptionalNot applicable.
recipientAttachments[]ModelEach itemExpand Deletes recipients from a template — response body — seals item recipient Attachments item
recipientAuthenticationStatusModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status
Not applicable.
recipientFeatureMetadataarrayOptionalMetadata about the features that are supported for the recipient type. This property is read-only.
recipientFeatureMetadata[]ModelEach itemExpand Deletes recipients from a template — response body — seals item recipient Feature Metadata item
recipientIdstringOptionalUnique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
recipientIdGuidstringOptionalThe 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.
recipientSignatureProvidersarrayOptional(Required) Indicates which electronic seal to apply on documents when creating an envelope.
recipientSignatureProviders[]ModelEach itemExpand Deletes recipients from a template — response body — seals item recipient Signature Providers item
recipientTypestringOptionalThe 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.
recipientTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
requireIdLookupstringOptionalNot applicable.
requireIdLookupMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Not applicable.
roleNamestringOptionalOptional element. Specifies the role name associated with the recipient.<br/><br/>This property is required when you are working with template recipients.
routingOrderstringOptional(Optional, default: 1)
Specifies the routing order of the electronic seal in the envelope.
The routing order assigned to your electronic seal cannot be shared with another recipient.
It is recommended that you set a routing order for your electronic seals.
routingOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
sentDateTimestringOptionalNot applicable.
signedDateTimestringOptionalNot applicable.
smsAuthenticationModelOptionalExpand Deletes recipients from a template — response body — seals item sms Authentication
Not applicable.
socialAuthenticationsarrayOptionalDeprecated.
socialAuthentications[]ModelEach itemExpand Deletes recipients from a template — response body — seals item social Authentications item
statusstringOptionalThe 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`.
statusCodestringOptionalThe code associated with the recipient's status. This property is read-only.
suppressEmailsstringOptionalNot applicable.
tabsModelOptionalExpand Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response 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.
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
totalTabCountstringOptionalNot applicable.
userIdstringOptionalNot applicable.
webFormRecipientViewIdstringOptional

Referenced models: Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body, Deletes recipients from a template — response body — seals item recipient Authentication Status, 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, Updates a template document — response body — name Metadata, 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 — seals item proof File, Deletes recipients from a template — response body — seals item sms Authentication, 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

Deletes recipients from a template — response body — seals item email Notification

FieldTypePresenceDescription and constraints
$objectRootSets custom email subject and email body for individual
recipients. **Note:** You must explicitly set `supportedLanguage`
if you use this feature.
emailBodystringOptionalThe body of the email message.
emailBodyMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `emailBody` property can be edited.
emailSubjectstringOptionalThe subject line for the email notification.
emailSubjectMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `emailSubject` property can be edited.
supportedLanguagestringOptionalThe 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/
supportedLanguageMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `supportedLanguage` property can be edited.

Referenced models: Updates a template document — response body — name Metadata

Deletes recipients from a template — response body — seals item id Check Information Input

FieldTypePresenceDescription and constraints
$objectRootA complex element that contains input information related to a recipient ID check.
addressInformationInputModelOptionalExpand Deletes recipients from a template — response body — seals item id Check Information Input address Information Input
An object that specifies recipient address information and how it is displayed.
dobInformationInputModelOptionalExpand Deletes recipients from a template — response body — seals item id Check Information Input dob Information Input
An object that specifies recipient date of birth information and how it is displayed.
ssn4InformationInputModelOptionalExpand Deletes recipients from a template — response body — seals item id Check Information Input ssn4 Information Input
An object that specifies the last four digits of the recipient's Social Security Number (SSN).
ssn9InformationInputModelOptionalExpand Deletes recipients from a template — response body — seals item id Check Information Input ssn9 Information Input
An object that specifies the recipient's Social Security Number (SSN) information. Note that ssn9 information cannot be returned in a response.

Referenced models: Deletes recipients from a template — response body — seals item id Check Information Input address Information Input, Deletes recipients from a template — response body — seals item id Check Information Input dob Information Input, Deletes recipients from a template — response body — seals item id Check Information Input ssn4 Information Input, Deletes recipients from a template — response body — seals item id Check Information Input ssn9 Information Input

Deletes recipients from a template — response body — seals item id Check Information Input address Information Input

FieldTypePresenceDescription and constraints
$objectRootContains address input information.
addressInformationModelOptionalExpand Get credit card information — response body — address
A complex type that contains the following information for the new account: `address1`, `address2`, `city`, `country`, `fax`, `phone`, `postalCode` and `stateOrProvince`.

The maximum characters for the strings are:
* `address1`, `address2`, `city`, `country` and `stateOrProvince`: 100 characters
* `postalCode`, `phone`, and `fax`: 20 characters

**Note:** If country is US (United States), `stateOrProvince` codes are validated. Otherwise, `stateOrProvince` is treated as a non-validated string used to specify a state, province, or region.
displayLevelCodestringOptionalSpecifies the display level for the recipient. Valid values are:
* `ReadOnly`
* `Editable`
* `DoNotDisplay`
receiveInResponsestringOptionalA Boolean value that specifies whether the information must be returned in the response.

Referenced models: Get credit card information — response body — address

Deletes recipients from a template — response body — seals item id Check Information Input dob Information Input

FieldTypePresenceDescription and constraints
$objectRootComplex type containing:

* dateOfBirth
* displayLevelCode
* receiveInResponse
dateOfBirthstringOptionalSpecifies the recipient's date, month, and year of birth.
displayLevelCodestringOptionalSpecifies the display level for the recipient. Valid values are:
* `ReadOnly`
* `Editable`
* `DoNotDisplay`
receiveInResponsestringOptionalA Boolean value that specifies whether the information must be returned in the response.

Deletes recipients from a template — response body — seals item id Check Information Input ssn4 Information Input

FieldTypePresenceDescription and constraints
$objectRoot
displayLevelCodestringOptionalSpecifies the display level for the recipient. Valid values are:
* `ReadOnly`
* `Editable`
* `DoNotDisplay`
receiveInResponsestringOptionalA Boolean value that specifies whether the information must be returned in the response.
ssn4stringOptionalThe last four digits of the recipient's Social Security Number (SSN).

Deletes recipients from a template — response body — seals item id Check Information Input ssn9 Information Input

FieldTypePresenceDescription and constraints
$objectRoot
displayLevelCodestringOptionalSpecifies the display level for the recipient. Valid values are:
* `ReadOnly`
* `Editable`
* `DoNotDisplay`
ssn9stringOptionalThe recipient's full Social Security Number (SSN).

Deletes recipients from a template — response body — seals item identity Verification

FieldTypePresenceDescription and constraints
$objectRootSpecifies 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.
inputOptionsarrayOptional
inputOptions[]ModelEach itemExpand Deletes recipients from a template — response body — seals item identity Verification input Options item
workflowIdstringOptionalID 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.
workflowIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
workflowLabelstringOptional

Referenced models: Updates a template document — response body — name Metadata, Deletes recipients from a template — response body — seals item identity Verification input Options item

Deletes recipients from a template — response body — seals item identity Verification input Options item

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptional
phoneNumberListarrayOptional
phoneNumberList[]ModelEach itemExpand Deletes recipients from a template — response body — seals item identity Verification input Options item phone Number List item
stringValuestringOptional
valueTypestringOptional

Referenced models: Deletes recipients from a template — response body — seals item identity Verification input Options item phone Number List item

Deletes recipients from a template — response body — seals item identity Verification input Options item phone Number List item

FieldTypePresenceDescription and constraints
$objectRoot
countryCodestringOptionalThe 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.
countryCodeLockstringOptional
countryCodeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates if the `countryCode` property is editable.
extensionstringOptionalThe telephone extension, if any.
extensionMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates if the `extension` property is editable.
numberstringOptionalThe 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`.
numberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates if the `number` property is editable.

Referenced models: Updates a template document — response body — name Metadata

Deletes recipients from a template — response body — seals item phone Authentication

FieldTypePresenceDescription and constraints
$objectRootA 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.
recipMayProvideNumberstringOptionalBoolean. When **true,** the recipient can supply a phone number their choice.
recipMayProvideNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `recipMayProvideNumber` property can be edited.
recordVoicePrintstringOptionalReserved for Docusign.
recordVoicePrintMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
senderProvidedNumbersarrayOptionalAn array containing a list of phone numbers that the recipient can use for SMS text authentication.
senderProvidedNumbers[]stringEach item
senderProvidedNumbersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `senderProvidedNumbers` property can be edited.
validateRecipProvidedNumberstringOptionalReserved for Docusign.
validateRecipProvidedNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.

Referenced models: Updates a template document — response body — name Metadata

Deletes recipients from a template — response body — seals item proof File

FieldTypePresenceDescription and constraints
$objectRootThe 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/)
hasIdentityAttemptsstringOptional
isInProofFilestringOptionalIndicates whether a proof file is available for this recipient.

Deletes recipients from a template — response body — seals item recipient Attachments item

FieldTypePresenceDescription and constraints
$objectRoot
attachmentIdstringOptionalThe unique identifier for the attachment.
attachmentTypestringOptionalSpecifies the type of the attachment for the recipient. Possible values are:

- `.htm`
- `.xml`
datastringOptionalA 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.
labelstringOptionalAn optional label for the attachment.
namestringOptionalThe name of the attachment.
remoteUrlstringOptionalThe 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.

Deletes recipients from a template — response body — seals item recipient Authentication Status

FieldTypePresenceDescription and constraints
$objectRootA complex element that contains information about a user's authentication status.
accessCodeResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
The result of a user's attempt to authenticate by using an access code. It returns:

- `Status`: `Pass` or `Fail`.
- `dateTime`: The date and time that the event occurred.
- `FailureDescription`: A string containing the details about a failed authentication.
- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
ageVerifyResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
The result of an age verification check. It returns:

- `Status`: `Pass` or `Fail`.
- `dateTime`: The date and time that the event occurred.
- `FailureDescription`: A string containing the details about a failed authentication.
- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
anySocialIDResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
Deprecated.
facebookResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
Deprecated.
googleResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
Deprecated.
idLookupResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
The result of an ID lookup authentication check. It returns:

- `Status`: `Pass` or `Fail`.
- `dateTime`: The date and time that the event occurred.
- `FailureDescription`: A string containing the details about a failed authentication.
- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
idQuestionsResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
The result of the user's answers to ID challenge questions. It returns:

- `Status`: `Pass` or `Fail`.
- `dateTime`: The date and time that the event occurred.
- `FailureDescription`: A string containing the details about a failed authentication.
- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
identityVerificationResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
The result of an [Identity Verification][IDV] workflow.

[IDV]: /docs/esign-rest-api/reference/accounts/identityverifications/
linkedinResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
Deprecated.
liveIDResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
Deprecated.
ofacResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
The result of an Office of Foreign Asset Control (OFAC) check. It returns:

- `Status`: `Pass` or `Fail`.
- `dateTime`: The date and time that the event occurred.
- `FailureDescription`: A string containing the details about a failed authentication.
- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
openIDResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
Deprecated.
phoneAuthResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
The result of the user's attempt to authenticate by using two-factor authentication (2FA) through phone messaging. It returns:

- `Status`: `Pass` or `Fail`.
- `dateTime`: The date and time that the event occurred.
- `FailureDescription`: A string containing the details about a failed authentication.
- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
sTANPinResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
The result of a Student Authentication Network (STAN) authentication check. It returns:

- `Status`: `Pass` or `Fail`.
- `dateTime`: The date and time that the event occurred.
- `FailureDescription`: A string containing the details about a failed authentication.
- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
salesforceResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
Success/failure result of authentication using sign-in with a Salesforce account. It returns:

- `Status`: `Pass` or `Fail`.
- `dateTime`: The date and time that the event occurred.
- `FailureDescription`: A string containing the details about a failed authentication.
- `VendorFailureStatusCode`: A string containing the vendor's status code for a failed authentication.
signatureProviderResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
The result of the user's attempt to authenticate by using a signature provider.
smsAuthResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
The result of the user's attempt to authenticate by using two-factor authentication (2FA) through SMS messaging on a mobile phone.
twitterResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
Deprecated.
yahooResultModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result
Deprecated.

Referenced models: Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result

Deletes recipients from a template — response body — seals item recipient Authentication Status ofac Result

FieldTypePresenceDescription and constraints
$objectRootInformation about the result of an event.
eventTimestampstringOptionalDate/time of the event.
failureDescriptionstringOptionalReason for failure, if the event failed.
statusstringOptionalEvent status.
vendorFailureStatusCodestringOptionalFailure status code, if the event failed.

Deletes recipients from a template — response body — seals item recipient Feature Metadata item

FieldTypePresenceDescription and constraints
$objectRoot
availabiltystringOptional
featureNamestringOptional

Deletes recipients from a template — response body — seals item recipient Signature Providers item

FieldTypePresenceDescription and constraints
$objectRootAn Electronic or Standards Based Signature (digital signature) provider for the signer to use. [More information](/docs/esign-rest-api/esign101/concepts/standards-based-signatures/).
sealDocumentsWithTabsOnlystringOptionalBy 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.
sealNamestringOptionalIndicates the name of the electronic seal to apply on documents.
signatureProviderNamestringOptionalThe 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`

signatureProviderNameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `signatureProviderName` property is editable.
signatureProviderOptionsModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Signature Providers item signature Provider Options
Not applicable for this object.

Referenced models: Updates a template document — response body — name Metadata, Deletes recipients from a template — response body — seals item recipient Signature Providers item signature Provider Options

Deletes recipients from a template — response body — seals item recipient Signature Providers item signature Provider Options

FieldTypePresenceDescription and constraints
$objectRootOption 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/)
cpfNumberstringOptionalReserved for Docusign.
cpfNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
oneTimePasswordstringOptionalA 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.
oneTimePasswordMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `oneTimePassword` property is editable.
signerRolestringOptionalThe role or capacity of the signing recipient. Examples: Manager, Approver, etc.
signerRoleMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `signerRole` property is editable.
smsstringOptionalThe 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.
smsMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `sms` property is editable.

Referenced models: Updates a template document — response body — name Metadata

Deletes recipients from a template — response body — seals item sms Authentication

FieldTypePresenceDescription and constraints
$objectRootContains the element senderProvidedNumbers which is an Array of phone numbers the recipient can use for SMS text authentication.
senderProvidedNumbersarrayOptionalAn array containing a list of phone numbers that the recipient can use for SMS text authentication.
senderProvidedNumbers[]stringEach item
senderProvidedNumbersMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `senderProvidedNumbers` property can be edited.

Referenced models: Updates a template document — response body — name Metadata

Deletes recipients from a template — response body — seals item social Authentications item

FieldTypePresenceDescription and constraints
$objectRoot
authenticationstringOptionalReserved for Docusign.

Deletes recipients from a template — response body — signers item

FieldTypePresenceDescription and constraints
$objectRootA complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document.
accessCodestringOptionalIf 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.
accessCodeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `accessCode` property is editable. This property is read-only.
addAccessCodeToEmailstringOptionalOptional. 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.
additionalNotificationsarrayOptionalAn array of additional notification objects.
additionalNotifications[]ModelEach itemExpand Deletes recipients from a template — response body — agents item additional Notifications item
agentCanEditEmailstringOptionalOptional element. When **true,** the agent recipient associated with this recipient can change the recipient's pre-populated email address. This element is only active if enabled for the account.
agentCanEditNamestringOptionalOptional. When **true,** the agent recipient associated with this recipient can change the recipient's pre-populated name. This element is only active if enabled for the account.
allowSystemOverrideForLockedRecipientstringOptionalWhen **true,** if the recipient is locked on a template, advanced recipient routing can override the lock.
autoNavigationstringOptionalWhen **true,** autonavigation is set for the recipient.
autoRespondedReasonstringOptionalError 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.
bulkRecipientsUristringOptionalReserved for Docusign.
bulkSendV2RecipientstringOptional
canSignOfflinestringOptionalWhen **true,** specifies that the signer can perform the signing ceremony offline.
clientUserIdstringOptionalSpecifies 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.
completedCountstringOptionalIndicates 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.
consentDetailsListarrayOptional
consentDetailsList[]ModelEach itemExpand Deletes recipients from a template — response body — agents item consent Details List item
creationReasonstringOptionalThe reason why the item was created.
customFieldsarrayOptionalAn optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign.

Each recipient may be assigned a maximum of 3 custom fields, and each customField string can be a maximum of 100 characters.
customFields[]stringEach item
declinedDateTimestringOptionalThe date and time the recipient declined the document. This property is read-only.
declinedReasonstringOptionalThe reason the recipient declined the document. This property is read-only.
defaultRecipientstringOptionalWhen **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.
delegatedByModelOptionalExpand Deletes recipients from a template — response body — signers item delegated By
delegatedToarrayOptional
delegatedTo[]ModelEach itemExpand Deletes recipients from a template — response body — signers item delegated By
deliveredDateTimestringOptionalThe date and time that the envelope was delivered to the recipient. This property is read-only.
deliveryMethodstringOptionalThe 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/
deliveryMethodMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
designatorIdstringOptionalReserved for Docusign.
designatorIdGuidstringOptionalReserved for Docusign.
documentTemplateIdstringOptional
documentVisibilityarrayOptionalA 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[]ModelEach itemExpand Updates document visibility for recipients — response body — document Visibility item
emailstringOptionalThe recipient's email address. The system sends notifications about the documents to sign to this address. Maximum length: 100 characters.
emailMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `email` property is editable. This property is read-only.
emailNotificationModelOptionalExpand 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`.
emailRecipientPostSigningURLstringOptional
embeddedRecipientStartURLstringOptionalSpecifies 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]]`
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
excludedDocumentsarrayOptionalSpecifies 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[]stringEach item
faxNumberstringOptionalReserved for Docusign.
faxNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
firstNamestringOptionalThe recipient's first name. Maximum Length: 50 characters.
firstNameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `firstName` property is editable. This property is read-only.
fullNamestringOptionalReserved for Docusign.
fullNameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
idCheckConfigurationNamestringOptionalThe 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.
idCheckConfigurationNameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
idCheckInformationInputModelOptionalExpand 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.
identityVerificationModelOptionalExpand 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).
inheritEmailNotificationConfigurationstringOptionalWhen **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.
isBulkRecipientstringOptionalWhen **true,** this signer is a bulk recipient and the recipient information is contained in a bulk recipient file.

Note that when this is true the email and name for the recipient becomes bulk@example.com and "Bulk Recipient". These fields can not be changed for the bulk recipient.
isBulkRecipientMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
lastNamestringOptionalThe recipient's last name.
lastNameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `lastName` property is editable. This property is read-only.
lockedRecipientPhoneAuthEditablestringOptionalReserved for Docusign.
lockedRecipientSmsEditablestringOptionalReserved for Docusign.
namestringOptionalThe 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.
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `name` property is editable. This property is read-only.
notaryIdstringOptionalThe `recipientId` of the notary for this signer.
notarySignerEmailSentstringOptional
notestringOptionalA 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.
noteMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `note` property is editable. This property is read-only.
offlineAttributesModelOptionalExpand Deletes recipients from a template — response body — signers item offline Attributes
Reserved for Docusign.
phoneAuthenticationModelOptionalExpand 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.

phoneNumberModelOptionalExpand Deletes recipients from a template — response body — agents item phone Number
Describes the recipient phone number.
proofFileModelOptionalExpand Deletes recipients from a template — response body — seals item proof File
The proof file of the recipient.
recipientAttachmentsarrayOptionalReserved for Docusign.
recipientAttachments[]ModelEach itemExpand Deletes recipients from a template — response body — seals item recipient Attachments item
recipientAuthenticationStatusModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status
Information about the recipient's authentication status. This property is read-only.
recipientFeatureMetadataarrayOptionalMetadata about the features that are supported for the recipient type. This property is read-only.
recipientFeatureMetadata[]ModelEach itemExpand Deletes recipients from a template — response body — seals item recipient Feature Metadata item
recipientIdstringOptionalA 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`.
recipientIdGuidstringOptionalThe 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.
recipientSignatureProvidersarrayOptionalThe 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[]ModelEach itemExpand Deletes recipients from a template — response body — seals item recipient Signature Providers item
recipientSuppliesTabsstringOptionalWhen **true,** specifies that the recipient creates the tabs.
recipientTypestringOptionalThe 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.
recipientTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
requireIdLookupstringOptionalWhen **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
requireIdLookupMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
requireSignOnPaperstringOptionalWhen **true,** the signer must print, sign, and upload or fax the signed documents to Docusign.
requireSignerCertificatestringOptionalSets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. Valid values:

* `docusign_express`: Requires a Docusign Express certificate.
* `safe`: Requires a SAFE-BioPharma certificate.
* `open_trust`: Requires an OpenTrust certificate.

**Important:** There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information.
requireUploadSignaturestringOptionalWhen **true,** the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal Docusign account.
roleNamestringOptionalOptional element. Specifies the role name associated with the recipient.<br/><br/>This property is required when you are working with template recipients.
routingOrderstringOptionalSpecifies the routing order of the recipient in the envelope.
routingOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
sentDateTimestringOptionalThe UTC DateTime when the envelope was sent. This property is read-only.
signInEachLocationstringOptionalWhen **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).
signInEachLocationMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only.
signatureInfoModelOptionalExpand 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.
signedDateTimestringOptionalReserved for Docusign.
signingGroupIdstringOptionalThe ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).
signingGroupIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
signingGroupNamestringOptionalOptional. The name of the signing group.

Maximum Length: 100 characters.
signingGroupTypestringOptional
signingGroupUsersarrayOptionalA complex type that contains information about users in the signing group.
signingGroupUsers[]ModelEach itemExpand Gets a specific template associated with a specified account — response body — owner
smsAuthenticationModelOptionalExpand 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.

socialAuthenticationsarrayOptionalDeprecated.
socialAuthentications[]ModelEach itemExpand Deletes recipients from a template — response body — seals item social Authentications item
statusstringOptionalSpecifies the status of the recipient at the time of the request. This property is read-only. Possible values are:

- `created`: The recipient is in a draft state. This is only associated with draft envelopes (envelopes with a created status).
- `sent`: The recipient has been sent an email notification that it is their turn to sign an envelope.
- `delivered`: The recipient has viewed the documents in an envelope through the Docusign signing web site. This is not an email delivery of the documents in an envelope.
- `signed`; The recipient has completed (performed all required interactions, such as signing or entering data) all required tags in an envelope. This is a temporary state during processing, after which the recipient is automatically moved to completed.
- `declined`: The recipient declined to sign the documents in the envelope.
- `completed`: The recipient has completed their actions (signing or other required actions if not a signer) for an envelope.
- `faxpending`: The recipient has finished signing and the system is waiting a fax attachment by the recipient before completing their signing step.
- `autoresponded`: The recipient's email system auto-responded to the email from Docusign. This status is used by the Docusign webapp (also known as the Docusign console) to inform senders about the auto-responded email.
statusCodestringOptionalReserved for Docusign.
suppressEmailsstringOptionalWhen **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox.
tabsModelOptionalExpand Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body
The tabs to assign to the recipient.
[More information](/docs/esign-rest-api/esign101/concepts/tabs/).
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
totalTabCountstringOptionalThe total number of tabs in the documents. This property is read-only.
userIdstringOptionalThe 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.
webFormRecipientViewIdstringOptional

Referenced models: Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body, 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

Deletes recipients from a template — response body — signers item delegated By

FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptional
namestringOptional
userAuthorizationIdstringOptional
userIdstringOptionalThe 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.

Deletes recipients from a template — response body — signers item offline Attributes

FieldTypePresenceDescription and constraints
$objectRootReserved for Docusign.
accountEsignIdstringOptionalReserved for Docusign.
deviceModelstringOptionalReserved for Docusign.
deviceNamestringOptionalReserved for Docusign.
gpsLatitudestringOptionalReserved for Docusign.
gpsLongitudestringOptionalReserved for Docusign.
offlineSigningHashstringOptionalReserved for Docusign.

Deletes recipients from a template — response body — signers item signature Info

FieldTypePresenceDescription and constraints
$objectRootAllows 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.
fontStylestringOptionalThe 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"`
signatureInitialsstringOptionalSpecifies the user's signature in initials format.
signatureNamestringOptionalSpecifies the user's signature name.

Deletes recipients from a template — response body — witnesses item

FieldTypePresenceDescription and constraints
$objectRootA 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.
accessCodestringOptionalIf 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.
accessCodeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `accessCode` property is editable. This property is read-only.
addAccessCodeToEmailstringOptionalOptional. 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.
additionalNotificationsarrayOptionalAn array of additional notification objects.
additionalNotifications[]ModelEach itemExpand Deletes recipients from a template — response body — agents item additional Notifications item
agentCanEditEmailstringOptionalOptional 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.
agentCanEditNamestringOptionalOptional 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.
allowSystemOverrideForLockedRecipientstringOptionalWhen **true,** if the recipient is locked on a template, advanced recipient routing can override the lock.
autoNavigationstringOptionalWhen **true,** autonavigation is set for the recipient.
autoRespondedReasonstringOptionalError 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.
bulkRecipientsUristringOptionalReserved for Docusign.
bulkSendV2RecipientstringOptional
canSignOfflinestringOptionalWhen **true,** specifies that the signer can perform the signing ceremony offline.
clientUserIdstringOptionalSpecifies 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.
completedCountstringOptionalIndicates 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.
consentDetailsListarrayOptional
consentDetailsList[]ModelEach itemExpand Deletes recipients from a template — response body — agents item consent Details List item
creationReasonstringOptionalThe reason why the recipient was created (for example, `sender`). This property is read-only.
customFieldsarrayOptionalAn 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[]stringEach item
declinedDateTimestringOptionalThe date and time the recipient declined the document. This property is read-only.
declinedReasonstringOptionalThe reason the recipient declined the document. This property is read-only.
defaultRecipientstringOptionalWhen **true,** this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient.
delegatedByModelOptionalExpand Deletes recipients from a template — response body — signers item delegated By
delegatedToarrayOptional
delegatedTo[]ModelEach itemExpand Deletes recipients from a template — response body — signers item delegated By
deliveredDateTimestringOptionalThe date and time that the envelope was delivered to the recipient. This property is read-only.
deliveryMethodstringOptionalThe 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/
deliveryMethodMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
designatorIdstringOptionalReserved for Docusign.
designatorIdGuidstringOptionalReserved for Docusign.
documentTemplateIdstringOptional
documentVisibilityarrayOptionalA 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[]ModelEach itemExpand Updates document visibility for recipients — response body — document Visibility item
emailstringOptionalThe recipient's email address.
emailMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `email` property is editable. This property is read-only.
emailNotificationModelOptionalExpand 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`.
emailRecipientPostSigningURLstringOptional
embeddedRecipientStartURLstringOptionalSpecifies 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]]`
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
excludedDocumentsarrayOptionalSpecifies 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[]stringEach item
faxNumberstringOptionalReserved for Docusign.
faxNumberMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
firstNamestringOptionalThe recipient's first name. Maximum Length: 50 characters.
firstNameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `firstName` property is editable. This property is read-only.
fullNamestringOptionalReserved for Docusign.
fullNameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
idCheckConfigurationNamestringOptionalThe 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.
idCheckConfigurationNameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only.
idCheckInformationInputModelOptionalExpand 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.
identityVerificationModelOptionalExpand 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).
inheritEmailNotificationConfigurationstringOptionalWhen **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.
isBulkRecipientstringOptionalReserved for Docusign.
isBulkRecipientMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Reserved for Docusign.
lastNamestringOptionalThe recipient's last name.
lastNameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `lastName` property is editable. This property is read-only.
lockedRecipientPhoneAuthEditablestringOptionalReserved for Docusign.
lockedRecipientSmsEditablestringOptionalReserved for Docusign.
namestringOptionalThe 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.
nameMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `name` property is editable. This property is read-only.
notaryIdstringOptional
notarySignerEmailSentstringOptional
notestringOptionalA 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.
noteMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `note` property is editable. This property is read-only.
offlineAttributesModelOptionalExpand Deletes recipients from a template — response body — signers item offline Attributes
Reserved for Docusign.
phoneAuthenticationModelOptionalExpand 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.

phoneNumberModelOptionalExpand Deletes recipients from a template — response body — agents item phone Number
Describes the recipient phone number.
proofFileModelOptionalExpand Deletes recipients from a template — response body — seals item proof File
The proof file of the recipient.
recipientAttachmentsarrayOptionalReserved for Docusign.
recipientAttachments[]ModelEach itemExpand Deletes recipients from a template — response body — seals item recipient Attachments item
recipientAuthenticationStatusModelOptionalExpand Deletes recipients from a template — response body — seals item recipient Authentication Status
Information about the recipient's authentication status. This property is read-only.
recipientFeatureMetadataarrayOptionalMetadata about the features that are supported for the recipient type. This property is read-only.
recipientFeatureMetadata[]ModelEach itemExpand Deletes recipients from a template — response body — seals item recipient Feature Metadata item
recipientIdstringOptionalUnique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
recipientIdGuidstringOptionalThe 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.
recipientSignatureProvidersarrayOptionalThe 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[]ModelEach itemExpand Deletes recipients from a template — response body — seals item recipient Signature Providers item
recipientSuppliesTabsstringOptionalWhen **true,** specifies that the recipient creates the tabs.
recipientTypestringOptionalThe 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.
recipientTypeMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `recipientType` property is editable. This property is read-only.
requireIdLookupstringOptionalWhen **true,** the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
requireIdLookupMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only.
requireSignOnPaperstringOptionalWhen **true,** the signer must print, sign, and upload or fax the signed documents to Docusign.
requireSignerCertificatestringOptionalBy 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.
requireUploadSignaturestringOptionalWhen **true,** the signer is required to upload a new signature, even if they have a pre-adopted signature in their personal Docusign account.
roleNamestringOptionalOptional element. Specifies the role name associated with the recipient.<br/><br/>This property is required when you are working with template recipients.
routingOrderstringOptionalSpecifies the routing order of the recipient in the envelope.
routingOrderMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `routingOrder` property is editable. This property is read-only.
sentDateTimestringOptionalThe UTC DateTime when the envelope was sent. This property is read-only.
signInEachLocationstringOptionalWhen **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).
signInEachLocationMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only.
signatureInfoModelOptionalExpand 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.
signedDateTimestringOptionalReserved for Docusign.
signingGroupIdstringOptionalThe ID of the [signing group](https://support.docusign.com/s/document-item?bundleId=gav1643676262430&topicId=zgn1578456447934.html).
signingGroupIdMetadataModelOptionalExpand Updates a template document — response body — name Metadata
Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only.
signingGroupNamestringOptionalOptional. The name of the signing group.

Maximum Length: 100 characters.
signingGroupTypestringOptional
signingGroupUsersarrayOptionalA complex type that contains information about users in the signing group.
signingGroupUsers[]ModelEach itemExpand Gets a specific template associated with a specified account — response body — owner
smsAuthenticationModelOptionalExpand 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.

socialAuthenticationsarrayOptionalDeprecated.
socialAuthentications[]ModelEach itemExpand Deletes recipients from a template — response body — seals item social Authentications item
statusstringOptionalThe 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`.
statusCodestringOptionalThe code associated with the recipient's status. This property is read-only.
suppressEmailsstringOptionalWhen **true,** email notifications are suppressed for the recipient, and they must access envelopes and documents from their Docusign inbox.
tabsModelOptionalExpand Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response 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.
templateLockedstringOptionalWhen **true,** the sender cannot change any attributes of the recipient. Used only when working with template recipients.
templateRequiredstringOptionalWhen **true,** the sender may not remove the recipient. Used only when working with template recipients.
totalTabCountstringOptionalThe total number of tabs in the documents. This property is read-only.
userIdstringOptionalThe 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.
webFormRecipientViewIdstringOptional
witnessForstringOptionalThe `recipientId` of the person or party for whom the recipient is a witness.
witnessForGuidstringOptionalNot used. Use the `witnessFor` property instead.

Referenced models: Adds tabs for a recipient — esignature esignature Recipients Post Recipient Tabs — response body, 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

Deletes recipients from an envelope — request body — body

FieldTypePresenceDescription and constraints
$objectRootEnvelope recipients
agentsarrayOptionalA list of agent recipients assigned to the documents.
agents[]ModelEach itemExpand Deletes recipients from a template — response body — agents item
authorizedSignatoriesarrayOptional
authorizedSignatories[]ModelEach itemExpand Updates recipients in a template — request body — body authorized Signatories item
carbonCopiesarrayOptionalA list of carbon copy recipients assigned to the documents.
carbonCopies[]ModelEach itemExpand Updates recipients in a template — request body — body carbon Copies item
certifiedDeliveriesarrayOptionalA complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.
certifiedDeliveries[]ModelEach itemExpand Deletes recipients from a template — response body — certified Deliveries item
currentRoutingOrderstringOptionalThe routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.
editorsarrayOptionalA list of users who can edit the envelope.
editors[]ModelEach itemExpand Deletes recipients from a template — response body — editors item
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
inPersonSignersarrayOptionalSpecifies a signer that is in the same physical location as a Docusign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.
inPersonSigners[]ModelEach itemExpand Updates recipients in a template — request body — body in Person Signers item
intermediariesarrayOptionalIdentifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).
intermediaries[]ModelEach itemExpand Deletes recipients from a template — response body — intermediaries item
notariesarrayOptionalA list of notary recipients on the envelope.
notaries[]ModelEach itemExpand Updates recipients in a template — request body — body notaries item
notaryWitnessesarrayOptional
notaryWitnesses[]ModelEach itemExpand Updates recipients in a template — request body — body notary Witnesses item
participantsarrayOptional
participants[]ModelEach itemExpand Deletes recipients from a template — response body — participants item
recipientCountstringOptionalThe number of recipients in the envelope.
sealsarrayOptionalA list of electronic seals to apply to documents.
seals[]ModelEach itemExpand Updates recipients in a template — request body — body seals item
signersarrayOptionalA list of signers on the envelope.
signers[]ModelEach itemExpand Updates recipients in a template — request body — body signers item
witnessesarrayOptionalA list of signers who act as witnesses on the envelope.
witnesses[]ModelEach itemExpand Updates recipients in a template — request body — body witnesses item

Referenced models: Deletes recipients from a template — response body — agents item, Deletes recipients from a template — response body — certified Deliveries item, Deletes recipients from a template — response body — editors item, Locks a template — response body — error Details, Deletes recipients from a template — response body — intermediaries item, Deletes recipients from a template — response body — participants item, Updates recipients in a template — request body — body authorized Signatories item, Updates recipients in a template — request body — body carbon Copies item, Updates recipients in a template — request body — body in Person Signers item, Updates recipients in a template — request body — body notaries item, Updates recipients in a template — request body — body notary Witnesses item, Updates recipients in a template — request body — body seals item, Updates recipients in a template — request body — body signers item, Updates recipients in a template — request body — body witnesses item

Deletes recipients from an envelope — response body

FieldTypePresenceDescription and constraints
$objectRootEnvelope recipients
agentsarrayOptionalA list of agent recipients assigned to the documents.
agents[]ModelEach itemExpand Deletes recipients from a template — response body — agents item
authorizedSignatoriesarrayOptional
authorizedSignatories[]ModelEach itemExpand Deletes recipients from a template — response body — authorized Signatories item
carbonCopiesarrayOptionalA list of carbon copy recipients assigned to the documents.
carbonCopies[]ModelEach itemExpand Deletes recipients from a template — response body — carbon Copies item
certifiedDeliveriesarrayOptionalA complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.
certifiedDeliveries[]ModelEach itemExpand Deletes recipients from a template — response body — certified Deliveries item
currentRoutingOrderstringOptionalThe routing order of the current recipient. If this value equals a particular signer's routing order, it indicates that the envelope has been sent to that recipient, but he or she has not completed the required actions.
editorsarrayOptionalA list of users who can edit the envelope.
editors[]ModelEach itemExpand Deletes recipients from a template — response body — editors item
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
inPersonSignersarrayOptionalSpecifies a signer that is in the same physical location as a Docusign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.
inPersonSigners[]ModelEach itemExpand Deletes recipients from a template — response body — in Person Signers item
intermediariesarrayOptionalIdentifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).
intermediaries[]ModelEach itemExpand Deletes recipients from a template — response body — intermediaries item
notariesarrayOptionalA list of notary recipients on the envelope.
notaries[]ModelEach itemExpand Deletes recipients from a template — response body — notaries item
notaryWitnessesarrayOptional
notaryWitnesses[]ModelEach itemExpand Deletes recipients from a template — response body — notary Witnesses item
participantsarrayOptional
participants[]ModelEach itemExpand Deletes recipients from a template — response body — participants item
recipientCountstringOptionalThe number of recipients in the envelope.
sealsarrayOptionalA list of electronic seals to apply to documents.
seals[]ModelEach itemExpand Deletes recipients from a template — response body — seals item
signersarrayOptionalA list of signers on the envelope.
signers[]ModelEach itemExpand Deletes recipients from a template — response body — signers item
witnessesarrayOptionalA list of signers who act as witnesses on the envelope.
witnesses[]ModelEach itemExpand Deletes recipients from a template — response body — witnesses item

Referenced models: Deletes recipients from a template — response body — agents item, Deletes recipients from a template — response body — authorized Signatories item, Deletes recipients from a template — response body — carbon Copies item, Deletes recipients from a template — response body — certified Deliveries item, Deletes recipients from a template — response body — editors item, Locks a template — response body — error Details, Deletes recipients from a template — response body — in Person Signers item, Deletes recipients from a template — response body — intermediaries item, Deletes recipients from a template — response body — notaries item, Deletes recipients from a template — response body — notary Witnesses item, Deletes recipients from a template — response body — participants item, Deletes recipients from a template — response body — seals item, Deletes recipients from a template — response body — signers item, Deletes recipients from a template — response body — witnesses item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.