ID Capture Scanner

Defined in package com.scandit.datacapture.id

IdCaptureScanner

interface IdCaptureScanner

Added in version 7.0.0

Base class for all IdCaptureScanners

Single Side Scanner

SingleSideScanner

class SingleSideScanner : IdCaptureScanner

Added in version 7.0.0

Represents a scanner configuration that focuses on specific parts of a document (referred to as “zones”) rather than the entire document. The scanner can be customized to extract data from one or more of the following zones: barcodes, Machine-Readable Zone (MRZ) and Human-Readable Zone (Visual Inspection Zone, VIZ).

This scanner type is useful for tailored use cases, such as extracting specific data points from documents or handling scenarios where different document types encode information in varying zones. When multiple zones are enabled, the scanner intelligently captures data from the zone available on the presented document.

SingleSideScanner()

SingleSideScanner(boolean barcode,
        boolean machineReadableZone,
        boolean visualInspectionZone)

Added in version 7.0.0

barcode

boolean getBarcode()

Added in version 7.0.0

Extracts data from barcodes on identity documents

machineReadableZone

boolean getMachineReadableZone()

Added in version 7.0.0

Extracts data from the Machine Readable Zone on identity documents

visualInspectionZone

boolean getVisualInspectionZone()

Added in version 7.0.0

Extracts all information from the front side of a card format document or equivalent to “Full Document” for booklet documents

Full Document Scanner

FullDocumentScanner

class FullDocumentScanner : IdCaptureScanner

Added in version 7.0.0

Represents a scanner configuration that captures data from all supported parts of a document. This includes the human-readable zone (visual inspection zone, VIZ), the machine-readable zone (MRZ), and barcodes, provided they are present and supported by the library.

For card-format documents (e.g., driver’s licenses or ID cards), both the front and back are scanned. The user is prompted to scan the back after the front, and the combined result is returned.

For booklet-format documents (e.g., passports), the identity page is scanned, encompassing both the human-readable and machine-readable parts. This scanner type is ideal for use cases requiring comprehensive data extraction, data consistency checks, or full-document image capture.

FullDocumentScanner()

FullDocumentScanner()

Added in version 7.0.0

equals(other)

boolean equals(@Nullable Object other)

Added in version 7.0.0

Indicates whether some other object is equal to this one.

hashCode()

int hashCode()

Added in version 7.0.0

Returns a hash code value for the object.