VIZ Result
Defined in framework ScanditIdCapture
- VizResult
open class VizResult : NSObject
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
open var firstName: String? { get }
Added in version 6.26.0
The first name of the document holder. Separated by spaces if more than one name is present.
- lastName
open var lastName: String? { get }
Added in version 6.26.0
The last name of the document holder. Separated by spaces if more than one name is present.
- fullName
open var fullName: String? { get }
Added in version 6.26.0
The full name of the document holder.
- additionalNameInformation
open var additionalNameInformation: String? { get }
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
open var additionalAddressInformation: String? { get }
Added in version 6.5.0
The additional address information of the document holder.
- placeOfBirth
open var placeOfBirth: String? { get }
Added in version 6.5.0
The place of birth of the document holder.
- religion
open var religion: String? { get }
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
open var profession: String? { get }
Added in version 6.5.0
The profession of the document holder.
- maritalStatus
open var maritalStatus: String? { get }
Added in version 6.5.0
The marital status of the document holder.
- residentialStatus
open var residentialStatus: String? { get }
Added in version 6.5.0
The residential status of the document holder.
- employer
open var employer: String? { get }
Added in version 6.5.0
The employer of the document holder.
- personalIdNumber
open var personalIdNumber: String? { get }
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
open var documentAdditionalNumber: String? { get }
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
open var issuingJurisdiction: String? { get }
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
open var issuingJurisdictionISO: String? { get }
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
open var issuingAuthority: String? { get }
Added in version 6.5.1
The government body issuing this ID, e.g. the Department of Motor Vehicles.
- bloodType
open var bloodType: String? { get }
Added in version 6.25.0
The blood type of the document owner.
- sponsor
open var sponsor: String? { get }
Added in version 6.25.0
The sponsor of the document owner.
- mothersName
open var mothersName: String? { get }
Added in version 6.25.0
The mother’s name of the document owner.
- fathersName
open var fathersName: String? { get }
Added in version 6.25.0
The father’s name of the document owner.
- drivingLicenseDetails
open var drivingLicenseDetails: DrivingLicenseDetails? { get }
Added in version 6.25.0
Extra information about the scanned driver’s license
- capturedSides
open var capturedSides: CapturedSides { get }
Added in version 6.6.0
The sides of the document that were scanned to extract this VizResult.
- isBackSideCaptureSupported
open var isBackSideCaptureSupported:
Bool{ get }Added in version 6.6.0
Indicates whether the document supports scanning of the back side.
- visaNumber
open var visaNumber: String? { get }
Added in version 7.0.0
The visa number of the document holder.
- passportNumber
open var passportNumber: String? { get }
Added in version 7.0.0
The passport number of the document holder.
- vehicleOwner
open var vehicleOwner: String? { get }
Added in version 7.2.0
The owner of the vehicle.
- dateOfBirth
open var dateOfBirth: DateResult? { get }
Added in version 7.2.0
The date of birth of the document holder.
- nationality
open var nationality: String? { get }
Added in version 7.2.0
The nationality of the document holder.
- address
open var address: String? { get }
Added in version 7.2.0
The address of the document holder.
- documentNumber
open var documentNumber: String? { get }
Added in version 7.2.0
The document number of the ID.
- dateOfExpiry
open var dateOfExpiry: DateResult? { get }
Added in version 7.2.0
The expiry date of the document.
- dateOfIssue
open var dateOfIssue: DateResult? { get }
Added in version 7.2.0
The issue date of the document.