VIZ Result

Defined in library scandit_datacapture_id

VizResult

class VizResult

Added in version 6.11.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

String? get firstName

Added in version 7.0.0

The first name of the document holder. Separated by spaces if more than one name is present.

lastName

String? get lastName

Added in version 7.0.0

The last name of the document holder. Separated by spaces if more than one name is present.

fullName

String? get fullName

Added in version 7.0.0

The full name of the document holder.

additionalNameInformation

String? get additionalNameInformation

Added in version 6.11.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

String? get additionalAddressInformation

Added in version 6.11.0

The additional address information of the document holder.

placeOfBirth

String? get placeOfBirth

Added in version 6.11.0

The place of birth of the document holder.

race

String? get race

Added in version 6.11.0

The race of the document holder.

religion

String? get religion

Added in version 6.11.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

String? get profession

Added in version 6.11.0

The profession of the document holder.

maritalStatus

String? get maritalStatus

Added in version 6.11.0

The marital status of the document holder.

residentialStatus

String? get residentialStatus

Added in version 6.11.0

The residential status of the document holder.

employer

String? get employer

Added in version 6.11.0

The employer of the document holder.

personalIdNumber

String? get personalIdNumber

Added in version 6.11.0

The personal identification number.

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

documentAdditionalNumber

String? get documentAdditionalNumber

Added in version 6.11.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

String? get issuingJurisdiction

Added in version 6.11.0

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

String? get issuingJurisdictionIso

Added in version 6.12.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

String? get issuingAuthority

Added in version 6.11.0

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

bloodType

String? get bloodType

Added in version 6.25.0

The blood type of the document owner.

sponsor

String? get sponsor

Added in version 6.25.0

The sponsor of the document owner.

mothersName

String? get mothersName

Added in version 6.25.0

The mother’s name of the document owner.

fathersName

String? get fathersName

Added in version 6.25.0

The father’s name of the document owner.

drivingLicenseDetails

DrivingLicenseDetails? get drivingLicenseDetails

Added in version 8.0.0

Extra information about the scanned driver’s license

capturedSides

CapturedSides get capturedSides

Added in version 6.11.0

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

isBackSideCaptureSupported

bool get isBackSideCaptureSupported

Added in version 6.11.0

Indicates whether the document supports scanning of the back side.

visaNumber

String? get visaNumber

Added in version 7.0.0

The visa number of the document holder.

passportNumber

String? get passportNumber

Added in version 7.0.0

The passport number of the document holder.

vehicleOwner

String? get vehicleOwner

Added in version 8.0.0

The owner of the vehicle.

sex

String? get sex

Added in version 8.0.0

The sex of the document holder.

dateOfBirth

DateResult? get dateOfBirth

Added in version 8.0.0

The date of birth of the document holder.

nationality

String? get nationality

Added in version 8.0.0

The nationality of the document holder.

address

String? get address

Added in version 8.0.0

The address of the document holder.

documentNumber

String? get documentNumber

Added in version 8.0.0

The document number of the ID.

dateOfExpiry

DateResult? get dateOfExpiry

Added in version 8.0.0

The expiry date of the document.

dateOfIssue

DateResult? get dateOfIssue

Added in version 8.0.0

The issue date of the document.