Name | Description | Type | Additional information |
---|---|---|---|
ServiceBrand |
Service brand |
string |
None. |
Language |
Language. Default - en-us (English). List of supported languages can be retrieved via the endpoint: {baseurl}/api/v1/Lookup/Language |
string |
None. |
DateFormat |
Uses European date format: dd/MM/yyyy hh:mm:ss tt in receipts if set to true |
DateFormatOption |
None. |
LocalTimeZone |
Local time zone |
string |
None. |
AttachXmlServiceEmails |
Attach XML Service emails. Default is false |
boolean |
None. |
SendAcknowledgement |
Sends acknowledgement messages if set to true |
boolean |
None. |
SendUnmarked |
Allows the option to send Registered EmailĀ® messages without banners. |
boolean |
None. |
SendPassword |
Allows the option to send decryption password in a separate email |
boolean |
None. |
SetPassword |
Allows the option to the recipients to set their decryption password. |
boolean |
None. |
RetrievePassword |
Allows the option to the recipients to retrieve decryption password. |
boolean |
None. |
Tls |
Enables TLS for secure messages to destinations that support TLS delivery |
boolean |
None. |
SecureReplyEnabled |
Enable Secure Reply Feature |
SecureReplyEnabledOption |
None. |
MinimumTlsVersion | string |
None. |
|
SecureReplyLandingPage |
Secure reply landing page |
string |
None. |
EsignExpiration |
Expiration time of esign process.The recipient(s) can sign the un-signed contract(s) until the number of days entered in this option before the document expires.Max days allowed is 90. |
integer |
None. |
Annotation |
Annonation value when true, allows signers to annotate the agreement by adding text or scripting on the document with their keyboard and mouse |
boolean |
None. |
HandSignMethod |
HandSignMethod value allows signers to sign the agreement either by adding text or by scripting on the document with their keyboard and mouse or both |
byte |
None. |
EsignSequential |
When set to true, allows to send the E-Sign email to the recipients in a sequential order, otherwise all recipients receive the email for ESign at the same time |
boolean |
None. |
EsignShowClientCode |
When set to true, displays the client code information on the signature certificate page on the signed contract. |
boolean |
None. |
EsignSignaturePageFirst |
0- signature page will be the last page in the final contract,1- signature page will be the first page in final contract.2 - No signature page will be added. |
byte |
None. |
EsignLandingPage |
Page, user is redirected to after the signing process is completed |
string |
None. |
LargeMailDownloadExpiration |
Number of days after the download link expires. Range must be between 1 to 90. |
integer |
None. |
LargeMailDownloadReminder |
Send reminder to recipient in X (Nummber of days before the download link expires). This should not be greater than LargeMailDownloadExpiration value |
integer |
None. |
EnableLargeMailDownloadNotice |
If true Download notice will be sent to the sender when a recipient downloads a file.Default value is true |
boolean |
None. |
SecureMailAttachmentDisplayOption |
Display type for secure attachments - embedded in secure pdf (1), download link (2), both (default - 0) |
integer |
None. |
SecureMailDownloadExpiration |
Number of days after the download link expires. Range must be between 1 to 90. |
integer |
None. |
SecureMailDownloadReminder |
Send reminder to recipient in X (Nummber of days before the download link expires). This should not be greater than LargeMailDownloadExpiration value |
integer |
None. |
EnableSecureMailDownloadNotice |
If true Download notice will be sent to the sender when a recipient downloads a file.Default value is true |
boolean |
None. |
MaxReceiptMessageSize |
Threshold for triggering large receipts.Accepted range is 1-24.5 MB |
decimal number |
None. |
ReceiptCopyDestination |
Copy of receipt will be sent to this destination if specified |
string |
None. |
ReceiptRerouteDestination |
Receipt will be sent to this destination instead of sender if specified |
string |
None. |
EsignContractCopyDestination |
Copy of final/signed contract will be sent to this destination if specified |
string |
None. |
EsignContractRerouteDestination |
Final/signed contract will be sent to this destination instead of sender if specified |
string |
None. |
TrackUnmarkedEmail |
Track unmarked email |
boolean |
None. |
SendRegisteredReplyAck |
Send acknowledgement for registered reply.Options are : 0-None , 1-SenderOnly , 2-RecipientSenderOny 3- Both Original Sender and RecipientSender |
byte |
None. |
SendSecureReplyAck |
Send acknowledgement for secure reply. Options are : 0-None , 1-SenderOnly , 2-RecipientSenderOny 3- Both Original Sender and RecipientSender |
byte |
None. |
SendRegisteredReplyRcpt |
Send receipt for registered reply.Options are : 0-None , 1-SenderOnly , 2-RecipientSenderOny 3- Both Original Sender and RecipientSender |
byte |
None. |
SendSecureReplyRcpt |
Send receipt for secure reply.Options are : 0-None , 1-SenderOnly , 2-RecipientSenderOny 3- Both Original Sender and RecipientSender |
byte |
None. |
CopyMeEnabled | boolean |
None. |
|
EncryptionEnabled | boolean |
None. |
|
EncryptionOption | boolean |
None. |
|
EncryptionOptionCustom | boolean |
None. |
|
EncryptionOptionCustomPassword | string |
None. |
|
EncryptionOptionCustomPasswordEmail | boolean |
None. |
|
ESignEnabled | boolean |
None. |
|
LanguageApp | string |
None. |
|
LargeFileTransferEnabled | boolean |
None. |
|
LargeFileTransferSendAuto | boolean |
None. |
|
LargeFileTransferSendByLargeMail | boolean |
None. |
|
SideNoteEnabled | boolean |
None. |
|
SideNoteCc | boolean |
None. |
|
SideNoteBcc | boolean |
None. |
|
SignatureUrl | string |
None. |
|
SignatureImageUrl | string |
None. |
|
SignatureText | string |
None. |
|
TrackProveEnabled | boolean |
None. |
|
AckRerouteAddress |
Acknowledgement reroute address |
string |
None. |
EsignSignatureAuthentication | boolean |
None. |
|
DocumentAnnotate |
Document annotation - combination of Annotation and AnnotationFreeFormEnabled |
DocumentAnnotateType |
None. |
PrefixRegisteredToSubject |
PrefixRegisteredToSubject |
boolean |
None. |
LargeMailDwnldNoticeCopyAddress |
LargeMailDwnldNoticeCopyAddress |
string |
None. |
LargeMailDwnldNoticeRerouteAddress |
LargeMailDwnldNoticeRerouteAddress |
string |
None. |
SecureMailDwnldNoticeCopyAddress |
SecureMailDwnldNoticeCopyAddress |
string |
None. |
SecureMailDwnldNoticeRerouteAddress |
SecureMailDwnldNoticeRerouteAddress |
string |
None. |
SendSigningNotice | boolean |
None. |
|
RequestReadReceipt |
RequestReadReceipt |
byte |
None. |
OneTimeDownload |
OneTimeDownload |
boolean |
None. |
AllowSigningByNonRecipientAddress |
AllowSigningByNonRecipientAddress |
boolean |
None. |
AttachOfferPDF |
AttachOfferPDF |
boolean |
None. |
DigitalSeal |
DigitalSeal |
boolean |
None. |
RedactSetting | RedactSettingsViewModel |
None. |
|
GenerateEsignTransparency |
GenerateEsignTransparency |
boolean |
None. |
SigningDestinationColor |
SigningDestinationColor |
boolean |
None. |
IsSigningLabel |
IsSigningLabel |
boolean |
None. |
SigningLabelValue |
SigningLabelValue |
integer |
None. |