Background
Typically when users fill out a form that will be sent to DocuSign, they must click on the Sign button, which will launch the E-Sign Pop-Up. In this window, users can configure several recipient settings for the DocuSign envelope before clicking the Send button, which will create the envelope at DocuSign and begin the signing process.
Customers may want to hide the E-Sign Pop-Up from users by configuring all recipient settings beforehand. This way, when users click the Sign button, the form(s) will be sent to DocuSign without any extra work performed by the user. This page details how to manage this approach for your DocuSign integration.
...
Property Name | Type | Default Value | Description |
|---|---|---|---|
AccessCode | AccessCode | null | Sets the recipient's Access Code |
IdentityCheck | ESignRequireIDCheckName | null | Sets the recipient's Auth type |
Instance | int | 0 | Sets the instance of the role (if using Form Group Instances) |
Order | int | 0 | Sets the recipient's Order |
PhoneNumber | int | 0 | Sets the recipient's PhoneNumber |
SendType | DocusignSendType | null | Sets the recipient's SendType |
Role | string | "" | Required. This is the role to be associated in the form. E.g "1own" for Owner 1. |
ExcludedDocuments | list | null | The form ID(s) of any form you wish to exclude the extra recipient from receiving. See Configuring Document Visibility for other dependencies. |
...
| Code Block | ||
|---|---|---|
| ||
{
"HostFormOnQuik":true,
"QuikFormID":"1",
"PrintEditablePDF":true,
"ESignType":{
"Type":"DocuSign",
"AuthUserID":"gatoso",
"SOBOFlag":"true",
"SignSubject":"test SOBO",
"SignCallBackURL":"http://somecallbackurl.com",
"ShowSignButton":true,
"SignEnvironmentID":2 ,
"AuthTypes":["NoIDCheck", "IDCheck", "SMS","Phone" ]
}
} |
Note: The SocialAll AuthType will show all social related auth types (Google, Facebook, etc.) if provided. Another way to enable social auth methods is by providing each one separately.
Sample Code of DocuSign configuration in XML format (SOAP) setting available AuthType and SendType options
Sample Code
| Code Block | ||
|---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<AuthenticationHeader xmlns="https://websvcs.quikforms.com/quikformsenginews/">
<CustomerID></CustomerID>
<UserName></UserName>
<Password></Password>
</AuthenticationHeader>
</soap:Header>
<soap:Body>
<Execute xmlns="https://websvcs.quikforms.com/quikformsenginews/">
<QFESettings>
<HostFormOnQuik>true</HostFormOnQuik>
<QuikFormID>1</QuikFormID>
<HTMLShowButtonSign>true</HTMLShowButtonSign>
<ShowSignButton>true</ShowSignButton>
<ESignType xsi:type="ESignTypeDocusign">
<SignCallBackURL>http://somecallbackurl.com</SignCallBackURL>
<AuthUserID>selenium</AuthUserID>
<SignEnvironmentID>2</SignEnvironmentID>
<HTMLShowButtonSign>true</HTMLShowButtonSign>
<ShowSignButton>true</ShowSignButton>
<HTMLShowButtonSign>true</HTMLShowButtonSign>
<AuthTypes>
<DocusignAuthType>IDCheck</DocusignAuthType>
<DocusignAuthType>Facebook</DocusignAuthType>
</AuthTypes>
<SendTypes>
<DocusignSendType>EmailToSign</DocusignSendType>
<DocusignSendType>SendCopy</DocusignSendType>
</SendTypes>
</ESignType>
</QFESettings>
</Execute>
</soap:Body>
</soap:Envelope> |
...
Details on this step can be found here.
Alternative Default Recipient Settings by Quik!
A default recipient can also be “hard-coded” into the Quik! system to apply the recipient to every form package created. This feature, which is manually set by the Quik! team, ensures that every package you create is routed to this default recipient last. The ideal use case is for having a notification be sent to an internal inbox that is monitored for completed e-sign transactions.
To set up this feature, Quik! needs you to request this setup with one or more Recipient Names and Recipient Email Addresses. Quik! will then add the record(s) to the e-sign signers for your customer account and add the application setting to turn on default recipients.