Purpose
Use the SubmitDocument method to send the document you want FormXtract to read and extract data from.
...
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.
...
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.
Parameter | Type | Required | Description |
|---|---|---|---|
AuthToken | String | Yes | OAuth token to authorize the API call |
Document | Base64 string | Yes | PDF or TIF file to be uploaded |
DocumentFileName | String | No | Quik! will automatically assign the SubmitDocTransID as the file name unless one is provided by the customer in which case the file name will be the SubmitDocTransID + DocumentFileName. |
DocumentUNID | String | No | Customer-provided ID that can be used to link multiple submitted documents together (i.e. a form package). |
DocumentOrder | Number | No | A numeric value representing the order of the documents in a DocumentUNID so the customer can reassemble the document data once returned by Quik!. |
...
Parameter | Type | Description |
|---|---|---|
SubmitDocumentTransID | Integer | Unique identifier for the submitted document IMPORTANT! Save this transaction ID in your system as it is required to get the extracted data or perform any other calls in this API. |
ErrorCode | String | Error code if the operation failed: 0 = Successfully submitted 5 = Documented rejected due to not being valid or supported file type 7 = Exceeds maximum number of pages per period |
ErrorMessage | String | Error message if the operation failed. File could not be validated as a PDF or TIF and was therefore rejected by the system. |
...