VIZ Result
Defined in library scandit_datacapture_id
- VizResult
class VizResultAdded 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.
- secondaryLastName
String? get secondaryLastName
Added in version 7.0.0
Optional secondary last name for document holders of French passports.
- additionalNameInformation
String? get additionalNameInformation
Added in version 6.11.0
The additional name information 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.
- 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.
- 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.
- 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.
- 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.
- capturedSides
CapturedSides get capturedSides
Added in version 6.11.0
The sides of the document that were scanned to extract this VizResult.