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

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

Inheritance diagram for DocuSign.eSign.Model.Intermediary:

Public Member Functions

 Intermediary (string AccessCode=default(string), PropertyMetadata AccessCodeMetadata=default(PropertyMetadata), string AddAccessCodeToEmail=default(string), List< RecipientAdditionalNotification > AdditionalNotifications=default(List< RecipientAdditionalNotification >), string AllowSystemOverrideForLockedRecipient=default(string), string AutoRespondedReason=default(string), string BulkSendV2Recipient=default(string), string ClientUserId=default(string), string CompletedCount=default(string), List< ConsentDetails > ConsentDetailsList=default(List< ConsentDetails >), List< string > CustomFields=default(List< string >), string DeclinedDateTime=default(string), string DeclinedReason=default(string), string DeliveredDateTime=default(string), string DeliveryMethod=default(string), PropertyMetadata DeliveryMethodMetadata=default(PropertyMetadata), string DesignatorId=default(string), string DesignatorIdGuid=default(string), List< DocumentVisibility > DocumentVisibility=default(List< DocumentVisibility >), string Email=default(string), PropertyMetadata EmailMetadata=default(PropertyMetadata), RecipientEmailNotification EmailNotification=default(RecipientEmailNotification), string EmailRecipientPostSigningURL=default(string), string EmbeddedRecipientStartURL=default(string), ErrorDetails ErrorDetails=default(ErrorDetails), List< string > ExcludedDocuments=default(List< string >), string FaxNumber=default(string), PropertyMetadata FaxNumberMetadata=default(PropertyMetadata), string FirstName=default(string), PropertyMetadata FirstNameMetadata=default(PropertyMetadata), string FullName=default(string), PropertyMetadata FullNameMetadata=default(PropertyMetadata), string IdCheckConfigurationName=default(string), PropertyMetadata IdCheckConfigurationNameMetadata=default(PropertyMetadata), IdCheckInformationInput IdCheckInformationInput=default(IdCheckInformationInput), RecipientIdentityVerification IdentityVerification=default(RecipientIdentityVerification), string InheritEmailNotificationConfiguration=default(string), string LastName=default(string), PropertyMetadata LastNameMetadata=default(PropertyMetadata), string LockedRecipientPhoneAuthEditable=default(string), string LockedRecipientSmsEditable=default(string), string Name=default(string), PropertyMetadata NameMetadata=default(PropertyMetadata), string Note=default(string), PropertyMetadata NoteMetadata=default(PropertyMetadata), RecipientPhoneAuthentication PhoneAuthentication=default(RecipientPhoneAuthentication), RecipientPhoneNumber PhoneNumber=default(RecipientPhoneNumber), List< RecipientAttachment > RecipientAttachments=default(List< RecipientAttachment >), AuthenticationStatus RecipientAuthenticationStatus=default(AuthenticationStatus), List< FeatureAvailableMetadata > RecipientFeatureMetadata=default(List< FeatureAvailableMetadata >), string RecipientId=default(string), string RecipientIdGuid=default(string), string RecipientType=default(string), PropertyMetadata RecipientTypeMetadata=default(PropertyMetadata), string RequireIdLookup=default(string), PropertyMetadata RequireIdLookupMetadata=default(PropertyMetadata), string RoleName=default(string), string RoutingOrder=default(string), PropertyMetadata RoutingOrderMetadata=default(PropertyMetadata), string SentDateTime=default(string), string SignedDateTime=default(string), string SigningGroupId=default(string), PropertyMetadata SigningGroupIdMetadata=default(PropertyMetadata), string SigningGroupName=default(string), List< UserInfo > SigningGroupUsers=default(List< UserInfo >), RecipientSMSAuthentication SmsAuthentication=default(RecipientSMSAuthentication), List< SocialAuthentication > SocialAuthentications=default(List< SocialAuthentication >), string Status=default(string), string StatusCode=default(string), string SuppressEmails=default(string), string TemplateLocked=default(string), string TemplateRequired=default(string), string TotalTabCount=default(string), string UserId=default(string))
 Initializes a new instance of the Intermediary 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 (Intermediary other)
 Returns true if Intermediary 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...
 
PropertyMetadata AccessCodeMetadata [get, set]
 Metadata that indicates whether the &#x60;accessCode&#x60; property is editable. This property is read-only. More...
 
string AddAccessCodeToEmail [get, set]
 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. More...
 
List< RecipientAdditionalNotificationAdditionalNotifications [get, set]
 Gets or Sets AdditionalNotifications More...
 
string AllowSystemOverrideForLockedRecipient [get, set]
 Gets or Sets AllowSystemOverrideForLockedRecipient More...
 
string AutoRespondedReason [get, set]
 Gets or Sets AutoRespondedReason More...
 
string BulkSendV2Recipient [get, set]
 Gets or Sets BulkSendV2Recipient 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...
 
string CompletedCount [get, set]
 Gets or Sets CompletedCount More...
 
List< ConsentDetailsConsentDetailsList [get, set]
 Gets or Sets ConsentDetailsList 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 DeclinedDateTime [get, set]
 The date and time the recipient declined the document. More...
 
string DeclinedReason [get, set]
 The reason the recipient declined the document. More...
 
string DeliveredDateTime [get, set]
 Reserved: For DocuSign use only. More...
 
string DeliveryMethod [get, set]
 Reserved: For DocuSign use only. More...
 
PropertyMetadata DeliveryMethodMetadata [get, set]
 Reserved for DocuSign. More...
 
string DesignatorId [get, set]
 Gets or Sets DesignatorId More...
 
string DesignatorIdGuid [get, set]
 Gets or Sets DesignatorIdGuid More...
 
List< DocumentVisibilityDocumentVisibility [get, set]
 Gets or Sets DocumentVisibility More...
 
string Email [get, set]
 Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. More...
 
PropertyMetadata EmailMetadata [get, set]
 Metadata that indicates whether the &#x60;email&#x60; property is editable. This property is read-only. 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 EmailRecipientPostSigningURL [get, set]
 Gets or Sets EmailRecipientPostSigningURL 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...
 
ErrorDetails ErrorDetails [get, set]
 Array or errors. More...
 
List< string > ExcludedDocuments [get, set]
 Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the &#x60;enforceSignerVisibility&#x60; 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. More...
 
string FaxNumber [get, set]
 Reserved: More...
 
PropertyMetadata FaxNumberMetadata [get, set]
 Reserved for DocuSign. More...
 
string FirstName [get, set]
 The user&#39;s first name. Maximum Length: 50 characters. More...
 
PropertyMetadata FirstNameMetadata [get, set]
 Metadata that indicates whether the &#x60;firstName&#x60; property is editable. This property is read-only. More...
 
string FullName [get, set]
 Gets or Sets FullName More...
 
PropertyMetadata FullNameMetadata [get, set]
 Reserved for DocuSign. 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...
 
PropertyMetadata IdCheckConfigurationNameMetadata [get, set]
 Metadata that indicates whether the &#x60;idCheckConfigurationName&#x60; property is editable. This property is read-only. More...
 
IdCheckInformationInput IdCheckInformationInput [get, set]
 An object that contains input information related to a recipient ID check. More...
 
RecipientIdentityVerification IdentityVerification [get, set]
 Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other recipient authentication methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients&#39; identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). More...
 
string InheritEmailNotificationConfiguration [get, set]
 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&#39;s account. More...
 
string LastName [get, set]
 Gets or Sets LastName More...
 
PropertyMetadata LastNameMetadata [get, set]
 Metadata that indicates whether the &#x60;lastName&#x60; property is editable. This property is read-only. More...
 
string LockedRecipientPhoneAuthEditable [get, set]
 Gets or Sets LockedRecipientPhoneAuthEditable More...
 
string LockedRecipientSmsEditable [get, set]
 Gets or Sets LockedRecipientSmsEditable More...
 
string Name [get, set]
 Gets or Sets Name More...
 
PropertyMetadata NameMetadata [get, set]
 Metadata that indicates whether the &#x60;name&#x60; property is editable. This property is read-only. 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...
 
PropertyMetadata NoteMetadata [get, set]
 Metadata that indicates whether the &#x60;note&#x60; property is editable. This property is read-only. 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...
 
RecipientPhoneNumber PhoneNumber [get, set]
 Describes the recipient phone number. More...
 
List< RecipientAttachmentRecipientAttachments [get, set]
 Reserved: More...
 
AuthenticationStatus RecipientAuthenticationStatus [get, set]
 Information about the recipient&#39;s authentication status. This property is read-only. More...
 
List< FeatureAvailableMetadataRecipientFeatureMetadata [get, set]
 Gets or Sets RecipientFeatureMetadata 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...
 
string RecipientIdGuid [get, set]
 Gets or Sets RecipientIdGuid More...
 
string RecipientType [get, set]
 Gets or Sets RecipientType More...
 
PropertyMetadata RecipientTypeMetadata [get, set]
 Metadata that indicates whether the &#x60;recipientType&#x60; property is editable. This property is read-only. More...
 
string RequireIdLookup [get, set]
 When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. More...
 
PropertyMetadata RequireIdLookupMetadata [get, set]
 Metadata that indicates whether the &#x60;requireIdLookup&#x60; property is editable. This property is read-only. 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 RoutingOrder [get, set]
 Specifies the routing order of the recipient in the envelope. More...
 
PropertyMetadata RoutingOrderMetadata [get, set]
 Metadata that indicates whether the &#x60;routingOrder&#x60; property is editable. This property is read-only. More...
 
string SentDateTime [get, set]
 The date and time the envelope was sent. More...
 
string SignedDateTime [get, set]
 Reserved: For DocuSign use only. 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...
 
PropertyMetadata SigningGroupIdMetadata [get, set]
 Metadata that indicates whether the &#x60;signingGroupId&#x60; property is editable. This property is read-only. More...
 
string SigningGroupName [get, set]
 The display name for the signing group. Maximum Length: 100 characters. More...
 
List< UserInfoSigningGroupUsers [get, set]
 A complex type that contains information about users in the signing group. 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...
 
string Status [get, set]
 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. More...
 
string StatusCode [get, set]
 Gets or Sets StatusCode More...
 
string SuppressEmails [get, set]
 Gets or Sets SuppressEmails More...
 
string TemplateLocked [get, set]
 When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. More...
 
string TemplateRequired [get, set]
 When set to true, the sender may not remove the recipient. Used only when working with template recipients. More...
 
string TotalTabCount [get, set]
 Gets or Sets TotalTabCount More...
 
string UserId [get, set]
 Gets or Sets UserId More...
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ Intermediary()

DocuSign.eSign.Model.Intermediary.Intermediary ( string  AccessCode = default(string),
PropertyMetadata  AccessCodeMetadata = default(PropertyMetadata),
string  AddAccessCodeToEmail = default(string),
List< RecipientAdditionalNotification AdditionalNotifications = default(List<RecipientAdditionalNotification>),
string  AllowSystemOverrideForLockedRecipient = default(string),
string  AutoRespondedReason = default(string),
string  BulkSendV2Recipient = default(string),
string  ClientUserId = default(string),
string  CompletedCount = default(string),
List< ConsentDetails ConsentDetailsList = default(List<ConsentDetails>),
List< string >  CustomFields = default(List<string>),
string  DeclinedDateTime = default(string),
string  DeclinedReason = default(string),
string  DeliveredDateTime = default(string),
string  DeliveryMethod = default(string),
PropertyMetadata  DeliveryMethodMetadata = default(PropertyMetadata),
string  DesignatorId = default(string),
string  DesignatorIdGuid = default(string),
List< DocumentVisibility DocumentVisibility = default(List<DocumentVisibility>),
string  Email = default(string),
PropertyMetadata  EmailMetadata = default(PropertyMetadata),
RecipientEmailNotification  EmailNotification = default(RecipientEmailNotification),
string  EmailRecipientPostSigningURL = default(string),
string  EmbeddedRecipientStartURL = default(string),
ErrorDetails  ErrorDetails = default(ErrorDetails),
List< string >  ExcludedDocuments = default(List<string>),
string  FaxNumber = default(string),
PropertyMetadata  FaxNumberMetadata = default(PropertyMetadata),
string  FirstName = default(string),
PropertyMetadata  FirstNameMetadata = default(PropertyMetadata),
string  FullName = default(string),
PropertyMetadata  FullNameMetadata = default(PropertyMetadata),
string  IdCheckConfigurationName = default(string),
PropertyMetadata  IdCheckConfigurationNameMetadata = default(PropertyMetadata),
IdCheckInformationInput  IdCheckInformationInput = default(IdCheckInformationInput),
RecipientIdentityVerification  IdentityVerification = default(RecipientIdentityVerification),
string  InheritEmailNotificationConfiguration = default(string),
string  LastName = default(string),
PropertyMetadata  LastNameMetadata = default(PropertyMetadata),
string  LockedRecipientPhoneAuthEditable = default(string),
string  LockedRecipientSmsEditable = default(string),
string  Name = default(string),
PropertyMetadata  NameMetadata = default(PropertyMetadata),
string  Note = default(string),
PropertyMetadata  NoteMetadata = default(PropertyMetadata),
RecipientPhoneAuthentication  PhoneAuthentication = default(RecipientPhoneAuthentication),
RecipientPhoneNumber  PhoneNumber = default(RecipientPhoneNumber),
List< RecipientAttachment RecipientAttachments = default(List<RecipientAttachment>),
AuthenticationStatus  RecipientAuthenticationStatus = default(AuthenticationStatus),
List< FeatureAvailableMetadata RecipientFeatureMetadata = default(List<FeatureAvailableMetadata>),
string  RecipientId = default(string),
string  RecipientIdGuid = default(string),
string  RecipientType = default(string),
PropertyMetadata  RecipientTypeMetadata = default(PropertyMetadata),
string  RequireIdLookup = default(string),
PropertyMetadata  RequireIdLookupMetadata = default(PropertyMetadata),
string  RoleName = default(string),
string  RoutingOrder = default(string),
PropertyMetadata  RoutingOrderMetadata = default(PropertyMetadata),
string  SentDateTime = default(string),
string  SignedDateTime = default(string),
string  SigningGroupId = default(string),
PropertyMetadata  SigningGroupIdMetadata = default(PropertyMetadata),
string  SigningGroupName = default(string),
List< UserInfo SigningGroupUsers = default(List<UserInfo>),
RecipientSMSAuthentication  SmsAuthentication = default(RecipientSMSAuthentication),
List< SocialAuthentication SocialAuthentications = default(List<SocialAuthentication>),
string  Status = default(string),
string  StatusCode = default(string),
string  SuppressEmails = default(string),
string  TemplateLocked = default(string),
string  TemplateRequired = default(string),
string  TotalTabCount = default(string),
string  UserId = default(string) 
)
inline

Initializes a new instance of the Intermediary 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..
AccessCodeMetadataMetadata that indicates whether the &#x60;accessCode&#x60; property is editable. This property is read-only..
AddAccessCodeToEmailThis 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..
AdditionalNotificationsAdditionalNotifications.
AllowSystemOverrideForLockedRecipientAllowSystemOverrideForLockedRecipient.
AutoRespondedReasonAutoRespondedReason.
BulkSendV2RecipientBulkSendV2Recipient.
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. .
CompletedCountCompletedCount.
ConsentDetailsListConsentDetailsList.
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..
DeclinedDateTimeThe date and time the recipient declined the document..
DeclinedReasonThe reason the recipient declined the document..
DeliveredDateTimeReserved: For DocuSign use only..
DeliveryMethodReserved: For DocuSign use only..
DeliveryMethodMetadataReserved for DocuSign..
DesignatorIdDesignatorId.
DesignatorIdGuidDesignatorIdGuid.
DocumentVisibilityDocumentVisibility.
EmailEmail id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. .
EmailMetadataMetadata that indicates whether the &#x60;email&#x60; property is editable. This property is read-only..
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. .
EmailRecipientPostSigningURLEmailRecipientPostSigningURL.
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; .
ErrorDetailsArray or errors..
ExcludedDocumentsSpecifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the &#x60;enforceSignerVisibility&#x60; 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..
FaxNumberReserved:.
FaxNumberMetadataReserved for DocuSign..
FirstNameThe user&#39;s first name. Maximum Length: 50 characters..
FirstNameMetadataMetadata that indicates whether the &#x60;firstName&#x60; property is editable. This property is read-only..
FullNameFullName.
FullNameMetadataReserved for DocuSign..
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..
IdCheckConfigurationNameMetadataMetadata that indicates whether the &#x60;idCheckConfigurationName&#x60; property is editable. This property is read-only..
IdCheckInformationInputAn object that contains input information related to a recipient ID check..
IdentityVerificationSpecifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other recipient authentication methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients&#39; identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)..
InheritEmailNotificationConfigurationWhen 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&#39;s account. .
LastNameLastName.
LastNameMetadataMetadata that indicates whether the &#x60;lastName&#x60; property is editable. This property is read-only..
LockedRecipientPhoneAuthEditableLockedRecipientPhoneAuthEditable.
LockedRecipientSmsEditableLockedRecipientSmsEditable.
NameName.
NameMetadataMetadata that indicates whether the &#x60;name&#x60; property is editable. This property is read-only..
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..
NoteMetadataMetadata that indicates whether the &#x60;note&#x60; property is editable. This property is read-only..
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. .
PhoneNumberDescribes the recipient phone number..
RecipientAttachmentsReserved:.
RecipientAuthenticationStatusInformation about the recipient&#39;s authentication status. This property is read-only..
RecipientFeatureMetadataRecipientFeatureMetadata.
RecipientIdUnique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..
RecipientIdGuidRecipientIdGuid.
RecipientTypeRecipientType.
RecipientTypeMetadataMetadata that indicates whether the &#x60;recipientType&#x60; property is editable. This property is read-only..
RequireIdLookupWhen set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. .
RequireIdLookupMetadataMetadata that indicates whether the &#x60;requireIdLookup&#x60; property is editable. This property is read-only..
RoleNameOptional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients..
RoutingOrderSpecifies the routing order of the recipient in the envelope. .
RoutingOrderMetadataMetadata that indicates whether the &#x60;routingOrder&#x60; property is editable. This property is read-only..
SentDateTimeThe date and time the envelope was sent..
SignedDateTimeReserved: For DocuSign use only. .
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)..
SigningGroupIdMetadataMetadata that indicates whether the &#x60;signingGroupId&#x60; property is editable. This property is read-only..
SigningGroupNameThe display name for the signing group. Maximum Length: 100 characters. .
SigningGroupUsersA complex type that contains information about users in the signing group..
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..
StatusIndicates 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..
StatusCodeStatusCode.
SuppressEmailsSuppressEmails.
TemplateLockedWhen set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. .
TemplateRequiredWhen set to true, the sender may not remove the recipient. Used only when working with template recipients..
TotalTabCountTotalTabCount.
UserIdUserId.

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if Intermediary instances are equal

Parameters
otherInstance of Intermediary to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AccessCode

string DocuSign.eSign.Model.Intermediary.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.

◆ AccessCodeMetadata

PropertyMetadata DocuSign.eSign.Model.Intermediary.AccessCodeMetadata
getset

Metadata that indicates whether the &#x60;accessCode&#x60; property is editable. This property is read-only.

Metadata that indicates whether the &#x60;accessCode&#x60; property is editable. This property is read-only.

◆ AddAccessCodeToEmail

string DocuSign.eSign.Model.Intermediary.AddAccessCodeToEmail
getset

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.

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.

◆ AdditionalNotifications

List<RecipientAdditionalNotification> DocuSign.eSign.Model.Intermediary.AdditionalNotifications
getset

Gets or Sets AdditionalNotifications

◆ AllowSystemOverrideForLockedRecipient

string DocuSign.eSign.Model.Intermediary.AllowSystemOverrideForLockedRecipient
getset

Gets or Sets AllowSystemOverrideForLockedRecipient

◆ AutoRespondedReason

string DocuSign.eSign.Model.Intermediary.AutoRespondedReason
getset

Gets or Sets AutoRespondedReason

◆ BulkSendV2Recipient

string DocuSign.eSign.Model.Intermediary.BulkSendV2Recipient
getset

Gets or Sets BulkSendV2Recipient

◆ ClientUserId

string DocuSign.eSign.Model.Intermediary.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.

◆ CompletedCount

string DocuSign.eSign.Model.Intermediary.CompletedCount
getset

Gets or Sets CompletedCount

◆ ConsentDetailsList

List<ConsentDetails> DocuSign.eSign.Model.Intermediary.ConsentDetailsList
getset

Gets or Sets ConsentDetailsList

◆ CustomFields

List<string> DocuSign.eSign.Model.Intermediary.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.

◆ DeclinedDateTime

string DocuSign.eSign.Model.Intermediary.DeclinedDateTime
getset

The date and time the recipient declined the document.

The date and time the recipient declined the document.

◆ DeclinedReason

string DocuSign.eSign.Model.Intermediary.DeclinedReason
getset

The reason the recipient declined the document.

The reason the recipient declined the document.

◆ DeliveredDateTime

string DocuSign.eSign.Model.Intermediary.DeliveredDateTime
getset

Reserved: For DocuSign use only.

Reserved: For DocuSign use only.

◆ DeliveryMethod

string DocuSign.eSign.Model.Intermediary.DeliveryMethod
getset

Reserved: For DocuSign use only.

Reserved: For DocuSign use only.

◆ DeliveryMethodMetadata

PropertyMetadata DocuSign.eSign.Model.Intermediary.DeliveryMethodMetadata
getset

Reserved for DocuSign.

Reserved for DocuSign.

◆ DesignatorId

string DocuSign.eSign.Model.Intermediary.DesignatorId
getset

Gets or Sets DesignatorId

◆ DesignatorIdGuid

string DocuSign.eSign.Model.Intermediary.DesignatorIdGuid
getset

Gets or Sets DesignatorIdGuid

◆ DocumentVisibility

List<DocumentVisibility> DocuSign.eSign.Model.Intermediary.DocumentVisibility
getset

Gets or Sets DocumentVisibility

◆ Email

string DocuSign.eSign.Model.Intermediary.Email
getset

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

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

◆ EmailMetadata

PropertyMetadata DocuSign.eSign.Model.Intermediary.EmailMetadata
getset

Metadata that indicates whether the &#x60;email&#x60; property is editable. This property is read-only.

Metadata that indicates whether the &#x60;email&#x60; property is editable. This property is read-only.

◆ EmailNotification

RecipientEmailNotification DocuSign.eSign.Model.Intermediary.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.

◆ EmailRecipientPostSigningURL

string DocuSign.eSign.Model.Intermediary.EmailRecipientPostSigningURL
getset

Gets or Sets EmailRecipientPostSigningURL

◆ EmbeddedRecipientStartURL

string DocuSign.eSign.Model.Intermediary.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;

◆ ErrorDetails

ErrorDetails DocuSign.eSign.Model.Intermediary.ErrorDetails
getset

Array or errors.

Array or errors.

◆ ExcludedDocuments

List<string> DocuSign.eSign.Model.Intermediary.ExcludedDocuments
getset

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the &#x60;enforceSignerVisibility&#x60; 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.

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the &#x60;enforceSignerVisibility&#x60; 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.

◆ FaxNumber

string DocuSign.eSign.Model.Intermediary.FaxNumber
getset

Reserved:

Reserved:

◆ FaxNumberMetadata

PropertyMetadata DocuSign.eSign.Model.Intermediary.FaxNumberMetadata
getset

Reserved for DocuSign.

Reserved for DocuSign.

◆ FirstName

string DocuSign.eSign.Model.Intermediary.FirstName
getset

The user&#39;s first name. Maximum Length: 50 characters.

The user&#39;s first name. Maximum Length: 50 characters.

◆ FirstNameMetadata

PropertyMetadata DocuSign.eSign.Model.Intermediary.FirstNameMetadata
getset

Metadata that indicates whether the &#x60;firstName&#x60; property is editable. This property is read-only.

Metadata that indicates whether the &#x60;firstName&#x60; property is editable. This property is read-only.

◆ FullName

string DocuSign.eSign.Model.Intermediary.FullName
getset

Gets or Sets FullName

◆ FullNameMetadata

PropertyMetadata DocuSign.eSign.Model.Intermediary.FullNameMetadata
getset

Reserved for DocuSign.

Reserved for DocuSign.

◆ IdCheckConfigurationName

string DocuSign.eSign.Model.Intermediary.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.

◆ IdCheckConfigurationNameMetadata

PropertyMetadata DocuSign.eSign.Model.Intermediary.IdCheckConfigurationNameMetadata
getset

Metadata that indicates whether the &#x60;idCheckConfigurationName&#x60; property is editable. This property is read-only.

Metadata that indicates whether the &#x60;idCheckConfigurationName&#x60; property is editable. This property is read-only.

◆ IdCheckInformationInput

IdCheckInformationInput DocuSign.eSign.Model.Intermediary.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.

◆ IdentityVerification

RecipientIdentityVerification DocuSign.eSign.Model.Intermediary.IdentityVerification
getset

Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other recipient authentication methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients&#39; identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).

Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other recipient authentication methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients&#39; identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).

◆ InheritEmailNotificationConfiguration

string DocuSign.eSign.Model.Intermediary.InheritEmailNotificationConfiguration
getset

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&#39;s account.

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&#39;s account.

◆ LastName

string DocuSign.eSign.Model.Intermediary.LastName
getset

Gets or Sets LastName

◆ LastNameMetadata

PropertyMetadata DocuSign.eSign.Model.Intermediary.LastNameMetadata
getset

Metadata that indicates whether the &#x60;lastName&#x60; property is editable. This property is read-only.

Metadata that indicates whether the &#x60;lastName&#x60; property is editable. This property is read-only.

◆ LockedRecipientPhoneAuthEditable

string DocuSign.eSign.Model.Intermediary.LockedRecipientPhoneAuthEditable
getset

Gets or Sets LockedRecipientPhoneAuthEditable

◆ LockedRecipientSmsEditable

string DocuSign.eSign.Model.Intermediary.LockedRecipientSmsEditable
getset

Gets or Sets LockedRecipientSmsEditable

◆ Name

string DocuSign.eSign.Model.Intermediary.Name
getset

Gets or Sets Name

◆ NameMetadata

PropertyMetadata DocuSign.eSign.Model.Intermediary.NameMetadata
getset

Metadata that indicates whether the &#x60;name&#x60; property is editable. This property is read-only.

Metadata that indicates whether the &#x60;name&#x60; property is editable. This property is read-only.

◆ Note

string DocuSign.eSign.Model.Intermediary.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.

◆ NoteMetadata

PropertyMetadata DocuSign.eSign.Model.Intermediary.NoteMetadata
getset

Metadata that indicates whether the &#x60;note&#x60; property is editable. This property is read-only.

Metadata that indicates whether the &#x60;note&#x60; property is editable. This property is read-only.

◆ PhoneAuthentication

RecipientPhoneAuthentication DocuSign.eSign.Model.Intermediary.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.

◆ PhoneNumber

RecipientPhoneNumber DocuSign.eSign.Model.Intermediary.PhoneNumber
getset

Describes the recipient phone number.

Describes the recipient phone number.

◆ RecipientAttachments

List<RecipientAttachment> DocuSign.eSign.Model.Intermediary.RecipientAttachments
getset

Reserved:

Reserved:

◆ RecipientAuthenticationStatus

AuthenticationStatus DocuSign.eSign.Model.Intermediary.RecipientAuthenticationStatus
getset

Information about the recipient&#39;s authentication status. This property is read-only.

Information about the recipient&#39;s authentication status. This property is read-only.

◆ RecipientFeatureMetadata

List<FeatureAvailableMetadata> DocuSign.eSign.Model.Intermediary.RecipientFeatureMetadata
getset

Gets or Sets RecipientFeatureMetadata

◆ RecipientId

string DocuSign.eSign.Model.Intermediary.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.

◆ RecipientIdGuid

string DocuSign.eSign.Model.Intermediary.RecipientIdGuid
getset

Gets or Sets RecipientIdGuid

◆ RecipientType

string DocuSign.eSign.Model.Intermediary.RecipientType
getset

Gets or Sets RecipientType

◆ RecipientTypeMetadata

PropertyMetadata DocuSign.eSign.Model.Intermediary.RecipientTypeMetadata
getset

Metadata that indicates whether the &#x60;recipientType&#x60; property is editable. This property is read-only.

Metadata that indicates whether the &#x60;recipientType&#x60; property is editable. This property is read-only.

◆ RequireIdLookup

string DocuSign.eSign.Model.Intermediary.RequireIdLookup
getset

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

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

◆ RequireIdLookupMetadata

PropertyMetadata DocuSign.eSign.Model.Intermediary.RequireIdLookupMetadata
getset

Metadata that indicates whether the &#x60;requireIdLookup&#x60; property is editable. This property is read-only.

Metadata that indicates whether the &#x60;requireIdLookup&#x60; property is editable. This property is read-only.

◆ RoleName

string DocuSign.eSign.Model.Intermediary.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.

◆ RoutingOrder

string DocuSign.eSign.Model.Intermediary.RoutingOrder
getset

Specifies the routing order of the recipient in the envelope.

Specifies the routing order of the recipient in the envelope.

◆ RoutingOrderMetadata

PropertyMetadata DocuSign.eSign.Model.Intermediary.RoutingOrderMetadata
getset

Metadata that indicates whether the &#x60;routingOrder&#x60; property is editable. This property is read-only.

Metadata that indicates whether the &#x60;routingOrder&#x60; property is editable. This property is read-only.

◆ SentDateTime

string DocuSign.eSign.Model.Intermediary.SentDateTime
getset

The date and time the envelope was sent.

The date and time the envelope was sent.

◆ SignedDateTime

string DocuSign.eSign.Model.Intermediary.SignedDateTime
getset

Reserved: For DocuSign use only.

Reserved: For DocuSign use only.

◆ SigningGroupId

string DocuSign.eSign.Model.Intermediary.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).

◆ SigningGroupIdMetadata

PropertyMetadata DocuSign.eSign.Model.Intermediary.SigningGroupIdMetadata
getset

Metadata that indicates whether the &#x60;signingGroupId&#x60; property is editable. This property is read-only.

Metadata that indicates whether the &#x60;signingGroupId&#x60; property is editable. This property is read-only.

◆ SigningGroupName

string DocuSign.eSign.Model.Intermediary.SigningGroupName
getset

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

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

◆ SigningGroupUsers

List<UserInfo> DocuSign.eSign.Model.Intermediary.SigningGroupUsers
getset

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

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

◆ SmsAuthentication

RecipientSMSAuthentication DocuSign.eSign.Model.Intermediary.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.Intermediary.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.

◆ Status

string DocuSign.eSign.Model.Intermediary.Status
getset

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.

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.

◆ StatusCode

string DocuSign.eSign.Model.Intermediary.StatusCode
getset

Gets or Sets StatusCode

◆ SuppressEmails

string DocuSign.eSign.Model.Intermediary.SuppressEmails
getset

Gets or Sets SuppressEmails

◆ TemplateLocked

string DocuSign.eSign.Model.Intermediary.TemplateLocked
getset

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

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

◆ TemplateRequired

string DocuSign.eSign.Model.Intermediary.TemplateRequired
getset

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

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

◆ TotalTabCount

string DocuSign.eSign.Model.Intermediary.TotalTabCount
getset

Gets or Sets TotalTabCount

◆ UserId

string DocuSign.eSign.Model.Intermediary.UserId
getset

Gets or Sets UserId


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