...
Table of Contents:
Table of Contents | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Basic Docusign Workflow
E-signing a document with DocuSign Docusign generally requires three major steps:
Creating an envelope containing documents, recipient information, and sign field locations (performed by Quik!)
Calling DocuSign Docusign for the status of the envelope (performed by Customer)
Downloading, processing, archiving, and/or submitting the signed document (performed by Customer)
...
Creating a flattened, read-only PDF with form data
Tagging the form with signature fields with location and role data in XML
Setting up recipients to sign and receive forms, including attributes including:
Signing order
Recipient email addresses
Security settings for identity checks
Initiating the e-sign process with DocuSignDocusign
Due to the complexity of the document, fields, roles, recipients and more, the process to generate the necessary data and final document to send DocuSign Docusign must be performed by a Quik! server. To enable this architecture, Quik! provides web service methods that give customers various methods to perform this first step.
The second and third step, to poll for status and download the final document, is the responsibility of the user interface, workflow and archive system that the customer is using. Since Quik! does not provide or manage the user experience beyond filling out the form and kicking off the e-sign process, the customer must call the DocuSign Docusign API directly using the EnvelopeID to get the status of the envelope and to download the final document for archival and workflow purposes.
...
Using
...
Docusign in Quik!
Important: All customers and partners must have a valid DocuSign Docusign account in order to use Quik! with DocuSign Docusign (Quik! is not a re-seller of DocuSignDocusign).
All Quik! HTML forms are designed for seamless e-signature integration with DocuSignDocusign. While there are three implementation models to integrate DocuSign Docusign with Quik!, the user experience of all three begin with the user clicking the "SIGN" button on the form viewer to start the e-sign process. The form will display an pop-up window (called the e-sign pop-up) that asks for signer information required by DocuSign Docusign (called "envelope information") including signer name, email, authentication type, etc. The user will complete the data fields and click SEND. Depending on the integration method used, this event will then send the form data to either Quik! servers or customer servers to process and create the envelope with DocuSign Docusign so that signers can begin e-signing the form.
Please review the technical requirements below for integrating Quik! with DocuSign Docusign regardless of the implementation model used:.
...
Create an OAuth
...
Token with Docusign
To streamline the process of signing documents, the Quik! Master Account must be set up with an OAuth token for the user/customer's
...
Docusign account.
Tip |
---|
New Method: Create OAuth tokens in the Quik! AppEffective Date: Please note that this new method will be accessible from June 28, 2024, onwards. We encourage transitioning to this new method for enhanced security. |
Login to the Quik! App:
Bookmark this login page: https://quikformsapp.com/
Navigate to Connection Settings:
Go to Settings in the Quik! App.
Select E-Signature.
Click on Add A Connection.
Connect to Docusign:
In the available options, click on the Docusign box. A popup window will display the Docusign authentication screen.
Login to Your Docusign Account:
Enter your email address, click Next.
Enter your password, click Log in.
Grant Access to Quik!:
Allow Quik! access to manage documents on your behalf by clicking Allow Access. This permission remains effective until explicitly revoked.
Configure Your Connection:
Update Connection Name: This will be used later in your form generation API request for the Docusign
AuthUserID
property.Set Connection Visibility: Choose between Public (Available To All Users) or Private (Available To Only You).
Select Docusign Account: Choose the account you want to use for sending envelopes. If you have multiple accounts, select your preferred one; otherwise, the default account will be pre-selected if available.
Finalize the Connection:
Click Add to finalize the setup. Your new Docusign connection is now ready and can be used in the Finalize screen of the Quik! App and by Quik! APIs.
Manage Your Connections:
To view or manage existing connections, navigate to E-Signature → Docusign Properties.
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Legacy Methods: REST API or Quik! Forms Enterprise ManagerPlease Note: We encourage transitioning to our new, more secure method at your convenience. While no date is set, legacy methods will be phased out in the future. |
OAuth tokens can still be set up through the Quik! Forms Enterprise Manager or via web service (REST or SOAP).
Partners
...
offering Quik! to multiple customers
...
must address how each of their customers will
...
establish OAuth tokens on their Quik! accounts.
...
Partners are encouraged to build a user interface that
...
allows customers to enter their
...
Docusign credentials, which
...
are then passed to our web service to establish the token. Quik! only stores the token, which does not
...
expire, allowing customers to change their
...
Docusign password without
...
impacting their integration with Quik!.
...
It is essential for customers to identify their
...
Docusign environment (e.g., NA1, NA2, Demo
...
) to
...
set up the token.
...
If there is uncertainty about which environment to
...
choose, customers should contact their representative at
...
Docusign or check the account environment by navigating to Settings > Plan and Billing within
...
their Docusign account.
...
...
Configuring Docusign Properties for Form Generation
Once a token is established, customers must include the following properties in their Execute request when generating HTML forms:
ESignTypeDocuSign
(establishes DocuSign
)ESignTypeDocusign
: Establishes Docusign as the e-signature service to be used
(indicatesAuthUserID
: Indicates which OAuth token will be used
,.
This comes from the Connection Name that was established upon token generation within the Quik! App
This is also known as ‘CustomerUserID’ when using
CustomerUserID
from the results when calling: GET/docusign/oathtokens
)
(indicatesSignEnvironmentID
: Indicates which
DocuSignDocusign environment will be used, see Docusign environment table below
)
(indicatesSignCallBackURL
orSignURL
: Indicates which implementation model will be used
)
(indicatesQuikFormID
: Indicates which forms will be generated, always required in any Execute request
)Any other
DocuSignDocusign settings (optional - see a complete list of
DocuSignDocusign properties here)
Docusign Environments:
SignEnvironmentID | Environment |
---|---|
1 |
|
2 |
|
3 |
|
4 |
|
5 |
|
9 |
|
10 |
|
11 |
|
12 |
|
13 |
|
14 |
|
15 |
|
16 |
|
...
Lastly, it is important to understand which forms can be e-signed in Quik!. See Enable E-Signatures on Forms for more information on esignability e-signability settings.
Now you are ready to build a DocuSign Docusign integration. See the following sections on using one of the three implementation models.