Physical Document Scanner
Defined under the namespace Scandit.Datacapture.Id
- PhysicalDocumentScanner
abstract class PhysicalDocumentScannerAdded in version 8.0.0
The base class for all physical document scanners. This class is abstract and cannot be instantiated directly.
- isSingleSideScanner()
isSingleSideScanner(): boolean
Added in version 8.0.0
Indicates whether the scanner is of type SingleSideScanner or not.
- isFullDocumentScanner()
isFullDocumentScanner(): boolean
Added in version 8.0.0
Indicates whether the scanner is of type FullDocumentScanner or not.
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.
- constructor(barcode, machineReadableZone, visualInspectionZone)
constructor(barcode: boolean, machineReadableZone: boolean, visualInspectionZone: boolean)
Added in version 8.0.0
Creates a new SingleSideScanner instance.
- barcode
get barcode(): boolean
Added in version 8.0.0
Extracts data from barcodes on identity 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.
- constructor()
constructor()Added in version 8.0.0
Creates a new FullDocumentScanner instance.