ScanView Configuration


Schema for SDK JSON configurations

No Additional Properties

Type: object

The following properties are required:

  • viewPluginConfig
Type: object

The following properties are required:

  • viewPluginCompositeConfig

Type: string

An optional description for the entire ScanView configuration.

Type: object

Schema for SDK Camera Configuration

No Additional Properties

Type: string

The preferred resolution for video capture (720, 720p, 1080, 1080p). This resolution is used to process images for scanning.

Type: string

The preferred resolution for taking images (720, 720p, 1080, 1080p).

Type: string Default: "BACK"

The preferred camera of the device (FRONT, BACK, EXTERNAL, EXTERNAL_FRONT).

Type: boolean Default: false

This flag enables or disables the zoom gesture if supported.

Type: number Default: 0

The focal length.

Type: number Default: 0

The zoom ratio.

Type: number Default: 0

The maximum zoom ratio.

Type: number Default: 0

The maximum focal length.

Type: array of string

Optional cameras to fall back if the defaultCamera is not found.

No Additional Items

Each item of this array must be:

Type: object

Schema for SDK Flash Configuration

No Additional Properties

Type: enum (of string) Default: "none"

The flash mode.

Must be one of:

  • "none"
  • "auto"
  • "manual"
  • "manual_off"
  • "manual_on"

Type: enum (of string) Default: "top_left"

The alignment of the flash button.

Must be one of:

  • "top"
  • "top_left"
  • "top_right"
  • "bottom"
  • "bottom_left"
  • "bottom_right"

Type: object

An optional offset (in dp) for the flash button.

No Additional Properties

Type: integer Default: 0

Type: integer Default: 0

Type: string

The asset name of the icon to be displayed when the flash is on.

Type: string

The asset name of the icon to be displayed when the flash is off.

Type: string

The asset name of the icon to be displayed when the flash is set to auto.

Type: object

Schema for SDK ViewPlugin Configuration

No Additional Properties

Type: object

General configuration for scan plugins

No Additional Properties

Type: object

The following properties are required:

  • id

Type: object

The following properties are required:

  • barcodeConfig
Type: object

The following properties are required:

  • meterConfig
Type: object

The following properties are required:

  • odometerConfig
Type: object

The following properties are required:

  • universalIdConfig
Type: object

The following properties are required:

  • mrzConfig
Type: object

The following properties are required:

  • japaneseLandingPermissionConfig
Type: object

The following properties are required:

  • vehicleRegistrationCertificateConfig
Type: object

The following properties are required:

  • licensePlateConfig
Type: object

The following properties are required:

  • tinConfig
Type: object

The following properties are required:

  • tireSizeConfig
Type: object

The following properties are required:

  • commercialTireIdConfig
Type: object

The following properties are required:

  • tireMakeConfig
Type: object

The following properties are required:

  • vinConfig
Type: object

The following properties are required:

  • containerConfig
Type: object

The following properties are required:

  • ocrConfig

Type: string

Sets a name for the scan plugin.

Type: boolean Default: true

Sets whether or not to continue scanning once a result is found.

Type: integer Default: 0

Sets an initial time period where scanned frames are not processed as results.

Value must be greater or equal to 0 and lesser or equal to 1000000

Type: array

Allows to fine-tune a list of options for plugins.

No Additional Items

Each item of this array must be:

Type: object

Describes a start variable for fine-tuning plugins.

No Additional Properties

Type: string

The key of the variable.

Type: string, number, integer or boolean

The value of the variable.

Type: object

Configuration for scanning barcodes

No Additional Properties

Type: boolean Default: false

Setting this to 'true' will enable reading multiple barcodes per frame.

Type: boolean Default: false

If this option is set, barcodes parsed according to the AAMVA standard. This only works for PDF417 codes on driving licenses.

Type: boolean Default: false

If this option is set, allows consecutive barcode results of the same barcode when scanning continuously.

Type: boolean Default: false

Sets whether or not to disable advanced barcode scanning even if the license supports it.

Type: array of enum (of string)

Set this to filter which barcode formats should be scanned. Setting 'ALL' will enable scanning all supported formats.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "ALL"
  • "ONE_D_INVERSE"
  • "AZTEC"
  • "AZTEC_INVERSE"
  • "BOOKLAND"
  • "CODABAR"
  • "CODE_11"
  • "CODE_32"
  • "CODE_39"
  • "CODE_93"
  • "CODE_128"
  • "DATABAR"
  • "COUPON"
  • "DATA_MATRIX"
  • "DISCRETE_2_5"
  • "DOT_CODE"
  • "EAN_8"
  • "EAN_13"
  • "GS1_QR_CODE"
  • "GS1_128"
  • "ITF"
  • "ISSN_EAN"
  • "ISBT_128"
  • "KIX"
  • "MATRIX_2_5"
  • "MSI"
  • "MICRO_QR"
  • "MICRO_PDF"
  • "PDF_417"
  • "POST_UK"
  • "QR_CODE"
  • "QR_INVERSE"
  • "RSS_14"
  • "RSS_EXPANDED"
  • "TRIOPTIC"
  • "UPC_A"
  • "UPC_E"
  • "UPC_EAN_EXTENSION"
  • "UPU_FICS"
  • "USPS_4CB"
  • "US_PLANET"
  • "US_POSTNET"
  • "MAXICODE"

Type: object

Configuration for scanning meters

No Additional Properties

Type: enum (of string) Default: "auto_analog_digital_meter"

Determines which types of meters to scan.

Must be one of:

  • "auto_analog_digital_meter"
  • "dial_meter"
  • "multi_field_digital_meter"
  • "digital_meter_2_experimental"

Type: integer

Sets a minimum confidence which has to be reached in order to trigger a scan result.

Type: integer Default: -1

Defines the maximum number of read decimal digits for values >=0. Negative values mean all decimal digits are read. Currently implemented only for the "autoanalogdigital_meter" scan mode.

Type: string

Sets a regular expression which the scanned text needs to match in order to trigger a scan result.

Type: object

Configuration for scanning odometers

No Additional Properties

Type: integer

Sets a minimum confidence which has to be reached in order to trigger a scan result.The value has to be between 0 and 100. Defaults to 60.

Value must be greater or equal to 0 and lesser or equal to 100

Type: string

Sets a regular expression which the scanned text needs to match in order to trigger a scan result.

Type: object

Configuration for scanning all kinds of identification documents

No Additional Properties

Type: enum (of string) Default: "latin"

Sets a specific character set.

Must be one of:

  • "latin"
  • "arabic"
  • "cyrillic"

Type: object

Specifies the document types to be scanned and optionally further specifies which types of layout are scanned per type.

No Additional Properties

Type: array of string

Sets a set of layouts to be included by the scanner. If none are set, every supported layout is included.

No Additional Items

Each item of this array must be:

Type: string
Must match regular expression: ([A-Z]{2}(-[A-Z]{2,3})?_[A-Z]{3}_[A-Z]+_[A-Z0-9]+(-[A-Z0-9]+)*_(F|B)(_v[0-9])?)

Type: array of string

Sets a set of layouts to be included by the scanner. If none are set, every supported layout is included.

Same definition as mrz

Type: array of string

Sets a set of layouts to be included by the scanner. If none are set, every supported layout is included.

Same definition as mrz

Type: array of string

Sets a set of layouts to be included by the scanner. If none are set, every supported layout is included.

Same definition as mrz

Type: object

Contains all the supported field scan options for MRZ.

No Additional Properties

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

No Additional Properties

Type: enum (of string) Default: "default"

The scanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior. Default behavior is one of the other three that yields the best recall results with all layouts enabled.

Must be one of:

  • "mandatory"
  • "optional"
  • "disabled"
  • "default"

Type: integer

Set the minConfidence which has to be reached in order to trigger a scan result. The value has to be between 0 and 100. Defaults to 60.

Value must be greater or equal to 0 and lesser or equal to 100

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Contains all the supported field scan options for driving licenses.

No Additional Properties

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Contains all the supported field scan options for ID front cards.

No Additional Properties

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Contains all the supported field scan options for insurance cards.

No Additional Properties

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: object

Configures scanning options for ID fields in order to fine-tune the ID scanner.

Same definition as vizAddress

Type: boolean Default: false

Sets whether the face detection approach is enabled.

Type: object

Configuration for scanning machine-readable zones (MRZ) of passports and other IDs

No Additional Properties

Type: object

The fieldmrzScanOptions configure which text fields shall be captured mandatory, optional or not at all.

No Additional Properties

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Must be one of:

  • "mandatory"
  • "optional"
  • "disabled"
  • "default"

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: enum (of string)

The mrzScanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior.

Same definition as surname

Type: object

The minFieldConfidences configure which fields must reach which confidence thresholds in order to be part of the scan result.

No Additional Properties

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Value must be greater or equal to 0 and lesser or equal to 100

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: integer

The minimum field confidence determines the minimum confidence a field text needs to reach in order to be taken into account. If the scanned field confidence is lower than the set minConfidenceField but the scanOption is not set to mandatory, a result will be retuned without the field. The value has to be between 0 and 100. Defaults to 60.

Same definition as surname

Type: boolean Default: false

The strictMode determines whether or not the MRZ must follow the ICAO standard.

Type: boolean Default: false

The cropAndTransformID determines whether or not the image shall be cropped and transformed.

Type: integer Default: 60

Sets a minimum confidence which has to be reached in order to trigger a scan result.

Value must be greater or equal to 0 and lesser or equal to 100

Type: boolean Default: false

Sets whether the face detection approach is enabled.

Type: object

Configuration for scanning japanese landing permission tickets

Type: object

Field option for JLP fields

Type: enum (of string) Default: "default"

The scanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior. Default behavior is one of the other three that yields the best recall results with all layouts enabled.

Must be one of:

  • "mandatory"
  • "optional"
  • "disabled"
  • "default"

Type: integer

Set the minConfidence between 0 and 100. Otherwise, it's defaulted.

Type: object

Configuration for scanning Vehicle Registration Certificates

No Additional Properties

Type: object

Contains all the supported field scan options for vehicle registration certificates.

No Additional Properties

Type: object

The DocumentNumber Field

No Additional Properties

Type: enum (of string) Default: "default"

The scanOption determines whether a field is considered optional, mandatory, disabled or follows a default behavior. Default behavior is one of the other three that yields the best recall results with all layouts enabled.

Must be one of:

  • "mandatory"
  • "optional"
  • "disabled"
  • "default"

Type: integer

Set the minConfidence between 0 and 100. Otherwise, it's defaulted.

Value must be greater or equal to 0 and lesser or equal to 100

Type: object

Configuration for scanning license plates

No Additional Properties

Type: enum (of string) Default: "auto"

Specifies a country or location of which license plates shall be scanned.

Must be one of:

  • "auto"
  • "austria"
  • "unitedkingdom"
  • "ireland"
  • "poland"
  • "norway"
  • "norwayspecial"
  • "germany"
  • "czech"
  • "finland"
  • "france"
  • "croatia"
  • "slovakia"
  • "slovenia"
  • "albania"
  • "andorra"
  • "armenia"
  • "azerbaijan"
  • "belarus"
  • "belgium"
  • "bosniaandherzegovina"
  • "bulgaria"
  • "cyprus"
  • "denmark"
  • "estonia"
  • "georgia"
  • "greece"
  • "hungary"
  • "iceland"
  • "italy"
  • "latvia"
  • "liechtenstein"
  • "lithuania"
  • "luxembourg"
  • "malta"
  • "moldova"
  • "monaco"
  • "montenegro"
  • "netherlands"
  • "northmacedonia"
  • "portugal"
  • "romania"
  • "russia"
  • "serbia"
  • "spain"
  • "sweden"
  • "switzerland"
  • "turkey"
  • "ukraine"
  • "unitedstates"
  • "africa"

Type: integer Default: 0

Sets a minimum confidence which has to be reached in order to trigger a scan result.

Type: string

Sets a regular expression per country. Expected format: "'countrycode':^regex$, 'othercountrycode':^otherregex$". The country code needs to be provided in the international vehicle registration code format that is visible on the license plate (for example 'A' for Austria). Note: not available for the scanModes unitedstates and africa.

Type: object

Configuration for scanning TIN numbers

No Additional Properties

Type: enum (of string) Default: "UNIVERSAL"

Sets the mode to scan universal TIN numbers ('UNIVERSAL') or TIN numbers of any length starting with DOT ('DOT').

Must be one of:

  • "UNIVERSAL"
  • "DOT"

Type: enum (of string) Default: "AUTO"

Sets whether the text shall also be scanned upside-down.

Must be one of:

  • "DISABLED"
  • "ENABLED"
  • "AUTO"

Type: integer

Sets a minimum confidence which has to be reached in order to trigger a scan result.

Type: boolean Default: false

Sets whether the production date validation is enabled. If it is set to false the scan result is also returned for invalid and missing dates.

Type: string

Sets a regular expression which the TIN text needs to match in order to trigger a scan result.

Type: object

Configuration for scanning Tire Size Specifications

No Additional Properties

Type: enum (of string) Default: "AUTO"

Sets whether the text shall also be scanned upside-down.

Must be one of:

  • "DISABLED"
  • "ENABLED"
  • "AUTO"

Type: integer

Sets a minimum confidence which has to be reached in order to trigger a scan result.

Type: string

Sets a regular expression which the tire size text needs to match in order to trigger a scan result.

Type: object

Configuration for scanning commercial Tire IDs

No Additional Properties

Type: enum (of string) Default: "AUTO"

Sets whether the text shall also be scanned upside-down.

Must be one of:

  • "DISABLED"
  • "ENABLED"
  • "AUTO"

Type: integer

Sets a minimum confidence which has to be reached in order to trigger a scan result.

Type: string

Sets a regular expression which the commercial tire id text needs to match in order to trigger a scan result.

Type: object

Configuration for scanning Tire Makes

No Additional Properties

Type: enum (of string) Default: "AUTO"

Sets whether the text shall also be scanned upside-down.

Must be one of:

  • "DISABLED"
  • "ENABLED"
  • "AUTO"

Type: integer

Sets a minimum confidence which has to be reached in order to trigger a scan result.

Type: string

Sets a regular expression which the tire make text needs to match in order to trigger a scan result. E.g. "(Continental|Dunlop)" will only trigger on Continental or Dunlop tires.

Type: object

Configuration for scanning vehicle identification numbers (VIN)

No Additional Properties

Type: string

Sets a regular expression which the scanned text needs to match in order to trigger a scan result.

Type: string

Restricts the scanner to a set of characters to be detected.

Type: object

Configuration for scanning shipping container numbers

No Additional Properties

Type: enum (of string) Default: "HORIZONTAL"

Determines if container numbers shall be scanned horizontally or vertically.

Must be one of:

  • "HORIZONTAL"
  • "VERTICAL"

Type: integer

Sets a minimum confidence which has to be reached in order to trigger a scan result.

Type: string

Sets a regular expression which the scanned text needs to match in order to trigger a scan result.

Type: object

Configuration for general OCR scanning use-cases

No Additional Properties

Type: enum (of string) Default: "auto"

Sets whether to scan single-line texts, multi-line texts in a grid-formation or finds text automatically.

Must be one of:

  • "line"
  • "grid"
  • "auto"

Type: array of string

Sets one or more custom Anyline models. The files have to be located in the project and point to a path relative from the project root. If no customCmdFile is set, only a maximum of one model is valid. If a customCmdFile is set, it depends whether or not the customCmdFile requires multiple models or not. Please check the official documentation for more details.

No Additional Items

Each item of this array must be:

Type: string

Sets a custom Anyline script. The file has to be located in the project and point to a path relative from the project root. Please check the official documentation for more details.

Type: integer

Sets a sharpnes factor (0-100) to rule out blurry images.

Type: integer

Sets the number of characters in each text line for 'grid' mode.

Type: integer

Sets the number of text lines for 'grid' mode.

Type: number

Defines the average horizontal distance between two characters in 'grid' mode, measured in percentage of the characters width.

Type: number

Defines the average vertical distance between two characters in 'grid' mode, measured in percentage of the characters height.

Type: integer

Sets a minimum confidence which has to be reached in order to trigger a scan result.

Type: integer

Sets a minimum character height (in pixels) to be considered in the scanning process.

Type: integer

Sets a maximum character height (in pixels) to be considered in the scanning process.

Type: string

Sets a regular expression which the scanned text needs to match in order to trigger a scan result.

Type: string

Restricts the scanner to a set of characters to be detected.

Type: object

Schema for SDK Cutout Configuration

No Additional Properties

Type: enum (of string) Default: "center"

The alignment of the cutout area.

Must be one of:

  • "top"
  • "top_half"
  • "center"
  • "bottom_half"
  • "bottom"

Type: integer Default: 0

The preferred width in pixels, relating to the camera resolution. If not specified or 0, the maximum possible width will be chosen.

Type: string

The maximum width in percent (0-100), relating to the size of the view.

Type: string

The maximum height in percent (0-100), relating to the size of the view.

Type: object

A size constraining the ratio of width / height. If set to 0, the ratio will be equal to the full frame.

No Additional Properties

Type: number Default: 0

Type: number Default: 0

Type: integer Default: 0

The stroke width of the cutout. If set to 0, the line will be invisible.

Type: string Default: "0099FF"

The hex string (RRGGBB) of the stroke color. (e.g. 00CCFF).

Type: string Default: "0099FF"

The hex string (RRGGBB) of the stroke color for visual feedback. (e.g. 00CCFF).

Type: integer Default: 0

Radius of the corners of the cutout.

Type: string Default: "4D000000"

Background color as a 6-digit (RRGGBB) or 8-digit (AARRGGBB) hex string.

Type: number

Optional transparency factor for the outer color (0.0 - 1.0).

Value must be greater or equal to 0 and lesser or equal to 1

Type: object

Position offset of the cutout, used in conjunction with alignment.

Same definition as offset

Type: enum (of string) Default: "none"

Animation type for the cutout when initially displayed. Values: none, fade, zoom

Must be one of:

  • "none"
  • "fade"
  • "zoom"

Type: object

Amount of padding to be applied to the cutout (NOTE: use positive amounts only). A crop padding truncates the visual area represented by the cutout used in optimizing scan performance for some plugins. Define as an x-y point structure.

Same definition as offset

Type: object

Used in conjunction with cropPadding. This offset further adjusts the crop position after the padding is applied. Define as an x-y point structure.

Same definition as offset

Type: object

Schema for SDK ScanFeedback Configuration

No Additional Properties

Type: enum (of string) Default: "rect"

The style of the feedback.

Must be one of:

  • "none"
  • "rect"
  • "contour_rect"
  • "contour_point"
  • "contour_underline"
  • "animated_rect"

Type: enum (of string) Default: "none"

The animation style of the feedback.

Must be one of:

  • "none"
  • "traverse_single"
  • "traverse_multi"
  • "kitt"
  • "blink"
  • "resize"
  • "pulse"
  • "pulse_random"

Type: integer

The timeout to redraw the visual feedback in milliseconds.

Type: integer

The corner radius of the visual feedback.

Type: integer

The duration of the animation in milliseconds.

Type: integer

The stroke width.

Type: string

The stroke color.

Type: string

The fill color.

Type: boolean

If true, make a beep sound when a result is found.

Type: boolean

If true, flash the view when a result is found.

Type: boolean

If true, vibrate the device when a result is found.

Type: object

General configuration for UI Feedback elements

Type: array

Elements inside UIFeedbackConfig.

No Additional Items

Each item of this array must be:

Type: object

Configuration for uiFeedback element

Type: string

Sets the id of the element.

Type: enum (of string) Default: "text"

Sets the view type of the element.

Must be one of:

  • "image"
  • "sound"
  • "text"

Type: object

Configuration for UI Feedback content

Type: string Default: ""

Sets the content of the element.

Type: integer Default: 0

Sets the duration of the element.

Value must be greater or equal to 0 and lesser or equal to 1000000

Type: integer Default: 1

Sets the priority of the element.

Value must be greater or equal to 0 and lesser or equal to 100

Type: boolean Default: false

Sets whether the view is clickable.

Type: string Default: ""

Sets a tag for the element.

Type: object

Configuration attributes for UI Feedback view elements

Type: enum (of string) Default: "center"

Sets the text alignment.

Must be one of:

  • "left"
  • "right"
  • "center"

Type: enum (of string) Default: "fit_center"

Sets the image scale type.

Must be one of:

  • "center"
  • "center_crop"
  • "fit_center"
  • "fit_xy"

Type: object

Trigger configuration for UI Feedback

Type: array

Allows to watch scanInfo events.

No Additional Items

Each item of this array must be:

Type: object

Configuration for triggering UI Feedback on ScanInfo events

Type: object

Configuration for triggering UI Feedback on ScanInfo events

Type: boolean Default: false

Sets whether the trigger must apply defaultAttributes.

Type: array

Allows to watch runSkipped events.

No Additional Items

Each item of this array must be:

Type: object

Configuration for triggering UI Feedback on RunSkipped events

Type: object

Configuration for triggering UI Feedback on RunSkipped events

Type: array
No Additional Items

Each item of this array must be:

Type: object

Configuration for UI Feedback overlays

Type: enum (of string) Default: "cutout"

Sets the source of the overlay.

Must be one of:

  • "cutout"

Type: enum (of string)

Sets the anchor of the overlay.

Must be one of:

  • "top_left"
  • "top_center"
  • "top_right"
  • "center_left"
  • "center"
  • "center_right"
  • "bottom_left"
  • "bottom_center"
  • "bottom_right"

Type: object

Sets the size dimension of the overlay.

Type: object

Sets the scale for x axis of the overlay.

OverlayScaleTypeConfig

Type: enum (of string)

Sets the scale type of the overlay.

Must be one of:

  • "none"
  • "fixed_px"
  • "keep_ratio"
  • "overlay"

Type: array

Allows to use overlay presets.

No Additional Items

Each item of this array must be:

Type: array

Allows to use element presets.

No Additional Items

Each item of this array must be:

Type: array

Preset definitions inside UIFeedbackConfig.

No Additional Items

Each item of this array must be:

Type: object

Configuration for uiFeedback preset definition.

Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

Type: object

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

Type: string

Sets the name of the preset definition.

Type: enum (of string)

Sets the preset definition type.

Must be one of:

  • "presetElementOverlay"
  • "presetElementTrigger"
  • "presetElement"
  • "preset"

Type: array

Attributes inside preset definition.

No Additional Items

Each item of this array must be:

Type: object

Configuration for uiFeedback preset definition attribute.

Type: enum (of string)

Sets the preset definition attribute element type.

Must be one of:

  • "int"
  • "long"
  • "double"
  • "boolean"
  • "string"
  • "any"

UIFeedbackPresetContentConfig

Type: object

Configuration for uiFeedback preset content definition.

Type: array

Allows to use presets.

No Additional Items

Each item of this array must be:

Type: object

Configuration for uiFeedback preset.

Same definition as UIFeedbackPresetConfig

Type: object

Schema for SDK ViewPlugin Configuration

No Additional Properties

Type: string

The ID (name) of the workflow.

Type: enum (of string)

The processing mode of the workflow (parallel, sequential, parallelFirstScan).

Must be one of:

  • "parallel"
  • "sequential"
  • "parallelFirstScan"

Type: array of object

The ordered list of viewPlugins, each as JSON object with a given viewPluginConfig.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: object