Registration parameters file structure

This reference describes the JSON file that defines registration parameters for the FlexiCapture Mobile Client.

File contents

The file must be encoded in UTF-8 and contain the following:

The registration parameters of documents, for the Document Definitions used in the project
The registration parameters of batches, for the Batch types used in the project
The registration parameters for unidentified documents, from the Batch types

Lists of registration parameters for unidentified documents let Operators enter parameters without specifying the document type.

Make sure the Document Definition names and Batch type names match the names used in the FlexiCapture project.

Parameter fields

Describe each registration parameter with the following fields:

Field	Description	Possible values
`name`	Name of the parameter shown in the Mobile Client interface. It identifies the parameter and must be unique within a batch’s or document type’s group of parameters.	Any text
`isRequired`	Marks the parameter as mandatory. If the field is absent, the parameter is optional. Mandatory parameters are checked before sending.	`true` \| `false`
`isHidden`	Hidden parameters are not shown on the device. Automatically filled parameters can be hidden.	`true` \| `false`
`type`	How the parameter is filled in on the device. This field is mandatory. See Parameter types.	A parameter type
`listValues`	Values for a `list`-type parameter. Cannot be used with other types.	The values shown in the drop-down list on the device

For a non-mandatory list parameter, a blank value appears at the top of the list and is selected by default. For a mandatory list parameter, there is no default blank value and the first value is selected instead, so the field is not highlighted in red on the device. You can add a blank value to the list manually ("").

Parameter types

The type field accepts the following values:

Type	How the value is filled in
`text`	Entered from a keyboard or by voice input
`list`	Selected from a drop-down menu
`autoGeo`	Filled automatically with GPS coordinates
`autoDate`	Filled automatically with the current date
`autoDeviceId`	Filled automatically with the device ID
`autoName`	Filled automatically with the Operator’s login

Example file

{
  "batchTypesInfo": [
    {
      "batchTypeName": "",
      "batchTypeRegParams": [],
      "unidentifiedDocDefinition": []
    },
    {
      "batchTypeName": "Mortgage",
      "batchTypeRegParams": [
        {
          "name": "Property value ($)",
          "type": "text"
        },
        {
          "name": "Loan amount ($)",
          "isRequired": true,
          "type": "text"
        },
        {
          "name": "Preferred rate type",
          "type": "list",
          "listValues": ["Fixed rates", "Amortized adjustable rates", "Interest-only adjustable rates"]
        },
        {
          "name": "Real estate agent",
          "isHidden": false,
          "type": "autoname"
        },
        {
          "name": "Device id",
          "type": "autodeviceid"
        },
        {
          "name": "Location",
          "type": "autogeo"
        },
        {
          "name": "Date",
          "type": "autodate"
        }
      ]
    },
    {
      "batchTypeName": "Mortgage Supporting Documents",
      "batchTypeRegParams": [
        {
          "name": "Property value ($)",
          "type": "text"
        },
        {
          "name": "Loan amount ($)",
          "isRequired": true,
          "type": "text"
        },
        {
          "name": "Preferred rate type",
          "type": "list",
          "listValues": ["Fixed rates", "Amortized adjustable rates", "Interest-only adjustable rates"]
        },
        {
          "name": "Real estate agent",
          "isHidden": false,
          "type": "autoname"
        },
        {
          "name": "Device id",
          "type": "autodeviceid"
        },
        {
          "name": "Location",
          "type": "autogeo"
        },
        {
          "name": "Date",
          "type": "autodate"
        }
      ],
      "unidentifiedDocDefinition": [
        {
          "name": "Real estate agent",
          "isHidden": false,
          "type": "autoname"
        },
        {
          "name": "Device id",
          "type": "autodeviceid"
        },
        {
          "name": "Location",
          "type": "autogeo"
        },
        {
          "name": "Date",
          "type": "autodate"
        }
      ]
    }
  ],
  "DocDefinitionsInfo": [
    {
      "DocDefinitionName": "US Passport",
      "DocDefinitionRegParams": [
        {
          "name": "Property value ($)",
          "type": "text"
        },
        {
          "name": "Loan amount ($)",
          "isRequired": true,
          "type": "text"
        },
        {
          "name": "Preferred rate type",
          "type": "list",
          "listValues": ["Fixed rates", "Amortized adjustable rates", "Interest-only adjustable rates"]
        },
        {
          "name": "Real estate agent",
          "isHidden": false,
          "type": "autoname"
        },
        {
          "name": "Device id",
          "type": "autodeviceid"
        },
        {
          "name": "Location",
          "type": "autogeo"
        },
        {
          "name": "Date",
          "type": "autodate"
        }
      ]
    },
    {
      "DocDefinitionName": "W-2 Form",
      "DocDefinitionRegParams": [
        {
          "name": "Total wages",
          "type": "text"
        }
      ]
    }
  ]
}

Verification Station

Invoice Operator's Guide

Mobile Client

Web Capture Station

Web Scanning Station

Web Verification Station

Web Data Verification

Monitoring Console

Web Authentication

Registration parameters file structure

File contents

Parameter fields

Parameter types

Example file

​File contents

​Parameter fields

​Parameter types

​Example file

File contents

Parameter fields

Parameter types

Example file