Fast-Start Guide

This guide is a short tutorial on how to start generating prefilled forms and e-signing them. By following this guide you’ll be able to quickly generate a prefilled bundle of forms and sign them with Docusign.

Once you have these basics down, you can layer in other features and options with Quik! to fully build out your solution and enhance the forms experience for your users.

1. Account Setup

   1. Setting up an account at Quik! requires two initial steps:

      1. Sign up at Quik! Forms

         1. Choose the Premium plan for the Quik! App for the free 14-day trial. Enter your credit card to extend beyond 14 days or speak with our team if you are an enterprise client who has or will be signing an enterprise agreement.

      2. Send an email to support@quikforms.com requesting your API Master Credentials to start using the APIs.

2. API Calls

   1. Authentication:

      1. Get a token via the REST Authentication service using your account Master Credentials (user credentials will not work with Quik! APIs).

      2. See REST Authentication for details on how to request a token.

   2. Generate Forms:

      1. Use the Quik! Forms Engine (QFE) endpoint to run the “execute/html” method to generate an HTML form (or “execute/pdf” for a PDF form).

         1. Swagger: https://websvcs.quikforms.com/rest/QuikFormsEngine/swagger/ui/index#!/QFE/QFE_Execute

         2. Sample Request - this sample request will generate a bundle including FormIDs 12 and 15 (each form in the Quik! library has a unique ID that never changes). The forms will include prefilled fields for owner 1’s First and Last name prefilled with Joe Smith. The return result of this API request will include a URL to a form hosted on the Quik! platform.
            NOTE: The HostFormOnQuik property should only be set to TRUE for testing and should never include actual client data as this method is not a safe place to host real private data.
            {
            "HostFormOnQuik":true,
            "FormFields":[
            {
            "FieldName":"1own.FName",
            "FieldValue":"Joe"
            },
            {
            "FieldName":"1own.LName",
            "FieldValue":"Smith"
            }
            ],
            "QuikFormID":"12,15"
            }

      2. Refer to the "Generate Forms" section in the Quik! API Guide. This section provides detailed instructions on how to generate forms using the Quik! API.

         1. URL: Generate Forms - Quik! Forms Engine Services

3. Pre-fill Forms with Data:

   • To prefill form data, you will pass a value-pair for each field including the field name and field value (e.g. 1own.FName, Tom). A field can also have attributes added in to require the field, set it to read only and more.

   • For more details on prefilling fields and setting attributes, see: AddFieldToForm Method

   • For a full list of fields see: The Quik! Field Definition Guide

4. Enable E-Signatures with DocuSign:

   • To enable e-signing in the Quik! HTML Form Viewer, you will need to connect your Docusign account to Quik! and set a few parameters in the API “execute” method.

   • To connect your Docusign account to Quik! see: Docusign | Create an OAuth Token with Docusign

   • To configure forms to use Docusign follow the steps in the Callback Method: Callback Model | :~:text=How To Use the Callback Method

The above steps will enable you to generate a bundle of forms with two fields of data prefilled and the ability to e-sign the form. You can add more fields to prefill, configure the HTML viewer with a custom logo and more, and enhance the Docusign implementation with additional settings. Please see other sections in this API Guide or ask us for help by emailing support@quikforms.com.