The Recipient element is used to specify envelope recipients.
Schema
| Name/Type | Description |
|---|---|
| ID LocalId | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. It must be a positive integer and cannot be 0 (zero). |
| UserName UserName | Full legal name of the recipient. This can be a maximum of 100 characters. If the recipient Type is InPersonSigner, this is the signing host for the envelope. |
| SignerName SignerName | The full legal name of a signer for an InPersonSigner recipient Type. This can be a maximum of 100 characters. |
| Email | Email of the recipient. Notification will be sent to this email id. This can be a maximum of 100 characters. |
| Type RecipientTypeCode | Specifies the role of the recipient. The role can be Signer, CarbonCopy, Editor, Agent, Intermediary, CertifiedDelivery or InPersonSigner. If InPersonSigner is used, SignerName is required and is the name of the person signing the tabs. Also, the UserName is the name of the signing host for the envelope. |
| AccessCode LongString | This Optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. |
| AddAccessCodeToEmail Boolean | This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. |
| RequireIDLookup Boolean | If set to true, then the recipient is required to complete an ID Check or Phone Authentication check. |
| IDCheckConfigurationName LongString | Specify ID check configuration by name. Overrides the default. |
| DeliveryMethod DeliveryMethod | This sets the delivery method used for the recipient. The two enumerations are Email or Fax. Email is the default value. |
| FaxNumber String | The fax number for the recipient. This is only active if the DeliveryMethod is Fax. This can be a maximum of 100 characters. |
| LiveIDRecipientAuthentication Boolean | If true, this is the information used for recipient authentication. |
| FacebookRecipientAuthentication Boolean | If true, this is the information used for recipient authentication. |
| LinkedinRecipientAuthentication Boolean | If true, this is the information used for recipient authentication. |
| GoogleRecipientAuthentication Boolean | If true, this is the information used for recipient authentication. |
| SalesforceRecipientAuthentication Boolean | If true, this is the information used for recipient authentication. |
| TwitterRecipientAuthentication Boolean | If true, this is the information used for recipient authentication. |
| YahooRecipientAuthentication Boolean | If true, this is the information used for recipient authentication. |
| OpenIDRecipientAuthentication Boolean | If true, this is the information used for recipient authentication. |
| AnySocialIDRecipientAuthentication Boolean | If true, this is the information used for recipient authentication. |
| PhoneAuthentication RecipientPhoneAuthentication | Optional element. Contains the elements: RecipMayProvideNumbers – Boolean (if true then recipient can use whatever phone number they want) SenderProvideNumbers – ArrayOfString (a list of phone numbers the recipient may use) RecordVoidPrint – ReservedValidateRecipProvideNumber – Reserved |
| SAMLAuthentication SAMLAttributes | Optional element, account must be set up to use SSO to use this. Contains an array of the name/value pairs for the SAML assertion attributes: Name – The name of the SAML assertion attribute. Value – The value associated with the named SAML assertion attribute. |
| SMSAuthentication RecipientSMSAuthentication | Optional element. Contains the element: SenderProvideNumbers – Array with a list of phone numbers the recipient may use for SMS text authentication. |
| SignatureInfo SignatureInfo | Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. |
| CaptiveInfo CaptiveInfo ClientUserId EmbeddedRecipientStartURL | CaptiveInfo is made up of two optional elements that 1) determine if a recipient is embedded or remote, and 2) express a redirect URL used for starting a recipient’s signing session. ClientUserId – This is a sender created value that can be a maximum of 100 characters. If there is a value for this (it is not null) then the recipient is considered to be embedded. Note that if a ClientUserId is used and the account settings SignerMustHaveAccount or SignerMustLoginToSign are true, an error is generated on sending. EmbeddedRecipientStartURL – This is a sender provided valid URL string for redirecting the 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 will be 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 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 one of the normal Docusign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) be used to verify the identity of the recipient. If a ClientUserId is NOT provided and an EmbeddedRecipientStartURL is provided, Docusign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the EmbeddedRecipientStartURL 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 Array of CustomField | Allows the sender to send custom data about the recipient. This information is returned in the envelope status but otherwise not used by Docusign. Each CustomField can be a maximum of 100 characters. |
| RoutingOrder PositiveShort | This element specifies the routing order of the recipient in the envelope |
| IDCheckInformationInput IDCheckInformationInput | This complex element contains information related to recipient ID check. It comprises of Address, DOB, SS4 and SS9. See the IDCheckInformationInput section for more information. |
| AutoNavigation Boolean | Specifies the auto navigation setting for recipient. |
| RecipientAttachment Attachment | It would be possible to send attachments with recipients. This complex element contains data in base64Binary. It also contains label and type for the attachment. |
| Note String | A note that will be unique to this recipient. This note will be sent to the recipient via the signing email. This note will display in the signing UI near the upper left corner of the document on the signing screen. This can be a maximum of 1000 characters. |
| RoleName String | Optional element. Used only when working with template recipients. Role name for the recipient |
| TemplateLocked Boolean | Optional element. Used only when working with template recipients. If true, the sender cannot change any attributes of the recipient. |
| TemplateRequired Boolean | Optional element. Used only when working with template recipients. If true, the sender may not remove the recipient. |
| TemplateAccessCodeRequired Boolean | Optional element. Used only when working with template recipients. If true and TemplateLocked = true, the sender must enter an access code. |
| DefaultRecipient Boolean | If true, this is the default recipient for the envelope. This option is used with the CreateEnvelopeFromTemplatesAndForms method. |
| EmailNotification RecipientEmailNotification | An optional complex type that has information for setting the language for the recipient’s email information. It is composed of three elements: Subject: a long string with the subject of the email sent to the recipient. EmailBlurb: a string with the email message sent to the recipient. Language: the simple type SupportedLanguage enumerating 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. Also, you must enable EmailNotification for all recipients. |
| AgentCanEditEmail Boolean | Optional element. If true, the Agent or Editor Recipient associated with this Recipient can change the Recipient’s pre-populated Email address. This element is only active if enabled for the account. |
| AgentCanEditName Boolean | Optional element. If true, the Agent or Editor Recipient associated with this recipient can change the recipient’s pre-populated name (UserName). This element is only active if enabled for the account. |
| SignInEachLocation Boolean | Optional element. If true, the signer must write their signature in each Signature or initial tab. Can only be used for Signer and InPersonSigner recipient types. |
| InheritEmailNotificationConfiguration 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. |
| ExcludedDocuments Array of positive integers | Optional element, can only be used if Document Visibility is enabled for the account. Accepts an array of Document IDs to set the documents in the envelope that are not visible to the recipient. If a recipient has a tab on a document, it cannot be excluded. |
| RequireSignerCertificate String | Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are: DocusignExpress – Requires a Docusign Express certificate. Safe – Requires a SAFE-BioPharma certificate. OpenTrust – Requires an OpenTrust certificate. Important: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See Rules and Restrictions for OpenTrust Envelopes more information. |