This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`. It describes information about the notary host. The following information is required when using the eNotary in-person signing flow: * `name`: Specifies the notary's full legal name. * `email`: Specifies the notary's email address. * `recipientId`: A unique ID number for the notary signing host. More...

Inheritance diagram for DocuSign.eSign.Model.NotaryHost:

Public Member Functions
	NotaryHost (string AccessCode=default(string), PropertyMetadata AccessCodeMetadata=default(PropertyMetadata), string AddAccessCodeToEmail=default(string), string AllowSystemOverrideForLockedRecipient=default(string), string AutoRespondedReason=default(string), string BulkSendV2Recipient=default(string), string ClientUserId=default(string), string CompletedCount=default(string), 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 EmbeddedRecipientStartURL=default(string), ErrorDetails ErrorDetails=default(ErrorDetails), string FaxNumber=default(string), PropertyMetadata FaxNumberMetadata=default(PropertyMetadata), string HostRecipientId=default(string), string IdCheckConfigurationName=default(string), PropertyMetadata IdCheckConfigurationNameMetadata=default(PropertyMetadata), IdCheckInformationInput IdCheckInformationInput=default(IdCheckInformationInput), RecipientIdentityVerification IdentityVerification=default(RecipientIdentityVerification), string InheritEmailNotificationConfiguration=default(string), 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), 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), 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 NotaryHost 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 (NotaryHost other)
	Returns true if NotaryHost 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...

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

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

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

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

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

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

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

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

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'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]`
	A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. 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

This object is used only when `inPersonSigningType` in the `inPersonSigner` object is `notary`. It describes information about the notary host. The following information is required when using the eNotary in-person signing flow: * `name`: Specifies the notary's full legal name. * `email`: Specifies the notary's email address. * `recipientId`: A unique ID number for the notary signing host.

Constructor & Destructor Documentation

◆ NotaryHost()

DocuSign.eSign.Model.NotaryHost.NotaryHost	(	string	AccessCode = `default(string)`,
		PropertyMetadata	AccessCodeMetadata = `default(PropertyMetadata)`,
		string	AddAccessCodeToEmail = `default(string)`,
		string	AllowSystemOverrideForLockedRecipient = `default(string)`,
		string	AutoRespondedReason = `default(string)`,
		string	BulkSendV2Recipient = `default(string)`,
		string	ClientUserId = `default(string)`,
		string	CompletedCount = `default(string)`,
		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	EmbeddedRecipientStartURL = `default(string)`,
		ErrorDetails	ErrorDetails = `default(ErrorDetails)`,
		string	FaxNumber = `default(string)`,
		PropertyMetadata	FaxNumberMetadata = `default(PropertyMetadata)`,
		string	HostRecipientId = `default(string)`,
		string	IdCheckConfigurationName = `default(string)`,
		PropertyMetadata	IdCheckConfigurationNameMetadata = `default(PropertyMetadata)`,
		IdCheckInformationInput	IdCheckInformationInput = `default(IdCheckInformationInput)`,
		RecipientIdentityVerification	IdentityVerification = `default(RecipientIdentityVerification)`,
		string	InheritEmailNotificationConfiguration = `default(string)`,
		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)`,
		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)`,
		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 NotaryHost 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..
AllowSystemOverrideForLockedRecipient	AllowSystemOverrideForLockedRecipient.
AutoRespondedReason	AutoRespondedReason.
BulkSendV2Recipient	BulkSendV2Recipient.
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.
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..
DeliveredDateTime	Reserved: For DocuSign use only..
DeliveryMethod	Reserved: For DocuSign use only..
DeliveryMethodMetadata	Reserved for DocuSign..
DesignatorId	DesignatorId.
DesignatorIdGuid	DesignatorIdGuid.
DocumentVisibility	DocumentVisibility.
Email	Email.
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. .
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..
FaxNumber	Reserved:.
FaxNumberMetadata	Reserved for DocuSign..
HostRecipientId	HostRecipientId.
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. .
LockedRecipientPhoneAuthEditable	LockedRecipientPhoneAuthEditable.
LockedRecipientSmsEditable	LockedRecipientSmsEditable.
Name	Name.
NameMetadata	Metadata that indicates whether the `name` property is editable. This property is read-only..
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..
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. .
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.
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..
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..
SignedDateTime	Reserved: For DocuSign use 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	A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients..
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.NotaryHost.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.NotaryHost.Equals ( NotaryHost other )

inline

Returns true if NotaryHost instances are equal

Parameters

other Instance of NotaryHost to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AccessCode

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

getset

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

◆ AddAccessCodeToEmail

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

◆ AllowSystemOverrideForLockedRecipient

string DocuSign.eSign.Model.NotaryHost.AllowSystemOverrideForLockedRecipient

getset

Gets or Sets AllowSystemOverrideForLockedRecipient

◆ AutoRespondedReason

string DocuSign.eSign.Model.NotaryHost.AutoRespondedReason

getset

Gets or Sets AutoRespondedReason

◆ BulkSendV2Recipient

string DocuSign.eSign.Model.NotaryHost.BulkSendV2Recipient

getset

Gets or Sets BulkSendV2Recipient

◆ ClientUserId

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

getset

Gets or Sets CompletedCount

◆ CustomFields

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

getset

The date and time the recipient declined the document.

◆ DeclinedReason

string DocuSign.eSign.Model.NotaryHost.DeclinedReason

getset

The reason the recipient declined the document.

◆ DeliveredDateTime

string DocuSign.eSign.Model.NotaryHost.DeliveredDateTime

getset

Reserved: For DocuSign use only.

◆ DeliveryMethod

string DocuSign.eSign.Model.NotaryHost.DeliveryMethod

getset

Reserved: For DocuSign use only.

◆ DeliveryMethodMetadata

PropertyMetadata DocuSign.eSign.Model.NotaryHost.DeliveryMethodMetadata

getset

Reserved for DocuSign.

◆ DesignatorId

string DocuSign.eSign.Model.NotaryHost.DesignatorId

getset

Gets or Sets DesignatorId

◆ DesignatorIdGuid

string DocuSign.eSign.Model.NotaryHost.DesignatorIdGuid

getset

Gets or Sets DesignatorIdGuid

◆ DocumentVisibility

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

getset

Gets or Sets DocumentVisibility

◆ Email

string DocuSign.eSign.Model.NotaryHost.Email

getset

Gets or Sets Email

◆ EmailMetadata

PropertyMetadata DocuSign.eSign.Model.NotaryHost.EmailMetadata

getset

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

◆ EmailNotification

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

◆ EmbeddedRecipientStartURL

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

getset

Array or errors.

◆ FaxNumber

string DocuSign.eSign.Model.NotaryHost.FaxNumber

getset

Reserved:

◆ FaxNumberMetadata

PropertyMetadata DocuSign.eSign.Model.NotaryHost.FaxNumberMetadata

getset

Reserved for DocuSign.

◆ HostRecipientId

string DocuSign.eSign.Model.NotaryHost.HostRecipientId

getset

Gets or Sets HostRecipientId

◆ IdCheckConfigurationName

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

getset

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

◆ IdCheckInformationInput

IdCheckInformationInput DocuSign.eSign.Model.NotaryHost.IdCheckInformationInput

getset

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

◆ IdentityVerification

RecipientIdentityVerification DocuSign.eSign.Model.NotaryHost.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.NotaryHost.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.

◆ LockedRecipientPhoneAuthEditable

string DocuSign.eSign.Model.NotaryHost.LockedRecipientPhoneAuthEditable

getset

Gets or Sets LockedRecipientPhoneAuthEditable

◆ LockedRecipientSmsEditable

string DocuSign.eSign.Model.NotaryHost.LockedRecipientSmsEditable

getset

Gets or Sets LockedRecipientSmsEditable

◆ Name

string DocuSign.eSign.Model.NotaryHost.Name

getset

Gets or Sets Name

◆ NameMetadata

PropertyMetadata DocuSign.eSign.Model.NotaryHost.NameMetadata

getset

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

◆ Note

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

getset

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

◆ PhoneAuthentication

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

◆ RecipientAttachments

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

getset

Reserved:

◆ RecipientAuthenticationStatus

AuthenticationStatus DocuSign.eSign.Model.NotaryHost.RecipientAuthenticationStatus

getset

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

◆ RecipientFeatureMetadata

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

getset

Gets or Sets RecipientFeatureMetadata

◆ RecipientId

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

getset

Gets or Sets RecipientIdGuid

◆ RecipientType

string DocuSign.eSign.Model.NotaryHost.RecipientType

getset

Gets or Sets RecipientType

◆ RecipientTypeMetadata

PropertyMetadata DocuSign.eSign.Model.NotaryHost.RecipientTypeMetadata

getset

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

◆ RequireIdLookup

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

getset

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

◆ RoleName

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

getset

Specifies the routing order of the recipient in the envelope.

◆ RoutingOrderMetadata

PropertyMetadata DocuSign.eSign.Model.NotaryHost.RoutingOrderMetadata

getset

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

◆ SentDateTime

string DocuSign.eSign.Model.NotaryHost.SentDateTime

getset

The date and time the envelope was sent.

◆ SignedDateTime

string DocuSign.eSign.Model.NotaryHost.SignedDateTime

getset

Reserved: For DocuSign use only.

◆ SigningGroupId

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

getset

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

◆ SigningGroupName

string DocuSign.eSign.Model.NotaryHost.SigningGroupName

getset

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

◆ SigningGroupUsers

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

getset

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

◆ SmsAuthentication

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

getset

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

◆ Status

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

getset

Gets or Sets StatusCode

◆ SuppressEmails

string DocuSign.eSign.Model.NotaryHost.SuppressEmails

getset

Gets or Sets SuppressEmails

◆ Tabs

Tabs DocuSign.eSign.Model.NotaryHost.Tabs

getset

A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.

◆ TemplateLocked

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

getset

Gets or Sets TotalTabCount

◆ UserId

string DocuSign.eSign.Model.NotaryHost.UserId

getset

Gets or Sets UserId

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ NotaryHost()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AccessCode

◆ AccessCodeMetadata

◆ AddAccessCodeToEmail

◆ AllowSystemOverrideForLockedRecipient

◆ AutoRespondedReason

◆ BulkSendV2Recipient

◆ ClientUserId

◆ CompletedCount

◆ CustomFields

◆ DeclinedDateTime

◆ DeclinedReason

◆ DeliveredDateTime

◆ DeliveryMethod

◆ DeliveryMethodMetadata

◆ DesignatorId

◆ DesignatorIdGuid

◆ DocumentVisibility

◆ Email

◆ EmailMetadata

◆ EmailNotification

◆ EmbeddedRecipientStartURL

◆ ErrorDetails

◆ FaxNumber

◆ FaxNumberMetadata

◆ HostRecipientId

◆ IdCheckConfigurationName

◆ IdCheckConfigurationNameMetadata

◆ IdCheckInformationInput

◆ IdentityVerification

◆ InheritEmailNotificationConfiguration

◆ LockedRecipientPhoneAuthEditable

◆ LockedRecipientSmsEditable

◆ Name

◆ NameMetadata

◆ Note

◆ NoteMetadata

◆ PhoneAuthentication

◆ RecipientAttachments

◆ RecipientAuthenticationStatus

◆ RecipientFeatureMetadata

◆ RecipientId

◆ RecipientIdGuid

◆ RecipientType

◆ RecipientTypeMetadata

◆ RequireIdLookup

◆ RequireIdLookupMetadata

◆ RoleName

◆ RoutingOrder

◆ RoutingOrderMetadata

◆ SentDateTime

◆ SignedDateTime

◆ SigningGroupId

◆ SigningGroupIdMetadata

◆ SigningGroupName

◆ SigningGroupUsers

◆ SmsAuthentication

◆ SocialAuthentications

◆ Status

◆ StatusCode

◆ SuppressEmails

◆ Tabs

◆ TemplateLocked

◆ TemplateRequired

◆ TotalTabCount

◆ UserId