PluginResult


Describes all kinds of scan results

 No Additional Properties

root allOf item 0
Type: object

The following properties are required:

  • pluginID
  • confidence
root allOf item 1

root allOf item 1 oneOf item 0
Type: object

The following properties are required:

  • barcodeResult
root allOf item 1 oneOf item 1
Type: object

The following properties are required:

  • universalIdResult
root allOf item 1 oneOf item 2
Type: object

The following properties are required:

  • vehicleRegistrationCertificateResult
root allOf item 1 oneOf item 3
Type: object

The following properties are required:

  • mrzResult
root allOf item 1 oneOf item 4
Type: object

The following properties are required:

  • licensePlateResult
root allOf item 1 oneOf item 5
Type: object

The following properties are required:

  • japaneseLandingPermissionResult
root allOf item 1 oneOf item 6
Type: object

The following properties are required:

  • meterResult
root allOf item 1 oneOf item 7
Type: object

The following properties are required:

  • odometerResult
root allOf item 1 oneOf item 8
Type: object

The following properties are required:

  • ocrResult
root allOf item 1 oneOf item 9
Type: object

The following properties are required:

  • tinResult
root allOf item 1 oneOf item 10
Type: object

The following properties are required:

  • tireSizeResult
root allOf item 1 oneOf item 11
Type: object

The following properties are required:

  • tireMakeResult
root allOf item 1 oneOf item 12
Type: object

The following properties are required:

  • commercialTireIdResult
root allOf item 1 oneOf item 13
Type: object

The following properties are required:

  • containerResult
root allOf item 1 oneOf item 14
Type: object

The following properties are required:

  • vinResult

root blobKey
Type: string

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

root pluginID
Type: string

The ID of the ScanPlugin that processed the result

root cropRect
Type: object

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

 No Additional Properties

root cropRect x
Type: integer

The X value

root cropRect y
Type: integer

The Y value

root cropRect width
Type: integer

The width

root cropRect height
Type: integer

The height

root confidence
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

root barcodeResult
Type: object

Describes result information of scanning barcodes

 No Additional Properties

root barcodeResult barcodes
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:

root barcodeResult barcodes barcode
Type: object

Describes barcode information

 No Additional Properties

root barcodeResult barcodes barcodes items value
Type: string

The value of the barcode

root barcodeResult barcodes barcodes items format
Type: string

The barcode format

root barcodeResult barcodes barcodes items coordinates
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:

root barcodeResult barcodes barcodes items coordinates coordinates items
Type: integer

root barcodeResult barcodes barcodes items base64value
Type: string

Contains the base64-encoded value

root barcodeResult barcodes barcodes items aamva
Type: object

Holds all encoded barcode information according to the AAMVA standard

root barcodeResult barcodes barcodes items aamva body-part
Type: object

root barcodeResult barcodes barcodes items aamva body-part auditInformation
Type: string

root barcodeResult barcodes barcodes items aamva body-part cardRevisionDate
Type: string

root barcodeResult barcodes barcodes items aamva body-part city
Type: string

root barcodeResult barcodes barcodes items aamva body-part complianceType
Type: string

root barcodeResult barcodes barcodes items aamva body-part countryID
Type: string

root barcodeResult barcodes barcodes items aamva body-part customerIDNumber
Type: string

root barcodeResult barcodes barcodes items aamva body-part dateOfBirth
Type: string

root barcodeResult barcodes barcodes items aamva body-part dateOfExpiry
Type: string

root barcodeResult barcodes barcodes items aamva body-part dateOfIssue
Type: string

root barcodeResult barcodes barcodes items aamva body-part documentDiscriminator
Type: string

root barcodeResult barcodes barcodes items aamva body-part drivingPrivilege
Type: string

root barcodeResult barcodes barcodes items aamva body-part endorsementCode
Type: string

root barcodeResult barcodes barcodes items aamva body-part eyes
Type: string

root barcodeResult barcodes barcodes items aamva body-part firstName
Type: string

root barcodeResult barcodes barcodes items aamva body-part firstNameTruncated
Type: string

root barcodeResult barcodes barcodes items aamva body-part hair
Type: string

root barcodeResult barcodes barcodes items aamva body-part height
Type: string

root barcodeResult barcodes barcodes items aamva body-part inventoryControlNumber
Type: string

root barcodeResult barcodes barcodes items aamva body-part jurisdictionCode
Type: string

root barcodeResult barcodes barcodes items aamva body-part lastName
Type: string

root barcodeResult barcodes barcodes items aamva body-part lastNameTruncated
Type: string

root barcodeResult barcodes barcodes items aamva body-part licenseClass
Type: string

root barcodeResult barcodes barcodes items aamva body-part middleName
Type: string

root barcodeResult barcodes barcodes items aamva body-part middleNameTruncated
Type: string

root barcodeResult barcodes barcodes items aamva body-part postalCode
Type: string

root barcodeResult barcodes barcodes items aamva body-part sex
Type: string

root barcodeResult barcodes barcodes items aamva body-part street
Type: string

root universalIdResult
Type: object

Describes result information of scanning different kinds of IDs

 No Additional Properties

root universalIdResult result

IdResult

Type: object

Yields field information of the ID

 No Additional Properties

root universalIdResult result additionalInformation
Type: object

Describes scanned parameters of an ID field

 No Additional Properties

root universalIdResult result additionalInformation textValues

Describes the text values of an ID field

 No Additional Properties

root universalIdResult result additionalInformation textValues anyOf item 0
Type: object

The following properties are required:

  • latin
root universalIdResult result additionalInformation textValues anyOf item 1
Type: object

The following properties are required:

  • cyrillic
root universalIdResult result additionalInformation textValues anyOf item 2
Type: object

The following properties are required:

  • arabic

root universalIdResult result additionalInformation textValues latin
Type: object

The text parameters

 No Additional Properties

root universalIdResult result additionalInformation textValues latin text
Type: string

The text value

root universalIdResult result additionalInformation textValues latin confidence
Type: integer Default: -1

The confidence value

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

root universalIdResult result additionalInformation textValues cyrillic
Type: object

The text parameters

 No Additional Properties

root universalIdResult result additionalInformation textValues cyrillic text
Type: string

The text value

root universalIdResult result additionalInformation textValues cyrillic confidence
Type: integer Default: -1

The confidence value

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

root universalIdResult result additionalInformation textValues arabic
Type: object

The text parameters

 No Additional Properties

root universalIdResult result additionalInformation textValues arabic text
Type: string

The text value

root universalIdResult result additionalInformation textValues arabic confidence
Type: integer Default: -1

The confidence value

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

root universalIdResult result additionalInformation dateValue
Type: object

Describes the date value of an ID field

 No Additional Properties

root universalIdResult result additionalInformation dateValue month
Type: integer

The month

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

root universalIdResult result additionalInformation dateValue day
Type: integer

The day

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

root universalIdResult result additionalInformation dateValue text
Type: string

The text value

root universalIdResult result additionalInformation dateValue formattedText
Type: string

The formatted text value

root universalIdResult result additionalInformation dateValue confidence
Type: integer Default: -1

The confidence value

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

root universalIdResult result additionalInformation1
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result additionalInformation2
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result additionalInformation3
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result age
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result address
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result airport
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result allCheckDigitsValid
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result audit
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result authority
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result barcode
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result bloodType
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result cardAccessNumber
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result checkDigitDateOfExpiry
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result checkDigitDocumentNumber
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result checkDigitPersonalNumber
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result checkDigitDateOfBirth
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result checkDigitFinal
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result cityNumber
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result conditions
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result country
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result dateOfBirth
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result dateOfBirthObject
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result dateOfExpiry
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result dateOfExpiryObject
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result dateOfIssue
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result dateOfRegistration
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result degreeOfDisability
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result divisionNumber
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result documentCategoryDefinition
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result documentDiscriminator
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result documentNumber
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result documentRegionDefinition
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result documentSideDefinition
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result documentType
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result documentTypeDefinition
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result documentVersionsDefinition
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result duplicate
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result duration
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result educationalInstitution
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result employer
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result endorsements
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result eyes
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result familyNumber
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result familyRelation
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result face
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result fathersName
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result firstIssued
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result firstName
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result fullName
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result folio
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result formattedDateOfBirth
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result formattedDateOfExpiry
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result formattedDateOfIssue
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result givenNames
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result hair
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result headOfFamily
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result height
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result hologram
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result initials
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result initialsAndDateOfBirth
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result issuingCountryCode
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result lastName
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result licenseClass
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result licenseType
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result maidenName
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result militaryRank
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result mirrorNumber
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result mothersName
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result mrz
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result mrzString
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result municipalityNumber
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result nationality
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result nationalityCountryCode
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result occupation
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result optionalData
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result office
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result parentsFirstName
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result parish
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result personalNumber
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result placeAndDateOfBirth
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result placeOfBirth
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result previousType
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result pseudonym
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result religion
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result restrictions
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result sex
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result signature
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result socialSecurityNumber
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result state
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result stateNumber
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result status
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result surname
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result vizAddress
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result vizDateOfIssue
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result vizDateOfIssueObject
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result vizSurname
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result vizGivenNames
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result vizDateOfBirth
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result vizDateOfBirthObject
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result vizDateOfExpiry
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result vizDateOfExpiryObject
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result voterId
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result weight
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult result workPermitNumber
Type: object

Describes scanned parameters of an ID field

Same definition as additionalInformation

root universalIdResult visualization
Type: object

Information about the visualization data of the scanned ID

 No Additional Properties

root universalIdResult visualization contours
Type: array of array

The found contours of the fields on the ID

 No Additional Items

Each item of this array must be:

root universalIdResult visualization contours contours items
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:

root universalIdResult visualization contours contours items contours items items
Type: integer

root universalIdResult visualization contourPoints
Type: array of array

The found contour points of the fields on the ID

 No Additional Items

Each item of this array must be:

root universalIdResult visualization contourPoints contourPoints items
Type: array of array

An array of contour points

 No Additional Items

Each item of this array must be:

root universalIdResult visualization contourPoints contourPoints items contourPoints items items
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:

root universalIdResult visualization contourPoints contourPoints items contourPoints items items contourPoints items items items
Type: integer

root universalIdResult visualization textRect
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:

root universalIdResult visualization textRect textRect items
Type: integer

root vehicleRegistrationCertificateResult
Type: object

Describes result information of scanning vehicle registration certificates

 No Additional Properties

root vehicleRegistrationCertificateResult result

VrcResult

Type: object

Yields field information of the vehicle registration certificate

 No Additional Properties

root vehicleRegistrationCertificateResult result documentNumber
Type: object

Describes scanned parameters of a vehicle registration certificate field

 No Additional Properties

root vehicleRegistrationCertificateResult result documentNumber text
Type: string

The text value

root vehicleRegistrationCertificateResult result documentNumber confidence
Type: integer Default: -1

The confidence value

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

root vehicleRegistrationCertificateResult result licensePlate
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result lastName
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result firstName
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result address
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result firstIssued
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result formattedFirstIssued
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result manufacturerCode
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result vehicleTypeCode
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result vehicleIdentificationNumber
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result brand
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result vehicleType
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result displacement
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result tire
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result documentRegionDefinition
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result documentCategoryDefinition
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result documentTypeDefinition
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result documentVersionsDefinition
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult result documentSideDefinition
Type: object

Describes scanned parameters of a vehicle registration certificate field

Same definition as documentNumber

root vehicleRegistrationCertificateResult visualization
Type: object

Information about the visualization data of the scanned ID

Same definition as visualization

root mrzResult
Type: object

Describes result information of scanning MRZ

 No Additional Properties

root mrzResult oneOf item 0
Type: object

The following properties are required:

  • lastName
  • firstName
root mrzResult oneOf item 1
Type: object

The following properties are required:

  • surname
  • givenNames

root mrzResult allCheckDigitsValid
Type: boolean

True if all check digits are valid

root mrzResult dateOfBirth
Type: string

The DateOfBirth

root mrzResult dateOfBirthObject
Type: string

The DateOfBirthObject

root mrzResult dateOfExpiry
Type: string

The DateOfExpiry

root mrzResult dateOfExpiryObject
Type: string

The DateOfExpiryObject

root mrzResult documentNumber
Type: string

The DocumentNumber

root mrzResult documentType
Type: string

The DocumentType

root mrzResult issuingCountryCode
Type: string

The IssuingCountryCode

root mrzResult nationalityCountryCode
Type: string

The NationalityCountryCode

root mrzResult sex
Type: string

The Sex

root mrzResult personalNumber
Type: string

The PersonalNumber

root mrzResult checkDigitDateOfExpiry
Type: string

The CheckDigitDateOfExpiry

root mrzResult checkDigitDocumentNumber
Type: string

The CheckDigitDocumentNumber

root mrzResult checkDigitPersonalNumber
Type: string

The CheckDigitPersonalNumber

root mrzResult checkDigitDateOfBirth
Type: string

The CheckDigitDateOfBirth

root mrzResult checkDigitFinal
Type: string

The CheckDigitFinal

root mrzResult mrzString
Type: string

The MRZString

root mrzResult surname
Type: string

The Surname

root mrzResult givenNames
Type: string

The GivenNames

root mrzResult firstName
Type: string

The FirstName

root mrzResult lastName
Type: string

The LastName

root mrzResult optionalData
Type: string

The OptionalData

root mrzResult vizAddress
Type: string

The Adress of the Visual Inspection Zone

root mrzResult vizDateOfIssue
Type: string

The DateOfIssue of the Visual Inspection Zone

root mrzResult vizDateOfIssueObject
Type: string

The DateOfIssueObject of the Visual Inspection Zone

root mrzResult vizSurname
Type: string

The Surname of the Visual Inspection Zone

root mrzResult vizGivenNames
Type: string

The GivenNames of the Visual Inspection Zone

root mrzResult vizDateOfBirth
Type: string

The DateOfBirth of the Visual Inspection Zone

root mrzResult vizDateOfBirthObject
Type: string

The DateOfBirthObject of the Visual Inspection Zone

root mrzResult vizDateOfExpiry
Type: string

The DateOfExpiry of the Visual Inspection Zone

root mrzResult vizDateOfExpiryObject
Type: string

The DateOfExpiryObject of the Visual Inspection Zone

root mrzResult fieldConfidences
Type: object

The confidence values of each field

 No Additional Properties

root mrzResult fieldConfidences surname
Type: integer Default: -1

The confidence value of the field

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

root mrzResult fieldConfidences givenNames
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences dateOfBirth
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences dateOfExpiry
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences documentNumber
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences documentType
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences issuingCountryCode
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences nationalityCountryCode
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences sex
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences personalNumber
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences optionalData
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences mrzString
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences checkDigitDateOfExpiry
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences checkDigitDocumentNumber
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences checkDigitPersonalNumber
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences checkDigitDateOfBirth
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences checkDigitFinal
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences vizAddress
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences vizDateOfIssue
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences vizSurname
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences vizGivenNames
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences vizDateOfBirth
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root mrzResult fieldConfidences vizDateOfExpiry
Type: integer Default: -1

The confidence value of the field

Same definition as surname

root licensePlateResult
Type: object

Describes result information of scanning license plates

 No Additional Properties

root licensePlateResult country
Type: string Default: ""

The country information

root licensePlateResult area
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"

root licensePlateResult plateText
Type: string Default: ""

The plate text

root licensePlateResult vehicleInspectionFound
Type: boolean Default: false

(Optional) If vehicleInspectionSticker config is OPTIONAL, this is true if a Visual Inspection Sticker was found, false otherwise. If the config is MANDATORY, this field is always true.

root licensePlateResult vehicleInspectionYear
Type: string Default: ""

(Optional) The year depicted on the Visual Inspection Sticker.

root licensePlateResult vehicleInspectionMonth
Type: string Default: ""

(Optional) The month depicted on the Visual Inspection Sticker.

root licensePlateResult vehicleInspectionValid
Type: boolean Default: false

(Optional) This is true, if the Visual Inspection Sticker depicts a date in the future.

root japaneseLandingPermissionResult
Type: object

Describes result information of scanning japanese landing permission tickets

 No Additional Properties

root japaneseLandingPermissionResult result

JlpResult

Type: object

Yields field information of a japanese landing permission ticket

 No Additional Properties

root japaneseLandingPermissionResult result airport
Type: object

Provides result information for japanese landing permission fields

 No Additional Properties

root japaneseLandingPermissionResult result airport text
Type: string

The text information of the field

root japaneseLandingPermissionResult result airport confidence
Type: integer Default: -1

The confidence information of the field

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

root japaneseLandingPermissionResult result dateOfExpiry
Type: object

Provides result information for japanese landing permission fields

Same definition as airport

root japaneseLandingPermissionResult result dateOfIssue
Type: object

Provides result information for japanese landing permission fields

Same definition as airport

root japaneseLandingPermissionResult result duration
Type: object

Provides result information for japanese landing permission fields

Same definition as airport

root japaneseLandingPermissionResult result status
Type: object

Provides result information for japanese landing permission fields

Same definition as airport

root meterResult
Type: object

Describes result information of scanning meters

 No Additional Properties

root meterResult value
Type: string

The meter value.

root meterResult unit
Type: string

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

root meterResult position
Type: string

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

root odometerResult
Type: object

Describes result information of scanning odometers

 No Additional Properties

root odometerResult value
Type: string

The odometer value.

root ocrResult
Type: object

Describes result information of scanning general OCR

 No Additional Properties

root ocrResult text
Type: string

The OCR text value.

root tinResult
Type: object

Describes result information of scanning tire identification numbers (TIN)

 No Additional Properties

root tinResult text
Type: string

The TIN text value.

root tinResult productionDate
Type: string

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

root tinResult tireAgeInYearsRoundedDown
Type: integer

The computed tire age in years rounded down.

root tinResult resultPrettified
Type: string

The TIN text split by context with spaces as delimiter.

root tireSizeResult
Type: object

Describes result information of scanning tire size specifications

 No Additional Properties

root tireSizeResult commercialTire
Type: object

root tireSizeResult commercialTire text
Type: string

The text value of the tire size field.

root tireSizeResult commercialTire confidence
Type: integer

The confidence value of the tire size field.

root tireSizeResult text
Type: object
Same definition as commercialTire

root tireMakeResult
Type: object

Describes result information of scanning tire makes

 No Additional Properties

root tireMakeResult text
Type: string

The text value of the tire make

root commercialTireIdResult
Type: object

Describes result information of scanning commercial tire IDs

 No Additional Properties

root commercialTireIdResult text
Type: string

The text value of the commercial tire ID

root containerResult
Type: object

Describes result information of scanning shipping containers

 No Additional Properties

root containerResult text
Type: string

The text value of the shipping container

root vinResult
Type: object

Describes result information of scanning vehicle identification numbers (VIN)

 No Additional Properties

root vinResult text
Type: string

The VIN text value