A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document. More...

Inheritance diagram for DocuSign.eSign.Model.Signer:

Public Member Functions
	Signer (string AccessCode=default(string), PropertyMetadata AccessCodeMetadata=default(PropertyMetadata), string AddAccessCodeToEmail=default(string), List< RecipientAdditionalNotification > AdditionalNotifications=default(List< RecipientAdditionalNotification >), string AgentCanEditEmail=default(string), string AgentCanEditName=default(string), string AllowSystemOverrideForLockedRecipient=default(string), string AutoNavigation=default(string), string AutoRespondedReason=default(string), string BulkRecipientsUri=default(string), string BulkSendV2Recipient=default(string), string CanSignOffline=default(string), string ClientUserId=default(string), string CompletedCount=default(string), List< ConsentDetails > ConsentDetailsList=default(List< ConsentDetails >), string CreationReason=default(string), List< string > CustomFields=default(List< string >), string DeclinedDateTime=default(string), string DeclinedReason=default(string), string DefaultRecipient=default(string), DelegationInfo DelegatedBy=default(DelegationInfo), List< DelegationInfo > DelegatedTo=default(List< DelegationInfo >), 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 IsBulkRecipient=default(string), PropertyMetadata IsBulkRecipientMetadata=default(PropertyMetadata), 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 NotaryId=default(string), string NotarySignerEmailSent=default(string), string Note=default(string), PropertyMetadata NoteMetadata=default(PropertyMetadata), OfflineAttributes OfflineAttributes=default(OfflineAttributes), RecipientPhoneAuthentication PhoneAuthentication=default(RecipientPhoneAuthentication), RecipientPhoneNumber PhoneNumber=default(RecipientPhoneNumber), RecipientProofFile ProofFile=default(RecipientProofFile), List< RecipientAttachment > RecipientAttachments=default(List< RecipientAttachment >), AuthenticationStatus RecipientAuthenticationStatus=default(AuthenticationStatus), List< FeatureAvailableMetadata > RecipientFeatureMetadata=default(List< FeatureAvailableMetadata >), string RecipientId=default(string), string RecipientIdGuid=default(string), List< RecipientSignatureProvider > RecipientSignatureProviders=default(List< RecipientSignatureProvider >), string RecipientSuppliesTabs=default(string), string RecipientType=default(string), PropertyMetadata RecipientTypeMetadata=default(PropertyMetadata), string RequireIdLookup=default(string), PropertyMetadata RequireIdLookupMetadata=default(PropertyMetadata), string RequireSignerCertificate=default(string), string RequireSignOnPaper=default(string), string RequireUploadSignature=default(string), string RoleName=default(string), string RoutingOrder=default(string), PropertyMetadata RoutingOrderMetadata=default(PropertyMetadata), string SentDateTime=default(string), RecipientSignatureInformation SignatureInfo=default(RecipientSignatureInformation), string SignedDateTime=default(string), string SignInEachLocation=default(string), PropertyMetadata SignInEachLocationMetadata=default(PropertyMetadata), 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), Tabs Tabs=default(Tabs), string TemplateLocked=default(string), string TemplateRequired=default(string), string TotalTabCount=default(string), string UserId=default(string))
	Initializes a new instance of the Signer 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 (Signer other)
	Returns true if Signer 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's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. More...

PropertyMetadata	AccessCodeMetadata `[get, set]`
	Metadata that indicates whether the `accessCode` 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< RecipientAdditionalNotification >	AdditionalNotifications `[get, set]`
	Gets or Sets AdditionalNotifications More...

string	AgentCanEditEmail `[get, set]`
	Gets or Sets AgentCanEditEmail More...

string	AgentCanEditName `[get, set]`
	Gets or Sets AgentCanEditName More...

string	AllowSystemOverrideForLockedRecipient `[get, set]`
	Gets or Sets AllowSystemOverrideForLockedRecipient More...

string	AutoNavigation `[get, set]`
	Gets or Sets AutoNavigation More...

string	AutoRespondedReason `[get, set]`
	Gets or Sets AutoRespondedReason More...

string	BulkRecipientsUri `[get, set]`
	Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. More...

string	BulkSendV2Recipient `[get, set]`
	Gets or Sets BulkSendV2Recipient More...

string	CanSignOffline `[get, set]`
	When set to true, specifies that the signer can perform the signing ceremony offline. More...

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

string	CompletedCount `[get, set]`
	Gets or Sets CompletedCount More...

List< ConsentDetails >	ConsentDetailsList `[get, set]`
	Gets or Sets ConsentDetailsList More...

string	CreationReason `[get, set]`
	Gets or Sets CreationReason 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	DefaultRecipient `[get, set]`
	Gets or Sets DefaultRecipient More...

DelegationInfo	DelegatedBy `[get, set]`
	Gets or Sets DelegatedBy More...

List< DelegationInfo >	DelegatedTo `[get, set]`
	Gets or Sets DelegatedTo 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< DocumentVisibility >	DocumentVisibility `[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 `email` 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's email information. IMPORTANT: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings. 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's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` 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 `enforceSignerVisibility` property must be set to true for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent. More...

string	FaxNumber `[get, set]`
	Reserved: More...

PropertyMetadata	FaxNumberMetadata `[get, set]`
	Reserved for DocuSign. More...

string	FirstName `[get, set]`
	The user's first name. Maximum Length: 50 characters. More...

PropertyMetadata	FirstNameMetadata `[get, set]`
	Metadata that indicates whether the `firstName` 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 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. More...

PropertyMetadata	IdCheckConfigurationNameMetadata `[get, set]`
	Metadata that indicates whether the `idCheckConfigurationName` 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' 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's account. More...

string	IsBulkRecipient `[get, set]`
	When set to true, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. Note that when this is true the email and name for the recipient becomes bulk@.nosp@m.reci.nosp@m.pient.nosp@m..com and "Bulk Recipient". These fields can not be changed for the bulk recipient. More...

PropertyMetadata	IsBulkRecipientMetadata `[get, set]`
	Reserved for DocuSign. More...

string	LastName `[get, set]`
	Gets or Sets LastName More...

PropertyMetadata	LastNameMetadata `[get, set]`
	Metadata that indicates whether the `lastName` 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 `name` property is editable. This property is read-only. More...

string	NotaryId `[get, set]`
	Gets or Sets NotaryId More...

string	NotarySignerEmailSent `[get, set]`
	Gets or Sets NotarySignerEmailSent 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 `note` property is editable. This property is read-only. More...

OfflineAttributes	OfflineAttributes `[get, set]`
	Reserved for DocuSign. More...

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

RecipientPhoneNumber	PhoneNumber `[get, set]`
	Describes the recipient phone number. More...

RecipientProofFile	ProofFile `[get, set]`
	The proof file of the recipient. More...

List< RecipientAttachment >	RecipientAttachments `[get, set]`
	Reserved: More...

AuthenticationStatus	RecipientAuthenticationStatus `[get, set]`
	Information about the recipient's authentication status. This property is read-only. More...

List< FeatureAvailableMetadata >	RecipientFeatureMetadata `[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...

List< RecipientSignatureProvider >	RecipientSignatureProviders `[get, set]`
	Gets or Sets RecipientSignatureProviders More...

string	RecipientSuppliesTabs `[get, set]`
	Gets or Sets RecipientSuppliesTabs More...

string	RecipientType `[get, set]`
	Gets or Sets RecipientType More...

PropertyMetadata	RecipientTypeMetadata `[get, set]`
	Metadata that indicates whether the `recipientType` 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 `requireIdLookup` property is editable. This property is read-only. More...

string	RequireSignerCertificate `[get, set]`
	Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are: * docusign_express - Requires a DocuSign Express certificate. * safe - Requires a SAFE-BioPharma certificate. * open_trust - Requires an OpenTrust certificate. Important: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information. More...

string	RequireSignOnPaper `[get, set]`
	When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign. More...

string	RequireUploadSignature `[get, set]`
	Gets or Sets RequireUploadSignature 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 `routingOrder` property is editable. This property is read-only. More...

string	SentDateTime `[get, set]`
	The date and time the envelope was sent. More...

RecipientSignatureInformation	SignatureInfo `[get, set]`
	Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. More...

string	SignedDateTime `[get, set]`
	Reserved: For DocuSign use only. More...

string	SignInEachLocation `[get, set]`
	When set to true, specifies that the signer must sign in all locations. More...

PropertyMetadata	SignInEachLocationMetadata `[get, set]`
	Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only. More...

string	SigningGroupId `[get, set]`
	When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). More...

PropertyMetadata	SigningGroupIdMetadata `[get, set]`
	Metadata that indicates whether the `signingGroupId` 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< UserInfo >	SigningGroupUsers `[get, set]`
	A complex type that contains information about users in the signing group. More...

RecipientSMSAuthentication	SmsAuthentication `[get, set]`
	When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. More...

List< SocialAuthentication >	SocialAuthentications `[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...

Tabs	Tabs `[get, set]`
	The tabs to assign to the recipient. More information. 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

A complex type containing information about a signer recipient. A signer is a recipient who must take action on a document, such as sign, initial, date, or add data to form fields on a document.

Constructor & Destructor Documentation

◆ Signer()

DocuSign.eSign.Model.Signer.Signer	(	string	AccessCode = `default(string)`,
		PropertyMetadata	AccessCodeMetadata = `default(PropertyMetadata)`,
		string	AddAccessCodeToEmail = `default(string)`,
		List< RecipientAdditionalNotification >	AdditionalNotifications = `default(List<RecipientAdditionalNotification>)`,
		string	AgentCanEditEmail = `default(string)`,
		string	AgentCanEditName = `default(string)`,
		string	AllowSystemOverrideForLockedRecipient = `default(string)`,
		string	AutoNavigation = `default(string)`,
		string	AutoRespondedReason = `default(string)`,
		string	BulkRecipientsUri = `default(string)`,
		string	BulkSendV2Recipient = `default(string)`,
		string	CanSignOffline = `default(string)`,
		string	ClientUserId = `default(string)`,
		string	CompletedCount = `default(string)`,
		List< ConsentDetails >	ConsentDetailsList = `default(List<ConsentDetails>)`,
		string	CreationReason = `default(string)`,
		List< string >	CustomFields = `default(List<string>)`,
		string	DeclinedDateTime = `default(string)`,
		string	DeclinedReason = `default(string)`,
		string	DefaultRecipient = `default(string)`,
		DelegationInfo	DelegatedBy = `default(DelegationInfo)`,
		List< DelegationInfo >	DelegatedTo = `default(List<DelegationInfo>)`,
		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	IsBulkRecipient = `default(string)`,
		PropertyMetadata	IsBulkRecipientMetadata = `default(PropertyMetadata)`,
		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	NotaryId = `default(string)`,
		string	NotarySignerEmailSent = `default(string)`,
		string	Note = `default(string)`,
		PropertyMetadata	NoteMetadata = `default(PropertyMetadata)`,
		OfflineAttributes	OfflineAttributes = `default(OfflineAttributes)`,
		RecipientPhoneAuthentication	PhoneAuthentication = `default(RecipientPhoneAuthentication)`,
		RecipientPhoneNumber	PhoneNumber = `default(RecipientPhoneNumber)`,
		RecipientProofFile	ProofFile = `default(RecipientProofFile)`,
		List< RecipientAttachment >	RecipientAttachments = `default(List<RecipientAttachment>)`,
		AuthenticationStatus	RecipientAuthenticationStatus = `default(AuthenticationStatus)`,
		List< FeatureAvailableMetadata >	RecipientFeatureMetadata = `default(List<FeatureAvailableMetadata>)`,
		string	RecipientId = `default(string)`,
		string	RecipientIdGuid = `default(string)`,
		List< RecipientSignatureProvider >	RecipientSignatureProviders = `default(List<RecipientSignatureProvider>)`,
		string	RecipientSuppliesTabs = `default(string)`,
		string	RecipientType = `default(string)`,
		PropertyMetadata	RecipientTypeMetadata = `default(PropertyMetadata)`,
		string	RequireIdLookup = `default(string)`,
		PropertyMetadata	RequireIdLookupMetadata = `default(PropertyMetadata)`,
		string	RequireSignerCertificate = `default(string)`,
		string	RequireSignOnPaper = `default(string)`,
		string	RequireUploadSignature = `default(string)`,
		string	RoleName = `default(string)`,
		string	RoutingOrder = `default(string)`,
		PropertyMetadata	RoutingOrderMetadata = `default(PropertyMetadata)`,
		string	SentDateTime = `default(string)`,
		RecipientSignatureInformation	SignatureInfo = `default(RecipientSignatureInformation)`,
		string	SignedDateTime = `default(string)`,
		string	SignInEachLocation = `default(string)`,
		PropertyMetadata	SignInEachLocationMetadata = `default(PropertyMetadata)`,
		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)`,
		Tabs	Tabs = `default(Tabs)`,
		string	TemplateLocked = `default(string)`,
		string	TemplateRequired = `default(string)`,
		string	TotalTabCount = `default(string)`,
		string	UserId = `default(string)`
	)

inline

Initializes a new instance of the Signer class.

Parameters

AccessCode	If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required..
AccessCodeMetadata	Metadata that indicates whether the `accessCode` property is editable. This property is read-only..
AddAccessCodeToEmail	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	AdditionalNotifications.
AgentCanEditEmail	AgentCanEditEmail.
AgentCanEditName	AgentCanEditName.
AllowSystemOverrideForLockedRecipient	AllowSystemOverrideForLockedRecipient.
AutoNavigation	AutoNavigation.
AutoRespondedReason	AutoRespondedReason.
BulkRecipientsUri	Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information..
BulkSendV2Recipient	BulkSendV2Recipient.
CanSignOffline	When set to true, specifies that the signer can perform the signing ceremony offline..
ClientUserId	Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters. .
CompletedCount	CompletedCount.
ConsentDetailsList	ConsentDetailsList.
CreationReason	CreationReason.
CustomFields	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	The date and time the recipient declined the document..
DeclinedReason	The reason the recipient declined the document..
DefaultRecipient	DefaultRecipient.
DelegatedBy	DelegatedBy.
DelegatedTo	DelegatedTo.
DeliveredDateTime	Reserved: For DocuSign use only..
DeliveryMethod	Reserved: For DocuSign use only..
DeliveryMethodMetadata	Reserved for DocuSign..
DesignatorId	DesignatorId.
DesignatorIdGuid	DesignatorIdGuid.
DocumentVisibility	DocumentVisibility.
Email	Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters. .
EmailMetadata	Metadata that indicates whether the `email` property is editable. This property is read-only..
EmailNotification	A complex type that contains information sets the language of the recipient's email information. IMPORTANT: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings. .
EmailRecipientPostSigningURL	EmailRecipientPostSigningURL.
EmbeddedRecipientStartURL	Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` .
ErrorDetails	Array or errors..
ExcludedDocuments	Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to true for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent..
FaxNumber	Reserved:.
FaxNumberMetadata	Reserved for DocuSign..
FirstName	The user's first name. Maximum Length: 50 characters..
FirstNameMetadata	Metadata that indicates whether the `firstName` property is editable. This property is read-only..
FullName	FullName.
FullNameMetadata	Reserved for DocuSign..
IdCheckConfigurationName	Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node..
IdCheckConfigurationNameMetadata	Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only..
IdCheckInformationInput	An object that contains input information related to a recipient ID check..
IdentityVerification	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' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address)..
InheritEmailNotificationConfiguration	When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. .
IsBulkRecipient	When set to true, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. Note that when this is true the email and name for the recipient becomes bulk@.nosp@m.reci.nosp@m.pient.nosp@m..com and "Bulk Recipient". These fields can not be changed for the bulk recipient. .
IsBulkRecipientMetadata	Reserved for DocuSign..
LastName	LastName.
LastNameMetadata	Metadata that indicates whether the `lastName` property is editable. This property is read-only..
LockedRecipientPhoneAuthEditable	LockedRecipientPhoneAuthEditable.
LockedRecipientSmsEditable	LockedRecipientSmsEditable.
Name	Name.
NameMetadata	Metadata that indicates whether the `name` property is editable. This property is read-only..
NotaryId	NotaryId.
NotarySignerEmailSent	NotarySignerEmailSent.
Note	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	Metadata that indicates whether the `note` property is editable. This property is read-only..
OfflineAttributes	Reserved for DocuSign..
PhoneAuthentication	When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When true, the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign. .
PhoneNumber	Describes the recipient phone number..
ProofFile	The proof file of the recipient..
RecipientAttachments	Reserved:.
RecipientAuthenticationStatus	Information about the recipient's authentication status. This property is read-only..
RecipientFeatureMetadata	RecipientFeatureMetadata.
RecipientId	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..
RecipientIdGuid	RecipientIdGuid.
RecipientSignatureProviders	RecipientSignatureProviders.
RecipientSuppliesTabs	RecipientSuppliesTabs.
RecipientType	RecipientType.
RecipientTypeMetadata	Metadata that indicates whether the `recipientType` property is editable. This property is read-only..
RequireIdLookup	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	Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only..
RequireSignerCertificate	Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are: * docusign_express - Requires a DocuSign Express certificate. * safe - Requires a SAFE-BioPharma certificate. * open_trust - Requires an OpenTrust certificate. Important: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information. .
RequireSignOnPaper	When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign..
RequireUploadSignature	RequireUploadSignature.
RoleName	Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients..
RoutingOrder	Specifies the routing order of the recipient in the envelope. .
RoutingOrderMetadata	Metadata that indicates whether the `routingOrder` property is editable. This property is read-only..
SentDateTime	The date and time the envelope was sent..
SignatureInfo	Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers..
SignedDateTime	Reserved: For DocuSign use only. .
SignInEachLocation	When set to true, specifies that the signer must sign in all locations..
SignInEachLocationMetadata	Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only..
SigningGroupId	When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once)..
SigningGroupIdMetadata	Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only..
SigningGroupName	The display name for the signing group. Maximum Length: 100 characters. .
SigningGroupUsers	A complex type that contains information about users in the signing group..
SmsAuthentication	When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. .
SocialAuthentications	Lists the social ID type that can be used for recipient authentication..
Status	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	StatusCode.
SuppressEmails	SuppressEmails.
Tabs	The tabs to assign to the recipient. More information..
TemplateLocked	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. .
TemplateRequired	When set to true, the sender may not remove the recipient. Used only when working with template recipients..
TotalTabCount	TotalTabCount.
UserId	UserId.

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.Signer.Equals ( object obj )

inline

Returns true if objects are equal

Parameters

obj	Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.Signer.Equals ( Signer other )

inline

Returns true if Signer instances are equal

Parameters

other Instance of Signer to be compared

Returns: Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.Signer.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

string DocuSign.eSign.Model.Signer.ToJson ( )

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.Signer.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AccessCode

string DocuSign.eSign.Model.Signer.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's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.

◆ AccessCodeMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.AccessCodeMetadata

getset

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

◆ AddAccessCodeToEmail

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

◆ AdditionalNotifications

List<RecipientAdditionalNotification> DocuSign.eSign.Model.Signer.AdditionalNotifications

getset

Gets or Sets AdditionalNotifications

◆ AgentCanEditEmail

string DocuSign.eSign.Model.Signer.AgentCanEditEmail

getset

Gets or Sets AgentCanEditEmail

◆ AgentCanEditName

string DocuSign.eSign.Model.Signer.AgentCanEditName

getset

Gets or Sets AgentCanEditName

◆ AllowSystemOverrideForLockedRecipient

string DocuSign.eSign.Model.Signer.AllowSystemOverrideForLockedRecipient

getset

Gets or Sets AllowSystemOverrideForLockedRecipient

◆ AutoNavigation

string DocuSign.eSign.Model.Signer.AutoNavigation

getset

Gets or Sets AutoNavigation

◆ AutoRespondedReason

string DocuSign.eSign.Model.Signer.AutoRespondedReason

getset

Gets or Sets AutoRespondedReason

◆ BulkRecipientsUri

string DocuSign.eSign.Model.Signer.BulkRecipientsUri

getset

Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.

◆ BulkSendV2Recipient

string DocuSign.eSign.Model.Signer.BulkSendV2Recipient

getset

Gets or Sets BulkSendV2Recipient

◆ CanSignOffline

string DocuSign.eSign.Model.Signer.CanSignOffline

getset

When set to true, specifies that the signer can perform the signing ceremony offline.

◆ ClientUserId

string DocuSign.eSign.Model.Signer.ClientUserId

getset

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

◆ CompletedCount

string DocuSign.eSign.Model.Signer.CompletedCount

getset

Gets or Sets CompletedCount

◆ ConsentDetailsList

List<ConsentDetails> DocuSign.eSign.Model.Signer.ConsentDetailsList

getset

Gets or Sets ConsentDetailsList

◆ CreationReason

string DocuSign.eSign.Model.Signer.CreationReason

getset

Gets or Sets CreationReason

◆ CustomFields

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

◆ DeclinedDateTime

string DocuSign.eSign.Model.Signer.DeclinedDateTime

getset

The date and time the recipient declined the document.

◆ DeclinedReason

string DocuSign.eSign.Model.Signer.DeclinedReason

getset

The reason the recipient declined the document.

◆ DefaultRecipient

string DocuSign.eSign.Model.Signer.DefaultRecipient

getset

Gets or Sets DefaultRecipient

◆ DelegatedBy

DelegationInfo DocuSign.eSign.Model.Signer.DelegatedBy

getset

Gets or Sets DelegatedBy

◆ DelegatedTo

List<DelegationInfo> DocuSign.eSign.Model.Signer.DelegatedTo

getset

Gets or Sets DelegatedTo

◆ DeliveredDateTime

string DocuSign.eSign.Model.Signer.DeliveredDateTime

getset

Reserved: For DocuSign use only.

◆ DeliveryMethod

string DocuSign.eSign.Model.Signer.DeliveryMethod

getset

Reserved: For DocuSign use only.

◆ DeliveryMethodMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.DeliveryMethodMetadata

getset

Reserved for DocuSign.

◆ DesignatorId

string DocuSign.eSign.Model.Signer.DesignatorId

getset

Gets or Sets DesignatorId

◆ DesignatorIdGuid

string DocuSign.eSign.Model.Signer.DesignatorIdGuid

getset

Gets or Sets DesignatorIdGuid

◆ DocumentVisibility

List<DocumentVisibility> DocuSign.eSign.Model.Signer.DocumentVisibility

getset

Gets or Sets DocumentVisibility

◆ Email

string DocuSign.eSign.Model.Signer.Email

getset

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.Signer.EmailMetadata

getset

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

◆ EmailNotification

RecipientEmailNotification DocuSign.eSign.Model.Signer.EmailNotification

getset

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

◆ EmailRecipientPostSigningURL

string DocuSign.eSign.Model.Signer.EmailRecipientPostSigningURL

getset

Gets or Sets EmailRecipientPostSigningURL

◆ EmbeddedRecipientStartURL

string DocuSign.eSign.Model.Signer.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's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]`

◆ ErrorDetails

ErrorDetails DocuSign.eSign.Model.Signer.ErrorDetails

getset

Array or errors.

◆ ExcludedDocuments

List<string> DocuSign.eSign.Model.Signer.ExcludedDocuments

getset

Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to true for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.

◆ FaxNumber

string DocuSign.eSign.Model.Signer.FaxNumber

getset

Reserved:

◆ FaxNumberMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.FaxNumberMetadata

getset

Reserved for DocuSign.

◆ FirstName

string DocuSign.eSign.Model.Signer.FirstName

getset

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

◆ FirstNameMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.FirstNameMetadata

getset

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

◆ FullName

string DocuSign.eSign.Model.Signer.FullName

getset

Gets or Sets FullName

◆ FullNameMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.FullNameMetadata

getset

Reserved for DocuSign.

◆ IdCheckConfigurationName

string DocuSign.eSign.Model.Signer.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 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node.

◆ IdCheckConfigurationNameMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.IdCheckConfigurationNameMetadata

getset

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

◆ IdCheckInformationInput

IdCheckInformationInput DocuSign.eSign.Model.Signer.IdCheckInformationInput

getset

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

◆ IdentityVerification

RecipientIdentityVerification DocuSign.eSign.Model.Signer.IdentityVerification

getset

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

◆ InheritEmailNotificationConfiguration

string DocuSign.eSign.Model.Signer.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's account.

◆ IsBulkRecipient

string DocuSign.eSign.Model.Signer.IsBulkRecipient

getset

When set to true, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. Note that when this is true the email and name for the recipient becomes bulk@.nosp@m.reci.nosp@m.pient.nosp@m..com and "Bulk Recipient". These fields can not be changed for the bulk recipient.

◆ IsBulkRecipientMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.IsBulkRecipientMetadata

getset

Reserved for DocuSign.

◆ LastName

string DocuSign.eSign.Model.Signer.LastName

getset

Gets or Sets LastName

◆ LastNameMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.LastNameMetadata

getset

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

◆ LockedRecipientPhoneAuthEditable

string DocuSign.eSign.Model.Signer.LockedRecipientPhoneAuthEditable

getset

Gets or Sets LockedRecipientPhoneAuthEditable

◆ LockedRecipientSmsEditable

string DocuSign.eSign.Model.Signer.LockedRecipientSmsEditable

getset

Gets or Sets LockedRecipientSmsEditable

◆ Name

string DocuSign.eSign.Model.Signer.Name

getset

Gets or Sets Name

◆ NameMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.NameMetadata

getset

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

◆ NotaryId

string DocuSign.eSign.Model.Signer.NotaryId

getset

Gets or Sets NotaryId

◆ NotarySignerEmailSent

string DocuSign.eSign.Model.Signer.NotarySignerEmailSent

getset

Gets or Sets NotarySignerEmailSent

◆ Note

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

◆ NoteMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.NoteMetadata

getset

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

◆ OfflineAttributes

OfflineAttributes DocuSign.eSign.Model.Signer.OfflineAttributes

getset

Reserved for DocuSign.

◆ PhoneAuthentication

RecipientPhoneAuthentication DocuSign.eSign.Model.Signer.PhoneAuthentication

getset

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

◆ PhoneNumber

RecipientPhoneNumber DocuSign.eSign.Model.Signer.PhoneNumber

getset

Describes the recipient phone number.

◆ ProofFile

RecipientProofFile DocuSign.eSign.Model.Signer.ProofFile

getset

The proof file of the recipient.

◆ RecipientAttachments

List<RecipientAttachment> DocuSign.eSign.Model.Signer.RecipientAttachments

getset

Reserved:

◆ RecipientAuthenticationStatus

AuthenticationStatus DocuSign.eSign.Model.Signer.RecipientAuthenticationStatus

getset

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

◆ RecipientFeatureMetadata

List<FeatureAvailableMetadata> DocuSign.eSign.Model.Signer.RecipientFeatureMetadata

getset

Gets or Sets RecipientFeatureMetadata

◆ RecipientId

string DocuSign.eSign.Model.Signer.RecipientId

getset

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.Signer.RecipientIdGuid

getset

Gets or Sets RecipientIdGuid

◆ RecipientSignatureProviders

List<RecipientSignatureProvider> DocuSign.eSign.Model.Signer.RecipientSignatureProviders

getset

Gets or Sets RecipientSignatureProviders

◆ RecipientSuppliesTabs

string DocuSign.eSign.Model.Signer.RecipientSuppliesTabs

getset

Gets or Sets RecipientSuppliesTabs

◆ RecipientType

string DocuSign.eSign.Model.Signer.RecipientType

getset

Gets or Sets RecipientType

◆ RecipientTypeMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.RecipientTypeMetadata

getset

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

◆ RequireIdLookup

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

◆ RequireIdLookupMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.RequireIdLookupMetadata

getset

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

◆ RequireSignerCertificate

string DocuSign.eSign.Model.Signer.RequireSignerCertificate

getset

Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are: * docusign_express - Requires a DocuSign Express certificate. * safe - Requires a SAFE-BioPharma certificate. * open_trust - Requires an OpenTrust certificate. Important: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information.

◆ RequireSignOnPaper

string DocuSign.eSign.Model.Signer.RequireSignOnPaper

getset

When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign.

◆ RequireUploadSignature

string DocuSign.eSign.Model.Signer.RequireUploadSignature

getset

Gets or Sets RequireUploadSignature

◆ RoleName

string DocuSign.eSign.Model.Signer.RoleName

getset

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

◆ RoutingOrder

string DocuSign.eSign.Model.Signer.RoutingOrder

getset

Specifies the routing order of the recipient in the envelope.

◆ RoutingOrderMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.RoutingOrderMetadata

getset

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

◆ SentDateTime

string DocuSign.eSign.Model.Signer.SentDateTime

getset

The date and time the envelope was sent.

◆ SignatureInfo

RecipientSignatureInformation DocuSign.eSign.Model.Signer.SignatureInfo

getset

Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers.

◆ SignedDateTime

string DocuSign.eSign.Model.Signer.SignedDateTime

getset

Reserved: For DocuSign use only.

◆ SignInEachLocation

string DocuSign.eSign.Model.Signer.SignInEachLocation

getset

When set to true, specifies that the signer must sign in all locations.

◆ SignInEachLocationMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.SignInEachLocationMetadata

getset

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

◆ SigningGroupId

string DocuSign.eSign.Model.Signer.SigningGroupId

getset

When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).

◆ SigningGroupIdMetadata

PropertyMetadata DocuSign.eSign.Model.Signer.SigningGroupIdMetadata

getset

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

◆ SigningGroupName

string DocuSign.eSign.Model.Signer.SigningGroupName

getset

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

◆ SigningGroupUsers

List<UserInfo> DocuSign.eSign.Model.Signer.SigningGroupUsers

getset

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

◆ SmsAuthentication

RecipientSMSAuthentication DocuSign.eSign.Model.Signer.SmsAuthentication

getset

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

◆ SocialAuthentications

List<SocialAuthentication> DocuSign.eSign.Model.Signer.SocialAuthentications

getset

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

◆ Status

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

◆ StatusCode

string DocuSign.eSign.Model.Signer.StatusCode

getset

Gets or Sets StatusCode

◆ SuppressEmails

string DocuSign.eSign.Model.Signer.SuppressEmails

getset

Gets or Sets SuppressEmails

◆ Tabs

Tabs DocuSign.eSign.Model.Signer.Tabs

getset

The tabs to assign to the recipient. More information.

◆ TemplateLocked

string DocuSign.eSign.Model.Signer.TemplateLocked

getset

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.Signer.TemplateRequired

getset

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

◆ TotalTabCount

string DocuSign.eSign.Model.Signer.TotalTabCount

getset

Gets or Sets TotalTabCount

◆ UserId

string DocuSign.eSign.Model.Signer.UserId

getset

Gets or Sets UserId

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

sdk/src/DocuSign.eSign/Model/Signer.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Signer()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AccessCode

◆ AccessCodeMetadata

◆ AddAccessCodeToEmail

◆ AdditionalNotifications

◆ AgentCanEditEmail

◆ AgentCanEditName

◆ AllowSystemOverrideForLockedRecipient

◆ AutoNavigation

◆ AutoRespondedReason

◆ BulkRecipientsUri

◆ BulkSendV2Recipient

◆ CanSignOffline

◆ ClientUserId

◆ CompletedCount

◆ ConsentDetailsList

◆ CreationReason

◆ CustomFields

◆ DeclinedDateTime

◆ DeclinedReason

◆ DefaultRecipient

◆ DelegatedBy

◆ DelegatedTo

◆ DeliveredDateTime

◆ DeliveryMethod

◆ DeliveryMethodMetadata

◆ DesignatorId

◆ DesignatorIdGuid

◆ DocumentVisibility

◆ Email

◆ EmailMetadata

◆ EmailNotification

◆ EmailRecipientPostSigningURL

◆ EmbeddedRecipientStartURL

◆ ErrorDetails

◆ ExcludedDocuments

◆ FaxNumber

◆ FaxNumberMetadata

◆ FirstName

◆ FirstNameMetadata

◆ FullName

◆ FullNameMetadata

◆ IdCheckConfigurationName

◆ IdCheckConfigurationNameMetadata

◆ IdCheckInformationInput

◆ IdentityVerification

◆ InheritEmailNotificationConfiguration

◆ IsBulkRecipient

◆ IsBulkRecipientMetadata

◆ LastName

◆ LastNameMetadata

◆ LockedRecipientPhoneAuthEditable

◆ LockedRecipientSmsEditable

◆ Name

◆ NameMetadata

◆ NotaryId

◆ NotarySignerEmailSent

◆ Note

◆ NoteMetadata

◆ OfflineAttributes

◆ PhoneAuthentication

◆ PhoneNumber

◆ ProofFile

◆ RecipientAttachments

◆ RecipientAuthenticationStatus

◆ RecipientFeatureMetadata

◆ RecipientId

◆ RecipientIdGuid

◆ RecipientSignatureProviders