GetData Method

AuthToken

String

Yes

OAuth token to authorize the API call

SubmitDocumentTransID

Integer

Yes

Unique identifier for the submitted document

FieldID

Quik!'s unique ID for the field on the form

147906533

QuikFormID

Quik!'s unique FormID for the document that was matched by FormXtract.

47095

PageNumber

The page number in the FormID where the field was found in the found (this not the page in the submitted document).

1

FieldName

The exact field name on the form

1ins.Gender

FieldType

The type of field (text, checkbox, signature)

checkbox

Value

The text or checkbox value extracted off the form. Signature fields will result in signed or not signed.

True

CheckboxValue

The actual value or export value of the checkbox (typically a number, YES, NO, TRUE or FALSE)

1

CheckboxValueLabel

The value represented by the checkbox, or the lookup value in the Quik! Field Definition. Not all checkboxes have lookup values or labels, so use the CheckboxValue in those cases.

Male

Alias

The field name alias, for human readability.

1

EntryType

The result of evaluating the field entry. Possible values are Valid, Invalid, Null or Blank.

An Invalid EntryType means the value could not be determined and must be inspected by the customer.

Valid

MissingInformation

A descriptive block of text that indicates what FormXtract found was missing in the submitted document. Missing information can include missing pages that were expected (e.g. only 4 out 5 pages in the form were processed and the missing page will be listed) and potentially missing data.

Comments

The comments section may contain miscellaneous information like warnings or error messages that did not stop the process but are reported.

FormCompany

The name of the company that owns the form

Equitable Financial - Life Insurance

LitNo

The form company’s internal literature number that represents their form

AXA-Life-2011 (rev. 11/11)

RevisionDate

The date (if any) that the form was last revised by the form company.

9/1/2018

VersionNumber

Quik!'s internal build version for the form - this value helps Quik! identify the right form version in the Quik! library, but does not represent the form company’s own version number.

4

Role

The role of the field, or parent field name in the Quik! Field Definition (e.g. Account Owner, Insured, Prior Account, etc.).

Insured

FieldLabel

The field’s short name in the Quik! Field Definition that is used for displaying the field in a user interface to make the field name easier to read and identify (e.g. “First Name” instead of “FName”)

Gender

RoleSystemName

The level 1 System Name role of the field from the Quik! Field Definition which is a continuous string (e.g. no spaces) that is typically used in software development.

Insured

BaseSystemName

The level 2 System Name field name of the field from the Quik! Field Definition which is a continuous string (e.g. no spaces) that is typically used in software development.

Gender

SubBaseSystemName

The level 3 System Name field name of the field from the Quik! Field Definition which is a continuous string (e.g. no spaces) that is typically used in software development.

FieldDescription

The description of the field’s intended purpose.

Gender

RoleNumber

The instance of the role. For example, the first account owner is role 1 and the second account owner is role 2.

1

FieldInstance

The instance of the field on the form, which will be greater than 1 when there are duplicate fields in the same form, which is common among checkboxes.

1

RefVersionID

The unique ID of this form version in the Quik! system.

This value is only used for debugging and troubleshooting.

849096

RefPageID

The unique ID of the form page the field is found on within the Quik! system.

This value is only used for debugging and troubleshooting.

8604970

SubmitDocumentTransID

Integer

Unique identifier for the submitted document

StatusID

Integer

StatusID of the document:

1 = Not Processed
2 = Submitted for Process
3 = Cancelled
4 = Processed
5 = Rejected
6 = AI Cannot Process

Status

String

Status label of the document:

1 = Not Processed
2 = Submitted for Process
3 = Cancelled
4 = Processed
5 = Rejected
6 = AI Cannot Process

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