VIZ Result

Defined in package com.scandit.datacapture.id.capture

VizResult
class VizResult

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

additionalNameInformation
@Nullable String getAdditionalNameInformation()

Added in version 6.5.0

The additional name information of the document holder.

additionalAddressInformation
@Nullable String getAdditionalAddressInformation()

Added in version 6.5.0

The additional address information of the document holder.

placeOfBirth
@Nullable String getPlaceOfBirth()

Added in version 6.5.0

The place of birth of the document holder.

race
@Nullable String getRace()

Added in version 6.5.0

The race of the document holder.

religion
@Nullable String getReligion()

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
@Nullable String getProfession()

Added in version 6.5.0

The profession of the document holder.

maritalStatus
@Nullable String getMaritalStatus()

Added in version 6.5.0

The marital status of the document holder.

residentialStatus
@Nullable String getResidentialStatus()

Added in version 6.5.0

The residential status of the document holder.

employer
@Nullable String getEmployer()

Added in version 6.5.0

The employer of the document holder.

personalIdNumber
@Nullable String getPersonalIdNumber()

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
@Nullable String getDocumentAdditionalNumber()

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
@Nullable String getIssuingJurisdiction()

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
@Nullable String getIssuingJurisdictionIso()

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
@Nullable String getIssuingAuthority()

Added in version 6.5.1

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

bloodType
@Nullable String getBloodType()

Added in version 6.25.0

The blood type of the document owner.

sponsor
@Nullable String getSponsor()

Added in version 6.25.0

The sponsor of the document owner.

mothersName
@Nullable String getMothersName()

Added in version 6.25.0

The mother’s name of the document owner.

fathersName
@Nullable String getFathersName()

Added in version 6.25.0

The father’s name of the document owner.

drivingLicenseDetails
@Nullable DrivingLicenseDetails getDrivingLicenseDetails()

Added in version 6.25.0

Extra information about the scanned driver’s license

capturedSides
SupportedSides getCapturedSides()

Added in version 6.6.0

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

isBackSideCaptureSupported
boolean isBackSideCaptureSupported()

Added in version 6.6.0

Indicates whether the document supports scanning of the back side.

equals(other)
boolean equals(@Nullable Object other)

Added in version 6.5.0

Indicates whether some other object is equal to this one.

hashCode()
int hashCode()

Added in version 6.5.0

Returns a hash code value for the object.