Versions Compared

Version Old Version 3 New Version 4
Changes made by

Rich Walker

Rich Walker

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

End Point

PROD: https://websvcs.quikforms.com/rest/QuikFormXTract/GetData

...

Parameter

Type

Description

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 so they definitively know which file the data belongs towas 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 (NOTE this may not be final JSON format!)the items below. JSON should nest the FormID and Page Numbers as shown in the sample JSON below, with clear labels for those values.

Code Block
{
  "QuikFormID": {
    "47095": {
      "PageNumber": {
        "1": {
          "FieldID": 147906527,
          "FieldName": "1acc.PlanName",
          "FieldType": "text",
          "Value": "Term 20",
          "CheckboxValue": "",
          "CheckboxValueLabel": "",
          "Alias": "Plan name (profit sharing, pensions, etc)",
          "EntryType": "Valid",
          "MissingInformation": "",
          "Comments": "",
          "FormCompany": "Equitable Financial - Life Insurance",
          "LitNo": "AXA-Life-2011 (rev. 11/11)",
          "RevisionDate": "9/1/2018",
          "VersionNumber": 4,
          "Role": "Account Information",
          "FieldLabel": "Plan name (profit sharing, pensions, etc)",
          "RoleSystemName": "AccountInformation",
          "BaseSystemName": "PlanName",
          "SubBaseSystemName": "",
          "FieldDescription": "Plan name (profit sharing, pensions, etc)",
          "RoleNumber": 1,
          "FieldInstance": 1,
          "RefVersionID": 849096,
          "RefPageID": 8604970
        },
        "2": {
          "FieldID": 147906529,
          "FieldName": "1ins.FName",
          "FieldType": "text",
          "Value": "Andrew",
          "CheckboxValue": "",
          "CheckboxValueLabel": "",
          "Alias": "First Name",
          "EntryType": "Valid",
          "MissingInformation": "",
          "Comments": "",
          "FormCompany": "Equitable Financial - Life Insurance",
          "LitNo": "AXA-Life-2011 (rev. 11/11)",
          "RevisionDate": "9/1/2018",
          "VersionNumber": 4,
          "Role": "Insured",
          "FieldLabel": "First Name",
          "RoleSystemName": "Insured",
          "BaseSystemName": "FirstName",
          "SubBaseSystemName": "",
          "FieldDescription": "First Name",
          "RoleNumber": 1,
          "FieldInstance": 1,
          "RefVersionID": 849096,
          "RefPageID": 8604970
        }
      }
    },
    "499": {
      "PageNumber": {
        "1": {
          "FieldID": 147906530,
          "FieldName": "1ins.MName",
          "FieldType": "text",
          "Value": "Allen",
          "CheckboxValue": "",
          "CheckboxValueLabel": "",
          "Alias": "Middle Name",
          "EntryType": "Valid",
          "MissingInformation": "",
          "Comments": "",
          "FormCompany": "Equitable Financial - Life Insurance",
          "LitNo": "AXA-Life-2011 (rev. 11/11)",
          "RevisionDate": "9/1/2018",
          "VersionNumber": 4,
          "Role": "Insured",
          "FieldLabel": "Middle Name",
          "RoleSystemName": "Insured",
          "BaseSystemName": "MiddleName",
          "SubBaseSystemName": "",
          "FieldDescription": "Middle Name",
          "RoleNumber": 1,
          "FieldInstance": 1,
          "RefVersionID": 849096,
          "RefPageID": 8604970
        }
      }
    }
  }

 

ErrorCode

String

Error code if the operation failed

ErrorMessage

String

Error message if the operation failed

Sample Response

{Insert Sample Response}