VIZ Result
Defined under the namespace Scandit.Datacapture.Id
- VIZResult
class VIZResultAdded in version 6.13.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
get firstName(): string | null
Added in version 6.26.0
The first name of the document holder. Separated by spaces if more than one name is present.
- lastName
get lastName(): string | null
Added in version 6.26.0
The last name of the document holder. Separated by spaces if more than one name is present.
- secondaryLastName
get secondaryLastName(): string | null
Added in version 6.26.0
Optional secondary last name for document holders of French passports.
- additionalNameInformation
get additionalNameInformation(): string | null
Added in version 6.13.0
The additional name information of the document holder.
- additionalAddressInformation
get additionalAddressInformation(): string | null
Added in version 6.13.0
The additional address information of the document holder.
- placeOfBirth
get placeOfBirth(): string | null
Added in version 6.13.0
The place of birth of the document holder.
- religion
get religion(): string | null
Added in version 6.13.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
get profession(): string | null
Added in version 6.13.0
The profession of the document holder.
- maritalStatus
get maritalStatus(): string | null
Added in version 6.13.0
The marital status of the document holder.
- residentialStatus
get residentialStatus(): string | null
Added in version 6.13.0
The residential status of the document holder.
- employer
get employer(): string | null
Added in version 6.13.0
The employer of the document holder.
- personalIdNumber
get personalIdNumber(): string | null
Added in version 6.13.0
The personal identification number.
If IdCaptureSettings.anonymizationMode is enabled for the field results, the returned value might be null for certain documents.
- documentAdditionalNumber
get documentAdditionalNumber(): string | null
Added in version 6.13.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
get issuingJurisdiction(): string | null
Added in version 6.13.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
get issuingJurisdictionIso(): string | null
Added in version 6.13.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
get issuingAuthority(): string | null
Added in version 6.13.0
The government body issuing this ID, e.g. the Department of Motor Vehicles.
- bloodType
get bloodType(): string | null
Added in version 6.28.0
The blood type of the document owner.
- mothersName
get mothersName(): string | null
Added in version 6.25.0
The mother’s name of the document owner.
- fathersName
get fathersName(): string | null
Added in version 6.25.0
The father’s name of the document owner.
- drivingLicenseDetails
get drivingLicenseDetails(): DrivingLicenseDetails | null
Added in version 6.25.0
Extra information about the scanned driver’s license
- capturedSides
get capturedSides(): CapturedSides
Added in version 6.13.0
The sides of the document that were scanned to extract this VizResult.
- isBackSideCaptureSupported
get isBackSideCaptureSupported(): boolean
Added in version 6.13.0
Indicates whether the document supports scanning of the back side.
- visaNumber
get visaNumber(): string | null
Added in version 7.0.0
The visa number of the document holder.
- passportNumber
get passportNumber(): string | null
Added in version 7.0.0
The passport number of the document holder.
- dateOfBirth
get dateOfBirth(): DateResult | null
Added in version 7.2.0
The date of birth of the document holder.
- nationality
get nationality(): string | null
Added in version 7.2.0
The nationality of the document holder.
- documentNumber
get documentNumber(): string | null
Added in version 7.2.0
The document number of the ID.
- dateOfExpiry
get dateOfExpiry(): DateResult | null
Added in version 7.2.0
The expiry date of the document.
- dateOfIssue
get dateOfIssue(): DateResult | null
Added in version 7.2.0
The issue date of the document.