/
Enable Esignature
Enable Esignature
Our REST service allows the user to specify which ESign type they want to use in the forms. Currently, we support one of: Docusign, Signix and Native Esign. Each of them are represented as a JSON object, and this json must be set in the "ESignType" property. It is very important to include the property "Type" as the first property of the Esign JSON object, or else the signature won't be enabled. The structure for all three are described as follows.
DocuSign
Docusign JSON
{ "Type":"DOCUSIGN", "AllowMarkup":true, "AllowReassign":true, "AllowRecipientRecursion":true, "Asynchronous":true, "AuthoritativeCopy":true, "AuthUserID":"string", "AutoNavigation":true, "BrandId":"string", "BrandLock":true, "CustomFields":{ "ListCustomFields":[ { "ListItems":[ "string" ], "Name":"string", "Required":true, "Show":true, "Value":"string" } ], "TextCustomFields":[ { "Name":"string", "Required":true, "Show":true, "Value":"string" } ] }, "EmailSettings":{ "BccEmailAddresses":[ "string" ], "ReplyEmailAddressOverride":"string", "ReplyEmailNameOverride":"string" }, "EnableWetSign":true, "EnforceSignerVisibility":true, "ESignMetaData":{ "AccountCode":"string", "ClientCode":"string", "FirmCode":"string", "RepCode":"string" }, "HTMLButtonSignName":"string", "MessageLock":true, "Notification":{ "Expirations":{ "ExpireAfter":0, "ExpireEnabled":true, "ExpireWarn":0 }, "Reminders":{ "ReminderDelay":0, "ReminderEnabled":true, "ReminderFrequency":0 }, "UseAccountDefaults":true }, "RecipientsLock":true, "SenderUserID":"string", "SignAllDocsCombined":true, "SignCallBackURL":"string", "SignEnvironmentID":0, "SignErrorMessage":"string", "SignHideEmptySigners":true, "SigningLocation":0, "SignJavascript":"string", "SignMessage":"string", "SignMultipleDocs":true, "SignOrderLock":true, "SignRequireIDCheck":true, "SignRequireIDCheckName":0, "SignSendJavascript":"string", "SignShowAccessCode":true, "SignShowVerifyCode":true, "SignShowVerifyIDCheck":true, "SignSubject":"string", "SignTransDescription":"string", "SignURL":"string", "SOBOFlag":true, "TransactionId":"string", "UseDisclosure":true, "Recipients": { "Signers": [ { "AccessCode": { "Code": "string", "ReadOnly": true, "Required": true }, "IdentityCheck": "string", "Instance": 0, "Order": 1, "PhoneNumber": 0, "Role": "string", "SendType": "string" }, { "AccessCode": { "Code": "string", "ReadOnly": true, "Required": true }, "IdentityCheck": "string", "Instance": 0, "Order": 1, "PhoneNumber": 0, "Role": "string", "SendType": "string" } ], "ExtraRecipients": [ { "AccessCode": { "Code": "string", "ReadOnly": true, "Required": true }, "IdentityCheck": "string", "Order": 0, "Name": "string", "Email": "string", "PhoneNumber": 0, "RecipientNumber": 0 }, { "AccessCode": { "Code": "string", "ReadOnly": true, "Required": true }, "IdentityCheck": "string", "Order": 0, "Name": "string", "Email": "string", "PhoneNumber": 0, "RecipientNumber": 0 } ] } }
NativeESign
NativeESign JSON
{ "Type": "NATIVEESIGN", "HTMLButtonSignName": "string" }
Signix
Signix JSON
{ "Type":"SIGNIX", "ESignMetaData":{ "AccountCode":"string", "ClientCode":"string", "FirmCode":"string", "RepCode":"string" }, "HTMLButtonSignName":"string", "SignAllDocsCombined":true, "SignCallBackURL":"string", "SignEnvironmentID":0, "SignErrorMessage":"string", "SignHideEmptySigners":true, "SignixAuthTypeShow":[ 1 ], "SignixBillingRef":"string", "SignixClientPrefAllowSignatureGraphic":0, "SignixClientPrefAuditTrailWithCC":0, "SignixClientPrefAutoAdvanceToNextDocument":0, "SignixClientPrefAutoAdvanceToNextSignature":0, "SignixClientPrefAutoOpenFirstDocument":0, "SignixClientPrefBrowserAutofill":0, "SignixClientPrefDateSignedFormat":0, "SignixClientPrefDateSignedTimeZone":0, "SignixClientPrefEnable21CFRPart11CompliantMode":0, "SignixClientPrefMiddleName":0, "SignixClientPrefMustSignFirstDocumentFirst":0, "SignixClientPrefNextPartyLink":0, "SignixClientPrefNotificationSchedule":"string", "SignixContactInfo":"string", "SignixDateSignedFormat":0, "SignixDateSignedTimeZone":0, "SignixDeliveryType":1, "SignixDemo":true, "SignixDistributeToSubmitter":true, "SignixDistributionEmailContent":"string", "SignixDistributionEmailList":"string", "SignixDocSetDescription":"string", "SignixExpireAfter":"string", "SignixShowSignNow":true, "SignixSubmitterEmail":"string", "SignixSubmitterEmailList":"string", "SignixSubmitterName":"string", "SignixSuspendOnStart":true, "SignixWorkgroup":"string", "SignJavascript":"string", "SignMessage":"string", "SignMultipleDocs":true, "SignOrderLock":true, "SignSendJavascript":"string", "SignShowVerifyCode":true, "SignURL":"string" }
Example
In order to use Docusign, for example, this is a valid json body:
Docusign example
{ "ESignType":{ "Type":"DOCUSIGN", "SignCallBackURL":"https://test.com" }, "HostFormOnQuik":true, "QuikFormID":"1" }
Related content
How to Configure Recipient Settings
How to Configure Recipient Settings
Read with this
How to Configure Optional Signature Fields
How to Configure Optional Signature Fields
More like this
Docusign E-Signature Pop-Up
Docusign E-Signature Pop-Up
Read with this
How to Configure SetContentTypeCallBackURL Property
How to Configure SetContentTypeCallBackURL Property
More like this
Callback Model
Callback Model
Read with this
E-Sign MetaData Services
E-Sign MetaData Services
More like this
For help regarding Quik! Forms and the Quik! API
Email: support@quikforms.com | Phone: (877) 456-QUIK