ID Scanner configuration file elements - ID Scanner 3.2.1

ID Scanner Plugin Guide 3.2.1
Applies to
ID Scanner 3.2.1
Last updated
2023-03-27
Content type
Guides > Plugin and extension guides
Language
English
Product
ID Scanner
Version
3.2

Identification document rules in the configuration file include the following elements.

Element Description Value type Example
DocumentType The first two characters of the first line, indicating the type of document. String ID
CountryCodes Characters 3 to 5 of the first line, indicating the ICAO country code of the issuing country. String ROU
LineCount The number of MRZ lines in the document. Can be 1, 2, or 3. Integer 2
Fields.Name The name of the IDScanner field to be mapped to the selected MRZ ranges. String DocumentID
Fields.Range Ranges of the MRZ data to be used to form the specified field.
Must be in the following format, where X, Y, and Z are integers:
{
"Line": X,
"Start": Y,
"End": Z
}
  • "Line" is the line index.
  • "Start" is the index of the first character for the range. This starts at 1 for each line.
  • "End" is the index of the last character for the range.
Multiple ranges of MRZ data can be joined to create a value for a single field.
 String 
{
"Line": 2,
"Start": 28,
"End": 29
},
{
"Line": 2,
"Start": 14,
"End": 19
},
{
"Line": 2,
"Start": 30,
"End": 35
}