Mobile Document Scanner

Defined under the namespace Scandit.Datacapture.Id

MobileDocumentScanner

class MobileDocumentScanner

Added in version 8.0.0

Configures scanning of mobile identity documents, including ISO 18013-5 compliant mobile driver’s licenses (mDL) and OCR-based mobile documents.

constructor(iso180135, ocr, elementsToRetain)

constructor(iso180135: boolean,
        ocr: boolean,
        elementsToRetain?: Set<MobileDocumentDataElement>)

Added in version 8.0.0

Creates a new MobileDocumentScanner instance with specified elements to retain.

Each requested data field includes a boolean IntentToRetain in device request according to ISO 18013-5 standards. This parameter allows you to specify which fields your application intends to retain, ensuring compliance with legal requirements. By default, IntentToRetain is set to false for all fields unless they are included in elementsToRetain.

iso180135

get iso180135(): boolean

Added in version 8.0.0

Indicates whether ISO 18013-5 mDL scanning is enabled. When enabled, the scanner can read mobile driver’s licenses that comply with the ISO 18013-5 standard via Bluetooth Low Energy (BLE) communication.

ocr

get ocr(): boolean

Added in version 8.0.0

Indicates whether OCR is enabled to extract data from mobile documents using a proprietary format. Note that this feature requires the ScanditLabelCaptureText library.

elementsToRetain

get elementsToRetain(): Set<MobileDocumentDataElement>

Added in version 8.0.0

The set of data elements that the application intends to retain from scanned mobile documents. This information is used to set the IntentToRetain flag in ISO 18013-5 mdoc requests, which is required for legal compliance with data protection standards. An empty set indicates no elements will be retained, and IntentToRetain will be set to false for all fields.