Configuring your SIGNiX Integration

Enterprise customers who build their application on the Quik! Forms Engine often want the ability to e-sign forms from directly within their own application and environment. In order to send a Quik! Form to SIGNiX, the data and the document must be transformed by Quik! and prepared to be sent to SIGNiX. Simply configure the relevant properties in the Quik! Forms Engine, and Quik! handles the back-end communication with SIGNiX APIs. 

When integrating with Quik! and SIGNiX, follow the steps below

Setup Details

Quik! hosts a REST API that manages all interactions with SIGNiX. This approach is the most simple to implement but the least flexible. For example, the customer will not be able to perform business logic after posting the data to the SignURL and BEFORE calling Signix. The only part of the process where the customer can have some control is AFTER our system calls Signix (See SignCallBackURL property below).

To e-sign forms with SIGNiX follow the steps below:

1. (REQUIRED) Add valid SIGNiX credentials to your Quik! account using either:

   1. the E-Signature Setup page in the Quik! Forms Enterprise Manager (details here), or

   2. the E-Signature REST API (details here)

2. (REQUIRED) Set ESignType property to Signix

3. (OPTIONAL) Set the SignCallBackURL property if you would like to receive the Signix response after the transaction was successful. This property is a customer-defined URL for the Quik! Form to post the SIGNiX data so customer's system knows the transaction is complete. 

4. (REQUIRED) Set the SignEnvironmentID property to the appropriate Signix environment (Demo or Prod)

5. (REQUIRED) Set the SignixSubmitterName and SignixSubmitterEmail properties to the name and email to be used as the sender in the implementation. If these two are not provided, the Sign button will not display.

6. (OPTIONAL) Set any custom Signix configurations with other supported Signix properties in the Quik! Forms Engine

SignCallBackURL JSON Format

When you build your web page to receive the transaction you'll need to respond to the form in JSON format. The format is as follows:

The StatusCode of 0 tells the form that the event was successful, any other code is a failure. The status message can be anything you want to display to the user.

NOTE: 

• If StatusCode is "0", the form will display whatever is provided in a "Message" property of the callback response, or a default message of: "Your form has been submitted for signature. Each recipient will receive an email to begin the signature process. Check your email for signature updates."

• If StatusCode is not "0" (indicating a failure), the form will display whatever is provided in a "StatusMessage" property of the callback response, or a default message of: "There was no message response from the CallBack URL. Plase contact an administrator."

Runtime Process Details

After the above setup is complete, the following process will take place when a user clicks the Sign button on a launched form:

1. The user clicks the "Sign" button, which captures the data needed for signing.

   1. The Sign button event displays the Quik! Form's e-sign popup screen.

   2. User enters relevant signing data and clicks the SEND button.

   3. The SEND event posts the form data directly to Quik! (https://websvcs.quikforms.com/rest/esignature/signix/sign)

2. Quik! starts a transaction with SIGNiX
   
   

   1. Quik! uses the provided Signix credentials information stored by Quik! and then calls the Signix Api to start the transaction

3. Signix responds with either a success or a failure. If a failure is returned, the Quik! Form (HTML window) will alert the error message from SIGNiX.

4. If successful, Quik! responds to user's Quik! Form (HTML window) with a successful message.  

   1. The transaction's metadata, including the SIGNiX Transaction ID, is stored with the QFVUNID in the Quik! system for later retrieval by the customer via web service as a backup method for retrieving e-sign transactions.

5. If using CallBack Url, the user's Quik! Form posts the SIGNiX response to the Customer's SignCallBackURL in JSON format along with any status message returned by the signing process

   1. The customer's server should then respond in JSON format to the user's form with a StatusCode and StatusMessage properties. 

6. Assuming a successful transaction was started, signers will begin receiving emails from Signix inviting them to e-sign the forms.

7. Once everyone has signed, customer can independently access and download the documents from Signix by logging into their Signix account.