DocuSign CSharp Docs
Public Member Functions | Properties | List of all members
DocuSign.eSign.Model.BulkSendingCopyRecipient Class Reference

This object contains details about a bulk send recipient. More...

Inheritance diagram for DocuSign.eSign.Model.BulkSendingCopyRecipient:

Public Member Functions

 BulkSendingCopyRecipient (string AccessCode=default(string), string ClientUserId=default(string), List< string > CustomFields=default(List< string >), string DeliveryMethod=default(string), string Email=default(string), RecipientEmailNotification EmailNotification=default(RecipientEmailNotification), string EmbeddedRecipientStartURL=default(string), string FaxNumber=default(string), string HostEmail=default(string), string HostName=default(string), string IdCheckConfigurationName=default(string), IdCheckInformationInput IdCheckInformationInput=default(IdCheckInformationInput), string IdentificationMethod=default(string), RecipientIdentityVerification IdentityVerification=default(RecipientIdentityVerification), string Name=default(string), string Note=default(string), RecipientPhoneAuthentication PhoneAuthentication=default(RecipientPhoneAuthentication), string RecipientId=default(string), List< RecipientSignatureProvider > RecipientSignatureProviders=default(List< RecipientSignatureProvider >), string RoleName=default(string), string SignerName=default(string), string SigningGroupId=default(string), RecipientSMSAuthentication SmsAuthentication=default(RecipientSMSAuthentication), List< SocialAuthentication > SocialAuthentications=default(List< SocialAuthentication >), List< BulkSendingCopyTab > Tabs=default(List< BulkSendingCopyTab >))
 Initializes a new instance of the BulkSendingCopyRecipient class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
string ToJson ()
 Returns the JSON string presentation of the object More...
 
override bool Equals (object obj)
 Returns true if objects are equal More...
 
bool Equals (BulkSendingCopyRecipient other)
 Returns true if BulkSendingCopyRecipient instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

string AccessCode [get, set]
 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&#39;s access code format setting. If blank, but the signer &#x60;accessCode&#x60; property is set in the envelope, then that value is used. If blank and the signer &#x60;accessCode&#x60; property is not set, then the access code is not required. More...
 
string ClientUserId [get, set]
 Specifies whether the recipient is embedded or remote. If the &#x60;clientUserId&#x60; property is not null then the recipient is embedded. Note that if the &#x60;ClientUserId&#x60; property is set and either &#x60;SignerMustHaveAccount&#x60; or &#x60;SignerMustLoginToSign&#x60; property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters. More...
 
List< string > CustomFields [get, set]
 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. More...
 
string DeliveryMethod [get, set]
 Reserved: For DocuSign use only. More...
 
string Email [get, set]
 Gets or Sets Email More...
 
RecipientEmailNotification EmailNotification [get, set]
 A complex type that contains information sets the language of the recipient&#39;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 &#x60;EmailBlurb&#x60; property settings. More...
 
string EmbeddedRecipientStartURL [get, set]
 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&#39;s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to &#x60;SIGN_AT_DOCUSIGN&#x60;, 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&#39;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 &#x60;EmbeddedRecipientStartURL&#x3D;SIGN_AT_DOCUSIGN&#x60;, 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 &#x60;clientUserId&#x60; property is NOT set, and the &#x60;embeddedRecipientStartURL&#x60; 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 &#x60;customFields&#x60; property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: &#x60;http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]&#x60; More...
 
string FaxNumber [get, set]
 Reserved: More...
 
string HostEmail [get, set]
 Gets or Sets HostEmail More...
 
string HostName [get, set]
 Gets or Sets HostName More...
 
string IdCheckConfigurationName [get, set]
 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 &#39;ID Check $&#39; and &#39;SMS Auth $&#39;. To use ID check in an envelope, the idCheckConfigurationName should be &#39;ID Check &#39;. If you wanted to use SMS, it would be &#39;SMS Auth $&#39; and you would need to add you would need to add phone number information to the &#x60;smsAuthentication&#x60; node. More...
 
IdCheckInformationInput IdCheckInformationInput [get, set]
 An object that contains input information related to a recipient ID check. More...
 
string IdentificationMethod [get, set]
 Gets or Sets IdentificationMethod More...
 
RecipientIdentityVerification IdentityVerification [get, set]
 Gets or Sets IdentityVerification More...
 
string Name [get, set]
 Gets or Sets Name More...
 
string Note [get, set]
 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. More...
 
RecipientPhoneAuthentication PhoneAuthentication [get, set]
 When &#x60;idCheckConfigurationName&#x60; is set to &#x60;Phone Auth $&#x60;, you use this complex type to provide the recipient authentication method details. It contains the following elements: * &#x60;recipMayProvideNumber&#x60;: Boolean. When true, the recipient can use whatever phone number they choose. * &#x60;senderProvidedNumbers&#x60;: ArrayOfStrings. A list of phone numbers the recipient can use. * &#x60;recordVoicePrint&#x60;: Reserved for DocuSign. * &#x60;validateRecipProvidedNumber&#x60;: Reserved for DocuSign. More...
 
string RecipientId [get, set]
 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. More...
 
List< RecipientSignatureProviderRecipientSignatureProviders [get, set]
 Gets or Sets RecipientSignatureProviders More...
 
string RoleName [get, set]
 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. More...
 
string SignerName [get, set]
 Gets or Sets SignerName More...
 
string SigningGroupId [get, set]
 When set to true and the feature is enabled in the sender&#39;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). More...
 
RecipientSMSAuthentication SmsAuthentication [get, set]
 When &#x60;idCheckConfigurationName&#x60; is set to &#x60;SMS Auth $&#x60;, you use this complex type to provide the recipient authentication method details. It contains the element &#x60;senderProvidedNumbers&#x60;, which is an array of phone numbers that the recipient can use for SMS text authentication. More...
 
List< SocialAuthenticationSocialAuthentications [get, set]
 Lists the social ID type that can be used for recipient authentication. More...
 
List< BulkSendingCopyTabTabs [get, set]
 Gets or Sets Tabs More...
 

Detailed Description

This object contains details about a bulk send recipient.

Constructor & Destructor Documentation

◆ BulkSendingCopyRecipient()

DocuSign.eSign.Model.BulkSendingCopyRecipient.BulkSendingCopyRecipient ( string  AccessCode = default(string),
string  ClientUserId = default(string),
List< string >  CustomFields = default(List<string>),
string  DeliveryMethod = default(string),
string  Email = default(string),
RecipientEmailNotification  EmailNotification = default(RecipientEmailNotification),
string  EmbeddedRecipientStartURL = default(string),
string  FaxNumber = default(string),
string  HostEmail = default(string),
string  HostName = default(string),
string  IdCheckConfigurationName = default(string),
IdCheckInformationInput  IdCheckInformationInput = default(IdCheckInformationInput),
string  IdentificationMethod = default(string),
RecipientIdentityVerification  IdentityVerification = default(RecipientIdentityVerification),
string  Name = default(string),
string  Note = default(string),
RecipientPhoneAuthentication  PhoneAuthentication = default(RecipientPhoneAuthentication),
string  RecipientId = default(string),
List< RecipientSignatureProvider RecipientSignatureProviders = default(List<RecipientSignatureProvider>),
string  RoleName = default(string),
string  SignerName = default(string),
string  SigningGroupId = default(string),
RecipientSMSAuthentication  SmsAuthentication = default(RecipientSMSAuthentication),
List< SocialAuthentication SocialAuthentications = default(List<SocialAuthentication>),
List< BulkSendingCopyTab Tabs = default(List<BulkSendingCopyTab>) 
)
inline

Initializes a new instance of the BulkSendingCopyRecipient class.

Parameters
AccessCodeIf 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&#39;s access code format setting. If blank, but the signer &#x60;accessCode&#x60; property is set in the envelope, then that value is used. If blank and the signer &#x60;accessCode&#x60; property is not set, then the access code is not required..
ClientUserIdSpecifies whether the recipient is embedded or remote. If the &#x60;clientUserId&#x60; property is not null then the recipient is embedded. Note that if the &#x60;ClientUserId&#x60; property is set and either &#x60;SignerMustHaveAccount&#x60; or &#x60;SignerMustLoginToSign&#x60; property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters. .
CustomFieldsAn 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..
DeliveryMethodReserved: For DocuSign use only..
EmailEmail.
EmailNotificationA complex type that contains information sets the language of the recipient&#39;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 &#x60;EmailBlurb&#x60; property settings. .
EmbeddedRecipientStartURLSpecifies 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&#39;s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to &#x60;SIGN_AT_DOCUSIGN&#x60;, 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&#39;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 &#x60;EmbeddedRecipientStartURL&#x3D;SIGN_AT_DOCUSIGN&#x60;, 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 &#x60;clientUserId&#x60; property is NOT set, and the &#x60;embeddedRecipientStartURL&#x60; 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 &#x60;customFields&#x60; property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: &#x60;http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]&#x60; .
FaxNumberReserved:.
HostEmailHostEmail.
HostNameHostName.
IdCheckConfigurationNameSpecifies 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 &#39;ID Check $&#39; and &#39;SMS Auth $&#39;. To use ID check in an envelope, the idCheckConfigurationName should be &#39;ID Check &#39;. If you wanted to use SMS, it would be &#39;SMS Auth $&#39; and you would need to add you would need to add phone number information to the &#x60;smsAuthentication&#x60; node..
IdCheckInformationInputAn object that contains input information related to a recipient ID check..
IdentificationMethodIdentificationMethod.
IdentityVerificationIdentityVerification.
NameName.
NoteSpecifies 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..
PhoneAuthenticationWhen &#x60;idCheckConfigurationName&#x60; is set to &#x60;Phone Auth $&#x60;, you use this complex type to provide the recipient authentication method details. It contains the following elements: * &#x60;recipMayProvideNumber&#x60;: Boolean. When true, the recipient can use whatever phone number they choose. * &#x60;senderProvidedNumbers&#x60;: ArrayOfStrings. A list of phone numbers the recipient can use. * &#x60;recordVoicePrint&#x60;: Reserved for DocuSign. * &#x60;validateRecipProvidedNumber&#x60;: Reserved for DocuSign. .
RecipientIdUnique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..
RecipientSignatureProvidersRecipientSignatureProviders.
RoleNameOptional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients..
SignerNameSignerName.
SigningGroupIdWhen set to true and the feature is enabled in the sender&#39;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)..
SmsAuthenticationWhen &#x60;idCheckConfigurationName&#x60; is set to &#x60;SMS Auth $&#x60;, you use this complex type to provide the recipient authentication method details. It contains the element &#x60;senderProvidedNumbers&#x60;, which is an array of phone numbers that the recipient can use for SMS text authentication. .
SocialAuthenticationsLists the social ID type that can be used for recipient authentication..
TabsTabs.

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.BulkSendingCopyRecipient.Equals ( object  obj)
inline

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.BulkSendingCopyRecipient.Equals ( BulkSendingCopyRecipient  other)
inline

Returns true if BulkSendingCopyRecipient instances are equal

Parameters
otherInstance of BulkSendingCopyRecipient to be compared
Returns
Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.BulkSendingCopyRecipient.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

string DocuSign.eSign.Model.BulkSendingCopyRecipient.ToJson ( )
inline

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.BulkSendingCopyRecipient.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AccessCode

string DocuSign.eSign.Model.BulkSendingCopyRecipient.AccessCode
getset

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&#39;s access code format setting. If blank, but the signer &#x60;accessCode&#x60; property is set in the envelope, then that value is used. If blank and the signer &#x60;accessCode&#x60; property is not set, then the access code is not required.

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&#39;s access code format setting. If blank, but the signer &#x60;accessCode&#x60; property is set in the envelope, then that value is used. If blank and the signer &#x60;accessCode&#x60; property is not set, then the access code is not required.

◆ ClientUserId

string DocuSign.eSign.Model.BulkSendingCopyRecipient.ClientUserId
getset

Specifies whether the recipient is embedded or remote. If the &#x60;clientUserId&#x60; property is not null then the recipient is embedded. Note that if the &#x60;ClientUserId&#x60; property is set and either &#x60;SignerMustHaveAccount&#x60; or &#x60;SignerMustLoginToSign&#x60; property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters.

Specifies whether the recipient is embedded or remote. If the &#x60;clientUserId&#x60; property is not null then the recipient is embedded. Note that if the &#x60;ClientUserId&#x60; property is set and either &#x60;SignerMustHaveAccount&#x60; or &#x60;SignerMustLoginToSign&#x60; property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters.

◆ CustomFields

List<string> DocuSign.eSign.Model.BulkSendingCopyRecipient.CustomFields
getset

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.

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.

◆ DeliveryMethod

string DocuSign.eSign.Model.BulkSendingCopyRecipient.DeliveryMethod
getset

Reserved: For DocuSign use only.

Reserved: For DocuSign use only.

◆ Email

string DocuSign.eSign.Model.BulkSendingCopyRecipient.Email
getset

Gets or Sets Email

◆ EmailNotification

RecipientEmailNotification DocuSign.eSign.Model.BulkSendingCopyRecipient.EmailNotification
getset

A complex type that contains information sets the language of the recipient&#39;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 &#x60;EmailBlurb&#x60; property settings.

A complex type that contains information sets the language of the recipient&#39;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 &#x60;EmailBlurb&#x60; property settings.

◆ EmbeddedRecipientStartURL

string DocuSign.eSign.Model.BulkSendingCopyRecipient.EmbeddedRecipientStartURL
getset

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&#39;s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to &#x60;SIGN_AT_DOCUSIGN&#x60;, 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&#39;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 &#x60;EmbeddedRecipientStartURL&#x3D;SIGN_AT_DOCUSIGN&#x60;, 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 &#x60;clientUserId&#x60; property is NOT set, and the &#x60;embeddedRecipientStartURL&#x60; 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 &#x60;customFields&#x60; property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: &#x60;http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]&#x60;

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&#39;s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to &#x60;SIGN_AT_DOCUSIGN&#x60;, 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&#39;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 &#x60;EmbeddedRecipientStartURL&#x3D;SIGN_AT_DOCUSIGN&#x60;, 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 &#x60;clientUserId&#x60; property is NOT set, and the &#x60;embeddedRecipientStartURL&#x60; 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 &#x60;customFields&#x60; property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: &#x60;http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]&#x60;

◆ FaxNumber

string DocuSign.eSign.Model.BulkSendingCopyRecipient.FaxNumber
getset

Reserved:

Reserved:

◆ HostEmail

string DocuSign.eSign.Model.BulkSendingCopyRecipient.HostEmail
getset

Gets or Sets HostEmail

◆ HostName

string DocuSign.eSign.Model.BulkSendingCopyRecipient.HostName
getset

Gets or Sets HostName

◆ IdCheckConfigurationName

string DocuSign.eSign.Model.BulkSendingCopyRecipient.IdCheckConfigurationName
getset

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 &#39;ID Check $&#39; and &#39;SMS Auth $&#39;. To use ID check in an envelope, the idCheckConfigurationName should be &#39;ID Check &#39;. If you wanted to use SMS, it would be &#39;SMS Auth $&#39; and you would need to add you would need to add phone number information to the &#x60;smsAuthentication&#x60; node.

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 &#39;ID Check $&#39; and &#39;SMS Auth $&#39;. To use ID check in an envelope, the idCheckConfigurationName should be &#39;ID Check &#39;. If you wanted to use SMS, it would be &#39;SMS Auth $&#39; and you would need to add you would need to add phone number information to the &#x60;smsAuthentication&#x60; node.

◆ IdCheckInformationInput

IdCheckInformationInput DocuSign.eSign.Model.BulkSendingCopyRecipient.IdCheckInformationInput
getset

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

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

◆ IdentificationMethod

string DocuSign.eSign.Model.BulkSendingCopyRecipient.IdentificationMethod
getset

Gets or Sets IdentificationMethod

◆ IdentityVerification

RecipientIdentityVerification DocuSign.eSign.Model.BulkSendingCopyRecipient.IdentityVerification
getset

Gets or Sets IdentityVerification

◆ Name

string DocuSign.eSign.Model.BulkSendingCopyRecipient.Name
getset

Gets or Sets Name

◆ Note

string DocuSign.eSign.Model.BulkSendingCopyRecipient.Note
getset

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.

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.

◆ PhoneAuthentication

RecipientPhoneAuthentication DocuSign.eSign.Model.BulkSendingCopyRecipient.PhoneAuthentication
getset

When &#x60;idCheckConfigurationName&#x60; is set to &#x60;Phone Auth $&#x60;, you use this complex type to provide the recipient authentication method details. It contains the following elements: * &#x60;recipMayProvideNumber&#x60;: Boolean. When true, the recipient can use whatever phone number they choose. * &#x60;senderProvidedNumbers&#x60;: ArrayOfStrings. A list of phone numbers the recipient can use. * &#x60;recordVoicePrint&#x60;: Reserved for DocuSign. * &#x60;validateRecipProvidedNumber&#x60;: Reserved for DocuSign.

When &#x60;idCheckConfigurationName&#x60; is set to &#x60;Phone Auth $&#x60;, you use this complex type to provide the recipient authentication method details. It contains the following elements: * &#x60;recipMayProvideNumber&#x60;: Boolean. When true, the recipient can use whatever phone number they choose. * &#x60;senderProvidedNumbers&#x60;: ArrayOfStrings. A list of phone numbers the recipient can use. * &#x60;recordVoicePrint&#x60;: Reserved for DocuSign. * &#x60;validateRecipProvidedNumber&#x60;: Reserved for DocuSign.

◆ RecipientId

string DocuSign.eSign.Model.BulkSendingCopyRecipient.RecipientId
getset

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

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

◆ RecipientSignatureProviders

List<RecipientSignatureProvider> DocuSign.eSign.Model.BulkSendingCopyRecipient.RecipientSignatureProviders
getset

Gets or Sets RecipientSignatureProviders

◆ RoleName

string DocuSign.eSign.Model.BulkSendingCopyRecipient.RoleName
getset

Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.

Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.

◆ SignerName

string DocuSign.eSign.Model.BulkSendingCopyRecipient.SignerName
getset

Gets or Sets SignerName

◆ SigningGroupId

string DocuSign.eSign.Model.BulkSendingCopyRecipient.SigningGroupId
getset

When set to true and the feature is enabled in the sender&#39;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).

When set to true and the feature is enabled in the sender&#39;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).

◆ SmsAuthentication

RecipientSMSAuthentication DocuSign.eSign.Model.BulkSendingCopyRecipient.SmsAuthentication
getset

When &#x60;idCheckConfigurationName&#x60; is set to &#x60;SMS Auth $&#x60;, you use this complex type to provide the recipient authentication method details. It contains the element &#x60;senderProvidedNumbers&#x60;, which is an array of phone numbers that the recipient can use for SMS text authentication.

When &#x60;idCheckConfigurationName&#x60; is set to &#x60;SMS Auth $&#x60;, you use this complex type to provide the recipient authentication method details. It contains the element &#x60;senderProvidedNumbers&#x60;, which is an array of phone numbers that the recipient can use for SMS text authentication.

◆ SocialAuthentications

List<SocialAuthentication> DocuSign.eSign.Model.BulkSendingCopyRecipient.SocialAuthentications
getset

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

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

◆ Tabs

List<BulkSendingCopyTab> DocuSign.eSign.Model.BulkSendingCopyRecipient.Tabs
getset

Gets or Sets Tabs


The documentation for this class was generated from the following file: