Docusign EnvelopeRecipients API

The EnvelopeRecipients resource allows you manage the recipients of an envelope. There are seven recipient types. All types share a [core set of parameters](#core-recipient-parameters). Some recipient types have additional parameters. | Recipient type | Description | | :--- | :--- | | [Agents](#agents-recipient) | An agent recipient can add name and email information for recipients that appear after the agent in routing order. | | [Carbon Copies](#carbon-copies-recipient) | Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. This type of recipient can be used in any routing order. Carbon copy recipients receive their copy of the envelope when the envelope reaches the recipient's order in the process flow and when the envelope is completed. | | [Certified Deliveries](#certified-deliveries-recipient) | Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents. | | [Editors](#editors-recipient) | Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor. | | [In-Person Signers](#in-person-signers-recipient) | An in-person recipient is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. | | [Intermediaries](#intermediaries-recipient) | An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added. | | [Seals](#seal-recipient) | An electronic seal recipient represents a legal person. Electronic seals can be used by organizations and governments to show evidence of origin and integrity of documents. | | [Signers](#signers-recipient) | A signer is a recipient who must sign, initial, date, or add data to form fields on the documents in the envelope. | Not all recipients are are available to all account types. Review your account plan to determine which recipient types are available to you. All recipient types are available in the Demo environment. ## Core Recipient Parameters All recipients, regardless of type, have the same common parameters. The following table contains the descriptions for the core properties for all recipient types. | Name | Required | Schema Type | Description | | :--- | :--- | :--- | :--- | | email | Yes | Email | Email of the recipient. Notification will be sent to this email id.Maximum Length: 100 characters. | | name | Yes | String | Full legal name of the recipient.Maximum Length: 100 characters. | | accessCode | No | String | This optional element specifies the access code a recipient has to enter to validate the identity.Maximum Length: 50 characters. | | addAccessCodeToEmail | No | Boolean | This optional attribute indicates that the access code is added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. | | clientUserId | No | String | This specifies whether the recipient is embedded or remote.If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending. | | embeddedRecipientStartURL | No | String | This is 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, but when the document link in the email is clicked the recipient is redirected, through DocuSign, to this URL to complete their actions. When routing to the URL, it is up to the sender's system (the server responding to the URL) to then request a recipient token to launch a signing session.If the value `SIGN_AT_DOCUSIGN` is used for this node, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that would be launched by any partner.It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application and DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets the `EmbeddedRecipientStartURL` property to `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 one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) be used to verify the identity of the recipient.If the `clientUserId` property is NOT set and the `embeddedRecipientStartURL` property is set, DocuSign ignores the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the `embeddedRecipientStartURL` property using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields must be part of the recipient or envelope. The merge fields are enclosed in double brackets._Example_:`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` | | customFields | No | customField |An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. String `customField` properties have a maximum length of 100 characters. | | emailNotification | No | emailNotification | An optional complex type that has information for setting the language for the recipient's email information. It is composed of three elements:*emailBody*: a string with the email message sent to the recipient.Maximum Length: 10000 characters.*emailSubject*: a string with the subject of the email sent to the recipient.Maximum Length: 100 characters.*supportedLanguage*: The simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi).**IMPORTANT**: If this is enabled for one recipient, it overrides the Envelope Subject and `EmailBlurb` property settings. Also, you must set the `emailNotification` property for all recipients. | | excludedDocuments | No | Array of Strings | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.When the enforceSignerVisibility property is set to **true**, 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. | | idCheckConfigurationName | No | String |Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting._Example_: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the `idCheckConfigurationName` property must be set to `ID Check $`. To use SMS, it must be set to `SMS Auth $` and you must add phone number information to the `smsAuthentication` node.| | iDCheckInformationInput | No | IdCheckInformationInput | This complex element contains input information related to a recipient ID check. It can include the following information.*addressInformationInput*: Used to set recipient address information and consists of:*addressInformation*: consists of six elements, with street2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4\. The maximum number of characters in each element are: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.*dobInformationInput*: Used to set recipient date of birth information and consists of:*dateOfBirth*: Specifies the recipient's date, month and year of birth.*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.*ssn4InformationInput*: Used to set the last four digits of the recipient's SSN information and consists of:*ssn4*: Specifies the last four digits of the recipient's SSN.*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.*ssn9InformationInput*: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:*ssn9*: Specifies the recipient's SSN.*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. | | inheritEmailNotificationConfiguration | No | Boolean | Optional element. If 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. | | note | No | String | A note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.Maximum Length: 1000 characters. | | phoneAuthentication | No | RecipientPhoneAuthentication | Optional element. Contains the elements: *recipMayProvideNumber*:Boolean. When set to **true** thenrecipient can use whatever phone number they choose to. *senderProvidedNumbers*: ArrayOfString. A list of phone numbers the recipient can use. *recordVoicePrint* - Reserved for DocuSign. *validateRecipProvidedNumber* - Reserved for DocuSign. | | | recipientAttachment | No | Attachment | Reserved for DocuSign. | | recipientId | No | String | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. | | requireIdLookup | No | Boolean | When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. | | roleName | No* | String | Optional element. Specifies the role name associated with the recipient.This is required when working with template recipients. | | routingOrder | Yes | String | This element specifies the routing order of the recipient in the envelope. | | smsAuthentication | No | senderProvidedNumbers | Optional element. Contains the element:*senderProvidedNumbers*: Array that contains a list of phone numbers the recipient can use for SMS text authentication. | | socialAuthentications | No | Boolean | Lists the social ID type that can be used for recipient authentication. | | templateAccessCodeRequired | No | Boolean | Optional element. Used only when working with template recipients. When set to **true** and the `TemplateLocked` parameter is set to **true**, the sender must enter an access code. | | templateLocked | No | Boolean | Optional element. Used only when working with template recipients. When set to **true**, the sender cannot change any attributes of the recipient. | | templateRequired | No | Boolean | Optional element. Used only when working with template recipients. When set to **true**, the sender may not remove the recipient. | **JSON layout** ``` "email": "email.name@company.com", "name": "recipient name", "accessCode": "", "addAccessCodeToEmail": false, "clientUserIs": null, "embeddedRecipientStartURL": "string", "customFields": { "sample string 1", "sample string 2" }, "emailNotification"{ "emailBody":"email text", "emailSubject":"Subject text", "supportedLanguage":"en", }, "excludedDocuments": ["2", "4"], "idCheckConfigurationName": null, "idCheckInformationInput": { "addressInformationInput": { "addressInformation": { "street1": "sample string 1", "street2": "sample string 2", "city": "sample string 3", "state": "sample string 4", "zip": "sample string 5", "zipPlus4": "sample string 6" }, "displayLevelCode": "sample string 1", "receiveInResponse": "sample string 2" }, "dobInformationInput": { "dateOfBirth": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn4InformationInput": { "ssn4": "sample string 1", "displayLevelCode": "sample string 2", "receiveInResponse": "sample string 3" }, "ssn9InformationInput": { "ssn9": "sample string 1", "displayLevelCode": "sample string 2" } }, "inheritEmailNotificationConfiguration": false, "note": "", "phoneAuthentication": { "recipMayProvideNumber": "sample string 1", "validateRecipProvidedNumber": "sample string 2", "recordVoicePrint": "sample string 3", "senderProvidedNumbers": [ "sample string 1", "sample string 2" ] }, "recipientAttachment": null, "recipientCaptiveInfo": null, "recipientId": "1", "requireIdLookup": false, "roleName": "", "routingOrder": 1, "smsAuthentication": { "senderProvidedNumbers":[ "sample string 1", "sample string 2" ] }, "socialAuthentications": null, "templateAccessCodeRequired": false, "templateLocked": false, "templateRequired": false, ... ``` ## Agents Recipient An agent recipient can add name and email information for recipients that appear after the agent in routing order. In addition to the [core parameters](#core-recipient-parameters), this type adds the following parameters. | Name | Required | Schema Type | Description | | :--- | :--- | :--- | :--- | | canEditRecipientEmails | No | Boolean | Optional element. When set to **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. | | canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. | **JSON layout** ``` "agents": [{ "canEditRecipientEmails": false, "canEditRecipientNames": false }], ``` ## Carbon Copies Recipient Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. This type of recipient can be used in any routing order. Carbon copy recipients receive their copy of the envelope when the envelope reaches the recipient's order in the process flow and when the envelope is completed. This recipient type uses only the [core parameters](#core-recipient-parameters). **JSON layout** ``` "carbonCopies": [{ ``` ## Certified Deliveries Recipient Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents. This recipient type uses only the [core parameters](#core-recipient-parameters). **JSON layout** ``` "certifiedDeliveries": [{ }], ``` ## Editors Recipient Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor. In addition to the [core parameters](#core-recipient-parameters), this type adds the following parameters. | Name | Required | Schema Type | Description | | :--- | :--- | :--- | :--- | | canEditRecipientEmails | No | Boolean | Optional element. When set to **true**, the Editors Recipient associated with this Recipient can change the Recipient's pre-populated Email address. This element is only active if enabled for the account. | | canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Editors Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. | **JSON layout** ``` "editors": [{ "canEditRecipientEmails": false, "canEditRecipientNames": false }], ``` ## In-Person Signers Recipient An in-person recipient is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. In addition to the [core parameters](#core-recipient-parameters), this type adds the following parameters. The following restrictions apply to using electronic notary when sending documents: * Authentication methods are allowed for the signer but not the notary. * The Sign On Paper, Document Markup, Field Markup and Change Signer options cannot be used for the documents. * Tabs may be assigned to the signer, but cannot be assigned to the notary. Refer to [eNotary Resources][enotary-resources] in the DocuSign Support Center for more information about how the eNotary feature works. | Name | Required | Schema Type | Description | | :------------------ | :---------------------------------------------------------------- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | inPersonSigningType | No | String | Specifies whether the envelope uses the eNotary feature. The accepted values are:`inPersonSigner` The envelope uses the normal in-person signing flow.`notary`: The envelope uses the eNotary signing flow. | | notaryHost | Yes, when `inPersonSigningType` is `notary` | NotaryHost | Sets the information for the notary host for the notary in person signing flow. The following information is required: `recipientId`: A unique ID number for the notary signing host. `name`: Specifies the notary's full legal name. `email`: Specifies the notary's email address. | | autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient. | | defaultRecipient | No | Boolean | When set to **true**, this is the default recipient for the envelope. This option is used when creating an envelope from a template. | | hostName | Yes, when `inPersonSigningType` is `inPersonSigner` | String | The name of the signing host. This is the DocuSign user that is hosting the in-person signing session. | | hostEmail | Yes, when `inPersonSigningType` is `inPersonSigner` | String | The email address of the signing host. This is the DocuSign user that is hosting the in-person signing session. | | signerName | Yes, when `inPersonSigningType` is `inPersonSigner` | String | The in-person signer's full legal name. | | signerEmail | No, but valid only when `inPersonSigningType` is `inPersonSigner` | String | The in-person signer's email address. | | name | Yes, when `inPersonSigningType` is `notary` | String | The full legal name of the signer in an eNotary flow. | | email | Yes, when `inPersonSigningType` is `notary` | String | The signer's email address in an eNotary flow. | | signatureInfo | No | String | Optional element only used with recipient types In Person Signers and Signers.Allows the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. | | signInEachLocation | No | Boolean | When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). | | tabs | No | Tab | Optional element only used with recipient types In Person Signers and Signers.Specifies the Tabs associated with the recipient. See the [EnvelopeRecipientTabs resource][envelopeRecipientTabsResource] for more information about tabs. | **JSON layout** ``` "inPersonSigners": [{ "hostEmail": "signing.host@company.com", "hostName": "Mike Host", "autoNavigation": false, "defaultRecipient": false, "signInEachLocation": false, "signatureInfo": null, "signerEmail": "inperson.signer@company.com", "signerName": "Isaac Inperson", "email": "notary.signer@example.com", "name": "Notary Signer" "tabs": { "approveTabs": null, "checkboxTabs": null, "companyTabs": null, "dateSignedTabs": null, "dateTabs": null, "declineTabs": null, "emailTabs": null, "envelopeIdTabs": null, "fullNameTabs": null, "initialHereTabs": null, "listTabs": null, "noteTabs": null, "numberTabs": null, "radioGroupTabs": null, "signHereTabs": [{ "signerAttachmentTabs": null, "ssnTabs": null, "textTabs": null, "titleTabs": null, "zipTabs": null } "inPersonSigningType": "notary", "notaryHost": { "email": "notary@example.com", "name": "Natalie Notary", "recipientId": "string" } }], ``` ## Intermediaries Recipient An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added. In addition to the [core parameters](#core-recipient-parameters), this type adds the following parameters. | Name | Required | Schema Type | Description | | :--- | :--- | :--- | :--- | | canEditRecipientEmails | No | Boolean | Optional element. When set to **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. | | canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. | **JSON layout** ``` "intermediaries": [{ "canEditRecipientEmails": false, "canEditRecipientNames": false }], ``` ## Seals Recipient An electronic seal recipient is not a natural but a legal 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. Electronic seal recipients rely on a subset of core properties. They also add a new `recipientSignatureProviders` parameter. | Name               | Required               | Schema Type       | Description     | | :--- | :--- | :--- | :--- | | recipientId| Yes | String | Indicates the unique ID of the applied electronic seal.| | routingOrder| No (default: 1) | String | 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.. | | recipientSignatureProviders| Yes | String | Indicates which electronic seal to apply on documents when creating an envelope. | By default, Electronic Seals apply on all documents in an envelope. However, the sealDocumentsWithTabsOnly property (see recipientSignatureProvider) allows you to seal only documents that have signHere tabs set for the Electronic Seal recipients. **JSON layout (Apply Electronic Seals on all documents)** ``` { .... "recipients": { "seals": [ { "recipientId": "10", "routingOrder" : 2, "recipientSignatureProviders": [{ "sealName": "ed8f186c-3b12-45cb-9eb3-c8c33dc4f6b0", "sealDocumentsWithTabsOnly": "false" }] }] }, "documents": [ { "documentId": "55", "name": " ACME Contract", "fileExtension": "pdf", "documentBase64": "DOC_IN_BASE64" } ] } ``` **JSON layout (Apply Electronic Seals on specific documents)** ``` { .... "recipients": { "seals": [{ "recipientId": "10", "routingOrder" : 2, "recipientSignatureProviders": [{ "sealName": "ed8f186c-3b12-45cb-9eb3-c8c33dc4f6b0", "sealDocumentsWithTabsOnly": "true" }], "tabs": { "signHereTabs": [{ "documentId": "55", "recipientId": "10", "pageNumber": "1", "xPosition": "272", "yPosition": "98", }] } }] }, "documents": [{ "documentId": "55", "name": " ACME Contract", "fileExtension": "pdf", "documentBase64": "DOC_EN_BASE64" }] } ``` ## Signers Recipient A signer is a recipient who must sign, initial, date, or add data to form fields on the documents in the envelope. In addition to the [core parameters](#core-recipient-parameters), this type adds the following parameters. | Name | Required | Schema Type | Description | | :--- | :--- | :--- | :--- | | autoNavigation | No | Boolean | Specifies whether auto navigation is set for the recipient.| | defaultRecipient | No | Boolean | When set to **true**, this is the default recipient for the envelope. This option is used with the CreateEnvelopeFromTemplatesAndForms method. | | signInEachLocation | No | Boolean | When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once). | | signatureInfo | No | String | Optional element only used with recipient types In Person Signers and Signers.Allows the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient. | | signerEmail | No | String | Optional element. The email address for an InPersonSigner recipient Type.Maximum Length: 100 characters. | | signerName | Yes | String | Required element with recipient type In Person Signers.Maximum Length: 100 characters.The full legal name of a signer for the envelope. | | tabs | No | Tab | Optional element only used with recipient types In Person Signers and Signers.Specifies the Tabs associated with the recipient. See the the [EnvelopeTabs resource][envelopeTabsResource] for more information about tabs. | | deliveryMethod | No | String | Reserved for DocuSign.| | deliveredDateTime | No | DateTime | Reserved for DocuSign. | | signedDateTime | No | DateTime | Reserved for DocuSign. | | offlineAttributes | No |   | Reserved for DocuSign.| **JSON layout** ``` "Signers": [{ "autoNavigation": false, "defaultRecipient": false, "signInEachLocation": false, "signatureInfo": null, "tabs": { "approveTabs": null, "checkboxTabs": null, "companyTabs": null, "dateSignedTabs": null, "dateTabs": null, "declineTabs": null, "emailTabs": null, "envelopeIdTabs": null, "fullNameTabs": null, "initialHereTabs": null, "listTabs": null, "noteTabs": null, "numberTabs": null, "radioGroupTabs": null, "signHereTabs": [{ "signerAttachmentTabs": null, "ssnTabs": null, "textTabs": null, "titleTabs": null, "zipTabs": null } "deliveryMethod":"", "deliveredDateTime":"String Content", "signedDateTime":"String Content", "offlineAttributes":{ "deviceName":"String Content", "deviceModel":"String Content", "gpsLatitude":"String Content", "gpsLongitude":"String Content", "accountEsignId":"String Content" } }], ``` [envelopeRecipientTabsResource]: https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/ [enotary-resources]: https://support.docusign.com/en/guides/ndse-user-guide-enotary-resources

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

docusign-enveloperecipients-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: DocuSign Admin AccountBrands EnvelopeRecipients API
  description: An API for an organization administrator to manage organizations, accounts and users
  termsOfService: https://www.docusign.com/company/terms-and-conditions/developers
  contact:
    name: DocuSign Developer Center
    url: https://developers.docusign.com
    email: devcenter@docusign.com
  version: v2.1
servers:
- url: https://api.docusign.net/Management
tags:
- name: EnvelopeRecipients
  description: "<!-- resources aren't rendered the same way\n     as other pages. This is a little hack to\n     make the headings work better -->\n<style>\nh1, h2, h3 {\n  margin-top: 1em;\n}\n</style>\n\nThe EnvelopeRecipients resource allows you manage the recipients of an\nenvelope. There are seven recipient types. All types share\na [core set of parameters](#core-recipient-parameters).\nSome recipient types have additional parameters.\n\n<br>\n\n| Recipient type | Description |\n| :--- | :--- |\n| [Agents](#agents-recipient) | An agent recipient can add name and email information for recipients that appear after the agent in routing order. |\n| [Carbon Copies](#carbon-copies-recipient) | Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date or add information to any of the documents. This type of recipient can be used in any routing order. Carbon copy recipients receive their copy of the envelope when the envelope reaches the recipient's order in the process flow and when the envelope is completed. |\n| [Certified Deliveries](#certified-deliveries-recipient) | Certified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents. |\n| [Editors](#editors-recipient) | Editors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor. |\n| [In-Person Signers](#in-person-signers-recipient) | An in-person recipient is a DocuSign user, acting as a Signing Host, who is in the same physical location as the signer. |\n| [Intermediaries](#intermediaries-recipient) | An intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added. |\n| [Seals](#seal-recipient) | An electronic seal recipient represents a legal person. Electronic seals can be used by organizations and governments to show evidence of origin and integrity of documents. |\n| [Signers](#signers-recipient) | A signer is a recipient who must sign, initial, date, or add data to form fields on the documents in the envelope. |\n\n<br>\n\nNot all recipients are are available to all account types.\nReview your account plan to determine\nwhich recipient types are available to you.\nAll recipient types are available in the Demo environment.\n\n\n## Core Recipient Parameters\n\nAll recipients, regardless of type, have the same common parameters.\nThe following table contains the descriptions\nfor the core properties for all recipient types.\n\n<br>\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| email | Yes | Email | Email of the recipient. Notification will be sent to this email id.<br/>Maximum Length: 100 characters. |\n| name | Yes | String | Full legal name of the recipient.<br/>Maximum Length: 100 characters. |\n| accessCode | No | String | This optional element specifies the access code a recipient has to enter to validate the identity.<br/>Maximum Length: 50 characters. |\n| addAccessCodeToEmail | No | Boolean | This optional attribute indicates that the access code is added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. |\n| clientUserId | No | String | This specifies whether the recipient is embedded or remote.<br/><br/>If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to  **true**, an error is generated on sending. |\n| embeddedRecipientStartURL | No | String | This is 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, but when the document link in the email is clicked the recipient is redirected, through DocuSign, to this URL to complete their actions. When routing to the URL, it is up to the sender's system (the server responding to the URL) to then request a recipient token to launch a signing session.<br/><br/>If the value `SIGN_AT_DOCUSIGN` is used for this node, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that would be launched by any partner.<br/><br/>It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application and DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets  the `EmbeddedRecipientStartURL` property to `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 one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) be used to verify the identity of the recipient.<br/><br>If the `clientUserId` property is NOT set and the `embeddedRecipientStartURL` property is set, DocuSign ignores the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the `embeddedRecipientStartURL` property using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields must be part of the recipient or envelope. The merge fields are enclosed in double brackets.<br/><br/>_Example_:<br/>`http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` |\n| customFields | No | customField |An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. String `customField` properties have a maximum length of 100 characters. |\n| emailNotification | No | emailNotification | An optional complex type that has information for setting the language for the recipient's email information. It is composed of three elements:<br/><br/>*emailBody*: a string with the email message sent to the recipient.<br/>Maximum Length: 10000 characters.<br/><br/>*emailSubject*: a string with the subject of the email sent to the recipient.<br/>Maximum Length: 100 characters.<br/><br/>*supportedLanguage*: The simple type enumeration of the language used. The supported languages, with the language value shown in parenthesis, are: Arabic (ar), Bahasa Indonesia (id), Bahasa Melayu (ms) Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro),Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi).<br/><br/>**IMPORTANT**: If this is enabled for one recipient, it overrides the Envelope Subject and `EmailBlurb` property settings. Also, you must set the  `emailNotification` property for all recipients. |\n| excludedDocuments | No | Array of Strings | Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this.<br/><br/>When the enforceSignerVisibility property is set to **true**, 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. |\n| idCheckConfigurationName | No | String |Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient). This overrides any default authentication setting.<br/><br/>_Example_:<br/> Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the `idCheckConfigurationName` property must be  set to `ID Check $`. To use SMS, it must be set to `SMS Auth $` and you must add phone number information to the `smsAuthentication` node.|\n| iDCheckInformationInput | No | IdCheckInformationInput | This complex element contains input information related to a recipient ID check. It can include the following information.<br/><br/>*addressInformationInput*: Used to set recipient address information and consists of:<br/><br/>*addressInformation*: consists of six elements, with street2 and zipPlus4 being optional. The elements are: street1, street2, city, state, zip, zipPlus4\\. The maximum number of characters in each element are: street1/street2 = 150 characters, city = 50 characters, state = 2 characters, and zip/zipPlus4 = 20 characters.<br/><br/>displayLevelCode: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.<br/><br/>*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.<br/><br/>*dobInformationInput*: Used to set recipient date of birth information and consists of:<br/><br/>*dateOfBirth*: Specifies the recipient's date, month and year of birth.<br/><br/>*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.<br/><br/>*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.<br/><br/>*ssn4InformationInput*: Used to set the last four digits of the recipient's SSN information and consists of:<br/><br/>*ssn4*: Specifies the last four digits of the recipient's SSN.<br/><br/>*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay.<br/><br/>*receiveInResponse*: A Boolean element that specifies if the information needs to be returned in the response.<br/><br/>*ssn9InformationInput*: Used to set the recipient's SSN information. Note that the ssn9 information can never be returned in the response. The ssn9 input consists of:<br/><br/><br/><br/>*ssn9*: Specifies the recipient's SSN.<br/><br/>*displayLevelCode*: Specifies the display level for the recipient. Values are: ReadOnly, Editable, or DoNotDisplay. |\n| inheritEmailNotificationConfiguration | No | Boolean | Optional element. If 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. |\n| note | No | String | A note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen.<br/>Maximum Length: 1000 characters. |\n| phoneAuthentication | No | RecipientPhoneAuthentication | Optional element. Contains the elements: <br/><br/> *recipMayProvideNumber*:Boolean. When set to **true** thenrecipient can use whatever phone number they choose to.<br/><br/> *senderProvidedNumbers*: ArrayOfString. A list of phone numbers the recipient can use. <br/><br/>*recordVoicePrint* - Reserved for DocuSign. <br/><br/>*validateRecipProvidedNumber* - Reserved for DocuSign. | |\n| recipientAttachment | No | Attachment | Reserved for DocuSign. |\n| recipientId | No | String | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. |\n| requireIdLookup | No | Boolean | When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. |\n| roleName | No* | String | Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. |\n| routingOrder | Yes | String | This element specifies the routing order of the recipient in the envelope. |\n| smsAuthentication | No | senderProvidedNumbers | Optional element. Contains the element:<br/><br/>*senderProvidedNumbers*: Array that contains a list of phone numbers the recipient can use for SMS text authentication. |\n| socialAuthentications | No | Boolean | Lists the social ID type that can be used for recipient authentication. |\n| templateAccessCodeRequired | No | Boolean | Optional element. Used only when working with template recipients. When set to **true** and the `TemplateLocked` parameter is set to **true**, the sender must enter an access code. |\n| templateLocked | No | Boolean | Optional element. Used only when working with template recipients. When set to **true**, the sender cannot change any attributes of the recipient. |\n| templateRequired | No | Boolean | Optional element. Used only when working with template recipients. When set to **true**,  the sender may not remove the recipient. |\n\n<br>\n\n**JSON layout**\n\n```\n\"email\": \"email.name@company.com\",\n  \"name\": \"recipient name\",\n  \"accessCode\": \"\",\n  \"addAccessCodeToEmail\": false,\n  \"clientUserIs\": null,\n  \"embeddedRecipientStartURL\": \"string\",\n  \"customFields\": {\n    \"sample string 1\",\n    \"sample string 2\"\n  },\n  \"emailNotification\"{\n    \"emailBody\":\"email text\",\n    \"emailSubject\":\"Subject text\",\n    \"supportedLanguage\":\"en\",\n  },\n  \"excludedDocuments\": [\"2\", \"4\"],\n  \"idCheckConfigurationName\": null,\n  \"idCheckInformationInput\": {\n    \"addressInformationInput\": {\n      \"addressInformation\": {\n        \"street1\": \"sample string 1\",\n        \"street2\": \"sample string 2\",\n        \"city\": \"sample string 3\",\n        \"state\": \"sample string 4\",\n        \"zip\": \"sample string 5\",\n        \"zipPlus4\": \"sample string 6\"\n      },\n      \"displayLevelCode\": \"sample string 1\",\n      \"receiveInResponse\": \"sample string 2\"\n    },\n    \"dobInformationInput\": {\n      \"dateOfBirth\": \"sample string 1\",\n      \"displayLevelCode\": \"sample string 2\",\n      \"receiveInResponse\": \"sample string 3\"\n    },\n    \"ssn4InformationInput\": {\n      \"ssn4\": \"sample string 1\",\n      \"displayLevelCode\": \"sample string 2\",\n      \"receiveInResponse\": \"sample string 3\"\n    },\n    \"ssn9InformationInput\": {\n      \"ssn9\": \"sample string 1\",\n      \"displayLevelCode\": \"sample string 2\"\n    }\n  },\n  \"inheritEmailNotificationConfiguration\": false,\n  \"note\": \"\",\n  \"phoneAuthentication\": {\n    \"recipMayProvideNumber\": \"sample string 1\",\n    \"validateRecipProvidedNumber\": \"sample string 2\",\n    \"recordVoicePrint\": \"sample string 3\",\n    \"senderProvidedNumbers\": [\n      \"sample string 1\",\n      \"sample string 2\"\n    ]\n  },\n  \"recipientAttachment\": null,\n  \"recipientCaptiveInfo\": null,\n  \"recipientId\": \"1\",\n  \"requireIdLookup\": false,\n  \"roleName\": \"\",\n  \"routingOrder\": 1,\n  \"smsAuthentication\": {\n    \"senderProvidedNumbers\":[\n      \"sample string 1\",\n      \"sample string 2\"\n    ]\n  },\n  \"socialAuthentications\": null,\n  \"templateAccessCodeRequired\": false,\n  \"templateLocked\": false,\n  \"templateRequired\": false,\n...\n```\n\n\n## Agents Recipient\n\nAn agent recipient can add name and email information for recipients that appear after the agent in routing order.\n\nIn addition to the [core parameters](#core-recipient-parameters),\nthis type adds the following parameters.\n\n<br>\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| canEditRecipientEmails | No | Boolean | Optional element. When set to **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. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n<br>\n\n**JSON layout**\n\n```\n\"agents\": [{\n <core parameters>\n  \"canEditRecipientEmails\": false,\n  \"canEditRecipientNames\": false\n}],\n```\n\n\n## Carbon Copies Recipient\n\nCarbon 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. Carbon copy recipients receive their copy of the envelope when the envelope reaches the recipient's order in the process flow and when the envelope is completed.\n\nThis recipient type uses only the [core parameters](#core-recipient-parameters).\n\n**JSON layout**\n\n```\n\"carbonCopies\": [{\n <core parameters>\n```\n\n\n## Certified Deliveries Recipient\n\nCertified delivery recipients must receive the completed documents for the envelope to be completed. However, they don't need to sign, initial, date or add information to any of the documents.\n\nThis recipient type uses only the [core parameters](#core-recipient-parameters).\n\n**JSON layout**\n\n```\n\"certifiedDeliveries\": [{\n<core parameters>\n}],\n```\n\n## Editors Recipient\n\nEditors have the same management and access rights for the envelope as the sender. They can make changes to the envelope as if they were using the Advanced Correct feature. This recipient can add name and email information, add or change the routing order and set authentication options for the remaining recipients. Additionally, this recipient can edit signature/initial tabs and data fields for the remaining recipients. The recipient must have a DocuSign account to be an editor.\n\nIn addition to the [core parameters](#core-recipient-parameters),\nthis type adds the following parameters.\n\n<br>\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| canEditRecipientEmails | No | Boolean | Optional element. When set to **true**, the Editors Recipient associated with this Recipient can change the Recipient's pre-populated Email address. This element is only active if enabled for the account. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Editors Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n<br>\n\n\n**JSON layout**\n\n```\n\"editors\": [{\n <core parameters>\n  \"canEditRecipientEmails\": false,\n  \"canEditRecipientNames\": false\n}],\n```\n\n\n## In-Person Signers Recipient\n\nAn in-person recipient is a DocuSign user,\nacting as a Signing Host,\nwho is in the same physical location as the signer.\n\nIn addition to the [core parameters](#core-recipient-parameters),\nthis type adds the following parameters.\n\nThe following restrictions apply\nto using electronic notary when sending documents:\n\n* Authentication methods are allowed for the signer but not the notary.\n* The Sign On Paper, Document Markup, Field Markup and Change Signer options cannot be used for the documents.\n* Tabs may be assigned to the signer, but cannot be assigned to the notary.\n\nRefer to [eNotary Resources][enotary-resources]\nin the DocuSign Support Center for more information\nabout how the eNotary feature works.\n\n<br>\n\n| Name                | Required                                                          | Schema Type | Description                                                                                                                                                                                                                                                                                                                            |\n| :------------------ | :---------------------------------------------------------------- | :---------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| inPersonSigningType | No                                                                | String      | Specifies whether the envelope uses the eNotary feature. The accepted values are:<ul markdown=1><li>`inPersonSigner` The envelope uses the normal in-person signing flow.</li><li>`notary`: The envelope uses the eNotary signing flow.</li></ul>                                                                                      |\n| notaryHost          | Yes, when `inPersonSigningType` is `notary`                       | NotaryHost  | Sets the information for the notary host for the notary in person signing flow. The following information is required: <ul markdown=1> <li>`recipientId`: A unique ID number for the notary signing host. </li> <li>`name`: Specifies the notary's full legal name.</li> <li>`email`: Specifies the notary's email address. </li> </ul>|\n| autoNavigation      | No                                                                | Boolean     | Specifies whether auto navigation is set for the recipient.                                                                                                                                                                                                                                                                            |\n| defaultRecipient    | No                                                                | Boolean     | When set to **true**, this is the default recipient for the envelope. This option is used when creating an envelope from a template.                                                                                                                                                                                                   |\n| hostName            | Yes, when `inPersonSigningType` is `inPersonSigner`               | String      | The name of the signing host. This is the DocuSign user that is hosting the in-person signing session.                                                                                                                                                                                                                                 |\n| hostEmail           | Yes, when `inPersonSigningType` is `inPersonSigner`               | String      | The email address of the signing host. This is the DocuSign user that is hosting the in-person signing session.                                                                                                                                                                                                                        |\n| signerName          | Yes, when `inPersonSigningType` is `inPersonSigner`               | String      | The in-person signer's full legal name.                                                                                                                                                                                                                                                                                                |\n| signerEmail         | No, but valid only when `inPersonSigningType` is `inPersonSigner` | String      | The in-person signer's email address.                                                                                                                                                                                                                                                                                                  |\n| name                | Yes, when `inPersonSigningType` is `notary`                       | String      | The full legal name of the signer in an eNotary flow.                                                                                                                                                                                                                                                                                  |\n| email               | Yes, when `inPersonSigningType` is `notary`                       | String      | The signer's email address in an eNotary flow.                                                                                                                                                                                                                                                                                         |\n| signatureInfo       | No                                                                | String      | Optional element only used with recipient types In Person Signers and Signers.<br/><br/>Allows the sender to pre-specify the signature name, signature initials, and signature font used in the signature stamp for the recipient.                                                                                                     |\n| signInEachLocation  | No                                                                | Boolean     | When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab (instead of adopting a signature/initial style or only drawing a signature/initial once).                                                                     |\n| tabs                | No                                                                | Tab         | Optional element only used with recipient types In Person Signers and Signers.<br/><br/>Specifies the Tabs associated with the recipient. See the [EnvelopeRecipientTabs resource][envelopeRecipientTabsResource] for more information about tabs.                                                                                     |\n\n<br>\n\n**JSON layout**\n\n```\n\"inPersonSigners\": [{\n  \"hostEmail\": \"signing.host@company.com\",\n  \"hostName\": \"Mike Host\",\n <core parameters>\n  \"autoNavigation\": false,\n  \"defaultRecipient\": false,\n  \"signInEachLocation\": false,\n  \"signatureInfo\": null,\n  \"signerEmail\": \"inperson.signer@company.com\",\n  \"signerName\": \"Isaac Inperson\",\n  \"email\": \"notary.signer@example.com\",\n  \"name\": \"Notary Signer\"\n  \"tabs\": {\n    \"approveTabs\": null,\n    \"checkboxTabs\": null,\n    \"companyTabs\": null,\n    \"dateSignedTabs\": null,\n    \"dateTabs\": null,\n    \"declineTabs\": null,\n    \"emailTabs\": null,\n    \"envelopeIdTabs\": null,\n    \"fullNameTabs\": null,\n    \"initialHereTabs\": null,\n    \"listTabs\": null,\n    \"noteTabs\": null,\n    \"numberTabs\": null,\n    \"radioGroupTabs\": null,\n    \"signHereTabs\": [{\n    \"signerAttachmentTabs\": null,\n    \"ssnTabs\": null,\n    \"textTabs\": null,\n    \"titleTabs\": null,\n    \"zipTabs\": null\n  }\n  \"inPersonSigningType\": \"notary\",\n  \"notaryHost\": {\n    \"email\": \"notary@example.com\",\n    \"name\": \"Natalie Notary\",\n    \"recipientId\": \"string\"\n  }\n}],\n```\n\n\n## Intermediaries Recipient\n\nAn intermediary is a recipient who can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order, unless subsequent agents, editors or intermediaries are added.\n\nIn addition to the [core parameters](#core-recipient-parameters),\nthis type adds the following parameters.\n\n<br>\n\n| Name | Required | Schema Type | Description |\n| :--- | :--- | :--- | :--- |\n| canEditRecipientEmails | No | Boolean | Optional element. When set to **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. |\n| canEditRecipientNames | No | Boolean | Optional element. When set to **true**, the Agents Recipient associated with this recipient can change the recipient's pre-populated name (`UserName`). This element is only active if enabled for the account. |\n\n<br>\n\n**JSON layout**\n\n```\n\"intermediaries\": [{\n<core parameters>\n  \"canEditRecipientEmails\": false,\n  \"canEditRecipientNames\": false\n}],\n```\n\n\n\n## Seals Recipient\n\nAn electronic seal recipient is not a natural but a legal person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents.\nEven 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.\nElectronic seal recipients rely on a subset of core properties. They also add a new `recipientSignatureProviders` parameter.\n\n\n<br>\n\n\n| Name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Required&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Schema Type&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp; |\n| :--- | :--- | :--- | :--- |\n| recipientId| Yes | String | Indicates the unique ID of the applied electronic seal.<br/>|\n| routingOrder| No (default: 1) | String | Specifies the routing order of the electronic seal in the envelope. <br />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.. |\n| recipientSignatureProviders| Yes | String | Indicates which electronic seal to apply on documents when creating an envelope. |\n\nBy default, Electronic Seals apply on all documents in an envelope. However, the sealDocumentsWithTabsOnly property (see recipientSignatureProvider) allows you to seal only documents that have signHere tabs set for the Electronic Seal recipients.\n\n\n\n**JSON layout (Apply Electronic Seals on all documents)**\n```\n{\n        ....\n\n        \"recipients\": {\n          \"seals\": [            {\n              \"recipientId\": \"10\",\n              \"routingOrder\" : 2,\n              \"recipientSignatureProviders\": [{\n                  \"sealName\": \"ed8f186c-3b12-45cb-9eb3-c8c33dc4f6b0\",\n                  \"sealDocumentsWithTabsOnly\": \"false\"\n                }]\n            }]\n        },\n        \"documents\": [\n            {\n                \"documentId\": \"55\",\n                \"name\": \" ACME Contract\",\n                \"fileExtension\": \"pdf\",\n                \"documentBase64\": \"DOC_IN_BASE64\"\

# --- truncated at 32 KB (471 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/docusign/refs/heads/main/openapi/docusign-enveloperecipients-api-openapi.yml