module:model/Intermediary

module:model/Intermediary

new module:model/Intermediary()

Source:

Constructs a new Intermediary.
Contains information about an intermediary 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.

Members

(inner) accessCode :String

Source:

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.

Type:
  • String

(inner) accessCodeMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the accessCode property is editable. This property is read-only.

Type:

(inner) addAccessCodeToEmail :String

Source:

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.

Type:
  • String

(inner) additionalNotifications :Array.<module:model/RecipientAdditionalNotification>

Source:
Type:

(inner) allowSystemOverrideForLockedRecipient :String

Source:
Type:
  • String

(inner) autoRespondedReason :String

Source:
Type:
  • String

(inner) bulkSendV2Recipient :String

Source:
Type:
  • String

(inner) clientUserId :String

Source:

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.ng. Maximum length: 100 characters.

Type:
  • String

(inner) completedCount :String

Source:
Type:
  • String

(inner) consentDetailsList :Array.<module:model/ConsentDetails>

Source:
Type:

(inner) customFields :Array.<String>

Source:

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

Type:
  • Array.<String>

(inner) declinedDateTime :String

Source:

The date and time the recipient declined the document.

Type:
  • String

(inner) declinedReason :String

Source:

The reason the recipient declined the document.

Type:
  • String

(inner) deliveredDateTime :String

Source:

Reserved: For DocuSign use only.

Type:
  • String

(inner) deliveryMethod :String

Source:

Reserved: For DocuSign use only.

Type:
  • String

(inner) deliveryMethodMetadata :module:model/PropertyMetadata

Source:

Reserved for DocuSign.

Type:

(inner) designatorId :String

Source:
Type:
  • String

(inner) designatorIdGuid :String

Source:
Type:
  • String

(inner) documentVisibility :Array.<module:model/DocumentVisibility>

Source:
Type:

(inner) email :String

Source:

Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.

Type:
  • String

(inner) emailMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the email property is editable. This property is read-only.

Type:

(inner) emailNotification :module:model/RecipientEmailNotification

Source:

A complex type that contains information sets the language of the recipient's email information. IMPORTANT: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and EmailBlurb property settings.

Type:

(inner) emailRecipientPostSigningURL :String

Source:
Type:
  • String

(inner) embeddedRecipientStartURL :String

Source:

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 that is 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, 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 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 fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]

Type:
  • String

(inner) errorDetails :module:model/ErrorDetails

Source:

Array or errors.

Type:

(inner) excludedDocuments :Array.<String>

Source:

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.

Type:
  • Array.<String>

(inner) faxNumber :String

Source:

Reserved:

Type:
  • String

(inner) faxNumberMetadata :module:model/PropertyMetadata

Source:

Reserved for DocuSign.

Type:

(inner) firstName :String

Source:

The user's first name. Maximum Length: 50 characters.

Type:
  • String

(inner) firstNameMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the firstName property is editable. This property is read-only.

Type:

(inner) fullName :String

Source:
Type:
  • String

(inner) fullNameMetadata :module:model/PropertyMetadata

Source:

Reserved for DocuSign.

Type:

(inner) idCheckConfigurationName :String

Source:

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 should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the smsAuthentication node.

Type:
  • String

(inner) idCheckConfigurationNameMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the idCheckConfigurationName property is editable. This property is read-only.

Type:

(inner) idCheckInformationInput :module:model/IdCheckInformationInput

Source:

An object that contains input information related to a recipient ID check.

Type:

(inner) identityVerification :module:model/RecipientIdentityVerification

Source:

Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the list method in the 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 methods.
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).

Type:

(inner) inheritEmailNotificationConfiguration :String

Source:

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.

Type:
  • String

(inner) lastName :String

Source:
Type:
  • String

(inner) lastNameMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the lastName property is editable. This property is read-only.

Type:

(inner) lockedRecipientPhoneAuthEditable :String

Source:
Type:
  • String

(inner) lockedRecipientSmsEditable :String

Source:
Type:
  • String

(inner) name :String

Source:
Type:
  • String

(inner) nameMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the name property is editable. This property is read-only.

Type:

(inner) note :String

Source:

Specifies 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.

Type:
  • String

(inner) noteMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the note property is editable. This property is read-only.

Type:

(inner) phoneAuthentication :module:model/RecipientPhoneAuthentication

Source:

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.

Type:

(inner) phoneNumber :module:model/RecipientPhoneNumber

Source:

Describes the recipient phone number.

Type:

(inner) recipientAttachments :Array.<module:model/RecipientAttachment>

Source:

Reserved:

Type:

(inner) recipientAuthenticationStatus :module:model/AuthenticationStatus

Source:

Information about the recipient's authentication status. This property is read-only.

Type:

(inner) recipientFeatureMetadata :Array.<module:model/FeatureAvailableMetadata>

Source:
Type:

(inner) recipientId :String

Source:

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

Type:
  • String

(inner) recipientIdGuid :String

Source:
Type:
  • String

(inner) recipientType :String

Source:
Type:
  • String

(inner) recipientTypeMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the recipientType property is editable. This property is read-only.

Type:

(inner) requireIdLookup :String

Source:

When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.

Type:
  • String

(inner) requireIdLookupMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the requireIdLookup property is editable. This property is read-only.

Type:

(inner) roleName :String

Source:

Optional element. Specifies the role name associated with the recipient.

This is required when working with template recipients.

Type:
  • String

(inner) routingOrder :String

Source:

Specifies the routing order of the recipient in the envelope.

Type:
  • String

(inner) routingOrderMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the routingOrder property is editable. This property is read-only.

Type:

(inner) sentDateTime :String

Source:

The date and time the envelope was sent.

Type:
  • String

(inner) signedDateTime :String

Source:

Reserved: For DocuSign use only.

Type:
  • String

(inner) signingGroupId :String

Source:

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).

Type:
  • String

(inner) signingGroupIdMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the signingGroupId property is editable. This property is read-only.

Type:

(inner) signingGroupName :String

Source:

The display name for the signing group. Maximum Length: 100 characters.

Type:
  • String

(inner) signingGroupUsers :Array.<module:model/UserInfo>

Source:

A complex type that contains information about users in the signing group.

Type:

(inner) smsAuthentication :module:model/RecipientSMSAuthentication

Source:

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.

Type:

(inner) socialAuthentications :Array.<module:model/SocialAuthentication>

Source:

Lists the social ID type that can be used for recipient authentication.

Type:

(inner) status :String

Source:

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.

Type:
  • String

(inner) statusCode :String

Source:
Type:
  • String

(inner) suppressEmails :String

Source:
Type:
  • String

(inner) templateLocked :String

Source:

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

Type:
  • String

(inner) templateRequired :String

Source:

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

Type:
  • String

(inner) totalTabCount :String

Source:
Type:
  • String

(inner) userId :String

Source:
Type:
  • String

Methods

(static) constructFromObject(data, obj) → {module:model/Intermediary}

Source:

Constructs a Intermediary from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.
obj module:model/Intermediary

Optional instance to populate.
Returns:

The populated Intermediary instance.

Type
module:model/Intermediary