PluginResult


Describes all kinds of scan results

No Additional Properties

Type: object

The following properties are required:

  • pluginID
  • confidence

Type: object

The following properties are required:

  • barcodeResult
Type: object

The following properties are required:

  • universalIdResult
Type: object

The following properties are required:

  • vehicleRegistrationCertificateResult
Type: object

The following properties are required:

  • mrzResult
Type: object

The following properties are required:

  • licensePlateResult
Type: object

The following properties are required:

  • japaneseLandingPermissionResult
Type: object

The following properties are required:

  • meterResult
Type: object

The following properties are required:

  • odometerResult
Type: object

The following properties are required:

  • ocrResult
Type: object

The following properties are required:

  • tinResult
Type: object

The following properties are required:

  • tireSizeResult
Type: object

The following properties are required:

  • tireMakeResult
Type: object

The following properties are required:

  • commercialTireIdResult
Type: object

The following properties are required:

  • containerResult
Type: object

The following properties are required:

  • vinResult

Type: string

The blobKey (provided optionally, depending on the Anyline license settings)

Type: string

The ID of the ScanPlugin that processed the result

Type: object

The rect information of the region that was processed within the image

No Additional Properties

Type: integer

The X value

Type: integer

The Y value

Type: integer

The width

Type: integer

The height

Type: integer Default: -1

Provides a general confidence value between 0 and 100 if applicable. -1 if no confidence was calculated

Value must be greater or equal to -1 and lesser or equal to 100

Type: object

Describes result information of scanning barcodes

No Additional Properties

Type: array

Contains a list of one or more barcodes found on the processed image

No Additional Items

Each item of this array must be:

Type: object

Describes barcode information

No Additional Properties

Type: string

The value of the barcode

Type: string

The barcode format

Type: array of integer

Corner points of a polygon surrounding the discovered barcode, starting from the bottom-left coordinate going counter-clockwise. The coordinates are in reference to the image of the plugin result.

No Additional Items

Each item of this array must be:

Type: string

Contains the base64-encoded value

Type: object

Holds all encoded barcode information according to the AAMVA standard

Type: object

Type: object

Describes result information of scanning different kinds of IDs

No Additional Properties

IdResult

Type: object

Yields field information of the ID

No Additional Properties

Type: object

Describes scanned parameters of an ID field

No Additional Properties


Describes the text values of an ID field

No Additional Properties

Type: object

The following properties are required:

  • latin
Type: object

The following properties are required:

  • cyrillic
Type: object

The following properties are required:

  • arabic

Type: object

The text parameters

No Additional Properties

Type: integer Default: -1

The confidence value

Value must be greater or equal to -1 and lesser or equal to 100

Type: object

The text parameters

No Additional Properties

Type: integer Default: -1

The confidence value

Value must be greater or equal to -1 and lesser or equal to 100

Type: object

The text parameters

No Additional Properties

Type: integer Default: -1

The confidence value

Value must be greater or equal to -1 and lesser or equal to 100

Type: object

Describes the date value of an ID field

No Additional Properties

Type: integer

The month

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

Type: integer

The day

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

Type: string

The text value

Type: string

The formatted text value

Type: integer Default: -1

The confidence value

Value must be greater or equal to -1 and lesser or equal to 100

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

Type: object

Information about the visualization data of the scanned ID

No Additional Properties

Type: array of array

The found contours of the fields on the ID

No Additional Items

Each item of this array must be:

Type: array of integer

An array of integer values

Must contain a minimum of 4 items

Must contain a maximum of 4 items

No Additional Items

Each item of this array must be:

Type: array of array

The found contour points of the fields on the ID

No Additional Items

Each item of this array must be:

Type: array of array

An array of contour points

No Additional Items

Each item of this array must be:

Type: array of integer

An array of integer values

Must contain a minimum of 2 items

Must contain a maximum of 2 items

No Additional Items

Each item of this array must be:

Type: array of integer

The found bounding rect of the text fields on the ID

Must contain a minimum of 4 items

Must contain a maximum of 4 items

No Additional Items

Each item of this array must be:

Type: object

Describes result information of scanning vehicle registration certificates

No Additional Properties

VrcResult

Type: object

Yields field information of the vehicle registration certificate

No Additional Properties

Type: object

Describes scanned parameters of a vehicle registration certificate field

No Additional Properties

Type: integer Default: -1

The confidence value

Value must be greater or equal to -1 and lesser or equal to 100

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

Type: object

Information about the visualization data of the scanned ID

Same definition as visualization

Type: object

Describes result information of scanning MRZ

No Additional Properties

Type: object

The following properties are required:

  • lastName
  • firstName
Type: object

The following properties are required:

  • surname
  • givenNames

Type: boolean

True if all check digits are valid

Type: string

The DateOfBirth

Type: string

The DateOfBirthObject

Type: string

The DateOfExpiry

Type: string

The DateOfExpiryObject

Type: string

The DocumentNumber

Type: string

The DocumentType

Type: string

The IssuingCountryCode

Type: string

The NationalityCountryCode

Type: string

The Sex

Type: string

The PersonalNumber

Type: string

The CheckDigitDateOfExpiry

Type: string

The CheckDigitDocumentNumber

Type: string

The CheckDigitPersonalNumber

Type: string

The CheckDigitDateOfBirth

Type: string

The CheckDigitFinal

Type: string

The MRZString

Type: string

The Surname

Type: string

The GivenNames

Type: string

The FirstName

Type: string

The LastName

Type: string

The OptionalData

Type: string

The Adress of the Visual Inspection Zone

Type: string

The DateOfIssue of the Visual Inspection Zone

Type: string

The DateOfIssueObject of the Visual Inspection Zone

Type: string

The Surname of the Visual Inspection Zone

Type: string

The GivenNames of the Visual Inspection Zone

Type: string

The DateOfBirth of the Visual Inspection Zone

Type: string

The DateOfBirthObject of the Visual Inspection Zone

Type: string

The DateOfExpiry of the Visual Inspection Zone

Type: string

The DateOfExpiryObject of the Visual Inspection Zone

Type: object

The confidence values of each field

No Additional Properties

Type: integer Default: -1

The confidence value of the field

Value must be greater or equal to -1 and lesser or equal to 100

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: integer Default: -1

The confidence value of the field

Same definition as surname

Type: object

Describes result information of scanning license plates

No Additional Properties

Type: string Default: ""

The country information

Type: enum (of string)

The area information

Must be one of:

  • "Alabama"
  • "Alaska"
  • "American Samoa"
  • "Arizona"
  • "Arkansas"
  • "California"
  • "Colorado"
  • "Connecticut"
  • "Delaware"
  • "District of Columbia"
  • "Florida"
  • "Georgia"
  • "Guam"
  • "Hawaii"
  • "Idaho"
  • "Illinois"
  • "Indiana"
  • "Iowa"
  • "Kansas"
  • "Kentucky"
  • "Louisiana"
  • "Maine"
  • "Maryland"
  • "Massachusetts"
  • "Michigan"
  • "Minnesota"
  • "Mississippi"
  • "Missouri"
  • "Montana"
  • "Nebraska"
  • "Nevada"
  • "New Hampshire"
  • "New Jersey"
  • "New Mexico"
  • "New York"
  • "North Carolina"
  • "North Dakota"
  • "Ohio"
  • "Oklahoma"
  • "Oregon"
  • "Pennsylvania"
  • "Puerto Rico"
  • "Rhode Island"
  • "South Carolina"
  • "South Dakota"
  • "Tennessee"
  • "Texas"
  • "Utah"
  • "Vermont"
  • "Virginia"
  • "Washington"
  • "West Virginia"
  • "Wisconsin"
  • "Wyoming"

Type: string Default: ""

The plate text

Type: object

Describes result information of scanning japanese landing permission tickets

No Additional Properties

JlpResult

Type: object

Yields field information of a japanese landing permission ticket

No Additional Properties

Type: object

Provides result information for japanese landing permission fields

No Additional Properties

Type: string

The text information of the field

Type: integer Default: -1

The confidence information of the field

Value must be greater or equal to -1 and lesser or equal to 100

Type: object

Provides result information for japanese landing permission fields

Same definition as airport

Type: object

Provides result information for japanese landing permission fields

Same definition as airport

Type: object

Provides result information for japanese landing permission fields

Same definition as airport

Type: object

Provides result information for japanese landing permission fields

Same definition as airport

Type: object

Describes result information of scanning meters

No Additional Properties

Type: string

The meter value.

Type: string

The unit value. Only applicable for multi-field meter scanning.

Type: string

The position. Only applicable for OBIS meters - see https://onemeter.com/docs/device/obis/

Type: object

Describes result information of scanning odometers

No Additional Properties

Type: string

The odometer value.

Type: object

Describes result information of scanning general OCR

No Additional Properties

Type: string

The OCR text value.

Type: object

Describes result information of scanning tire identification numbers (TIN)

No Additional Properties

Type: string

The TIN text value.

Type: string

The production date on the TIN reformatted to YYYY/MM.

Type: integer

The computed tire age in years rounded down.

Type: string

The TIN text split by context with spaces as delimiter.

Type: object

Describes result information of scanning tire size specifications

No Additional Properties

Type: object

Type: string

The text value of the tire size field.

Type: integer

The confidence value of the tire size field.

Type: object

Describes result information of scanning tire makes

No Additional Properties

Type: string

The text value of the tire make

Type: object

Describes result information of scanning commercial tire IDs

No Additional Properties

Type: string

The text value of the commercial tire ID

Type: object

Describes result information of scanning shipping containers

No Additional Properties

Type: string

The text value of the shipping container

Type: object

Describes result information of scanning vehicle identification numbers (VIN)

No Additional Properties

Type: string

The VIN text value