Overview

FormXtract is designed for enterprises who must handle, process and extract data off lots of completed forms. The minimum expected volume of a FormXtract customer is 500 pages per month, though customers can scale into millions of pages per month with this service.

Because the pricing of FormXtract is discounted for higher volume usage, customers are encouraged to use FormXtract for virtually any form within their business, not just the most used forms. One of the key challenges businesses face is handling the small volume forms as it’s typically not cost-effective to automate them. Using FormXtract makes it possible to handle any incoming document and by adding more documents into your workflow, your volume will increase and pricing will go down.

Requirements to Use FormXtract

To use Quik! FormXtract you will need the following:

1. A Quik! Enterprise Agreement

2. A Quik! Account (CustomerID, credentials) with the FormXtract product

3. Forms added to the Quik! Library

4. Implement the FormXtract APIs

How You’ll Integrate With FormXtract

To use FormXtract APIs, you’ll do the following:

1. Identify the event or trigger in your workflow to send a completed document to FormXtract

   1. This implies that you have control or possession of a PDF or TIF image of the completed form

2. Implement the SubmitDocument method to send the document to FormXtract.

   1. Optional calls you might implement include the CancelDocument and GetDocumentStatus methods

3. Configure a webhook listener and register your webhook with Quik! to know when form data is ready.

4. Call the GetData FormXtract API endpoint to retrieve your extracted data.

5. Transform the output from FormXtract into your own format to use within your system.

Enterprise Agreement

If you don’t currently have an agreement to use FormXtract, please contact sales@quikforms.com.

While Quik! strives to enable customers to make highly informed decisions about using Quik! products prior to signing an agreement, FormXtract places Quik! in a higher position of risk of transaction costs from using this API that requires the customer to be well-informed and established before test transactions can be sent through. Our agreement easily allows for early termination and refunds if after trying FormXtract you determine it is not the right fit.

Quik! Account

Existing customers can use their current Quik! account with FormXtract by requesting the FormXtract product be added to their list of products (support@quikforms.com).

New customers can sign up for a Quik! App account at Quik! Forms.

NOTE: We ask API and enterprise customers to use the Quik! App as their account manager and a vehicle for testing forms. The signup process requests a credit card to be entered before your 14-day trial ends. By becoming an enterprise customer, your account will become free and will not require a credit card. Be sure to communicate with us so we know to set your account to the correct settings.

Master Credentials

To use our APIs you will need to request your account’s Master Credentials from our support team (support@quikforms.com) or from one of our implementation specialists. Although you may be able to authenticate via our REST Authentication service using your user account, you won’t be able to use the FormXtract API without your master credentials.

Master Credentials are comprised of a CustomerID, Username and Password, which are all assigned by Quik! during the signup process.

Please do NOT share your master credentials with anyone.

Forms Library

FormXtract works by comparing the submitted document to the forms in the Quik! Library. Thus, in order to use FormXtract the customer account the forms the customer wants to submit must be:

1. Built and published in the Quik! forms library

2. Assigned to the customer account for explicit use with FormXtract

Customers who use Quik! App or API to generate form may have access to thousands of forms but may only want to process a subset of those forms using FormXtract. In order to keep FormXtract efficient, the Quik! team will assign only the forms the customer wants to process to the customer account.

When a form is submitted for processing, FormXtract will only compare the received document to the forms that are assigned to the customer account.

For example, lets say the customer has their own New Account Form plus a form for a custodian (“Custodian Form”) and the customer submits both to FormXtract. If the customer’s FormXtract product is only assigned to process the New Account Form then the Custodian Form will result in no matches and no fields being extracted (note: there is still a per page cost to process pages that cannot be matched).

Alternatively, the customer could have both forms assigned to their account, as FormXtract does not care who owns the form, which would result in data being extracted from both forms.

Implementation

The implementation of the FormXtract APIs are in the Developer Resources section of this guide. Our team is here to support you so please work with us closely to ensure a rapid and successful implementation.