---
Source: https://docs.microblink.com/blinkid-web-sdk
---

**@microblink/blinkid**

***

# @microblink/blinkid

## Classes {/* #classes */}

- [AnalyticService](classes/AnalyticService.md)
- [BlinkIdWorker](classes/BlinkIdWorker.md)
- [Camera](classes/Camera.md)
- [CameraError](classes/CameraError.md)
- [CameraManager](classes/CameraManager.md)
- [FeedbackStabilizer](classes/FeedbackStabilizer.md)
- [HapticFeedbackManager](classes/HapticFeedbackManager.md)
- [VideoFrameProcessor](classes/VideoFrameProcessor.md)

## Interfaces {/* #interfaces */}

- [BlinkIdUxManager](interfaces/BlinkIdUxManager.md)
- [PingBase](interfaces/PingBase.md)
- [UADataValues](interfaces/UADataValues.md)
- [WasmBindings](interfaces/WasmBindings.md)
- [WasmModule](interfaces/WasmModule.md)

## Type Aliases {/* #type-aliases */}

- [AddressDetailedInfo](type-aliases/AddressDetailedInfo.md)
- [AlphabetStringResult](type-aliases/AlphabetStringResult.md)
- [AlphabetType](type-aliases/AlphabetType.md)
- [AnonymizationMode](type-aliases/AnonymizationMode.md)
- [BarcodeData](type-aliases/BarcodeData.md)
- [BarcodeElement](type-aliases/BarcodeElement.md)
- [BarcodeElementKey](type-aliases/BarcodeElementKey.md)
- [BarcodeResult](type-aliases/BarcodeResult.md)
- [BarcodeType](type-aliases/BarcodeType.md)
- [BlinkIdComponent](type-aliases/BlinkIdComponent.md)
- [BlinkIdComponentOptions](type-aliases/BlinkIdComponentOptions.md)
- [BlinkIdCore](type-aliases/BlinkIdCore.md)
- [BlinkIdInitSettings](type-aliases/BlinkIdInitSettings.md)
- [BlinkIdPageTransitionKey](type-aliases/BlinkIdPageTransitionKey.md)
- [BlinkIdProcessingError](type-aliases/BlinkIdProcessingError.md)
- [BlinkIdProcessResult](type-aliases/BlinkIdProcessResult.md)
- [BlinkIdReticleType](type-aliases/BlinkIdReticleType.md)
- [BlinkIdScanningResult](type-aliases/BlinkIdScanningResult.md)
- [BlinkIdScanningSession](type-aliases/BlinkIdScanningSession.md)
- [BlinkIdSessionError](type-aliases/BlinkIdSessionError.md)
- [BlinkIdSessionErrorType](type-aliases/BlinkIdSessionErrorType.md)
- [BlinkIdSessionErrorWithBuffer](type-aliases/BlinkIdSessionErrorWithBuffer.md)
- [BlinkIdSessionSettings](type-aliases/BlinkIdSessionSettings.md)
- [BlinkIdUiErrorStateKey](type-aliases/BlinkIdUiErrorStateKey.md)
- [BlinkIdUiIntroStateKey](type-aliases/BlinkIdUiIntroStateKey.md)
- [BlinkIdUiMappableKey](type-aliases/BlinkIdUiMappableKey.md)
- [BlinkIdUiState](type-aliases/BlinkIdUiState.md)
- [BlinkIdUiStateKey](type-aliases/BlinkIdUiStateKey.md)
- [BlinkIdUiStateMap](type-aliases/BlinkIdUiStateMap.md)
- [BlinkIdUiStepSuccessKey](type-aliases/BlinkIdUiStepSuccessKey.md)
- [BlinkIdUxManagerOptions](type-aliases/BlinkIdUxManagerOptions.md)
- [BlinkIdUxManagerType](type-aliases/BlinkIdUxManagerType.md)
- [BlinkIdWorkerInitSettings](type-aliases/BlinkIdWorkerInitSettings.md)
- [BlinkIdWorkerProxy](type-aliases/BlinkIdWorkerProxy.md)
- [BrowserStorageSupport](type-aliases/BrowserStorageSupport.md)
- [CameraErrorCode](type-aliases/CameraErrorCode.md)
- [CameraManagerComponent](type-aliases/CameraManagerComponent.md)
- [CameraManagerOptions](type-aliases/CameraManagerOptions.md)
- [CameraManagerStore](type-aliases/CameraManagerStore.md)
- [CameraManagerUiOptions](type-aliases/CameraManagerUiOptions.md)
- [CameraPermission](type-aliases/CameraPermission.md)
- [CameraPreference](type-aliases/CameraPreference.md)
- [CameraUiLocaleRecord](type-aliases/CameraUiLocaleRecord.md)
- [CameraUiLocalizationStrings](type-aliases/CameraUiLocalizationStrings.md)
- [CameraUiRefs](type-aliases/CameraUiRefs.md)
- [CanvasRenderingMode](type-aliases/CanvasRenderingMode.md)
- [Country](type-aliases/Country.md)
- [CroppedImageSettings](type-aliases/CroppedImageSettings.md)
- [DataMatchFieldState](type-aliases/DataMatchFieldState.md)
- [DataMatchFieldType](type-aliases/DataMatchFieldType.md)
- [DataMatchResult](type-aliases/DataMatchResult.md)
- [DataMatchState](type-aliases/DataMatchState.md)
- [DateResult](type-aliases/DateResult.md)
- [DependentInfo](type-aliases/DependentInfo.md)
- [DerivedDeviceInfo](type-aliases/DerivedDeviceInfo.md)
- [DetailedCroppedImageResult](type-aliases/DetailedCroppedImageResult.md)
- [DetailedFieldType](type-aliases/DetailedFieldType.md)
- [DetectionLevel](type-aliases/DetectionLevel.md)
- [DetectionStatus](type-aliases/DetectionStatus.md)
- [DeviceInfo](type-aliases/DeviceInfo.md)
- [DeviceScreenInfo](type-aliases/DeviceScreenInfo.md)
- [DismountCallback](type-aliases/DismountCallback.md)
- [DocumentAnonymizationSettings](type-aliases/DocumentAnonymizationSettings.md)
- [DocumentClassFilter](type-aliases/DocumentClassFilter.md)
- [DocumentClassInfo](type-aliases/DocumentClassInfo.md)
- [DocumentFilter](type-aliases/DocumentFilter.md)
- [DocumentImageColor](type-aliases/DocumentImageColor.md)
- [DocumentNumberAnonymizationSettings](type-aliases/DocumentNumberAnonymizationSettings.md)
- [DocumentOrientation](type-aliases/DocumentOrientation.md)
- [DocumentRotation](type-aliases/DocumentRotation.md)
- [DocumentRules](type-aliases/DocumentRules.md)
- [DocumentType](type-aliases/DocumentType.md)
- [DownloadProgress](type-aliases/DownloadProgress.md)
- [DriverLicenceDetailedInfo](type-aliases/DriverLicenceDetailedInfo.md)
- [ErrorCallback](type-aliases/ErrorCallback.md)
- [ExtractionArea](type-aliases/ExtractionArea.md)
- [FacingMode](type-aliases/FacingMode.md)
- [FeedbackUiOptions](type-aliases/FeedbackUiOptions.md)
- [FieldType](type-aliases/FieldType.md)
- [FormFactor](type-aliases/FormFactor.md)
- [FrameCaptureCallback](type-aliases/FrameCaptureCallback.md)
- [GpuInfo](type-aliases/GpuInfo.md)
- [HapticFeedbackType](type-aliases/HapticFeedbackType.md)
- [ImageAnalysisDetectionStatus](type-aliases/ImageAnalysisDetectionStatus.md)
- [ImageAnalysisLightingStatus](type-aliases/ImageAnalysisLightingStatus.md)
- [ImageExtractionType](type-aliases/ImageExtractionType.md)
- [ImageSource](type-aliases/ImageSource.md)
- [InputImageAnalysisResult](type-aliases/InputImageAnalysisResult.md)
- [InputImageSource](type-aliases/InputImageSource.md)
- [LicenseRequest](type-aliases/LicenseRequest.md)
- [LicenseTokenState](type-aliases/LicenseTokenState.md)
- [LicenseUnlockResult](type-aliases/LicenseUnlockResult.md)
- [LoadWasmParams](type-aliases/LoadWasmParams.md)
- [LocaleRecord](type-aliases/LocaleRecord.md)
- [LocalizationStrings](type-aliases/LocalizationStrings.md)
- [MrzDocumentType](type-aliases/MrzDocumentType.md)
- [MrzResult](type-aliases/MrzResult.md)
- [ParentInfo](type-aliases/ParentInfo.md)
- [PartialProcessResult](type-aliases/PartialProcessResult.md)
- [Ping](type-aliases/Ping.md)
- [PingBrowserDeviceInfo](type-aliases/PingBrowserDeviceInfo.md)
- [PingBrowserDeviceInfoData](type-aliases/PingBrowserDeviceInfoData.md)
- [PingCameraHardwareInfo](type-aliases/PingCameraHardwareInfo.md)
- [PingCameraHardwareInfoData](type-aliases/PingCameraHardwareInfoData.md)
- [PingCameraInputInfo](type-aliases/PingCameraInputInfo.md)
- [PingCameraInputInfoData](type-aliases/PingCameraInputInfoData.md)
- [PingCameraPermission](type-aliases/PingCameraPermission.md)
- [PingCameraPermissionData](type-aliases/PingCameraPermissionData.md)
- [PingError](type-aliases/PingError.md)
- [PingErrorData](type-aliases/PingErrorData.md)
- [PingLog](type-aliases/PingLog.md)
- [PingLogData](type-aliases/PingLogData.md)
- [PingScanningConditions](type-aliases/PingScanningConditions.md)
- [PingScanningConditionsData](type-aliases/PingScanningConditionsData.md)
- [PingSdkInitStart](type-aliases/PingSdkInitStart.md)
- [PingSdkInitStartData](type-aliases/PingSdkInitStartData.md)
- [PingUxEvent](type-aliases/PingUxEvent.md)
- [PingUxEventData](type-aliases/PingUxEventData.md)
- [PingWrapperProductInfo](type-aliases/PingWrapperProductInfo.md)
- [PingWrapperProductInfoData](type-aliases/PingWrapperProductInfoData.md)
- [PlaybackState](type-aliases/PlaybackState.md)
- [Point](type-aliases/Point.md)
- [ProcessingStatus](type-aliases/ProcessingStatus.md)
- [ProcessResultWithBuffer](type-aliases/ProcessResultWithBuffer.md)
- [ProgressStatusCallback](type-aliases/ProgressStatusCallback.md)
- [Quadrilateral](type-aliases/Quadrilateral.md)
- [RecognitionMode](type-aliases/RecognitionMode.md)
- [RecognitionModeFilter](type-aliases/RecognitionModeFilter.md)
- [Rectangle](type-aliases/Rectangle.md)
- [Region](type-aliases/Region.md)
- [RemoteScanningSession](type-aliases/RemoteScanningSession.md)
- [Resolution](type-aliases/Resolution.md)
- [ResourceFileType](type-aliases/ResourceFileType.md)
- [ResultCompleteness](type-aliases/ResultCompleteness.md)
- [ScanningMode](type-aliases/ScanningMode.md)
- [ScanningSettings](type-aliases/ScanningSettings.md)
- [ScanningSide](type-aliases/ScanningSide.md)
- [ScanningStatus](type-aliases/ScanningStatus.md)
- [SchemaName](type-aliases/SchemaName.md)
- [ServerPermissionErrorReason](type-aliases/ServerPermissionErrorReason.md)
- [ServerPermissionSubmitError](type-aliases/ServerPermissionSubmitError.md)
- [SingleSideScanningResult](type-aliases/SingleSideScanningResult.md)
- [StartCameraStreamOptions](type-aliases/StartCameraStreamOptions.md)
- [StringResult](type-aliases/StringResult.md)
- [UiState](type-aliases/UiState.md)
- [UiStateEvent](type-aliases/UiStateEvent.md)
- [UiStateMap](type-aliases/UiStateMap.md)
- [VehicleClassInfo](type-aliases/VehicleClassInfo.md)
- [VideoFrameProcessorInitOptions](type-aliases/VideoFrameProcessorInitOptions.md)
- [VideoResolutionName](type-aliases/VideoResolutionName.md)
- [VizResult](type-aliases/VizResult.md)
- [WasmBuildType](type-aliases/WasmBuildType.md)
- [WasmSimdVariant](type-aliases/WasmSimdVariant.md)
- [WasmVariant](type-aliases/WasmVariant.md)
- [WorkerScanningSession](type-aliases/WorkerScanningSession.md)

## Variables {/* #variables */}

- [blinkIdPageTransitionKeys](variables/blinkIdPageTransitionKeys.md)
- [blinkIdUiErrorStateKeys](variables/blinkIdUiErrorStateKeys.md)
- [blinkIdUiIntroStateKeys](variables/blinkIdUiIntroStateKeys.md)
- [blinkIdUiStateMap](variables/blinkIdUiStateMap.md)
- [blinkIdUiStepSuccessKeys](variables/blinkIdUiStepSuccessKeys.md)
- [cameraManagerStore](variables/cameraManagerStore.md)
- [cameraUiRefStore](variables/cameraUiRefStore.md)
- [createBlinkIdUxManager](variables/createBlinkIdUxManager.md)
- [defaultCameraManagerOptions](variables/defaultCameraManagerOptions.md)
- [defaultSessionSettings](variables/defaultSessionSettings.md)
- [getBuffer](variables/getBuffer.md)
- [getCrossOriginWorkerURL](variables/getCrossOriginWorkerURL.md)
- [HAPTIC\_FEEDBACK\_CONFIGS](variables/HAPTIC_FEEDBACK_CONFIGS.md)
- [MOUNT\_POINT\_ID](variables/MOUNT_POINT_ID.md)
- [resetCameraManagerStore](variables/resetCameraManagerStore.md)
- [resourceFileTypes](variables/resourceFileTypes.md)
- [videoResolutions](variables/videoResolutions.md)
- [wasmBuildTypes](variables/wasmBuildTypes.md)
- [wasmSimdVariants](variables/wasmSimdVariants.md)
- [wasmVariants](variables/wasmVariants.md)

## Functions {/* #functions */}

- [createBlinkId](functions/createBlinkId.md)
- [createBlinkIdFeedbackUi](functions/createBlinkIdFeedbackUi.md)
- [createCameraManagerUi](functions/createCameraManagerUi.md)
- [createDerivedDeviceInfo](functions/createDerivedDeviceInfo.md)
- [createProxyWorker](functions/createProxyWorker.md)
- [extractBarcodeImage](functions/extractBarcodeImage.md)
- [extractFaceImage](functions/extractFaceImage.md)
- [extractSideDocumentImage](functions/extractSideDocumentImage.md)
- [extractSideInputImage](functions/extractSideInputImage.md)
- [extractSignatureImage](functions/extractSignatureImage.md)
- [findResolutionKey](functions/findResolutionKey.md)
- [getDeviceInfo](functions/getDeviceInfo.md)
- [getNormalizedResolution](functions/getNormalizedResolution.md)
- [getUiStateKey](functions/getUiStateKey.md)
- [getUserAgentData](functions/getUserAgentData.md)
- [getUserId](functions/getUserId.md)
- [isBufferDetached](functions/isBufferDetached.md)
- [loadBlinkIdCore](functions/loadBlinkIdCore.md)
- [matchClosestResolution](functions/matchClosestResolution.md)
- [returnLongerSide](functions/returnLongerSide.md)


Last updated on Apr 16, 2026