VIZ MRZ Comparison Verifier

Defined under the namespace Scandit.Datacapture.Id

VizMrzComparisonCheckResult

Added in version 6.23.0

The result of a comparison done by VizMrzComparisonVerifier of a single piece of data from a personal identification document with a VIZ and an MRZ.

Passed

Added in version 6.23.0

The compared data matches. In some instances the check may permit minor data divergence, to compensate, for example, for a single character misread by OCR.

Failed

Added in version 6.23.0

Some suspicious differences detected. This doesn’t automatically mean that the document is fraudulent, but such document should be inspected more carefully.

Skipped

Added in version 6.23.0

The data necessary to perform the check is missing and thus it is skipped.

VizMrzComparisonCheck

interface VizMrzComparisonCheck<T>

Added in version 6.23.0

A comparison done by VizMrzComparisonVerifier of a single piece of data from a personal identification document with a VIZ and an MRZ.

checkResult

readonly checkResult: VizMrzComparisonCheckResult

Added in version 6.23.0

Whether any suspicious divergence in data is detected.

resultDescription

readonly resultDescription: string

Added in version 6.23.0

The human-readable result of the comparison.

vizValue

readonly vizValue: T | null

Added in version 6.23.0

The piece of data extracted from the human-readable zone of a personal identification document with a VIZ and an MRZ.

mrzValue

readonly mrzValue: T | null

Added in version 6.23.0

The piece of data extracted from the MRZ present at the front or the back side of a personal identification document with a VIZ and an MRZ.

VizMrzComparisonResult

class VizMrzComparisonResult

Added in version 6.23.0

The result of a personal identification document with a VIZ and an MRZ verification conducted by VizMrzComparisonVerifier.

checksPassed

get checksPassed(): boolean

Added in version 6.23.0

Whether all the checks conducted by the verifier passed. Only the check that were run count, so true is returned even if some of the checks were skipped.

fullNamesMatch

get fullNamesMatch(): VizMrzComparisonCheck<string>

Added in version 6.23.0

Whether the holder’s full names extracted from both sources of the data match. This check may permit minor data divergence, to compensate, for example, for a single character misread by OCR.

documentNumbersMatch

get documentNumbersMatch(): VizMrzComparisonCheck<string>

Added in version 6.23.0

Whether the document numbers extracted from both sources of the data match. This check may permit minor data divergence, to compensate, for example, for a single character misread by OCR.

datesOfBirthMatch

get datesOfBirthMatch(): VizMrzComparisonCheck<DateResult>

Added in version 6.23.0

Whether the holder’s dates of birth extracted from both sources of the data are the same.

datesOfExpiryMatch

get datesOfExpiryMatch(): VizMrzComparisonCheck<DateResult>

Added in version 6.23.0

Whether the document’s dates of expiry extracted from both sources of the data are the same.

issuingCountryIsoMatch

get issuingCountryIsoMatch(): VizMrzComparisonCheck<string>

Added in version 6.23.0

Whether the issuing countries extracted from both sources of the data are the same.

resultDescription

get resultDescription(): string

Added in version 6.23.0

The human-readable result of the verification.

VizMrzComparisonVerifier

class VizMrzComparisonVerifier

Added in version 6.23.0

Verifies a personal identification document with a VIZ and an MRZ by comparing the human-readable data of the document with the data encoded in the MRZ, and signals any suspicious differences.

The verifier may permit minor data divergence, to compensate, for example, for a single character misread by OCR. Thus, while it automatically detects many fraudulent documents, a failed check does not necessary mean that the document is invalid. It is up to the user to subject such documents to additional scrutiny.

Create the verifier and initialize IdCapture with the following settings:

const dataCaptureContext = DataCaptureContext.forLicenseKey("-- ENTER YOUR SCANDIT LICENSE KEY HERE --");

const verifier = VizMrzComparisonVerifier.create();

const settings = new IdCaptureSettings()
settings.supportedDocuments = [IdDocumentType.IdCardVIZ]
settings.supportedSides = SupportedSides.FrontAndBack

const idCapture = IdCapture.forContext(dataCaptureContext, settings)

Then proceed to capture the front side & the back side of a document as usual. After you capture the back side and receive the combined result for both sides, you may run the verifier as follows:

const idCaptureListener = {
    didCaptureId: async (_, session) => {
        const capturedId = session.newlyCapturedId;
        const vizResult = capturedId.vizResult;
        const mrzResult = capturedId.mrzResult;

        if (mrzResult && vizResult && vizResult.capturedSides === Scandit.SupportedSides.FrontAndBack) {
            const result = await verifier.verify(session.newlyCapturedId);
            if (result.checksPassed) {
                // Nothing suspicious was detected.
            } else {
                // You may inspect the results of individual checks, if you wish:
                if (result.datesOfBirthMatch.checkResult === VizMrzComparisonCheckResult.Failed) {
                    // The holder’s date of birth from the front side does not match the one encoded in the MRZ.
                }
            }
        }
    }
}

The return value allows you to query both the overall result of the verification and the results of individual checks. See VizMrzComparisonResult for details.

create(context)

static create(context: DataCaptureContext): VizMrzComparisonVerifier

Added in version 6.23.0

Creates a new instance of this verifier.

verify(capturedId)

verify(capturedId: CapturedId): Promise<VizMrzComparisonResult | null>

Added in version 6.23.0

Compares the human-readable data of the document with the data encoded in the MRZ, and signals any suspicious differences.