SubmitDocument Method

Purpose

Use the SubmitDocument method to send the document you want FormXtract to read and extract data from.

End Point

PROD: https://websvcs.quikforms.com/rest/quikformxtract/v1000/documents

Description

The SubmitDocument method enables a customer to send a document to Quik! FormXtract to read the data off of the form.

This method accepts a document in multi-page TIF or PDF format. A document may contain one or more pages, representing one or more forms. For best practices, it is recommended to only send one form (e.g the document matching the form in the Quik! Form library) by splitting your original document into it’s requisite parts.

NOTE: If splitting a document is not feasible, it’s ok, just submit the original document and let FormXtract do it’s best.

How To Track Split Documents in FormXtract

If a document contains multiple forms, as many transactions often do, the most efficient way to use FormXtract is to submit one form at a time. However, by doing this you may need to reassemble the individual forms back into a single document once the data has been extracted.

To track your split document, there are two optional parameters to send: DocumentUNID and DocumentOrder. The DocumentUNID is your unique document identifier (e.g. a file name or transaction ID, etc.). The DocumentOrder is the original order each split document has in the original file.

For example, if your document is a New Account Form, a Transfer Form and an Order Ticket, represented by a transaction ID of ABC123, then your API calls would consist of:

1. FormXtract Call #1 - New Account Form

   1. DocumentUNID = ABC123

   2. DocumentOrder = 1

2. FormXtract Call #2 - Transfer Form

   1. DocumentUNID = ABC123

   2. DocumentOrder = 2

3. FormXtract Call #3 - Order Ticket

   1. DocumentUNID = ABC123

   2. DocumentOrder = 3

Splitting a document into it’s individual forms helps avoid data problems when a form package contains multiple copies of the same form (e.g. 3 transfer forms sent to Quik! FormXtract at the same time may be difficult to know which pages belong together if the sort order of the pages is not perfect).

While FormXtract will process any number of forms bundled together in a single request, splitting documents into individual requests will yield the best results.

10-Minute Delay

Requests to the SubmitDocument process are automatically delayed for 10 minutes to allow customers 10 minutes to Cancel the request if needed.

Request

To send a form to FormXtract, the customer will first get an AuthToken from the REST Authentication service. To call the SubmitDocument method send the AuthToken and the document file in a base64 string.

Optionally, the customer can include a DocumentFileName, DocumentUNID and DocumentOrder values to be used by the customer to associate multiple SubmitDocument requests together upon return of the data from FormXtract.

IMPORTANT! The response from the SubmitDocument method will include a SubmitDocumentTransID that represents the submitted document in FormXtract - this value MUST BE SAVED in your system for future calls of the FormXtract API.

Sample Request

URL: https://websvcs.quikforms.com/rest/quikformxtract/v1000/documents

Method: POST

Content-type: application/json

Body:

Response

The response from the SubmitDocument API will include a unique transaction ID from Quik! (SubmitDocumentTransID) and any error responses, including a success message.

Sample Response