AAMVA VIZ Barcode Comparison Verifier

Defined in package com.scandit.datacapture.id.verification.aamvavizbarcode

ComparisonCheckResult

Added in version 6.11.0

The result of a comparison done by AamvaVizBarcodeComparisonVerifier of a single piece of data from an AAMVA-compliant personal identification document.

PASSED

Added in version 6.11.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.11.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.11.0

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

ComparisonCheck
interface ComparisonCheck<@NonNull T>

Added in version 6.11.0

A comparison done by AamvaVizBarcodeComparisonVerifier of a single piece of data from an AAMVA-compliant personal identification document.

checkResult
ComparisonCheckResult getCheckResult()

Added in version 6.11.0

Whether any suspicious divergence in data is detected.

resultDescription
@NonNull String getResultDescription()

Added in version 6.11.0

The human-readable result of the comparison.

aamvaBarcodeValue
@NonNull T getAamvaBarcodeValue()

Added in version 6.11.0

The piece of data extracted from the barcode present at the back side of an AAMVA-compliant personal identification document.

vizValue
@NonNull T getVizValue()

Added in version 6.11.0

The piece of data extracted from the human-readable front side of an AAMVA-compliant personal identification document.

AamvaVizBarcodeComparisonResult
class AamvaVizBarcodeComparisonResult

Added in version 6.11.0

The result of an AAMVA-compliant personal identification document verification conducted by AamvaVizBarcodeComparisonVerifier.

checksPassed
boolean getChecksPassed()

Added in version 6.11.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.

issuingCountryIsoMatch
@NonNull ComparisonCheck<@NonNull String> getIssuingCountryIsoMatch()

Added in version 6.11.0

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

issuingJurisdictionIsoMatch
@NonNull ComparisonCheck<@NonNull String> getIssuingJurisdictionIsoMatch()

Added in version 6.11.0

Whether the issuing jurisdictions (for example: an issuing state, territory or federal district for USA, or an issuing province or territory for Canada) extracted from both sources of the data are the same.

documentNumbersMatch
@NonNull ComparisonCheck<@NonNull String> getDocumentNumbersMatch()

Added in version 6.11.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.

fullNamesMatch
@NonNull ComparisonCheck<@NonNull String> getFullNamesMatch()

Added in version 6.11.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.

datesOfBirthMatch
@NonNull ComparisonCheck<@NonNull DateResult> getDatesOfBirthMatch()

Added in version 6.11.0

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

datesOfExpiryMatch
@NonNull ComparisonCheck<@NonNull DateResult> getDatesOfExpiryMatch()

Added in version 6.11.0

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

datesOfIssueMatch
@NonNull ComparisonCheck<@NonNull DateResult> getDatesOfIssueMatch()

Added in version 6.11.0

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

resultDescription
@NonNull String getResultDescription()

Added in version 6.11.0

The human-readable result of the verification.

toJson()
@NonNull String toJson()

Added in version 6.12.0

Returns the JSON representation of this object.

AamvaVizBarcodeComparisonVerifier
class AamvaVizBarcodeComparisonVerifier

Added in version 6.11.0

Validates the authenticity of the document by comparing the data from the VIZ and from the barcode on the back.

This verifier supports documents that follow the Driver License/Identification Card specification by the American Association of Motor Vehicle Administrators (AAMVA) and requires the front & back scanning mode.

Create the verifier and initialize IdCapture with the following settings:

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

AamvaVizBarcodeComparisonVerifier verifier = AamvaVizBarcodeComparisonVerifier.create();

IdCaptureSettings settings = new IdCaptureSettings();
settings.setSupportedDocuments(IdDocumentType.DL_VIZ);
settings.setSupportedSides(SupportedSides.FRONT_AND_BACK);

IdCapture idCapture = IdCapture.create(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:

@override
void didCaptureId(IdCapture idCapture, IdCaptureSession session) {
    CapturedId capturedId = session.getNewlyCapturedId();
    VizResult viz = capturedId.getViz();

    if (viz != null && viz.getCapturedSides() == SupportedSides.FRONT_AND_BACK) {
        AamvaVizBarcodeComparisonResult result = verifier.verify(capturedId);

        if (result.checksPassed()) {
            // Nothing suspicious was detected.
        } else {
            // You may inspect the results of individual checks, if you wish:

            if (result.datesOfBirthMatch.checkResult == FAILED) {
                // The holder’s date of birth from the front side does not match the one encoded in the barcode.
            }
        }
    }
}

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

create()
static @NonNull AamvaVizBarcodeComparisonVerifier create()

Added in version 6.11.0

Creates a new instance of this verifier.

verify(capturedId)
@NonNull AamvaVizBarcodeComparisonResult verify(@NonNull CapturedId capturedId)

Added in version 6.11.0

Compares the human-readable data from the front side of the document with the data encoded in the barcode, and signals any suspicious differences.