| accessCode |
String |
If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. |
[optional] |
| accessCodeMetadata |
PropertyMetadata |
|
[optional] |
| addAccessCodeToEmail |
String |
Optional. When set to true, the access code will be added to the email sent to the recipient. This nullifies the security measure of `accessCode` on the recipient. |
[optional] |
| additionalNotifications |
[RecipientAdditionalNotification] |
|
[optional] |
| agentCanEditEmail |
String |
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. |
[optional] |
| agentCanEditName |
String |
Optional element. When set to 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. |
[optional] |
| allowSystemOverrideForLockedRecipient |
String |
|
[optional] |
| clientUserId |
String |
Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Use this field to associate the signer with their userId in your app. Authenticating the user is the responsibility of your app when you use embedded signing. Note: 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. Maximum length: 100 characters. |
[optional] |
| completedCount |
String |
Indicates the number of times that the recipient has been through a signing completion for the envelope. If this number is greater than 0 for a signing group, only the user who previously completed may sign again. Read only. |
[optional] |
| customFields |
[String] |
An optional array of strings that enables the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each `customField` string can be a maximum of 100 characters. |
[optional] |
| declinedDateTime |
String |
The date and time the recipient declined the document. Read only. |
[optional] |
| declinedReason |
String |
The reason the recipient declined the document. Read only. |
[optional] |
| deliveredDateTime |
String |
The date and time that the envelope was delivered to the recipient. Read only. |
[optional] |
| deliveryMethod |
String |
Reserved for DocuSign. |
[optional] |
| deliveryMethodMetadata |
PropertyMetadata |
|
[optional] |
| designatorId |
String |
|
[optional] |
| designatorIdGuid |
String |
|
[optional] |
| documentVisibility |
[DocumentVisibility] |
A list of `documentVisibility` objects. Each object in the list specifies whether a document in the envelope is visible to this recipient. For the envelope to use this functionality, Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to true. |
[optional] |
| email |
String |
The recipient's email address. |
[optional] |
| emailMetadata |
PropertyMetadata |
|
[optional] |
| emailNotification |
RecipientEmailNotification |
|
[optional] |
| embeddedRecipientStartURL |
String |
Specifies a sender-provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `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]]` |
[optional] |
| errorDetails |
ErrorDetails |
|
[optional] |
| excludedDocuments |
[String] |
Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to true for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. |
[optional] |
| faxNumber |
String |
Reserved for DocuSign. |
[optional] |
| faxNumberMetadata |
PropertyMetadata |
|
[optional] |
| firstName |
String |
The recipient's first name. Maximum Length: 50 characters. |
[optional] |
| firstNameMetadata |
PropertyMetadata |
|
[optional] |
| fullName |
String |
Reserved for DocuSign. |
[optional] |
| fullNameMetadata |
PropertyMetadata |
|
[optional] |
| idCheckConfigurationName |
String |
The name of the authentication check to use. This value must match one of the authentication types that the account uses. The names of these authentication types appear in the web console sending interface in the Identify list for a recipient. This setting overrides any default authentication setting. Valid values are: - `Phone Auth $`: The recipient must authenticate by using two-factor authentication (2FA). You provide the phone number to use for 2FA in the `phoneAuthentication` object. - `SMS Auth $`: The recipient must authenticate via SMS. You provide the phone number to use in the `smsAuthentication` object. - `ID Check $`: The recipient must answer detailed security questions. Example: Your account has ID Check and SMS Authentication available. In the web console Identify list, these appear as ID Check $ and SMS Auth $. To use ID Check in an envelope, the idCheckConfigurationName should be ID Check $. For SMS, you would use SMS Auth $, and you would also need to add a phone number to the smsAuthentication node. |
[optional] |
| idCheckConfigurationNameMetadata |
PropertyMetadata |
|
[optional] |
| idCheckInformationInput |
IdCheckInformationInput |
|
[optional] |
| identityVerification |
RecipientIdentityVerification |
|
[optional] |
| inheritEmailNotificationConfiguration |
String |
When set to 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. |
[optional] |
| lastName |
String |
The recipient's last name. |
[optional] |
| lastNameMetadata |
PropertyMetadata |
|
[optional] |
| lockedRecipientPhoneAuthEditable |
String |
Reserved for DocuSign. |
[optional] |
| lockedRecipientSmsEditable |
String |
Reserved for DocuSign. |
[optional] |
| name |
String |
The full legal name of the recipient. Maximum Length: 100 characters. Note: You must always set a value for this property in requests, even if `firstName` and `lastName` are set. |
[optional] |
| nameMetadata |
PropertyMetadata |
|
[optional] |
| note |
String |
A note sent to the recipient in the signing email. This note is unique to this recipient. In the user interface, it appears near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. |
[optional] |
| noteMetadata |
PropertyMetadata |
|
[optional] |
| phoneAuthentication |
RecipientPhoneAuthentication |
|
[optional] |
| proofFile |
RecipientProofFile |
|
[optional] |
| recipientAttachments |
[RecipientAttachment] |
Reserved for DocuSign. |
[optional] |
| recipientAuthenticationStatus |
AuthenticationStatus |
|
[optional] |
| recipientFeatureMetadata |
[FeatureAvailableMetadata] |
Metadata about the features that are supported for the recipient type. Read only. |
[optional] |
| recipientId |
String |
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the document. |
[optional] |
| recipientIdGuid |
String |
The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. |
[optional] |
| recipientType |
String |
The recipient type, as specified by the following values: - `agent`: Agent recipients can add name and email information for recipients that appear after the agent in routing order. - `carbonCopy`: Carbon copy recipients get a copy of the envelope but don't need to sign, initial, date, or add information to any of the documents. This type of recipient can be used in any routing order. - `certifiedDelivery`: Certified delivery recipients must receive the completed documents for the envelope to be completed. They don't need to sign, initial, date, or add information to any of the documents. - `editor`: Editors have the same management and access rights for the envelope as the sender. Editors can add name and email information, add or change the routing order, set authentication options, and can edit signature/initial tabs and data fields for the remaining recipients. - `inPersonSigner`: In-person recipients are DocuSign users who act as signing hosts in the same physical location as the signer. - `intermediaries`: Intermediary recipients can optionally add name and email information for recipients at the same or subsequent level in the routing order. - `seal`: Electronic seal recipients represent legal entities. - `signer`: Signers are recipients who must sign, initial, date, or add data to form fields on the documents in the envelope. - `witness`: Witnesses are recipients whose signatures affirm that the identified signers have signed the documents in the envelope. |
[optional] |
| recipientTypeMetadata |
PropertyMetadata |
|
[optional] |
| requireIdLookup |
String |
When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. |
[optional] |
| requireIdLookupMetadata |
PropertyMetadata |
|
[optional] |
| roleName |
String |
Optional element. Specifies the role name associated with the recipient.<br/><br/>This property is required when you are working with template recipients. |
[optional] |
| routingOrder |
String |
Specifies the routing order of the recipient in the envelope. |
[optional] |
| routingOrderMetadata |
PropertyMetadata |
|
[optional] |
| sentDateTime |
String |
The UTC DateTime when the envelope was sent. Read only. |
[optional] |
| signedDateTime |
String |
Reserved for DocuSign. |
[optional] |
| signingGroupId |
String |
Optional. The ID of the signing group. Note: When you send an envelope to a signing group, anyone in the group can open it and sign it with their own signature. For this reason, we recommend that you do not include non-signer recipients (such as carbon copy recipients) in the same signing group as signer recipients. However, you could create a second signing group for the non-signer recipients and change the default action of Needs to Sign to a different value, such as Receives a Copy. |
[optional] |
| signingGroupIdMetadata |
PropertyMetadata |
|
[optional] |
| signingGroupName |
String |
Optional. The name of the signing group. Maximum Length: 100 characters. |
[optional] |
| signingGroupUsers |
[UserInfo] |
A complex type that contains information about users in the signing group. |
[optional] |
| smsAuthentication |
RecipientSMSAuthentication |
|
[optional] |
| socialAuthentications |
[SocialAuthentication] |
Deprecated. |
[optional] |
| status |
String |
The status of the recipient. Read only. Possible 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 document(s) in the envelope. - `delivered`: The recipient has viewed the document(s) 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`. |
[optional] |
| statusCode |
String |
The code associated with the recipient's status. Read only. |
[optional] |
| suppressEmails |
String |
When set to true, email notifications are suppressed for the recipient, and they must access envelopes and documents from their DocuSign inbox. |
[optional] |
| templateLocked |
String |
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. |
[optional] |
| templateRequired |
String |
When set to true, the sender may not remove the recipient. Used only when working with template recipients. |
[optional] |
| totalTabCount |
String |
The total number of tabs in the documents. Read only. |
[optional] |
| userId |
String |
The ID of the user to access. Generally this is the ID of the current authenticated user, but if the authenticated user is an Administrator on the account, `userId` can represent another user whom the Administrator is accessing. |
[optional] |