End Point
PROD: https://websvcs.quikforms.com/rest/QuikFormXTract/GetDataquikformxtract/v1000/documents/{{submitDocTransId}}/data
Description
Once a document has been processed, the customer is notified about the completion via webhook. Either after the webhook notification is received OR after waiting 3 hours, customers will call the GetData method to retrieve the data from Quik! FormXtract.
...
Parameter | Type | Required | Description |
|---|---|---|---|
AuthToken | String | Yes | OAuth token to authorize the API call |
SubmitDocumentTransID | Integer | Yes | Unique identifier for the submitted document |
Sample Request
{Insert Sample Request}URL: https://websvcs.quikforms.com/rest/quikformxtract/v1000/documents/{{submitDocTransId}}/data
Method: GET
Returned Field Meta Data
Data will be returned in JSON format and is comprised of 26 parameters, as indicated below.
...
Parameter | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
SubmitDocumentTransID | Integer | Unique identifier for the submitted document | ||||||
StatusID | Integer | StatusID of the document: 1 = Not Processed | ||||||
Status | String | Status label of the document: 1 = Not Processed | ||||||
Document | File (Base64 string) | The customer’s original PDF or TIFF file the data was extracted from. | ||||||
DocumentUNID | String | Customer-provided ID that can be used to link multiple submitted documents together (i.e. a form package). | ||||||
DocumentOrder | String | The customer's numeric value of the sort order of this document within the DocumentUNID | ||||||
DocumentFileName | String | The file name the customer gave the submitted document | ||||||
FormDataDetails | Data Object
| Form data and meta data returned in JSON (default) or XML format. Data to return includes the items below. JSON should nest the FormID and Page Numbers as shown in the sample JSON below, with clear labels for those values.
| ||||||
ErrorCode | String | Error code if the operation failed | ||||||
ErrorMessage | String | Error message if the operation failed |
Sample Response
| Code Block | ||
|---|---|---|
| ||
{ "SubmitDocTransId": 51, "StatusId": 4, "Status": "Processed", "Document": "JVBERi0xLjcKJeLjz9MKOTU4...","DocumentUNID": "8f2679d9-bdc2-424f-a889-09dfc617bb13", "DocumentOrder": 1, "DocumentName": "Test", "FormDataDetails": { "QuikFormId": { "12": { "PageNumber": { "2": [ { "FieldId": 179070330, "FieldName": "1own.FName", "FieldType": "text", "Value": "A1", "CheckboxValue": "", "CheckboxValueLabel": "", "Alias": null, "EntryType": null, "MissingInformation": null, "Comments": null, "FormCompany": "American Funds", "LitNo": "MFGEFM-087", "RevisionDate": "2022-04-01T00:00:00", "VersionNumber": 38, "Role": "Owner", "FieldLabel": "First Name", "RoleSystemName": "Owner", "BaseSystemName": "Owner", "SubBaseSystemName": "", "FieldDescription": "First Name", "RoleNumber": 1, "FieldInstance": 1, "RefVersionId": 879581, "RefPageId": 11825159 } ] } }, "24": { "PageNumber": { "4": [ { "FieldId": 123456789, "FieldName": "1own.LName", "FieldType": "text", "Value": "B2", "CheckboxValue": "", "CheckboxValueLabel": "", "Alias": null, "EntryType": null, "MissingInformation": null, "Comments": null, |
...
|
...
|
...
" |
...
FormCompany": " |
...
Form Company", |
...
|
...
" |
...
LitNo": "FORMCO-011", |
...
|
...
|
...
"RevisionDate": " |
...
2022-04-01T00:00:00", |
...
|
...
|
...
|
...
|
...
"VersionNumber": 15, |
...
|
...
|
...
|
...
|
...
|
...
" |
...
Role": |
...
"Owner", |
...
|
...
|
...
|
...
" |
...
FieldLabel": "Last |
...
Name", |
...
|
...
" |
...
RoleSystemName": " |
...
Owner", |
...
|
...
" |
...
BaseSystemName": "Owner", |
...
" |
...
SubBaseSystemName": " |
...
", |
...
|
...
...
|
...
" |
...
FieldDescription": "Last Name", |
...
|
...
|
...
|
...
|
...
|
...
" |
...
RoleNumber": |
...
1, |
...
|
...
" |
...
FieldInstance": |
...
3, |
...
|
...
|
...
|
...
|
...
"RefVersionId": 666666, |
...
|
...
|
...
|
...
" |
...
RefPageId": |
...
12345678 |
...
|
...
|
...
} |
...
|
...
|
...
|
...
] |
...
|
...
|
...
} |
...
|
...
} |
...
} } |
...
...
ErrorCode
...
String
...
Error code if the operation failed
...
ErrorMessage
...
String
...
Error message if the operation failed
Sample Response
...
} |