Version: v3000 (Next)

API reference (Web SDK)

Enumerations

PreferredCameraType

Defined in: src/MicroblinkSDK/CameraUtils.ts:8

Preferred type of camera to be used when opening the camera feed.

Enumeration Members

BackFacingCamera

BackFacingCamera: 0

Defined in: src/MicroblinkSDK/CameraUtils.ts:11

Prefer back facing camera

FrontFacingCamera

FrontFacingCamera: 1

Defined in: src/MicroblinkSDK/CameraUtils.ts:13

Prefer front facing camera

ImageOrientation

Defined in: src/MicroblinkSDK/DataStructures.ts:18

Specifies the orientation of the contents of the image. This is important for some recognizers, especially when performing recognition on the mobile device.

Enumeration Members

RotatedLeft90

RotatedLeft90: 0

Defined in: src/MicroblinkSDK/DataStructures.ts:26

Image contents are rotated 90 degrees left. This usually happens on mobile devices when capturing image while device is held in "portrait" orientation, while device camera sensor is mounted horizontally (i.e. produced image is in "landscape" orienation).

NoRotation

NoRotation: 1

Defined in: src/MicroblinkSDK/DataStructures.ts:36

Image contents are not rotated in any manner. This is the default for images captured using HTML canvas, as used in FrameCapture class. This orientation also usually happens on mobile devices when capturing image while device is held in "landscape" orientation, while device camera sensor is mounted horizontally (i.e. also in same orientation).

RotatedRight90

RotatedRight90: 2

Defined in: src/MicroblinkSDK/DataStructures.ts:44

Image contents are rotated 90 degrees right. This usually happens on mobile devices when capturing image while device is held in "reverse-portrait" orientation, while device camera sensor is mounted horizontally (i.e. produced image is in "landscape" orienation).

Rotated180

Rotated180: 3

Defined in: src/MicroblinkSDK/DataStructures.ts:52

Image contents are rotated 180 degrees, i.e. image contents are "upside down". This usually happens on mobile devices when capturing image while device is held in "reverse-landscape" orientation, while device camera sensor is mounted horizontally (i.e. produced image is in "landscape" orienation).

RecognizerResultState

Defined in: src/MicroblinkSDK/DataStructures.ts:58

Specifies the state of the recognition result.

Enumeration Members

Empty

Empty: 0

Defined in: src/MicroblinkSDK/DataStructures.ts:61

Nothing has been recognized.

Uncertain

Uncertain: 1

Defined in: src/MicroblinkSDK/DataStructures.ts:63

Something has been recognized, but some mandatory data is still missing.

Valid

Valid: 2

Defined in: src/MicroblinkSDK/DataStructures.ts:65

All required data has been recognized.

StageValid

StageValid: 3

Defined in: src/MicroblinkSDK/DataStructures.ts:67

Single stage of a multi-stage recognition is finished.

DetectionLevel

Defined in: src/MicroblinkSDK/DetectionLevel.ts:12

Represents the different levels of detection sensitivity.

This enum class is used to configure detection thresholds and enable or disable detection functionality. The levels range from turning detection off completely to setting various levels of sensitivity (Low, Mid, High).

Enumeration Members

Off

Off: 0

Defined in: src/MicroblinkSDK/DetectionLevel.ts:13

Low

Low: 1

Defined in: src/MicroblinkSDK/DetectionLevel.ts:14

Mid

Mid: 2

Defined in: src/MicroblinkSDK/DetectionLevel.ts:15

High

High: 3

Defined in: src/MicroblinkSDK/DetectionLevel.ts:16

DocumentSide

Defined in: src/MicroblinkSDK/DocumentSide.ts:9

The side of the document.

Enumeration Members

Front

Front: 0

Defined in: src/MicroblinkSDK/DocumentSide.ts:11

Back

Back: 1

Defined in: src/MicroblinkSDK/DocumentSide.ts:12

ErrorCodes

Defined in: src/MicroblinkSDK/ErrorTypes.ts:12

Structures of Error Codes, Error Messages, and CustomError compatible objects for the Error Generator utility. Error Code convention: SECTION_OBJECT_(ACTION)_PROBLEM

Enumeration Members

WORKER_WASM_LOAD_FAILURE

WORKER_WASM_LOAD_FAILURE: "WORKER_WASM_LOAD_FAILURE"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:13

WORKER_WASM_INIT_MISSING

WORKER_WASM_INIT_MISSING: "WORKER_WASM_INIT_MISSING"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:14

WORKER_FUNCTION_INVOKE_FAILURE

WORKER_FUNCTION_INVOKE_FAILURE: "WORKER_FUNCTION_INVOKE_FAILURE"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:15

WORKER_RECOGNIZER_CREATION_FAILURE

WORKER_RECOGNIZER_CREATION_FAILURE: "WORKER_RECOGNIZER_CREATION_FAILURE"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:16

WORKER_RUNNER_EXISTS

WORKER_RUNNER_EXISTS: "WORKER_RUNNER_EXISTS"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:17

WORKER_RUNNER_CREATION_FAILURE

WORKER_RUNNER_CREATION_FAILURE: "WORKER_RUNNER_CREATION_FAILURE"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:18

WORKER_RUNNER_MISSING

WORKER_RUNNER_MISSING: "WORKER_RUNNER_MISSING"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:19

WORKER_RUNNER_RECONFIGURE_FAILURE

WORKER_RUNNER_RECONFIGURE_FAILURE: "WORKER_RUNNER_RECONFIGURE_FAILURE"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:20

WORKER_RUNNER_DELETED

WORKER_RUNNER_DELETED: "WORKER_RUNNER_DELETED"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:21

WORKER_RUNNER_DELETE_FAILURE

WORKER_RUNNER_DELETE_FAILURE: "WORKER_RUNNER_DELETE_FAILURE"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:22

WORKER_OBJECT_INVOKE_FAILURE

WORKER_OBJECT_INVOKE_FAILURE: "WORKER_OBJECT_INVOKE_FAILURE"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:23

WORKER_IMAGE_PROCESS_FAILURE

WORKER_IMAGE_PROCESS_FAILURE: "WORKER_IMAGE_PROCESS_FAILURE"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:24

WORKER_HANDLE_UNDEFINED

WORKER_HANDLE_UNDEFINED: "WORKER_HANDLE_UNDEFINED"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:25

WORKER_MESSAGE_ACTION_UNKNOWN

WORKER_MESSAGE_ACTION_UNKNOWN: "WORKER_MESSAGE_ACTION_UNKNOWN"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:26

WORKER_LICENSE_UNLOCK_ERROR

WORKER_LICENSE_UNLOCK_ERROR: "WORKER_LICENSE_UNLOCK_ERROR"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:27

WORKER_INTEGRATION_INFO_FAILURE

WORKER_INTEGRATION_INFO_FAILURE: "WORKER_INTEGRATION_INFO_FAILURE"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:28

LOCAL_SDK_RUNNER_MISSING

LOCAL_SDK_RUNNER_MISSING: "LOCAL_SDK_RUNNER_MISSING"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:30

LOCAL_SDK_RUNNER_EMPTY

LOCAL_SDK_RUNNER_EMPTY: "LOCAL_SDK_RUNNER_EMPTY"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:31

LICENSE_UNLOCK_ERROR

LICENSE_UNLOCK_ERROR: "LICENSE_UNLOCK_ERROR"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:33

FRAME_CAPTURE_SVG_UNSUPPORTED

FRAME_CAPTURE_SVG_UNSUPPORTED: "FRAME_CAPTURE_SVG_UNSUPPORTED"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:35

FRAME_CAPTURE_CANVAS_MISSING

FRAME_CAPTURE_CANVAS_MISSING: "FRAME_CAPTURE_CANVAS_MISSING"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:36

SDK_WASM_SETTINGS_MISSING

SDK_WASM_SETTINGS_MISSING: "SDK_WASM_SETTINGS_MISSING"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:38

SDK_LICENSE_KEY_MISSING

SDK_LICENSE_KEY_MISSING: "SDK_LICENSE_KEY_MISSING"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:39

SDK_WASM_MODULE_NAME_MISSING

SDK_WASM_MODULE_NAME_MISSING: "SDK_WASM_MODULE_NAME_MISSING"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:40

SDK_ENGINE_LOCATION_INVALID

SDK_ENGINE_LOCATION_INVALID: "SDK_ENGINE_LOCATION_INVALID"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:41

SDK_WORKER_LOCATION_INVALID

SDK_WORKER_LOCATION_INVALID: "SDK_WORKER_LOCATION_INVALID"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:42

SDK_MISSING

SDK_MISSING: "SDK_MISSING"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:43

SDK_RECOGNIZERS_MISSING

SDK_RECOGNIZERS_MISSING: "SDK_RECOGNIZERS_MISSING"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:44

VIDEO_RECOGNIZER_ELEMENT_MISSING

VIDEO_RECOGNIZER_ELEMENT_MISSING: "VIDEO_RECOGNIZER_ELEMENT_MISSING"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:46

VIDEO_RECOGNIZER_CAMERA_MISSING

VIDEO_RECOGNIZER_CAMERA_MISSING: "VIDEO_RECOGNIZER_CAMERA_MISSING"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:47

VIDEO_RECOGNIZER_CAMERA_NOT_ALLOWED

VIDEO_RECOGNIZER_CAMERA_NOT_ALLOWED: "VIDEO_RECOGNIZER_CAMERA_NOT_ALLOWED"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:48

VIDEO_RECOGNIZER_CAMERA_UNAVAILABLE

VIDEO_RECOGNIZER_CAMERA_UNAVAILABLE: "VIDEO_RECOGNIZER_CAMERA_UNAVAILABLE"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:49

VIDEO_RECOGNIZER_CAMERA_IN_USE

VIDEO_RECOGNIZER_CAMERA_IN_USE: "VIDEO_RECOGNIZER_CAMERA_IN_USE"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:50

VIDEO_RECOGNIZER_MEDIA_DEVICES_UNSUPPORTED

VIDEO_RECOGNIZER_MEDIA_DEVICES_UNSUPPORTED: "VIDEO_RECOGNIZER_MEDIA_DEVICES_UNSUPPORTED"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:51

VIDEO_RECOGNIZER_FEED_RELEASED

VIDEO_RECOGNIZER_FEED_RELEASED: "VIDEO_RECOGNIZER_FEED_RELEASED"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:52

VIDEO_RECOGNIZER_FEED_NOT_PAUSED

VIDEO_RECOGNIZER_FEED_NOT_PAUSED: "VIDEO_RECOGNIZER_FEED_NOT_PAUSED"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:53

VIDEO_RECOGNIZER_PLAY_REQUEST_INTERRUPTED

VIDEO_RECOGNIZER_PLAY_REQUEST_INTERRUPTED: "VIDEO_RECOGNIZER_PLAY_REQUEST_INTERRUPTED"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:54

VIDEO_RECOGNIZER_FEED_PAUSED

VIDEO_RECOGNIZER_FEED_PAUSED: "VIDEO_RECOGNIZER_FEED_PAUSED"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:55

VIDEO_RECOGNIZER_RECOGNIZERS_RESET_FAILURE

VIDEO_RECOGNIZER_RECOGNIZERS_RESET_FAILURE: "VIDEO_RECOGNIZER_RECOGNIZERS_RESET_FAILURE"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:56

VIDEO_RECOGNIZER_FEED_MISSING

VIDEO_RECOGNIZER_FEED_MISSING: "VIDEO_RECOGNIZER_FEED_MISSING"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:57

ErrorMessages

Defined in: src/MicroblinkSDK/ErrorTypes.ts:60

Enumeration Members

WORKER_HANDLE_UNDEFINED

WORKER_HANDLE_UNDEFINED: "Cannot find object with handle: undefined"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:61

WORKER_WASM_LOAD_FAILURE

WORKER_WASM_LOAD_FAILURE: "Failed to load WASM in web worker!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:62

WORKER_WASM_INIT_MISSING

WORKER_WASM_INIT_MISSING: "WASM module is not initialized!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:63

WORKER_FUNCTION_INVOKE_FAILURE

WORKER_FUNCTION_INVOKE_FAILURE: "Failed to invoke function!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:64

WORKER_RECOGNIZER_CREATION_FAILURE

WORKER_RECOGNIZER_CREATION_FAILURE: "Failed to create new recognizer!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:65

WORKER_RUNNER_EXISTS

WORKER_RUNNER_EXISTS: "Recognizer runner is already created! Multiple instances are not allowed!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:66

WORKER_RUNNER_CREATION_FAILURE

WORKER_RUNNER_CREATION_FAILURE: "Failed to create new recognizer runner!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:67

WORKER_RUNNER_MISSING

WORKER_RUNNER_MISSING: "Recognizer runner is not created! There is nothing to reconfigure!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:68

WORKER_RUNNER_RECONFIGURE_FAILURE

WORKER_RUNNER_RECONFIGURE_FAILURE: "Failed to reconfigure recognizer runner!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:69

WORKER_RUNNER_DELETED

WORKER_RUNNER_DELETED: "Recognizer runner is already deleted!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:70

WORKER_RUNNER_DELETE_FAILURE

WORKER_RUNNER_DELETE_FAILURE: "Failed to delete recognizer runner!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:71

WORKER_OBJECT_INVOKE_FAILURE

WORKER_OBJECT_INVOKE_FAILURE: "Failed to invoke object!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:72

WORKER_IMAGE_PROCESS_FAILURE

WORKER_IMAGE_PROCESS_FAILURE: "Recognizer runner is not initialized! Cannot process image!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:73

WORKER_INTEGRATION_INFO_FAILURE

WORKER_INTEGRATION_INFO_FAILURE: "Failed to get product integration info!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:74

LOCAL_SDK_RUNNER_MISSING

LOCAL_SDK_RUNNER_MISSING: "Property nativeRecognizerRunner is not available!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:76

LOCAL_SDK_RUNNER_EMPTY

LOCAL_SDK_RUNNER_EMPTY: "Native RecognizerRunner cannot be empty!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:77

LICENSE_TOKEN_STATE_INCORRECT

LICENSE_TOKEN_STATE_INCORRECT: "Internal error (Incorrect token state)"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:79

LICENSE_PAYLOAD_VERIFICATION_FAILED

LICENSE_PAYLOAD_VERIFICATION_FAILED: "Failed to verify server permission's digital signature!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:80

LICENSE_PAYLOAD_CORRUPTED

LICENSE_PAYLOAD_CORRUPTED: "Server permission payload is corrupted!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:81

LICENSE_PERMISSION_EXPIRED

LICENSE_PERMISSION_EXPIRED: "Internal error (server permission expired)"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:82

LICENSE_REMOTE_LOCKED

LICENSE_REMOTE_LOCKED: "Provided license key has been remotely locked. Please contact support for more information!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:83

FRAME_CAPTURE_SVG_UNSUPPORTED

FRAME_CAPTURE_SVG_UNSUPPORTED: "Recognition of SVG elements not supported!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:85

FRAME_CAPTURE_CANVAS_MISSING

FRAME_CAPTURE_CANVAS_MISSING: "Could not get canvas 2d context!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:86

SDK_WASM_SETTINGS_MISSING

SDK_WASM_SETTINGS_MISSING: "Missing WASM load settings!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:88

SDK_LICENSE_KEY_MISSING

SDK_LICENSE_KEY_MISSING: "Missing license key!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:89

SDK_WASM_MODULE_NAME_MISSING

SDK_WASM_MODULE_NAME_MISSING: "Missing WASM module name!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:90

SDK_ENGINE_LOCATION_INVALID

SDK_ENGINE_LOCATION_INVALID: "Setting property 'engineLocation' must be a string!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:91

SDK_WORKER_LOCATION_INVALID

SDK_WORKER_LOCATION_INVALID: "Setting property 'workerLocation' must be a string!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:92

SDK_MISSING

SDK_MISSING: "SDK is not provided!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:93

SDK_RECOGNIZERS_MISSING

SDK_RECOGNIZERS_MISSING: "To create RecognizerRunner at least 1 recognizer is required."

Defined in: src/MicroblinkSDK/ErrorTypes.ts:94

VIDEO_RECOGNIZER_ELEMENT_MISSING

VIDEO_RECOGNIZER_ELEMENT_MISSING: "Video element, i.e. camera feed is not provided!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:96

VIDEO_RECOGNIZER_CAMERA_MISSING

VIDEO_RECOGNIZER_CAMERA_MISSING: "Camera not found!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:97

VIDEO_RECOGNIZER_CAMERA_NOT_ALLOWED

VIDEO_RECOGNIZER_CAMERA_NOT_ALLOWED: "Camera not allowed!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:98

VIDEO_RECOGNIZER_CAMERA_UNAVAILABLE

VIDEO_RECOGNIZER_CAMERA_UNAVAILABLE: "Camera not available!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:99

VIDEO_RECOGNIZER_CAMERA_IN_USE

VIDEO_RECOGNIZER_CAMERA_IN_USE: "Camera in use!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:100

VIDEO_RECOGNIZER_MEDIA_DEVICES_UNSUPPORTED

VIDEO_RECOGNIZER_MEDIA_DEVICES_UNSUPPORTED: "Media devices not supported by browser."

Defined in: src/MicroblinkSDK/ErrorTypes.ts:101

VIDEO_RECOGNIZER_FEED_RELEASED

VIDEO_RECOGNIZER_FEED_RELEASED: "The associated video feed has been released!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:102

VIDEO_RECOGNIZER_FEED_NOT_PAUSED

VIDEO_RECOGNIZER_FEED_NOT_PAUSED: "The associated video feed is not paused. Use resumeRecognition instead!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:103

VIDEO_RECOGNIZER_PLAY_REQUEST_INTERRUPTED

VIDEO_RECOGNIZER_PLAY_REQUEST_INTERRUPTED: "The play() request was interrupted or prevented by browser security rules!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:104

VIDEO_RECOGNIZER_FEED_PAUSED

VIDEO_RECOGNIZER_FEED_PAUSED: "Cannot resume recognition while video feed is paused! Use recognize or startRecognition"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:105

VIDEO_RECOGNIZER_RECOGNIZERS_RESET_FAILURE

VIDEO_RECOGNIZER_RECOGNIZERS_RESET_FAILURE: "Could not reset recognizers!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:106

VIDEO_RECOGNIZER_FEED_MISSING

VIDEO_RECOGNIZER_FEED_MISSING: "Missing video feed!"

Defined in: src/MicroblinkSDK/ErrorTypes.ts:107

LicenseTokenState

Defined in: src/MicroblinkSDK/License.ts:8

Enumeration Members

Invalid

Invalid: 0

Defined in: src/MicroblinkSDK/License.ts:10

RequiresServerPermission

RequiresServerPermission: 1

Defined in: src/MicroblinkSDK/License.ts:11

Valid

Valid: 2

Defined in: src/MicroblinkSDK/License.ts:12

LicenseErrorType

Defined in: src/MicroblinkSDK/License.ts:31

Enumeration Members

LicenseTokenStateInvalid

LicenseTokenStateInvalid: "LICENSE_TOKEN_STATE_INVALID"

Defined in: src/MicroblinkSDK/License.ts:32

NetworkError

NetworkError: "NETWORK_ERROR"

Defined in: src/MicroblinkSDK/License.ts:33

RemoteLock

RemoteLock: "REMOTE_LOCK"

Defined in: src/MicroblinkSDK/License.ts:34

PermissionExpired

PermissionExpired: "PERMISSION_EXPIRED"

Defined in: src/MicroblinkSDK/License.ts:35

PayloadCorrupted

PayloadCorrupted: "PAYLOAD_CORRUPTED"

Defined in: src/MicroblinkSDK/License.ts:36

PayloadSignatureVerificationFailed

PayloadSignatureVerificationFailed: "PAYLOAD_SIGNATURE_VERIFICATION_FAILED"

Defined in: src/MicroblinkSDK/License.ts:37

IncorrectTokenState

IncorrectTokenState: "INCORRECT_TOKEN_STATE"

Defined in: src/MicroblinkSDK/License.ts:38

ServerPermissionSubmitResultStatus

Defined in: src/MicroblinkSDK/License.ts:86

Enumeration Members

Ok

Ok: 0

Defined in: src/MicroblinkSDK/License.ts:88

NetworkError

NetworkError: 1

Defined in: src/MicroblinkSDK/License.ts:89

RemoteLock

RemoteLock: 2

Defined in: src/MicroblinkSDK/License.ts:90

PermissionExpired

PermissionExpired: 3

Defined in: src/MicroblinkSDK/License.ts:91

PayloadCorrupted

PayloadCorrupted: 4

Defined in: src/MicroblinkSDK/License.ts:92

PayloadSignatureVerificationFailed

PayloadSignatureVerificationFailed: 5

Defined in: src/MicroblinkSDK/License.ts:93

IncorrectTokenState

IncorrectTokenState: 6

Defined in: src/MicroblinkSDK/License.ts:94

DetectionStatus

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:52

Detection status of the specific detected object.

Enumeration Members

Failed

Failed: 0

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:55

Detection has failed.

Success

Success: 1

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:57

Document has been detected.

CameraTooFar

CameraTooFar: 2

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:59

Document has been detected but the camera is too far from the document.

CameraTooClose

CameraTooClose: 3

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:61

Document has been detected but the camera is too close to the document.

CameraAngleTooSteep

CameraAngleTooSteep: 4

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:63

Document has been detected but the camera’s angle is too steep.

DocumentTooCloseToCameraEdge

DocumentTooCloseToCameraEdge: 5

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:65

Document has been detected but the document is too close to the camera edge.

DocumentPartiallyVisible

DocumentPartiallyVisible: 6

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:67

Only part of the document is visible.

FallbackSuccess

FallbackSuccess: 7

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:69

Fallback detection was successful (PhotoPay specific).

VideoRecognitionMode

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:36

Indicates mode of recognition in VideoRecognizer.

Enumeration Members

Recognition

Recognition: 0

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:38

Normal recognition

RecognitionTest

RecognitionTest: 1

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:40

Indefinite scan. Useful for profiling the performance of scan (using onDebugText metadata callback)

DetectionTest

DetectionTest: 2

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:42

Only detection. Useful for profiling the performance of detection (using onDebugText metadata callback)

WasmType

Defined in: src/MicroblinkSDK/WasmType.ts:8

Defines the type of the WASM that will be loaded.

Enumeration Members

Basic

Basic: "BASIC"

Defined in: src/MicroblinkSDK/WasmType.ts:14

The WASM that will be loaded will be most compatible with all browsers that support the WASM, but will lack features that could be used to improve performance.

Advanced

Advanced: "ADVANCED"

Defined in: src/MicroblinkSDK/WasmType.ts:22

The WASM that will be loaded will be built with advanced WASM features, such as bulk memory, SIMD, non-trapping floating point and sign extension. Such WASM can only be executed in browsers that support those features. Attempting to run this WASM in a non-compatible browser will crash your app.

AdvancedWithThreads

AdvancedWithThreads: "ADVANCED_WITH_THREADS"

Defined in: src/MicroblinkSDK/WasmType.ts:30

The WASM that will be loaded will be build with advanced WASM features, just like above. Additionally, it will be also built with support for multi-threaded processing. This feature requires a browser with support for both advanced WASM features and SharedArrayBuffer

LivenessStatus

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:24

Enumeration Members

NotAvailable

NotAvailable: 0

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:28

Verification process has not been started yet

HandNotPresent

HandNotPresent: 1

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:32

Hand not present

NotEnoughHandPresent

NotEnoughHandPresent: 2

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:36

Not enough hand present

DocumentNotInHand

DocumentNotInHand: 3

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:40

Detected document not in hand

DocumentInHand

DocumentInHand: 4

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:44

Detected document in hand

CheckResult

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:49

Enumeration Members

NotPerformed

NotPerformed: 0

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:50

Pass

Pass: 1

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:51

Fail

Fail: 2

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:52

MatchLevel

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:55

Enumeration Members

Disabled

Disabled: 0

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:56

Level1

Level1: 1

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:57

Level2

Level2: 2

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:58

Level3

Level3: 3

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:59

Level4

Level4: 4

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:60

Level5

Level5: 5

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:61

Level6

Level6: 6

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:62

Level7

Level7: 7

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:63

Level8

Level8: 8

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:64

Level9

Level9: 9

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:65

Level10

Level10: 10

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:66

AnonymizationMode

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:88

Determines which data is anonymized in the returned recognizer result

Enumeration Members

None

None: 0

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:91

No anonymization is performed in this mode.

ImageOnly

ImageOnly: 1

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:97

Sensitive data in the document image is anonymized with black boxes covering selected sensitive data. Data returned in result fields is not changed.

ResultFieldsOnly

ResultFieldsOnly: 2

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:100

Document image is not changed. Data returned in result fields is redacted.

FullResult

FullResult: 3

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:106

Sensitive data in the image is anonymized with black boxes covering selected sensitive data. Data returned in result fields is redacted.

Count

Count: 4

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:109

Number of possible anonymization modes.

CardIssuer

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:369

Payment Card Issuer defines supported issuing institutions that issued the card to the card holder.

Enumeration Members

Other

Other: 0

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:372

AmericanExpress

AmericanExpress: 1

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:375

ChinaUnionPay

ChinaUnionPay: 2

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:378

Diners

Diners: 3

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:381

DiscoverCard

DiscoverCard: 4

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:384

Elo

Elo: 5

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:387

Jcb

Jcb: 6

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:390

Maestro

Maestro: 7

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:393

Mastercard

Mastercard: 8

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:396

RuPay

RuPay: 9

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:399

Verve

Verve: 10

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:402

Visa

Visa: 11

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:405

VPay

VPay: 12

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:408

Count

Count: 13

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:411

ProcessingStatus

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:417

Detailed information about the recognition process.

Enumeration Members

Success

Success: 0

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:420

Recognition was successful.

DetectionFailed

DetectionFailed: 1

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:423

Detection of the document failed.

ImagePreprocessingFailed

ImagePreprocessingFailed: 2

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:426

Preprocessing of the input image has failed.

StabilityTestFailed

StabilityTestFailed: 3

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:429

Recognizer has inconsistent results.

ScanningWrongSide

ScanningWrongSide: 4

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:432

Wrong side of the document has been scanned.

FieldIdentificationFailed

FieldIdentificationFailed: 5

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:435

Identification of the fields present on the card has failed.

ImageReturnFailed

ImageReturnFailed: 6

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:438

Failed to return a requested image.

UnsupportedCard

UnsupportedCard: 7

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:441

Payment card currently not supported by the recognizer.

Count

Count: 8

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:444

Number of possible processing statuses.

Classes

SelectedCamera

Defined in: src/MicroblinkSDK/CameraUtils.ts:171

Constructors

Constructor

new SelectedCamera(mdi, facing, label?): SelectedCamera

Defined in: src/MicroblinkSDK/CameraUtils.ts:181

Parameters

mdi

MediaDeviceInfo

facing

PreferredCameraType

label?

string

Returns

SelectedCamera

Properties

deviceId

readonly deviceId: string

Defined in: src/MicroblinkSDK/CameraUtils.ts:173

groupId

readonly groupId: string

Defined in: src/MicroblinkSDK/CameraUtils.ts:175

facing

readonly facing: PreferredCameraType

Defined in: src/MicroblinkSDK/CameraUtils.ts:177

label

readonly label: string

Defined in: src/MicroblinkSDK/CameraUtils.ts:179

CapturedFrame

Defined in: src/MicroblinkSDK/FrameCapture.ts:20

Represents a captured frame from HTMLVideoElement.

Constructors

Constructor

new CapturedFrame(imageData, orientation, videoFrame): CapturedFrame

Defined in: src/MicroblinkSDK/FrameCapture.ts:31

Parameters

imageData

ImageData

orientation

ImageOrientation

videoFrame

boolean

Returns

CapturedFrame

Properties

imageData

readonly imageData: ImageData

Defined in: src/MicroblinkSDK/FrameCapture.ts:23

Instance of ImageData object - contains pixels and metadata about the captured image.

orientation

readonly orientation: ImageOrientation

Defined in: src/MicroblinkSDK/FrameCapture.ts:26

Orientation of the captured frame

videoFrame

readonly videoFrame: boolean

Defined in: src/MicroblinkSDK/FrameCapture.ts:29

Indicates whether captured frame originated from still image or video stream.

SDKError

Defined in: src/MicroblinkSDK/SDKError.ts:8

Extends

Error

Constructors

Constructor

new SDKError(error, details?): SDKError

Defined in: src/MicroblinkSDK/SDKError.ts:16

Parameters

error

{ code: string; message: string; } | SerializableSDKError

details?

any

Returns

SDKError

Overrides

Error.constructor

Properties

code

code: string

Defined in: src/MicroblinkSDK/SDKError.ts:10

message

message: string

Defined in: src/MicroblinkSDK/SDKError.ts:12

Overrides

Error.message

details?

optional details: any

Defined in: src/MicroblinkSDK/SDKError.ts:14

SerializableSDKError

Defined in: src/MicroblinkSDK/SDKError.ts:48

Constructors

Constructor

new SerializableSDKError(error, details?): SerializableSDKError

Defined in: src/MicroblinkSDK/SDKError.ts:56

Parameters

error

code

string

message

string

details?

any

Returns

SerializableSDKError

Properties

code

code: string

Defined in: src/MicroblinkSDK/SDKError.ts:50

message

message: string

Defined in: src/MicroblinkSDK/SDKError.ts:52

details?

optional details: any

Defined in: src/MicroblinkSDK/SDKError.ts:54

VideoRecognizer

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:59

A wrapper around RecognizerRunner that can use it to perform recognition of video feeds - either from live camera or from predefined video file.

Constructors

Constructor

new VideoRecognizer(videoElement, recognizerRunner, cameraFlipped, deviceId): VideoRecognizer

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:114

Use only if provided factory functions are not well-suited for your use case.

Creates a new VideoRecognizer with provided HTMLVideoElement.

Keep in mind that HTMLVideoElement must have a video feed which is ready to use.

If you want to take advantage of provided camera management, use createVideoRecognizerFromCameraStream
In case that static video file should be processed, use createVideoRecognizerFromVideoPath

Parameters

videoElement

HTMLVideoElement

HTMLVideoElement with video feed which is going to be processed

recognizerRunner

RecognizerRunner

RecognizerRunner that should be used for video stream recognition

cameraFlipped

boolean = false

Whether the camera is flipped, e.g. if front-facing camera is used

deviceId

string | null

Returns

VideoRecognizer

Properties

deviceId

deviceId: string | null = null

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:65

Methods

createVideoRecognizerFromCameraStream()

static createVideoRecognizerFromCameraStream(cameraFeed, recognizerRunner, cameraId, preferredCameraType): Promise<VideoRecognizer>

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:171

Creates a new VideoRecognizer by opening a camera stream and attaching it to given HTMLVideoElement. If camera cannot be accessed, the returned promise will be rejected.

Parameters

cameraFeed

HTMLVideoElement

HTMLVideoElement to which camera stream should be attached

recognizerRunner

RecognizerRunner

RecognizerRunner that should be used for video stream recognition

cameraId

User can provide specific camera ID to be selected and used

string | null

preferredCameraType

PreferredCameraType = PreferredCameraType.BackFacingCamera

Whether back facing or front facing camera is preferred. Obeyed only if there is a choice (i.e. if device has only front-facing camera, the opened camera will be a front-facing camera, regardless of preference)

Returns

Promise<VideoRecognizer>

createVideoRecognizerFromVideoPath()

static createVideoRecognizerFromVideoPath(videoPath, videoElement, recognizerRunner): VideoRecognizer

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:224

Creates a new VideoRecognizer by attaching the given URL to video to given HTMLVideoElement and using it to display video frames while processing them.

Parameters

videoPath

string

URL of the video file that should be recognized.

videoElement

HTMLVideoElement

HTMLVideoElement to which video file will be attached

recognizerRunner

RecognizerRunner

RecognizerRunner that should be used for video stream recognition.

Returns

VideoRecognizer

setOnFrameProcessed()

setOnFrameProcessed(onFrameProcessed): void

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:249

Sets the callback that will be invoked when frame is processed

Parameters

onFrameProcessed

Callback that will be invoked when frame is processed

OnFrameProcessed | null

Returns

void

flipCamera()

flipCamera(): Promise<void>

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:254

Returns

Promise<void>

isCameraFlipped()

isCameraFlipped(): boolean

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:261

Returns

boolean

setVideoRecognitionMode()

setVideoRecognitionMode(videoRecognitionMode): Promise<void>

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:269

Sets the video recognition mode to be used.

Parameters

videoRecognitionMode

VideoRecognitionMode

Returns

Promise<void>

startRecognition()

startRecognition(onScanningDone, recognitionTimeoutMs): Promise<void>

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:302

Starts the recognition of the video stream associated with this VideoRecognizer. The stream will be unpaused and recognition loop will start. After recognition completes, an onScanningDone callback will be invoked with state of the recognition.

NOTE: As soon as the execution of the callback completes, the recognition loop will continue and recognition state will be retained. To clear the recognition state, use resetRecognizers (within your callback). To pause the recognition loop, use pauseRecognition (within your callback) - to resume it later use resumeRecognition. To completely stop the recognition and video feed, while keeping the ability to use this VideoRecognizer later, use pauseVideoFeed. To completely stop the recognition and video feed and release all the resources involved with the video stream, use releaseVideoFeed.

Parameters

onScanningDone

OnScanningDone

Callback that will be invoked when recognition completes.

recognitionTimeoutMs

number = 20000

Amount of time in ms that the recognizer will stay in the Uncertain state before resolving.

Returns

Promise<void>

resumeRecognition()

resumeRecognition(resetRecognizers): Promise<void>

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:334

Resumes the recognition and video playback

Parameters

resetRecognizers

boolean

Indicates whether resetRecognizers should be invoked while resuming the recognition

Returns

Promise<void>

recognize()

recognize(recognitionTimeoutMs): Promise<RecognizerResultState>

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:387

Performs the recognition of the video stream associated with this VideoRecognizer. The stream will be unpaused, recognition will be performed and promise will be resolved with recognition status. After the resolution of returned promise, the video stream will be paused, but not released. To release the stream, use function releaseVideoFeed.

This is a simple version of startRecognition that should be used for most cases, like when you only need to perform one scan per video session.

Parameters

recognitionTimeoutMs

number = 20000

Amount of time in ms that the recognizer will stay in the Uncertain state before resolving.

Returns

Promise<RecognizerResultState>

pauseVideoFeed()

pauseVideoFeed(): void

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:407

Pauses the video feed. You can resume the feed by calling recognize or startRecognition. Note that this pauses both the camera feed and recognition. If you just want to pause recognition, while keeping the camera feed active, call method pauseRecognition.

Returns

void

pauseRecognition()

pauseRecognition(): void

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:426

Pauses the recognition. This means that video frames that arrive from given video source will not be recognized. To resume recognition, call resumeRecognition.

Returns

void

cancelRecognition()

cancelRecognition(): void

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:434

Cancels current ongoing recognition. Unlike pauseRecognition this will reset everything

Returns

void

resetRecognizers()

resetRecognizers(hardReset): Promise<void>

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:444

Convenience method for invoking RecognizerRunner.resetRecognizers on associated RecognizerRunner.

Parameters

hardReset

boolean

Returns

Promise<void>

getRecognizerRunner()

getRecognizerRunner(): RecognizerRunner

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:455

Convenience method for accessing RecognizerRunner associated with this VideoRecognizer. Sometimes it's useful to reconfigure RecognizerRunner while handling onScanningDone callback and this method makes that much more convenient.

Returns

RecognizerRunner

getVideoElement()

getVideoElement(): HTMLVideoElement

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:463

Getter for videoElement

Returns

HTMLVideoElement

changeCameraDevice()

changeCameraDevice(camera): Promise<void>

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:476

Change currently used camera device for recognition. To get list of available camera devices use getCameraDevices method.

Keep in mind that this method will reset recognizers.

Parameters

camera

SelectedCamera

Desired camera device which should be used for recognition.

Returns

Promise<void>

releaseVideoFeed()

releaseVideoFeed(): void

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:648

Stops all media stream tracks associated with videoElement.

Returns

void

WasmSDKLoadSettings

Defined in: src/MicroblinkSDK/WasmLoadSettings.ts:23

Settings object for function loadWasmModule.

Constructors

Constructor

new WasmSDKLoadSettings(licenseKey): WasmSDKLoadSettings

Defined in: src/MicroblinkSDK/WasmLoadSettings.ts:108

Parameters

licenseKey

string

License key for unlocking the WebAssembly module.

Returns

WasmSDKLoadSettings

Properties

licenseKey

licenseKey: string

Defined in: src/MicroblinkSDK/WasmLoadSettings.ts:28

License key for unlocking the WebAssembly module. Bound to the domain name from which the application is served.

allowHelloMessage

allowHelloMessage: boolean = true

Defined in: src/MicroblinkSDK/WasmLoadSettings.ts:38

Write a hello message to the browser console when license check is successfully performed.

Hello message will contain the name and version of the SDK, which are required information for all support tickets.

The default value is true.

engineLocation

engineLocation: string = ""

Defined in: src/MicroblinkSDK/WasmLoadSettings.ts:52

Absolute location of WASM and related JS/data files. Useful when resource files should be loaded over CDN, or when web frameworks/libraries are used which store resources in specific locations, e.g. inside "assets" folder.

Important: if the engine is hosted on another origin, CORS must be enabled between two hosts. That is, server where engine is hosted must have 'Access-Control-Allow-Origin' header for the location of the web app.

Important: SDK and WASM resources must be from the same version of a package.

Default value is empty string, i.e. "". In case of empty string, value of "window.location.origin" property is going to be used.

workerLocation

workerLocation: string = ""

Defined in: src/MicroblinkSDK/WasmLoadSettings.ts:65

The absolute location of the Web Worker script file that loads the WebAssembly module.

Important: the worker script must be served via HTTPS and must be of the same origin as the initiator. See https://github.com/w3c/ServiceWorker/issues/940 (same applies for Web Workers).

Important: SDK, worker script and WebAssembly resources must be from the same version of the package.

The default value is an empty string, i.e. "", and in that case, the worker script is loaded from the default location in resources folder.

wasmType

wasmType: WasmType | null = null

Defined in: src/MicroblinkSDK/WasmLoadSettings.ts:71

Type of the WASM that will be loaded. By default, if not set, the SDK will automatically determine the best WASM to load.

wasmFlavor

wasmFlavor: string

Defined in: src/MicroblinkSDK/WasmLoadSettings.ts:78

Flavor of the WASM that will be loaded. By default, the SDK will automatically determine the best WASM flavor to load. If there are no flavors, use "", i.e. empty string.

numberOfWorkers

numberOfWorkers: number | null = null

Defined in: src/MicroblinkSDK/WasmLoadSettings.ts:87

Defines the number of workers that will be used for multi-threaded processing of the images. If not set, the number of worker used will match the number of detected CPU cores on a device.

If the browser does not support multi-threaded processing or it was deliberately disabled using the wasmType property, then this property will be ignored.

loadProgressCallback

loadProgressCallback: OptionalLoadProgressCallback = null

Defined in: src/MicroblinkSDK/WasmLoadSettings.ts:96

Optional callback function that will report the SDK loading progress.

This can be useful for displaying progress bar to users with slow connections.

The default value is null.

wasmModuleName

wasmModuleName: string = defaultWasmModuleName

Defined in: src/MicroblinkSDK/WasmLoadSettings.ts:103

Name of the file containing the WebAssembly module.

Change this only if you have renamed the original WASM and its support JS file for your purposes.

CardNumberAnonymizationSettings

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:115

Holds the settings which control card number anonymization.

Constructors

Constructor

new CardNumberAnonymizationSettings(): CardNumberAnonymizationSettings

Returns

CardNumberAnonymizationSettings

Properties

mode

mode: AnonymizationMode = AnonymizationMode.ImageOnly

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:118

Defines the mode of card number anonymization.

prefixDigitsVisible

prefixDigitsVisible: number = 0

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:121

Defines how many digits at the beginning of the card number remain visible after anonymization.

suffixDigitsVisible

suffixDigitsVisible: number = 4

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:124

Defines how many digits at the end of the card number remain visible after anonymization.

AnonymizationSettings

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:127

Constructors

Constructor

new AnonymizationSettings(): AnonymizationSettings

Returns

AnonymizationSettings

Properties

cardNumberAnonymizationSettings

cardNumberAnonymizationSettings: CardNumberAnonymizationSettings

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:130

Defines the parameters of card number anonymization.

cardNumberPrefixAnonymizationMode

cardNumberPrefixAnonymizationMode: AnonymizationMode = AnonymizationMode.None

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:133

Defines the mode of card number prefix anonymization.

cvvAnonymizationMode

cvvAnonymizationMode: AnonymizationMode = AnonymizationMode.None

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:136

Defines the mode of CVV anonymization.

ibanAnonymizationMode

ibanAnonymizationMode: AnonymizationMode = AnonymizationMode.ImageOnly

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:139

Defines the mode of IBAN anonymization.

ownerAnonymizationMode

ownerAnonymizationMode: AnonymizationMode = AnonymizationMode.None

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:142

Defines the mode of owner anonymization.

fallbackAnonymization

fallbackAnonymization: boolean = false

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:145

If true, anonymization is applied on all fields of the image if extraction is uncertain.

BlinkCardRecognizerSettings

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:151

A settings object that is used for configuring the BlinkCardRecognizer.

Implements

FullDocumentImageOptions
RecognizerSettings

Constructors

Constructor

new BlinkCardRecognizerSettings(): BlinkCardRecognizerSettings

Returns

BlinkCardRecognizerSettings

Properties

allowBlurFilter

allowBlurFilter: boolean = true

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:157

Whether blured frames filtering is allowed

anonymizationSettings

anonymizationSettings: AnonymizationSettings

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:160

Whether sensitive data should be redacted from the result

paddingEdge

paddingEdge: number = 0.0

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:168

Padding is a minimum distance from the edge of the frame and is defined as a percentage of the frame width. Default value is 0.0f and in that case padding edge and image edge are the same. If padding edge is needed, recommended value is 0.02f.

allowInvalidCardNumber

allowInvalidCardNumber: boolean = false

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:173

Whether invalid card number is accepted

tiltDetectionLevel

tiltDetectionLevel: DetectionLevel = DetectionLevel.Mid

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:182

The level of allowed detected tilt of the document in the image. Defines the severity of allowed detected tilt of the document in the image, as defined in DetectionLevel. Values range from Off (detection turned off) to higher levels of allowed tilt. By default, this is set to 'Mid'.

extractCvv

extractCvv: boolean = true

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:187

Whether to return CVV in recognizer results

extractExpiryDate

extractExpiryDate: boolean = true

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:192

Whether to return expiry date in recognizer results

extractIban

extractIban: boolean = true

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:197

Whether to return IBAN in recognizer results

extractOwner

extractOwner: boolean = true

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:202

Whether to return owner in recognizer results

returnFullDocumentImage

returnFullDocumentImage: boolean = true

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:205

If enabled, the result will contain dewarped image of the document.

Implementation of

FullDocumentImageOptions.returnFullDocumentImage

returnEncodedFullDocumentImage

returnEncodedFullDocumentImage: boolean = false

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:207

If enabled, the result will contain JPEG-encoded image of the document.

Implementation of

FullDocumentImageOptions.returnEncodedFullDocumentImage

handScaleThreshold

handScaleThreshold: number = 0.15

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:213

Hand scale is calculated as a ratio between area of hand mask and document mask. handScaleThreshold is the minimal value for hand to be accepted as significant.

handDocumentOverlapThreshold

handDocumentOverlapThreshold: number = 0.05

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:221

This parameter is used to adjust heuristics that eliminate cases when the hand is present in the input but it is not holding the document. handDocumentOverlapThreshold is the minimal ratio of hand pixels inside the frame surrounding the document and area of that frame. Only pixels inside that frame are used to ignore false-positive hand segmentations inside the document (e.g. profile photo on documents)

screenAnalysisMatchLevel

screenAnalysisMatchLevel: MatchLevel = MatchLevel.Level5

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:226

Screen analysis match level - higher is stricter.

photocopyAnalysisMatchLevel

photocopyAnalysisMatchLevel: MatchLevel = MatchLevel.Level5

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:231

Photocopy analysis match level - higher is stricter.

documentLivenessCallback

documentLivenessCallback: DocumentLivenessCallback | null = null

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:236

Called when document verification status is available.

fullDocumentImageExtensionFactors

fullDocumentImageExtensionFactors: ExtensionFactors

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:248

extension factors for full document image.

Implementation of

FullDocumentImageOptions.fullDocumentImageExtensionFactors

Accessors

fullDocumentImageDpi

Get Signature

get fullDocumentImageDpi(): number

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:240

The DPI (Dots Per Inch) for full document image in cases when it should be returned. It applies for both encoded and non-encoded versions.

Returns

number

Set Signature

set fullDocumentImageDpi(value): void

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:242

The DPI (Dots Per Inch) for full document image in cases when it should be returned. It applies for both encoded and non-encoded versions.

Parameters

value

number

Returns

void

Implementation of

FullDocumentImageOptions.fullDocumentImageDpi

Interfaces

CameraDevices

Defined in: src/MicroblinkSDK/CameraUtils.ts:201

Properties

frontCameras

frontCameras: SelectedCamera[]

Defined in: src/MicroblinkSDK/CameraUtils.ts:203

backCameras

backCameras: SelectedCamera[]

Defined in: src/MicroblinkSDK/CameraUtils.ts:204

WasmNativeObject

Defined in: src/MicroblinkSDK/DataStructures.ts:76

Specifies an abstract object placed on the WebAssembly heap. Objects placed on the WebAssembly heap are not cleaned up by the garbage collector of the JavaScript engine. The memory used by the object must be cleaned up manually by calling the delete() method.

Methods

delete()

delete(): Promise<void>

Defined in: src/MicroblinkSDK/DataStructures.ts:81

Cleans up the object from the WebAssembly heap.

Returns

Promise<void>

RecognizerResult

Defined in: src/MicroblinkSDK/DataStructures.ts:87

Specifies the abstract recognition result.

Extended by

SuccessFrameGrabberRecognizerResult
BlinkCardRecognizerResult

Properties

state

readonly state: RecognizerResultState

Defined in: src/MicroblinkSDK/DataStructures.ts:90

State of the recognition result. See the documentation for RecognizerResultState for more information.

RecognizerSettings

Defined in: src/MicroblinkSDK/DataStructures.ts:97

Specifies the abstract settings for the Recognizer object.

Recognizer

Defined in: src/MicroblinkSDK/DataStructures.ts:104

Specifies an abstract Recognizer object. The Recognizer object is the basic unit of processing.

Extends

WasmNativeObject

Extended by

SuccessFrameGrabberRecognizer
BlinkCardRecognizer

Properties

recognizerName

readonly recognizerName: string

Defined in: src/MicroblinkSDK/DataStructures.ts:109

Name of this recognizer.

Methods

delete()

delete(): Promise<void>

Defined in: src/MicroblinkSDK/DataStructures.ts:81

Cleans up the object from the WebAssembly heap.

Returns

Promise<void>

Inherited from

WasmNativeObject.delete

currentSettings()

currentSettings(): Promise<RecognizerSettings>

Defined in: src/MicroblinkSDK/DataStructures.ts:114

Returns the currently applied settings to the specific recognizer.

Returns

Promise<RecognizerSettings>

updateSettings()

updateSettings(newSettings): Promise<void>

Defined in: src/MicroblinkSDK/DataStructures.ts:121

Applies the new settings to the specific recognizer. Note: if the recognizer is associated with RecognizerRunner, this method will fail.

Parameters

newSettings

RecognizerSettings

New settings to be applied to the recognizer.

Returns

Promise<void>

getResult()

getResult(): Promise<RecognizerResult>

Defined in: src/MicroblinkSDK/DataStructures.ts:126

Returns the current result of the recognition.

Returns

Promise<RecognizerResult>

toSignedJSON()

toSignedJSON(): Promise<SignedPayload | null>

Defined in: src/MicroblinkSDK/DataStructures.ts:136

Returns the JSON representation of the recognizer's result. The JSON will be digitally signed and can be used to verify that the result was provided by the SDK and that it hasn't been manually altered. If the SDK does not have this feature compiled into the WASM, this method will return null.

Returns

Promise<SignedPayload | null>

RecognizerRunner

Defined in: src/MicroblinkSDK/DataStructures.ts:142

Specifies a main Recognizer orchestrator object.

Extends

WasmNativeObject

Properties

recognizers

recognizers: Recognizer[]

Defined in: src/MicroblinkSDK/DataStructures.ts:147

Array of recognizer objects that are currently associated with the RecognizerRunner.

Methods

delete()

delete(): Promise<void>

Defined in: src/MicroblinkSDK/DataStructures.ts:81

Cleans up the object from the WebAssembly heap.

Returns

Promise<void>

Inherited from

WasmNativeObject.delete

processImage()

processImage(image): Promise<RecognizerResultState>

Defined in: src/MicroblinkSDK/DataStructures.ts:155

Starts the recognition of the given image using recognizer objects currently associated with the RecognizerRunner.

Parameters

image

CapturedFrame

Image to be processed.

Returns

Promise<RecognizerResultState>

Promise that will resolve when image processing finishes.

reconfigureRecognizers()

reconfigureRecognizers(recognizers, allowMultipleResults): Promise<void>

Defined in: src/MicroblinkSDK/DataStructures.ts:165

Reconfigures the instance of RecognizerRunner with new recognizers. The currently associated recognizer objects are un-associated from this RecognizerRunner and are elligible for calling the updateSettings() method on them after that.

Parameters

recognizers

Recognizer[]

Array of recognizer objects that should be associated with the RecognizerRunner.

allowMultipleResults

boolean

Whether or not it is allowed to return multiple results from single image. See README.md for more details about this option.

Returns

Promise<void>

setMetadataCallbacks()

setMetadataCallbacks(metadataCallbacks): Promise<void>

Defined in: src/MicroblinkSDK/DataStructures.ts:174

Sets the new callbacks for obtaining recognition event. Make sure you call this method while image processing is not in progress, otherwise you will have undefined behaviour.

Parameters

metadataCallbacks

MetadataCallbacks

Callback functions that will be called when certain recognition events occur.

For more information, check the documentation of MetadataCallbacks class.

Returns

Promise<void>

resetRecognizers()

resetRecognizers(hardReset): Promise<void>

Defined in: src/MicroblinkSDK/DataStructures.ts:182

Resets the state of all recognizers in current recognition chain, i.e. deletes the cached data from multiple recognitions.

Parameters

hardReset

boolean

If set to false, multi-side recognizers will not be reset. If set to true, all recognizers will be reset.

Returns

Promise<void>

setDetectionOnlyMode()

setDetectionOnlyMode(detectionOnly): Promise<void>

Defined in: src/MicroblinkSDK/DataStructures.ts:191

If enabled, recognizers will be instructed to only perform object detection, but not the entire recognition process. This is useful for testing your implementations of MetadataCallbacks without the need for the entire process to complete. Also, VideoRecognizers sets this to true only if in DetectionTest mode of video recognition.

Parameters

detectionOnly

boolean

Should recognizers perform only object detection.

Returns

Promise<void>

setCameraPreviewMirrored()

setCameraPreviewMirrored(mirrored): Promise<void>

Defined in: src/MicroblinkSDK/DataStructures.ts:200

Sets whether camera preview displaying the image being recognized is being mirrored horizontally. If enabled, coordinates returned via metadatacallbacks will be adjusted accordingly due to the image being processed being different of image being displayed. The camera preview is usually mirrored when using front-facing camera.

Parameters

mirrored

boolean

Whether or not metadatacallbacks should adjust coordinates for mirrored image.

Returns

Promise<void>

WasmSDK

Defined in: src/MicroblinkSDK/DataStructures.ts:229

Specifies a main object that is used for communication with the WebAssembly module. This object is usually given as a parameter to functions that interop with the WebAssembly module. You can obtain an instance of this object after a promise from MicroblinkSDK.loadWasmModule is successfully resolved.

Properties

mbWasmWorker

readonly mbWasmWorker: Worker

Defined in: src/MicroblinkSDK/DataStructures.ts:238

delete()

delete: () => void

Defined in: src/MicroblinkSDK/DataStructures.ts:240

Returns

void

getProductIntegrationInfo()

getProductIntegrationInfo: () => Promise<ProductIntegrationInfo>

Defined in: src/MicroblinkSDK/DataStructures.ts:242

Returns

Promise<ProductIntegrationInfo>

loadedWasmType

loadedWasmType: WasmType

Defined in: src/MicroblinkSDK/DataStructures.ts:247

The type of the WASM that was actually loaded.

showOverlay

showOverlay: boolean

Defined in: src/MicroblinkSDK/DataStructures.ts:249

MBDate

Defined in: src/MicroblinkSDK/DataStructures.ts:256

Specifies a date object, as parsed from some documents. Unlike JavaScript Date object, it does not depend on time zone.

Properties

day

readonly day: number

Defined in: src/MicroblinkSDK/DataStructures.ts:259

Day in month.

month

readonly month: number

Defined in: src/MicroblinkSDK/DataStructures.ts:262

Month in year.

year

readonly year: number

Defined in: src/MicroblinkSDK/DataStructures.ts:265

Year

originalString

readonly originalString: string

Defined in: src/MicroblinkSDK/DataStructures.ts:268

Original string on the document from which date was parsed.

successfullyParsed

readonly successfullyParsed: boolean

Defined in: src/MicroblinkSDK/DataStructures.ts:271

Indicates whether date was parsed successfully.

empty

readonly empty: boolean

Defined in: src/MicroblinkSDK/DataStructures.ts:274

Indicates whether object is empty. Note that it is possible to successfully parse an empty date.

SignedPayload

Defined in: src/MicroblinkSDK/DataStructures.ts:280

Specifies a digital signature of the specific recognizer result.

Properties

payload

readonly payload: string

Defined in: src/MicroblinkSDK/DataStructures.ts:283

The digital signature payload.

signature

readonly signature: string

Defined in: src/MicroblinkSDK/DataStructures.ts:286

The digital signature of the payload.

signatureVersion

readonly signatureVersion: string

Defined in: src/MicroblinkSDK/DataStructures.ts:289

Version of the digital signature.

ProductIntegrationInfo

Defined in: src/MicroblinkSDK/DataStructures.ts:295

Describes a structure containing information about product integration.

Properties

userId

readonly userId: string

Defined in: src/MicroblinkSDK/DataStructures.ts:297

licenseId

readonly licenseId: string

Defined in: src/MicroblinkSDK/DataStructures.ts:299

licensee

readonly licensee: string

Defined in: src/MicroblinkSDK/DataStructures.ts:301

productVersion

readonly productVersion: string

Defined in: src/MicroblinkSDK/DataStructures.ts:303

platform

readonly platform: string

Defined in: src/MicroblinkSDK/DataStructures.ts:305

device

readonly device: string

Defined in: src/MicroblinkSDK/DataStructures.ts:307

packageName

readonly packageName: string

Defined in: src/MicroblinkSDK/DataStructures.ts:309

LicenseUnlockResult

Defined in: src/MicroblinkSDK/License.ts:15

Properties

allowRemoveDemoOverlay

readonly allowRemoveDemoOverlay: boolean

Defined in: src/MicroblinkSDK/License.ts:17

allowRemoveProductionOverlay

readonly allowRemoveProductionOverlay: boolean

Defined in: src/MicroblinkSDK/License.ts:18

isTrial

readonly isTrial: boolean

Defined in: src/MicroblinkSDK/License.ts:19

licenseId

readonly licenseId: string

Defined in: src/MicroblinkSDK/License.ts:20

licensee

readonly licensee: string

Defined in: src/MicroblinkSDK/License.ts:21

applicationIds

readonly applicationIds: string[]

Defined in: src/MicroblinkSDK/License.ts:22

packageName

readonly packageName: string

Defined in: src/MicroblinkSDK/License.ts:23

sdkName

readonly sdkName: string

Defined in: src/MicroblinkSDK/License.ts:24

sdkVersion

readonly sdkVersion: string

Defined in: src/MicroblinkSDK/License.ts:25

unlockResult

readonly unlockResult: LicenseTokenState

Defined in: src/MicroblinkSDK/License.ts:26

userId

readonly userId: string

Defined in: src/MicroblinkSDK/License.ts:27

licenseError

readonly licenseError: string

Defined in: src/MicroblinkSDK/License.ts:28

ServerPermissionSubmitResult

Defined in: src/MicroblinkSDK/License.ts:97

Properties

status

readonly status: ServerPermissionSubmitResultStatus

Defined in: src/MicroblinkSDK/License.ts:99

lease

readonly lease: number

Defined in: src/MicroblinkSDK/License.ts:100

networkErrorDescription?

readonly optional networkErrorDescription: string

Defined in: src/MicroblinkSDK/License.ts:101

UnlockResult

Defined in: src/MicroblinkSDK/License.ts:104

Properties

error

readonly error: SDKError | null

Defined in: src/MicroblinkSDK/License.ts:106

lease?

readonly optional lease: number

Defined in: src/MicroblinkSDK/License.ts:107

showOverlay?

readonly optional showOverlay: boolean

Defined in: src/MicroblinkSDK/License.ts:108

MetadataCallbacks

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:12

Interface representing possible events that can occur during image processing. All functions in this interface are optional and will be called only if they are implemented.

Methods

onDebugText()?

optional onDebugText(debugTest): void

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:18

Called when recognition process wants to display some debug text information.

Parameters

debugTest

string

Debug text information to be displayed.

Returns

void

onDetectionFailed()?

optional onDetectionFailed(): void

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:23

Called when all recognizers in RecognizerRunner have failed to detect anything on the image.

Returns

void

onQuadDetection()?

optional onQuadDetection(quad): void

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:29

Called when recognition process wants to display some quadrilateral.

Parameters

quad

DisplayableQuad

Quadrilateral to be displayed.

Returns

void

onPointsDetection()?

optional onPointsDetection(pointSet): void

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:35

Called when recognition process wants to display some points.

Parameters

pointSet

DisplayablePoints

Points to be displayed.

Returns

void

onFirstSideResult()?

optional onFirstSideResult(): void

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:40

Called when first side recognition with the multi-side recognizer completes.

Returns

void

onGlare()?

optional onGlare(hasGlare): void

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:46

Called when glare detection has completed with result whether glare has been found or not.

Parameters

hasGlare

boolean

indicates whether glare has been found on the input image or not

Returns

void

Displayable

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:75

Interface representing any displayable object.

Extended by

DisplayableQuad
DisplayablePoints

Properties

detectionStatus

detectionStatus: DetectionStatus

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:78

Detection status of the displayable object.

transformMatrix

transformMatrix: Float32Array

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:83

3x3 transformation matrix from the image's coordinate system to view's coordinate system.

DisplayableQuad

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:89

Interface representing quadrilateral in image.

Extends

Displayable.Quadrilateral

Properties

topLeft

topLeft: Point

Defined in: src/MicroblinkSDK/Geometry.ts:23

Top-left point of the quadrilateral

Inherited from

Quadrilateral.topLeft

topRight

topRight: Point

Defined in: src/MicroblinkSDK/Geometry.ts:26

Top-right point of the quadrilateral

Inherited from

Quadrilateral.topRight

bottomLeft

bottomLeft: Point

Defined in: src/MicroblinkSDK/Geometry.ts:29

Bottom-left point of the quadrilateral

Inherited from

Quadrilateral.bottomLeft

bottomRight

bottomRight: Point

Defined in: src/MicroblinkSDK/Geometry.ts:32

Bottom-right point of the quadrilateral

Inherited from

Quadrilateral.bottomRight

detectionStatus

detectionStatus: DetectionStatus

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:78

Detection status of the displayable object.

Inherited from

Displayable.detectionStatus

transformMatrix

transformMatrix: Float32Array

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:83

3x3 transformation matrix from the image's coordinate system to view's coordinate system.

Inherited from

Displayable.transformMatrix

DisplayablePoints

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:95

Interface representing list of points in image.

Extends

Displayable

Properties

detectionStatus

detectionStatus: DetectionStatus

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:78

Detection status of the displayable object.

Inherited from

Displayable.detectionStatus

transformMatrix

transformMatrix: Float32Array

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:83

3x3 transformation matrix from the image's coordinate system to view's coordinate system.

Inherited from

Displayable.transformMatrix

points

points: Point[]

Defined in: src/MicroblinkSDK/MetadataCallbacks.ts:98

Array of points

TieredCheck

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:69

Properties

result

result: CheckResult

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:70

matchLevel

matchLevel: MatchLevel

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:71

DocumentLivenessCheckSingleSideResult

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:74

Properties

screenCheck

screenCheck: TieredCheck

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:75

photocopyCheck

photocopyCheck: TieredCheck

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:76

handPresenceCheck

handPresenceCheck: CheckResult

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:77

DocumentLivenessCheck

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:80

Properties

front

front: DocumentLivenessCheckSingleSideResult

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:81

back

back: DocumentLivenessCheckSingleSideResult

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:82

BlinkCardRecognizerResult

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:254

The result of image recognition when using the BlinkCardRecognizer.

Extends

RecognizerResult

Properties

state

readonly state: RecognizerResultState

Defined in: src/MicroblinkSDK/DataStructures.ts:90

State of the recognition result. See the documentation for RecognizerResultState for more information.

Inherited from

RecognizerResult.state

cardNumber

readonly cardNumber: string

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:259

The payment card number.

cardNumberPrefix

readonly cardNumberPrefix: string

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:264

The payment card number prefix.

cardNumberValid

readonly cardNumberValid: boolean

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:269

The payment card number.

cvv

readonly cvv: string

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:274

Payment card's security code/value.

expiryDate

readonly expiryDate: MBDate

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:279

The payment card's expiry date.

firstSideBlurred

readonly firstSideBlurred: boolean

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:284

Wheater the first scanned side is blurred.

firstSideFullDocumentImage

readonly firstSideFullDocumentImage: ImageResult

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:289

Full image of the payment card from first side recognition.

iban

readonly iban: string

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:294

Payment card's IBAN.

issuer

readonly issuer: CardIssuer

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:299

Payment card's issuing network

owner

readonly owner: string

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:304

Information about the payment card owner.

processingStatus

readonly processingStatus: ProcessingStatus

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:309

Status of the last recognition process.

scanningFirstSideDone

readonly scanningFirstSideDone: boolean

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:314

Whether the scanning of the first side is finished.

secondSideBlurred

readonly secondSideBlurred: boolean

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:319

Wheater the second scanned side is blurred.

secondSideFullDocumentImage

readonly secondSideFullDocumentImage: ImageResult

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:324

Full image of the payment card from second side recognition.

firstSideAnonymized

readonly firstSideAnonymized: boolean

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:329

Is front side anonymized.

secondSideAnonymized

readonly secondSideAnonymized: boolean

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:334

Is back side anonymized.

documentLivenessCheck

readonly documentLivenessCheck: DocumentLivenessCheck

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:339

Document liveness check for both sides (screen, photocopy, hand presence);

BlinkCardRecognizer

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:345

The Blink Card Recognizer is used for scanning Blink Card.

Extends

Recognizer

Properties

recognizerName

readonly recognizerName: string

Defined in: src/MicroblinkSDK/DataStructures.ts:109

Name of this recognizer.

Inherited from

Recognizer.recognizerName

Methods

delete()

delete(): Promise<void>

Defined in: src/MicroblinkSDK/DataStructures.ts:81

Cleans up the object from the WebAssembly heap.

Returns

Promise<void>

Inherited from

Recognizer.delete

toSignedJSON()

toSignedJSON(): Promise<SignedPayload | null>

Defined in: src/MicroblinkSDK/DataStructures.ts:136

Returns

Promise<SignedPayload | null>

Inherited from

Recognizer.toSignedJSON

currentSettings()

currentSettings(): Promise<BlinkCardRecognizerSettings>

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:348

Returns the currently applied BlinkCardRecognizerSettings.

Returns

Promise<BlinkCardRecognizerSettings>

Overrides

Recognizer.currentSettings

updateSettings()

updateSettings(newSettings): Promise<void>

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:351

Applies new settings to the recognizer.

Parameters

newSettings

BlinkCardRecognizerSettings

Returns

Promise<void>

Overrides

Recognizer.updateSettings

getResult()

getResult(): Promise<BlinkCardRecognizerResult>

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:354

Returns the current result of the recognition.

The result object of the SuccessFrameGrabberRecognizer.

Extends

RecognizerResult

Properties

state

readonly state: RecognizerResultState

Defined in: src/MicroblinkSDK/DataStructures.ts:90

State of the recognition result. See the documentation for RecognizerResultState for more information.

Inherited from

RecognizerResult.state

successFrame

readonly successFrame: ImageData | null

Defined in: src/Recognizers/SuccessFrameGrabberRecognizer.ts:22

Camera frame on which given recognizer's result ha become valid. If given recognizer's result never became valid, contains null.

frameOrientation

readonly frameOrientation: ImageOrientation

Defined in: src/Recognizers/SuccessFrameGrabberRecognizer.ts:27

Orientation of the success frame.

SuccessFrameGrabberRecognizer

Defined in: src/Recognizers/SuccessFrameGrabberRecognizer.ts:34

Recognizer that can wrap another recognizer and capture the frame on which the wrapped recognizer has succeeded to recognize.

Extends

Recognizer

Type Parameters

T

T extends Recognizer

Properties

recognizerName

readonly recognizerName: string

Defined in: src/MicroblinkSDK/DataStructures.ts:109

Name of this recognizer.

Inherited from

Recognizer.recognizerName

wrappedRecognizer

readonly wrappedRecognizer: T

Defined in: src/Recognizers/SuccessFrameGrabberRecognizer.ts:40

Reference to recognizer that is being wrapped by this SuccessFrameGrabberRecognizer.

Methods

currentSettings()

currentSettings(): Promise<RecognizerSettings>

Defined in: src/MicroblinkSDK/DataStructures.ts:114

Returns the currently applied settings to the specific recognizer.

Returns

Promise<RecognizerSettings>

Inherited from

Recognizer.currentSettings

updateSettings()

updateSettings(newSettings): Promise<void>

Defined in: src/MicroblinkSDK/DataStructures.ts:121

Applies the new settings to the specific recognizer. Note: if the recognizer is associated with RecognizerRunner, this method will fail.

Parameters

newSettings

RecognizerSettings

New settings to be applied to the recognizer.

Returns

Promise<void>

Inherited from

Recognizer.updateSettings

toSignedJSON()

toSignedJSON(): Promise<SignedPayload | null>

Defined in: src/MicroblinkSDK/DataStructures.ts:136

Returns

Promise<SignedPayload | null>

Inherited from

Recognizer.toSignedJSON

getResult()

getResult(): Promise<SuccessFrameGrabberRecognizerResult>

Defined in: src/Recognizers/SuccessFrameGrabberRecognizer.ts:47

Returns the current result of the recognition. Note that result will not contain the result of the wrapped recognizer. To obtain that result, call getResult on wrapped recognizer.

Returns

Promise<SuccessFrameGrabberRecognizerResult>

Overrides

Recognizer.getResult

delete()

delete(): Promise<void>

Defined in: src/Recognizers/SuccessFrameGrabberRecognizer.ts:52

Cleans up the object from the WebAssembly heap.

Returns

Promise<void>

Overrides

Recognizer.delete

Type Aliases

OnScanningDone()

OnScanningDone = (recognitionState) => void

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:51

Invoked when VideoRecognizer finishes the recognition of the video stream.

Parameters

recognitionState

RecognizerResultState

The state of recognition after finishing. If Empty or Uncertain are returned, this indicates that the scanning was cancelled or timeout has been reached.

Returns

void

OnFrameProcessed()

OnFrameProcessed = (result, frame) => void

Defined in: src/MicroblinkSDK/VideoRecognizer.ts:53

Parameters

result

BlinkCardRecognizerResult

frame

ImageData

Returns

void

LoadProgressCallback()

LoadProgressCallback = (loadPercentage) => void

Defined in: src/MicroblinkSDK/WasmLoadSettings.ts:14

Function that will be called during loading of the SDK.

Parameters

loadPercentage

number

Number between 0 and 100 indicating the loading progress.

Returns

void

OptionalLoadProgressCallback

OptionalLoadProgressCallback = LoadProgressCallback | null

Defined in: src/MicroblinkSDK/WasmLoadSettings.ts:16

DocumentLivenessCallback()

DocumentLivenessCallback = (livenessStatus) => void

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:47

Parameters

livenessStatus

LivenessStatus

Returns

void

Variables

videoRecognizerErrors

const videoRecognizerErrors: object

Defined in: src/MicroblinkSDK/ErrorTypes.ts:110

Type Declaration

feedMissing

feedMissing: object

feedMissing.message

message: ErrorMessages = ErrorMessages.VIDEO_RECOGNIZER_FEED_MISSING

feedMissing.code

code: ErrorCodes = ErrorCodes.VIDEO_RECOGNIZER_FEED_MISSING

recognizersResetFailure

recognizersResetFailure: object

recognizersResetFailure.message

message: ErrorMessages = ErrorMessages.VIDEO_RECOGNIZER_RECOGNIZERS_RESET_FAILURE

recognizersResetFailure.code

code: ErrorCodes = ErrorCodes.VIDEO_RECOGNIZER_RECOGNIZERS_RESET_FAILURE

feedPaused

feedPaused: object

feedPaused.message

message: ErrorMessages = ErrorMessages.VIDEO_RECOGNIZER_FEED_PAUSED

feedPaused.code

code: ErrorCodes = ErrorCodes.VIDEO_RECOGNIZER_FEED_PAUSED

playRequestInterrupted

playRequestInterrupted: object

playRequestInterrupted.message

message: ErrorMessages = ErrorMessages.VIDEO_RECOGNIZER_PLAY_REQUEST_INTERRUPTED

playRequestInterrupted.code

code: ErrorCodes = ErrorCodes.VIDEO_RECOGNIZER_PLAY_REQUEST_INTERRUPTED

videoFeedNotPaused

videoFeedNotPaused: object

videoFeedNotPaused.message

message: ErrorMessages = ErrorMessages.VIDEO_RECOGNIZER_FEED_NOT_PAUSED

videoFeedNotPaused.code

code: ErrorCodes = ErrorCodes.VIDEO_RECOGNIZER_FEED_NOT_PAUSED

videoFeedReleased

videoFeedReleased: object

videoFeedReleased.message

message: ErrorMessages = ErrorMessages.VIDEO_RECOGNIZER_FEED_RELEASED

videoFeedReleased.code

code: ErrorCodes = ErrorCodes.VIDEO_RECOGNIZER_FEED_RELEASED

mediaDevicesUnsupported

mediaDevicesUnsupported: object

mediaDevicesUnsupported.code

code: ErrorCodes = ErrorCodes.VIDEO_RECOGNIZER_MEDIA_DEVICES_UNSUPPORTED

mediaDevicesUnsupported.message

message: ErrorMessages = ErrorMessages.VIDEO_RECOGNIZER_MEDIA_DEVICES_UNSUPPORTED

cameraMissing

cameraMissing: object

cameraMissing.code

code: ErrorCodes = ErrorCodes.VIDEO_RECOGNIZER_CAMERA_MISSING

cameraMissing.message

message: ErrorMessages = ErrorMessages.VIDEO_RECOGNIZER_CAMERA_MISSING

cameraNotAllowed

cameraNotAllowed: object

cameraNotAllowed.code

code: ErrorCodes = ErrorCodes.VIDEO_RECOGNIZER_CAMERA_NOT_ALLOWED

cameraNotAllowed.message

message: ErrorMessages = ErrorMessages.VIDEO_RECOGNIZER_CAMERA_NOT_ALLOWED

elementMissing

elementMissing: object

elementMissing.message

message: ErrorMessages = ErrorMessages.VIDEO_RECOGNIZER_ELEMENT_MISSING

elementMissing.code

code: ErrorCodes = ErrorCodes.VIDEO_RECOGNIZER_ELEMENT_MISSING

sdkErrors

const sdkErrors: object

Defined in: src/MicroblinkSDK/ErrorTypes.ts:153

Type Declaration

wasmSettingsMissing

wasmSettingsMissing: object

wasmSettingsMissing.message

message: ErrorMessages = ErrorMessages.SDK_WASM_SETTINGS_MISSING

wasmSettingsMissing.code

code: ErrorCodes = ErrorCodes.SDK_WASM_SETTINGS_MISSING

licenseKeyMissing

licenseKeyMissing: object

licenseKeyMissing.message

message: ErrorMessages = ErrorMessages.SDK_LICENSE_KEY_MISSING

licenseKeyMissing.code

code: ErrorCodes = ErrorCodes.SDK_LICENSE_KEY_MISSING

wasmModuleNameMissing

wasmModuleNameMissing: object

wasmModuleNameMissing.message

message: ErrorMessages = ErrorMessages.SDK_WASM_MODULE_NAME_MISSING

wasmModuleNameMissing.code

code: ErrorCodes = ErrorCodes.SDK_WASM_MODULE_NAME_MISSING

engineLocationInvalid

engineLocationInvalid: object

engineLocationInvalid.message

message: ErrorMessages = ErrorMessages.SDK_ENGINE_LOCATION_INVALID

engineLocationInvalid.code

code: ErrorCodes = ErrorCodes.SDK_ENGINE_LOCATION_INVALID

workerLocationInvalid

workerLocationInvalid: object

workerLocationInvalid.message

message: ErrorMessages = ErrorMessages.SDK_WORKER_LOCATION_INVALID

workerLocationInvalid.code

code: ErrorCodes = ErrorCodes.SDK_WORKER_LOCATION_INVALID

missing

missing: object

missing.message

message: ErrorMessages = ErrorMessages.SDK_MISSING

missing.code

code: ErrorCodes = ErrorCodes.SDK_MISSING

recognizersMissing

recognizersMissing: object

recognizersMissing.message

message: ErrorMessages = ErrorMessages.SDK_RECOGNIZERS_MISSING

recognizersMissing.code

code: ErrorCodes = ErrorCodes.SDK_RECOGNIZERS_MISSING

frameCaptureErrors

const frameCaptureErrors: object

Defined in: src/MicroblinkSDK/ErrorTypes.ts:184

Type Declaration

svgUnsupported

svgUnsupported: object

svgUnsupported.message

message: ErrorMessages = ErrorMessages.FRAME_CAPTURE_SVG_UNSUPPORTED

svgUnsupported.code

code: ErrorCodes = ErrorCodes.FRAME_CAPTURE_SVG_UNSUPPORTED

canvasMissing

canvasMissing: object

canvasMissing.message

message: ErrorMessages = ErrorMessages.FRAME_CAPTURE_CANVAS_MISSING

canvasMissing.code

code: ErrorCodes = ErrorCodes.FRAME_CAPTURE_CANVAS_MISSING

licenseErrors

const licenseErrors: object

Defined in: src/MicroblinkSDK/ErrorTypes.ts:195

Type Declaration

licenseTokenStateIncorrect

licenseTokenStateIncorrect: object

licenseTokenStateIncorrect.code

code: ErrorCodes = ErrorCodes.LICENSE_UNLOCK_ERROR

licenseTokenStateIncorrect.message

message: ErrorMessages = ErrorMessages.LICENSE_TOKEN_STATE_INCORRECT

licensePayloadVerificationFailed

licensePayloadVerificationFailed: object

licensePayloadVerificationFailed.code

code: ErrorCodes = ErrorCodes.LICENSE_UNLOCK_ERROR

licensePayloadVerificationFailed.message

message: ErrorMessages = ErrorMessages.LICENSE_PAYLOAD_VERIFICATION_FAILED

licensePayloadCorrupted

licensePayloadCorrupted: object

licensePayloadCorrupted.code

code: ErrorCodes = ErrorCodes.LICENSE_UNLOCK_ERROR

licensePayloadCorrupted.message

message: ErrorMessages = ErrorMessages.LICENSE_PAYLOAD_CORRUPTED

licensePermissionExpired

licensePermissionExpired: object

licensePermissionExpired.code

code: ErrorCodes = ErrorCodes.LICENSE_UNLOCK_ERROR

licensePermissionExpired.message

message: ErrorMessages = ErrorMessages.LICENSE_PERMISSION_EXPIRED

licenseRemoteLocked

licenseRemoteLocked: object

licenseRemoteLocked.code

code: ErrorCodes = ErrorCodes.LICENSE_UNLOCK_ERROR

licenseRemoteLocked.message

message: ErrorMessages = ErrorMessages.LICENSE_REMOTE_LOCKED

licenseNetworkError

licenseNetworkError: object

licenseNetworkError.code

code: ErrorCodes = ErrorCodes.LICENSE_UNLOCK_ERROR

licenseInvalid

licenseInvalid: object

licenseInvalid.code

code: ErrorCodes = ErrorCodes.LICENSE_UNLOCK_ERROR

localSdkErrors

const localSdkErrors: object

Defined in: src/MicroblinkSDK/ErrorTypes.ts:224

Type Declaration

runnerMissing

runnerMissing: object

runnerMissing.message

message: ErrorMessages = ErrorMessages.LOCAL_SDK_RUNNER_MISSING

runnerMissing.code

code: ErrorCodes = ErrorCodes.LOCAL_SDK_RUNNER_MISSING

runnerEmpty

runnerEmpty: object

runnerEmpty.message

message: ErrorMessages = ErrorMessages.LOCAL_SDK_RUNNER_EMPTY

runnerEmpty.code

code: ErrorCodes = ErrorCodes.LOCAL_SDK_RUNNER_EMPTY

workerErrors

const workerErrors: object

Defined in: src/MicroblinkSDK/ErrorTypes.ts:235

Type Declaration

imageProcessFailure

imageProcessFailure: object

imageProcessFailure.message

message: ErrorMessages = ErrorMessages.WORKER_IMAGE_PROCESS_FAILURE

imageProcessFailure.code

code: ErrorCodes = ErrorCodes.WORKER_IMAGE_PROCESS_FAILURE

objectInvokeFailure

objectInvokeFailure: object

objectInvokeFailure.message

message: ErrorMessages = ErrorMessages.WORKER_OBJECT_INVOKE_FAILURE

objectInvokeFailure.code

code: ErrorCodes = ErrorCodes.WORKER_OBJECT_INVOKE_FAILURE

runnerDeleteFailure

runnerDeleteFailure: object

runnerDeleteFailure.message

message: ErrorMessages = ErrorMessages.WORKER_RUNNER_DELETE_FAILURE

runnerDeleteFailure.code

code: ErrorCodes = ErrorCodes.WORKER_RUNNER_DELETE_FAILURE

runnerDeleted

runnerDeleted: object

runnerDeleted.message

message: ErrorMessages = ErrorMessages.WORKER_RUNNER_DELETED

runnerDeleted.code

code: ErrorCodes = ErrorCodes.WORKER_RUNNER_DELETED

runnerReconfigureFailure

runnerReconfigureFailure: object

runnerReconfigureFailure.message

message: ErrorMessages = ErrorMessages.WORKER_RUNNER_RECONFIGURE_FAILURE

runnerReconfigureFailure.code

code: ErrorCodes = ErrorCodes.WORKER_RUNNER_RECONFIGURE_FAILURE

runnerMissing

runnerMissing: object

runnerMissing.message

message: ErrorMessages = ErrorMessages.WORKER_RUNNER_MISSING

runnerMissing.code

code: ErrorCodes = ErrorCodes.WORKER_RUNNER_MISSING

runnerCreationFailure

runnerCreationFailure: object

runnerCreationFailure.message

message: ErrorMessages = ErrorMessages.WORKER_RUNNER_CREATION_FAILURE

runnerCreationFailure.code

code: ErrorCodes = ErrorCodes.WORKER_RUNNER_CREATION_FAILURE

runnerExists

runnerExists: object

runnerExists.message

message: ErrorMessages = ErrorMessages.WORKER_RUNNER_EXISTS

runnerExists.code

code: ErrorCodes = ErrorCodes.WORKER_RUNNER_EXISTS

recognizerCreationFailure

recognizerCreationFailure: object

recognizerCreationFailure.message

message: ErrorMessages = ErrorMessages.WORKER_RECOGNIZER_CREATION_FAILURE

recognizerCreationFailure.code

code: ErrorCodes = ErrorCodes.WORKER_RECOGNIZER_CREATION_FAILURE

functionInvokeFailure

functionInvokeFailure: object

functionInvokeFailure.message

message: ErrorMessages = ErrorMessages.WORKER_FUNCTION_INVOKE_FAILURE

functionInvokeFailure.code

code: ErrorCodes = ErrorCodes.WORKER_FUNCTION_INVOKE_FAILURE

wasmInitMissing

wasmInitMissing: object

wasmInitMissing.message

message: ErrorMessages = ErrorMessages.WORKER_WASM_INIT_MISSING

wasmInitMissing.code

code: ErrorCodes = ErrorCodes.WORKER_WASM_INIT_MISSING

wasmLoadFailure

wasmLoadFailure: object

wasmLoadFailure.message

message: ErrorMessages = ErrorMessages.WORKER_WASM_LOAD_FAILURE

wasmLoadFailure.code

code: ErrorCodes = ErrorCodes.WORKER_WASM_LOAD_FAILURE

handleUndefined

handleUndefined: object

handleUndefined.message

message: ErrorMessages = ErrorMessages.WORKER_HANDLE_UNDEFINED

handleUndefined.code

code: ErrorCodes = ErrorCodes.WORKER_HANDLE_UNDEFINED

integrationInfoFailure

integrationInfoFailure: object

integrationInfoFailure.message

message: ErrorMessages = ErrorMessages.WORKER_INTEGRATION_INFO_FAILURE

integrationInfoFailure.code

code: ErrorCodes = ErrorCodes.WORKER_INTEGRATION_INFO_FAILURE

Functions

isAndroidDevice()

isAndroidDevice(): boolean

Defined in: src/MicroblinkSDK/CameraUtils.ts:147

Returns

boolean

isIOSDevice()

isIOSDevice(): boolean

Defined in: src/MicroblinkSDK/CameraUtils.ts:153

Returns

boolean

isMobileDevice()

isMobileDevice(): boolean

Defined in: src/MicroblinkSDK/CameraUtils.ts:159

Returns

boolean

getCameraDevices()

getCameraDevices(): Promise<CameraDevices>

Defined in: src/MicroblinkSDK/CameraUtils.ts:207

Returns

Promise<CameraDevices>

selectCamera()

selectCamera(cameraId, preferredCameraType): Promise<SelectedCamera | null>

Defined in: src/MicroblinkSDK/CameraUtils.ts:274

Parameters

cameraId

string | null

preferredCameraType

PreferredCameraType

Returns

Promise<SelectedCamera | null>

bindCameraToVideoFeed()

bindCameraToVideoFeed(camera, videoFeed, preferredCameraType): Promise<boolean>

Defined in: src/MicroblinkSDK/CameraUtils.ts:450

Bind camera device to video feed (HTMLVideoElement).

This function will return true in case that video feed of camera device has been flipped, and false otherwise.

Parameters

camera

SelectedCamera

Camera device which should be binded with the video element.

videoFeed

HTMLVideoElement

HTMLVideoElement to which camera device should be binded.

preferredCameraType

PreferredCameraType = PreferredCameraType.BackFacingCamera

Enum representing whether to use front facing or back facing camera.

Returns

Promise<boolean>

isBrowserSupported()

isBrowserSupported(): boolean

Defined in: src/MicroblinkSDK/DeviceUtils.ts:10

Checks if browser is supported by the SDK. The minimum requirements for the browser is the support for WebAssembly. If your browser does not support executing WebAssembly, this function will return false.

Returns

boolean

isInAppBrowser()

isInAppBrowser(): boolean

Defined in: src/MicroblinkSDK/DeviceUtils.ts:34

Check if current browser is in-app / embedded. Detects Instagram, Facebook, LinkedIn, Twitter, WeChat, Whatsapp, and Tiktok.

Returns

boolean

Boolean whether the browser is in-app or not

captureFrame()

captureFrame(imageSource, shouldCrop): CapturedFrame

Defined in: src/MicroblinkSDK/FrameCapture.ts:52

Captures a frame from any CanvasImageSource, such as HTMLVideoElement or HTMLImageElement.

Parameters

imageSource

CanvasImageSource

image source from which frame should be captured

shouldCrop

boolean = false

Returns

CapturedFrame

instance of CapturedFrame

obtainNewServerPermission()

obtainNewServerPermission(unlockResult, wasmModule): Promise<ServerPermissionSubmitResult>

Defined in: src/MicroblinkSDK/License.ts:116

Parameters

unlockResult

LicenseUnlockResult

wasmModule

any

Returns

Promise<ServerPermissionSubmitResult>

unlockWasmSDK()

unlockWasmSDK(licenseKey, allowHelloMessage, userId, wasmModule): Promise<UnlockResult>

Defined in: src/MicroblinkSDK/License.ts:163

Parameters

licenseKey

string

allowHelloMessage

boolean

userId

string

wasmModule

any

Returns

Promise<UnlockResult>

loadWasmModule()

loadWasmModule(loadSettings): Promise<any>

Defined in: src/MicroblinkSDK/MicroblinkSDK.ts:69

Asynchronously loads and compiles the WebAssembly module.

Parameters

loadSettings

WasmSDKLoadSettings

Object defining the settings for loading the WebAssembly module.

Returns

Promise<any>

Promise that resolves if WebAssembly module was successfully loaded and rejects if not.

createRecognizerRunner()

createRecognizerRunner(wasmSDK, recognizers, allowMultipleResults, metadataCallbacks): Promise<RecognizerRunner>

Defined in: src/MicroblinkSDK/MicroblinkSDK.ts:146

Function for creating a new RecognizerRunner. Note that it is currently not possible to have multiple instances of RecognizerRunner per instance of WasmSDK. Attempt to create new instance of RecognizerRunner prior deleting the previous one will fail.

Parameters

wasmSDK

WasmSDK

Instance of WasmSDK which will be used to communicate with the WebAssembly module.

recognizers

Recognizer[]

Array of recognizers that will be used by RecognizerRunner.

allowMultipleResults

boolean = false

Whether or not it is allowed to return multiple results from single recognition session. See README.md for more information.

metadataCallbacks

MetadataCallbacks = {}

Returns

Promise<RecognizerRunner>

isSafari()

isSafari(): boolean

Defined in: src/MicroblinkSDK/WasmLoadUtils.ts:17

Returns

boolean

isIOSUserAgent()

isIOSUserAgent(): boolean

Defined in: src/MicroblinkSDK/WasmLoadUtils.ts:23

Returns

boolean

detectWasmFeatures()

detectWasmFeatures(): Promise<WasmType>

Defined in: src/MicroblinkSDK/WasmLoadUtils.ts:55

Returns

Promise<WasmType>

detectWasmType()

detectWasmType(): Promise<WasmType>

Defined in: src/MicroblinkSDK/WasmLoadUtils.ts:90

Returns

Promise<WasmType>

wasmFolder()

wasmFolder(wasmType): string

Defined in: src/MicroblinkSDK/WasmLoadUtils.ts:116

Parameters

wasmType

WasmType

Returns

string

createBlinkCardRecognizer()

createBlinkCardRecognizer(wasmSDK): Promise<BlinkCardRecognizer>

Defined in: src/Recognizers/BlinkCard/BlinkCardRecognizer.ts:361

This function is used to create a new instance of BlinkCardRecognizer.

Parameters

wasmSDK

WasmSDK

Instance of WasmSDK which will be used to communicate with the WebAssembly module.

Returns

Promise<BlinkCardRecognizer>

createSuccessFrameGrabberRecognizer()

createSuccessFrameGrabberRecognizer<T>(wasmSDK, slaveRecognizer): Promise<SuccessFrameGrabberRecognizer<T>>

Defined in: src/Recognizers/SuccessFrameGrabberRecognizer.ts:61

Creates a new instance of SuccessFrameGrabberRecognizer.

Type Parameters

T

T extends Recognizer

Parameters

wasmSDK

WasmSDK

Instance of WasmSDK which will be used to communicate with the WebAssembly module.

slaveRecognizer

T

Instance of Recognizer that will be wrapped.

Returns

Promise<SuccessFrameGrabberRecognizer<T>>

Enumerations​

PreferredCameraType​

Enumeration Members​

BackFacingCamera​

FrontFacingCamera​

ImageOrientation​

Enumeration Members​

RotatedLeft90​

NoRotation​

RotatedRight90​

Rotated180​

RecognizerResultState​

Enumeration Members​

Empty​

Uncertain​

Valid​

StageValid​

DetectionLevel​

Enumeration Members​

Off​

Low​

Mid​

High​

DocumentSide​

Enumeration Members​

Front​

Back​

ErrorCodes​

Enumeration Members​

WORKER_WASM_LOAD_FAILURE​

WORKER_WASM_INIT_MISSING​

WORKER_FUNCTION_INVOKE_FAILURE​

WORKER_RECOGNIZER_CREATION_FAILURE​

WORKER_RUNNER_EXISTS​

WORKER_RUNNER_CREATION_FAILURE​

WORKER_RUNNER_MISSING​

WORKER_RUNNER_RECONFIGURE_FAILURE​

WORKER_RUNNER_DELETED​

WORKER_RUNNER_DELETE_FAILURE​

WORKER_OBJECT_INVOKE_FAILURE​

WORKER_IMAGE_PROCESS_FAILURE​

WORKER_HANDLE_UNDEFINED​

WORKER_MESSAGE_ACTION_UNKNOWN​

WORKER_LICENSE_UNLOCK_ERROR​

WORKER_INTEGRATION_INFO_FAILURE​

LOCAL_SDK_RUNNER_MISSING​

LOCAL_SDK_RUNNER_EMPTY​

LICENSE_UNLOCK_ERROR​

FRAME_CAPTURE_SVG_UNSUPPORTED​

FRAME_CAPTURE_CANVAS_MISSING​

SDK_WASM_SETTINGS_MISSING​

SDK_LICENSE_KEY_MISSING​

SDK_WASM_MODULE_NAME_MISSING​

SDK_ENGINE_LOCATION_INVALID​

SDK_WORKER_LOCATION_INVALID​

SDK_MISSING​

SDK_RECOGNIZERS_MISSING​

VIDEO_RECOGNIZER_ELEMENT_MISSING​

VIDEO_RECOGNIZER_CAMERA_MISSING​

VIDEO_RECOGNIZER_CAMERA_NOT_ALLOWED​

VIDEO_RECOGNIZER_CAMERA_UNAVAILABLE​

VIDEO_RECOGNIZER_CAMERA_IN_USE​

VIDEO_RECOGNIZER_MEDIA_DEVICES_UNSUPPORTED​

VIDEO_RECOGNIZER_FEED_RELEASED​

VIDEO_RECOGNIZER_FEED_NOT_PAUSED​

VIDEO_RECOGNIZER_PLAY_REQUEST_INTERRUPTED​

VIDEO_RECOGNIZER_FEED_PAUSED​

VIDEO_RECOGNIZER_RECOGNIZERS_RESET_FAILURE​

VIDEO_RECOGNIZER_FEED_MISSING​

ErrorMessages​

Enumeration Members​

WORKER_HANDLE_UNDEFINED​

WORKER_WASM_LOAD_FAILURE​

WORKER_WASM_INIT_MISSING​

WORKER_FUNCTION_INVOKE_FAILURE​

WORKER_RECOGNIZER_CREATION_FAILURE​

WORKER_RUNNER_EXISTS​

WORKER_RUNNER_CREATION_FAILURE​

WORKER_RUNNER_MISSING​

WORKER_RUNNER_RECONFIGURE_FAILURE​

Enumerations

PreferredCameraType

Enumeration Members

BackFacingCamera

FrontFacingCamera

ImageOrientation

Enumeration Members

RotatedLeft90

NoRotation

RotatedRight90

Rotated180

RecognizerResultState

Enumeration Members

Empty

Uncertain

Valid

StageValid

DetectionLevel

Enumeration Members

Off

Low

Mid

High

DocumentSide

Enumeration Members

Front

Back

ErrorCodes

Enumeration Members

WORKER_WASM_LOAD_FAILURE

WORKER_WASM_INIT_MISSING

WORKER_FUNCTION_INVOKE_FAILURE

WORKER_RECOGNIZER_CREATION_FAILURE

WORKER_RUNNER_EXISTS

WORKER_RUNNER_CREATION_FAILURE

WORKER_RUNNER_MISSING

WORKER_RUNNER_RECONFIGURE_FAILURE

WORKER_RUNNER_DELETED

WORKER_RUNNER_DELETE_FAILURE

WORKER_OBJECT_INVOKE_FAILURE

WORKER_IMAGE_PROCESS_FAILURE

WORKER_HANDLE_UNDEFINED

WORKER_MESSAGE_ACTION_UNKNOWN

WORKER_LICENSE_UNLOCK_ERROR

WORKER_INTEGRATION_INFO_FAILURE

LOCAL_SDK_RUNNER_MISSING

LOCAL_SDK_RUNNER_EMPTY

LICENSE_UNLOCK_ERROR

FRAME_CAPTURE_SVG_UNSUPPORTED

FRAME_CAPTURE_CANVAS_MISSING

SDK_WASM_SETTINGS_MISSING

SDK_LICENSE_KEY_MISSING

SDK_WASM_MODULE_NAME_MISSING

SDK_ENGINE_LOCATION_INVALID

SDK_WORKER_LOCATION_INVALID

SDK_MISSING

SDK_RECOGNIZERS_MISSING

VIDEO_RECOGNIZER_ELEMENT_MISSING

VIDEO_RECOGNIZER_CAMERA_MISSING

VIDEO_RECOGNIZER_CAMERA_NOT_ALLOWED

VIDEO_RECOGNIZER_CAMERA_UNAVAILABLE

VIDEO_RECOGNIZER_CAMERA_IN_USE

VIDEO_RECOGNIZER_MEDIA_DEVICES_UNSUPPORTED

VIDEO_RECOGNIZER_FEED_RELEASED

VIDEO_RECOGNIZER_FEED_NOT_PAUSED

VIDEO_RECOGNIZER_PLAY_REQUEST_INTERRUPTED

VIDEO_RECOGNIZER_FEED_PAUSED

VIDEO_RECOGNIZER_RECOGNIZERS_RESET_FAILURE

VIDEO_RECOGNIZER_FEED_MISSING

ErrorMessages

Enumeration Members

WORKER_HANDLE_UNDEFINED

WORKER_WASM_LOAD_FAILURE

WORKER_WASM_INIT_MISSING

WORKER_FUNCTION_INVOKE_FAILURE

WORKER_RECOGNIZER_CREATION_FAILURE

WORKER_RUNNER_EXISTS

WORKER_RUNNER_CREATION_FAILURE

WORKER_RUNNER_MISSING

WORKER_RUNNER_RECONFIGURE_FAILURE