VIZ Result

Defined in package com.scandit.datacapture.id.capture

VizResult

class VizResult

Added in version 6.5.0

Document scan results with information obtained from documents or their parts intended to be read by humans (for example Visual Inspection Zone (VIZ) of a Machine-Readable Travel Document (MRTD)).

firstName

val firstName: String?

Added in version 6.26.0

The first name of the document holder. Separated by spaces if more than one name is present. Certain documents do not distinguish between given name and surname. If the name cannot be split reliably, this field may be null.

lastName

val lastName: String?

Added in version 6.26.0

The last name of the document holder. Separated by spaces if more than one name is present. Certain documents do not distinguish between given name and surname. If the name cannot be split reliably, this field may be null.

fullName

val fullName: String?

Added in version 6.26.0

The full name of the document holder.

additionalNameInformation

val additionalNameInformation: String?

Added in version 6.5.0

The additional name information of the document holder that might be present on the document.

Note

The content of this field varies by document type:

German passports and IDs: Contains the maiden name or birth name of the document holder
French passports: Contains the married name of the document holder

additionalAddressInformation

val additionalAddressInformation: String?

Added in version 6.5.0

The additional address information of the document holder.

placeOfBirth

val placeOfBirth: String?

Added in version 6.5.0

The place of birth of the document holder.

race

val race: String?

Added in version 6.5.0

The race of the document holder.

religion

val religion: String?

Added in version 6.5.0

The religion of the document holder.

If IdCaptureSettings.anonymizationMode is enabled for the field results, the returned value might be null for certain documents.

profession

val profession: String?

Added in version 6.5.0

The profession of the document holder.

maritalStatus

val maritalStatus: String?

Added in version 6.5.0

The marital status of the document holder.

residentialStatus

val residentialStatus: String?

Added in version 6.5.0

The residential status of the document holder.

employer

val employer: String?

Added in version 6.5.0

The employer of the document holder.

personalIdNumber

val personalIdNumber: String?

Added in version 6.5.0

The personal identification number.

If IdCaptureSettings.anonymizationMode is enabled for the field results, the returned value might be null for certain documents.

documentAdditionalNumber

val documentAdditionalNumber: String?

Added in version 6.5.0

The additional number of the document.

If IdCaptureSettings.anonymizationMode is enabled for the field results, the returned value might be null for certain documents.

issuingJurisdiction

val issuingJurisdiction: String?

Added in version 6.5.1

A human readable name of the issuing jurisdiction (for example: an issuing state, territory or federal district for USA, or an issuing province or territory for Canada).

issuingJurisdictionIso

val issuingJurisdictionIso: String?

Added in version 6.7.0

The ISO code of the issuing jurisdiction (for example: an issuing state, territory or federal district for the USA, or an issuing province or territory for Canada). null if the issuing jurisdiction has no valid ISO code (for example cities in Mexico).

Note

The returned value will only contain the jurisdiction specific code: for instance for California the returned value would be “CA” and not “US-CA”.

Please note that for the New York City ID, this field is set to “NYC” as ISO-3166-2 does not specify city-level names.

issuingAuthority

val issuingAuthority: String?

Added in version 6.5.1

The government body issuing this ID, e.g. the Department of Motor Vehicles.

bloodType

val bloodType: String?

Added in version 6.25.0

The blood type of the document owner.

sponsor

val sponsor: String?

Added in version 6.25.0

The sponsor of the document owner.

mothersName

val mothersName: String?

Added in version 6.25.0

The mother’s name of the document owner.

fathersName

val fathersName: String?

Added in version 6.25.0

The father’s name of the document owner.

drivingLicenseDetails

val drivingLicenseDetails: DrivingLicenseDetails?

Added in version 6.25.0

Extra information about the scanned driver’s license

capturedSides

val capturedSides: CapturedSides

Added in version 6.6.0

The sides of the document that were scanned to extract this VizResult.

isBackSideCaptureSupported

val isBackSideCaptureSupported: Boolean

Added in version 6.6.0

Indicates whether the document supports scanning of the back side.

visaNumber

val visaNumber: String?

Added in version 7.0.0

The visa number of the document holder.

passportNumber

val passportNumber: String?

Added in version 7.0.0

The passport number of the document holder.

vehicleOwner

val vehicleOwner: String?

Added in version 7.2.0

The owner of the vehicle.

sex

val sex: String?

Added in version 7.2.0

The sex of the document holder.

dateOfBirth

val dateOfBirth: DateResult?

Added in version 7.2.0

The date of birth of the document holder.

nationality

val nationality: String?

Added in version 7.2.0

The nationality of the document holder.

address

val address: String?

Added in version 7.2.0

The address of the document holder.

documentNumber

val documentNumber: String?

Added in version 7.2.0

The document number of the ID.

dateOfExpiry

val dateOfExpiry: DateResult?

Added in version 7.2.0

The expiry date of the document.

dateOfIssue

val dateOfIssue: DateResult?

Added in version 7.2.0

The issue date of the document.