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, freeFormText, options)
constructor(barcode: boolean, machineReadableZone: boolean, visualInspectionZone: boolean, freeFormText: boolean, options?: SingleSideScannerOptions)
Added in version 8.3.0
Creates a new SingleSideScanner instance; freeFormText defaults to false. The freeFormText parameter is experimental and cannot be used without a compliant license key. The optional options parameter, available since 8.7, carries settings that are not zones, see SingleSideScannerOptions.
- barcode
get barcode(): boolean
Added in version 8.0.0
Extracts data from barcodes on identity documents
- machineReadableZone
get machineReadableZone(): boolean
Added in version 8.0.0
Extracts data from the Machine Readable Zone on identity documents
- visualInspectionZone
get visualInspectionZone(): boolean
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
- freeFormText
get freeFormText(): boolean
Added in version 8.3.0
Extracts free-form text from the document. This parameter is experimental and cannot be used without a compliant license key.
- manipulationCheck
get manipulationCheck(): boolean
Added in version 8.7.0
Whether the scanner runs in the manipulation check mode, set through SingleSideScannerOptions.manipulationCheck. Experimental.
- SingleSideScannerOptions
interface SingleSideScannerOptionsAdded in version 8.7.0
Additional settings of a SingleSideScanner that are not zones to extract data from.
- manipulationCheck
manipulationCheck?: boolean
Added in version 8.7.0
Experimental. Enables a verdict-only mode in which the document is localized on the device and its image is sent to the Scandit cloud for a manipulation check; no document data is extracted. The outcome is delivered as VerificationResult.documentManipulationResult on the captured document, or as a rejection with RejectionReason.ManipulatedDocument when the document is found to be manipulated. Requires cloud scanning to be allowed on the scanner and cannot be combined with any zone, including freeFormText: free-form text extracts data, while the manipulation check only returns a verdict. Requires a license key that includes ID Validate: Document Manipulation Detection; without it, the context status is 33830 and scanning stops.
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.