Physical Document Scanner

Defined in library scandit_datacapture_id

PhysicalDocumentScanner

abstract class PhysicalDocumentScanner

Added in version 8.0.0

Sealed interface representing scanner configurations for physical identity documents (cards and booklets). Physical documents include ID cards, driver’s licenses, passports, and other government-issued documents.

Implementations:

SingleSideScanner - Scans specific zones (barcode, MRZ, VIZ) of a document

FullDocumentScanner - Scans all supported parts of a document, including both sides for card-format documents

Single Side Scanner

SingleSideScanner

class SingleSideScanner : PhysicalDocumentScanner

Added in version 8.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(barcode, machineReadableZone, visualInspectionZone)

 SingleSideScanner(bool barcode,
        bool machineReadableZone,
        bool visualInspectionZone)

Added in version 8.0.0

Creates a new SingleSideScanner instance.

barcode

bool get barcode

Added in version 8.0.0

Extracts data from barcodes on identity documents

machineReadableZone

bool get machineReadableZone

Added in version 8.0.0

Extracts data from the Machine Readable Zone on identity documents

visualInspectionZone

bool get visualInspectionZone

Added in version 8.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 : PhysicalDocumentScanner

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

Creates a new FullDocumentScanner instance.