Physical Document Scanner

Defined in framework ScanditIdCapture

PhysicalDocumentScanner

open class PhysicalDocumentScanner : NSObject

Added in version 8.0.0

Base class for physical document scanners. Physical document scanners are used to capture data from physical identity documents such as ID cards, driver’s licenses, and passports. Concrete implementations are SingleSideScanner and FullDocumentScanner.

Single Side Scanner

SingleSideScanner

open 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.

init

convenience init(barcode: Bool = false, machineReadableZone: Bool = false, visualInspectionZone: Bool = false)

Added in version 8.0.0

Creates a new SingleSideScanner instance. All parameters default to false if not specified.

init

convenience init(enablingBarcode barcode: Bool, machineReadableZone: Bool, visualInspectionZone: Bool)

Added in version 8.0.0

Creates a new SingleSideScanner instance.

init

init(__enablingBarcode barcode: Bool, machineReadableZone: Bool, visualInspectionZone: Bool)

Added in version 8.0.0

Creates a new SingleSideScanner instance.

barcode

open var barcode: Bool { get }

Added in version 8.0.0

Extracts data from barcodes on identity documents

machineReadableZone

open var machineReadableZone: Bool { get }

Added in version 8.0.0

Extracts data from the Machine Readable Zone on identity documents

visualInspectionZone

open var visualInspectionZone: Bool { get }

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

open 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.

init

init()

Added in version 7.0.0

Creates a new FullDocumentScanner instance.