ID Capture Listener

Defined under the namespace Scandit.Datacapture.Id

Listener

interface Listener

Added in version 6.13.0

Listener interface for id capture.

didCaptureId(capturedId)

didCaptureId?: (capturedId: CapturedId) => Promise<void> | void

Added in version 7.0.0

Called whenever a document is recognized and parsed.

didRejectId(capturedId, reason)

didRejectId?: (capturedId: CapturedId,
        reason: RejectionReason) => Promise<void> | void

Added in version 7.0.0

Called whenever a personal identification document or its part is recognized in a frame, but rejected. A document is rejected if (a) it’s not enabled in the settings, (b) it’s a barcode of a correct symbology or a Machine Readable Zone (MRZ), but the data is encoded in an unexpected/incorrect format, (c) it’s a voided document and “RejectVoidedIds” is enabled.

didFailWithError(idCapture, error)

didFailWithError?: (idCapture: IdCapture,
        error: IdCaptureError) => void

Added in version 6.13.0

Called whenever an error occurred during frame processing. When called with the error code IdCaptureErrorCode.RecoveredAfterFailure, the process responsible to scan images malfunctioned and was restarted. When scanning both front and back sides, the developer is responsible to reset the scanning process by calling IdCapture.reset() and inform the user to start over with the front side.