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)).

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.

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.

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.

documentAdditionalNumber#
String? get documentAdditionalNumber

Added in version 6.11.0

The additional number of the document.

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

An 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.

capturedSides#
SupportedSides 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.