Developer Resources

The FormXtract API guide helps developers implement these APIs within their own systems.

API Endpoints

This API is available in production (PROD) and testing (UAT) environments.

NOTE: Only use UAT for testing new functionality and not for performing real transactions as UAT data may be erased without notice and/or the UAT environment is not guaranteed to be available 24x7.

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

UAT: https://uatwebsvcs.quikforms.com/rest/quikformxtract/v1000/

Assumptions

• FormXtract business hours are 9am - 3pm in the customer’s local timezone.

  • Any business submitted to FormXtract after 3pm will be delivered by 9am the next business day

• The FormXtract API can only accept TIF and PDF file formats.

• To use FormXtract the form must already exist in Quik! AND be assigned to the customer account for usage.

• The customer’s implementation must store the SubmitDocumentTransID that the FormXtract API returns when a document is submitted - this ID is required for all other subsequent API calls.

• Processing a submitted document will be delayed by 10 minutes to allow for changes and then will take a maximum of 3 hours during business hours. In some cases the FormXtract API may return the data much faster.

• Customers will submit documents to FormXtract one at a time, as they are ready to be submitted - customers should NOT wait or save their documents in order to send them in batches.

API Methods

The FormXtract API is a REST-based service comprised of 5 methods:

• SubmitDocument - Send your document to be processed

• CancelDocument - Cancel your submitted document

• GetDocumentStatus - Get the processing status for your document

• GetData - Download the extracted data

• UpdateData - Mark records for deletion