Table of Contents

Class SendForSign

Namespace
BoldSign.Model
Assembly
BoldSign.Api.dll

Send for Sign request DTO.

[DataContract(Name = "SendForSignRequest")]
public class SendForSign : IDocumentUpload
Inheritance
SendForSign
Implements
Derived
Inherited Members

Properties

AutoDetectFields

Gets or sets a value indicating whether to AutoDetect Fields for the document signer.

public bool AutoDetectFields { get; set; }

Property Value

bool

BrandId

Gets or sets the brand id.

[JsonProperty("brandId")]
public string BrandId { get; set; }

Property Value

string

CC

Gets or sets document CC details.

[JsonProperty("cc")]
public IEnumerable<DocumentCC> CC { get; set; }

Property Value

IEnumerable<DocumentCC>

DisableEmails

Gets or sets a value indicating whether to enable DisableEmails. When DisableEmails is enabled, Reminder is automatically ignored.

[JsonProperty("disableEmails")]
public bool DisableEmails { get; set; }

Property Value

bool

DisableExpiryAlert

Gets or sets a value indicating whether Disableexpiryalert is true or false. This property will send the expiry alert email before the day of expiry for the pending signers. If the document expires in one day, the email will be sent before 2 hours of the expiry.

[JsonProperty("disableExpiryAlert")]
public bool? DisableExpiryAlert { get; set; }

Property Value

bool?

DisableSMS

Gets or sets a value indicating whether to enable SMS notification. When DisableSMS is enabled, Reminder is automatically ignored.

[JsonProperty("disableSMS")]
public bool DisableSMS { get; set; }

Property Value

bool

DocumentDownloadOption

Gets or sets a value to customize how the documents are downloaded.

[JsonProperty("documentDownloadOption")]
public DocumentDownloadOption? DocumentDownloadOption { get; set; }

Property Value

DocumentDownloadOption?

DocumentInfo

Gets or sets a documentInfo.

[JsonProperty("documentInfo")]
public IEnumerable<DocumentInfo> DocumentInfo { get; set; }

Property Value

IEnumerable<DocumentInfo>

EnableEmbeddedSigning

Gets or sets a value indicating whether to enable EnableEmbeddedSigning. When EnableEmbeddedSigning is enabled, Reminder is automatically ignored.

[Obsolete("EnableEmbeddedSigning is deprecated, please use DisableEmails instead")]
[JsonProperty("EnableEmbeddedSigning")]
public bool EnableEmbeddedSigning { get; set; }

Property Value

bool

EnablePrintAndSign

Gets or sets a value indicating whether to enable print and sign mode.

[JsonProperty("enablePrintAndSign")]
public bool EnablePrintAndSign { get; set; }

Property Value

bool

EnableReassign

Gets or sets a value indicating whether to enable reassign mode. By Default True.

[JsonProperty("enableReassign")]
public bool EnableReassign { get; set; }

Property Value

bool

EnableSigningOrder

Gets or sets a value indicating whether to enable signing order for the document signer.

public bool EnableSigningOrder { get; set; }

Property Value

bool

ExpiryDateType

Gets or sets the expiry date type.

[JsonProperty("expiryDateType")]
public ExpiryDateType? ExpiryDateType { get; set; }

Property Value

ExpiryDateType?

ExpiryDays

Number of days after which the document will expire.

[Obsolete("ExpiryDays is deprecated, please use ExpiryValue instead.")]
[JsonProperty("expiryDays")]
public int ExpiryDays { get; set; }

Property Value

int

ExpiryValue

Gets or sets the expiry value based on expiry date type.

[JsonProperty("expiryValue")]
public long ExpiryValue { get; set; }

Property Value

long

FileUrls

Gets or sets the File URLs to be uploaded.

[JsonProperty("fileUrls")]
public List<Uri> FileUrls { get; set; }

Property Value

List<Uri>

Files

Gets or sets the files to be uploaded.

[Required]
[JsonProperty("files")]
public List<IDocumentFile> Files { get; set; }

Property Value

List<IDocumentFile>

HideDocumentId

Gets or sets a value indicating whether to remove the document ID watermark from all the PDF pages of the document. Default is false.

[JsonProperty("hideDocumentId")]
public bool? HideDocumentId { get; set; }

Property Value

bool?

Labels

Gets or sets the labels.

[JsonProperty("labels")]
public List<string> Labels { get; set; }

Property Value

List<string>

Message

Gets or sets common message for all the document recipients.

[JsonProperty("message")]
public string Message { get; set; }

Property Value

string

OnBehalfOf

Gets or sets the on behalf of email address.

[JsonProperty("onBehalfOf")]
public string OnBehalfOf { get; set; }

Property Value

string

RecipientNotificationSettings

Gets or sets the Recipient Notification Settings.

[JsonProperty("recipientNotificationSettings")]
[Display(Description = "Recipient Notification Settings of the document.")]
public RecipientNotificationSettings RecipientNotificationSettings { get; set; }

Property Value

RecipientNotificationSettings

ReminderSettings

Gets or sets the reminder settings for the signature request.

[JsonProperty("reminderSettings")]
public ReminderSettings ReminderSettings { get; set; }

Property Value

ReminderSettings

Signers

Gets or sets document Signers details.

[Required]
public IEnumerable<DocumentSigner> Signers { get; set; }

Property Value

IEnumerable<DocumentSigner>

TextTagDefinitions

Gets or sets the text tags definitions declared in the list can be used in the document by using the definition ID.

[JsonProperty("textTagDefinitions")]
public List<TextTagDefinition> TextTagDefinitions { get; set; }

Property Value

List<TextTagDefinition>

Title

Gets or sets title for the signature request.

[JsonProperty("title")]
public string Title { get; set; }

Property Value

string

UseTextTags

Gets or sets a value indicating whether to convert the text tags to form fields.

[JsonProperty("useTextTags")]
public bool UseTextTags { get; set; }

Property Value

bool