VIZ Result

Defined in framework ScanditIdCapture

SDCVizResult
@interface SDCVizResult : 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
@property (nonatomic, nullable, readonly) NSString *firstName

Added in version 6.26.0

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

lastName
@property (nonatomic, nullable, readonly) NSString *lastName

Added in version 6.26.0

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

secondaryLastName
@property (nonatomic, nullable, readonly) NSString *secondaryLastName

Added in version 6.26.0

Optional secondary last name for document holders of French passports.

fullName
@property (nonatomic, nonnull, readonly) NSString *fullName

Added in version 6.26.0

The full name of the document holder.

additionalNameInformation
@property (nonatomic, nullable, readonly) NSString *additionalNameInformation

Added in version 6.5.0

The additional name information of the document holder.

additionalAddressInformation
@property (nonatomic, nullable, readonly) NSString *additionalAddressInformation

Added in version 6.5.0

The additional address information of the document holder.

placeOfBirth
@property (nonatomic, nullable, readonly) NSString *placeOfBirth

Added in version 6.5.0

The place of birth of the document holder.

race
@property (nonatomic, nullable, readonly) NSString *race

Added in version 6.5.0

The race of the document holder.

religion
@property (nonatomic, nullable, readonly) NSString *religion

Added in version 6.5.0

The religion of the document holder.

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

profession
@property (nonatomic, nullable, readonly) NSString *profession

Added in version 6.5.0

The profession of the document holder.

maritalStatus
@property (nonatomic, nullable, readonly) NSString *maritalStatus

Added in version 6.5.0

The marital status of the document holder.

residentialStatus
@property (nonatomic, nullable, readonly) NSString *residentialStatus

Added in version 6.5.0

The residential status of the document holder.

employer
@property (nonatomic, nullable, readonly) NSString *employer

Added in version 6.5.0

The employer of the document holder.

personalIdNumber
@property (nonatomic, nullable, readonly) NSString *personalIdNumber

Added in version 6.5.0

The personal identification number.

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

documentAdditionalNumber
@property (nonatomic, nullable, readonly) NSString *documentAdditionalNumber

Added in version 6.5.0

The additional number of the document.

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

issuingJurisdiction
@property (nonatomic, nullable, readonly) NSString *issuingJurisdiction

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
@property (nonatomic, nullable, readonly) NSString *issuingJurisdictionISO

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). nil 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
@property (nonatomic, nullable, readonly) NSString *issuingAuthority

Added in version 6.5.1

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

bloodType
@property (nonatomic, nullable, readonly) NSString *bloodType

Added in version 6.25.0

The blood type of the document owner.

sponsor
@property (nonatomic, nullable, readonly) NSString *sponsor

Added in version 6.25.0

The sponsor of the document owner.

mothersName
@property (nonatomic, nullable, readonly) NSString *mothersName

Added in version 6.25.0

The mother’s name of the document owner.

fathersName
@property (nonatomic, nullable, readonly) NSString *fathersName

Added in version 6.25.0

The father’s name of the document owner.

drivingLicenseDetails
@property (nonatomic, nullable, readonly) SDCDrivingLicenseDetails *drivingLicenseDetails

Added in version 6.25.0

Extra information about the scanned driver’s license

capturedSides
@property (nonatomic, readonly) SDCSupportedSides capturedSides

Added in version 6.6.0

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

isBackSideCaptureSupported
@property (nonatomic, readonly) BOOL isBackSideCaptureSupported

Added in version 6.6.0

Indicates whether the document supports scanning of the back side.

JSONString
@property (nonatomic, nonnull, readonly) NSString *JSONString

Added in version 6.6.0