Table of Contents

Class EditDocumentSigner

Namespace
BoldSign.Api.Model.EditDocument
Assembly
BoldSign.Api.dll

The edit document signer request.

[DataContract]
public class EditDocumentSigner
Inheritance
EditDocumentSigner
Inherited Members

Properties

AllowFieldConfiguration

Gets or sets a value indicating whether the fields can be configured.

[DataMember(Name = "allowFieldConfiguration", EmitDefaultValue = false)]
public bool? AllowFieldConfiguration { get; set; }

Property Value

bool?

AuthenticationCode

Gets or sets the authentication code.

[DataMember(Name = "authenticationCode", EmitDefaultValue = false)]
[MaxLength(50, ErrorMessage = "The authentication code exceeds the limit of 50 characters.")]
public string AuthenticationCode { get; set; }

Property Value

string

AuthenticationRetryCount

Gets or sets the authentication retry count.

[DataMember(Name = "authenticationRetryCount", EmitDefaultValue = false)]
[Range(1, 10, ErrorMessage = "Authentication retry count should be between 1 and 10.")]
public int? AuthenticationRetryCount { get; set; }

Property Value

int?

AuthenticationSettings

Gets or sets the authentication settings.

[DataMember(Name = "authenticationSettings", EmitDefaultValue = false)]
public AuthenticationSettings AuthenticationSettings { get; set; }

Property Value

AuthenticationSettings

AuthenticationType

Gets or sets the authentication type.

Defaults to None.

[DataMember(Name = "authenticationType", EmitDefaultValue = false)]
public AuthenticationType? AuthenticationType { get; set; }

Property Value

AuthenticationType?

DeliveryMode

Gets or Sets the delivery mode of the signer.

[DataMember(Name = "deliveryMode", EmitDefaultValue = false)]
public DeliveryMode? DeliveryMode { get; set; }

Property Value

DeliveryMode?

EditAction

Gets or sets the edit action to be performed.

[Required]
[DataMember(Name = "editAction", EmitDefaultValue = false)]
public EditAction? EditAction { get; set; }

Property Value

EditAction?

EmailAddress

Gets or sets the email address.

[DataMember(Name = "emailAddress", EmitDefaultValue = false)]
public string EmailAddress { get; set; }

Property Value

string

EnableEmailOTP

Gets or sets a value indicating whether to enable email OTP.

Email OTP takes higher precedence over AuthenticationCode.

[DataMember(Name = "enableEmailOTP", EmitDefaultValue = false)]
public bool? EnableEmailOTP { get; set; }

Property Value

bool?

EnableQes

Gets or sets a value indicating whether to enable qualified electronic signature the document signer.

[DataMember(Name = "enableQes", EmitDefaultValue = false)]
public bool? EnableQes { get; set; }

Property Value

bool?

FormFields

Gets or sets the document form fields such as Sign, Checkbox, Radio buttons etc.

[DataMember(Name = "formFields", EmitDefaultValue = false)]
public IEnumerable<EditFormField> FormFields { get; set; }

Property Value

IEnumerable<EditFormField>

GroupId

Gets or sets the group id.

[DataMember(Name = "groupId", EmitDefaultValue = false)]
public string GroupId { get; set; }

Property Value

string

Gets or sets the group id.

HostEmail

Gets or sets the host email.

[DataMember(Name = "hostEmail", EmitDefaultValue = false)]
public string HostEmail { get; set; }

Property Value

string

Id

Gets or sets the signer id.

[DataMember(Name = "id", EmitDefaultValue = false)]
public string Id { get; set; }

Property Value

string

IdentityVerificationSettings

Gets or sets value for the identity verification settings.

[DataMember(Name = "identityVerificationSettings", EmitDefaultValue = false)]
public IdentityVerificationSettings IdentityVerificationSettings { get; set; }

Property Value

IdentityVerificationSettings

Language

Gets or sets the languages such as English, French, Spanish, German.

[DataMember(Name = "language", EmitDefaultValue = false)]
public Languages? Language { get; set; }

Property Value

Languages?

Remarks

Language is deprecated, please use locales instead.

Locale

Gets or sets the locale such as EN, FR, ES.

[DataMember(Name = "locale", EmitDefaultValue = false)]
public Locales? Locale { get; set; }

Property Value

Locales?

Name

Gets or sets the name.

[DataMember(Name = "name", EmitDefaultValue = false)]
public string Name { get; set; }

Property Value

string

PhoneNumber

Gets or sets the phone number.

[DataMember(Name = "phoneNumber", EmitDefaultValue = false)]
public PhoneNumber PhoneNumber { get; set; }

Property Value

PhoneNumber

PrivateMessage

Gets or sets the private message.

[DataMember(Name = "privateMessage", EmitDefaultValue = false)]
[MaxLength(5000, ErrorMessage = "The private message exceeds the limit of 5000 characters.")]
public string PrivateMessage { get; set; }

Property Value

string

RecipientNotificationSettings

Gets or sets the recipient notification settings.

[DataMember(Name = "recipientNotificationSettings", EmitDefaultValue = false)]
public RecipientNotificationSettings RecipientNotificationSettings { get; set; }

Property Value

RecipientNotificationSettings

SignType

Gets or sets the sign type.

[DataMember(Name = "signType", EmitDefaultValue = false)]
public SignType? SignType { get; set; }

Property Value

SignType?

Gets or sets the sign type of the signer.

SignerOrder

Gets or sets the signer order.

[DataMember(Name = "signerOrder", EmitDefaultValue = false)]
public int? SignerOrder { get; set; }

Property Value

int?

SignerRole

Gets or sets the signer role.

[DataMember(Name = "signerRole", EmitDefaultValue = false)]
public string SignerRole { get; set; }

Property Value

string

SignerType

Gets or sets the signer type.

Defaults to Signer.

[DataMember(Name = "signerType", EmitDefaultValue = false)]
public SignerType? SignerType { get; set; }

Property Value

SignerType?