BlinkID/blinkid-web v7.0.0 on GitHub

We're excited to introduce BlinkID v7, a major upgrade designed to simplify your integration and deliver a simpler ID scanning experience. With BlinkID v7, we're taking a fresh approach to scanning logic by introducing a more straightforward, session-based API for an easier configuration path, all while boosting first-time scan success rate.

Highlights & Integration Improvements

Unified session-based API: We've moved away from juggling multiple recognizers (e.g., SingleSide, MultiSide) to a single session-based approach, unifying scanning logic under one simplified API. There's no need to switch recognizers anymore.
Backward compatibility: Existing production keys will continue to work with v7.0. No new license key is required for the upgrade.
More maintainable codebase: This new architecture sets the stage for easier and faster updates.

Architecture Changes

New core components: Instead of Recognizer-based architecture, BlinkID uses a streamlined session-based approach.
Modern TypeScript: Written with modern TypeScript features for improved developer experience.
Component-based UI: Simplified, customizable UI components for easier integration.
Simplified flow: More straightforward API with clearer separation of concerns.

Major API Changes

New session-based API
- Replaces the recognizer-based approach with a single, streamlined session model for easier scanning logic and better maintainability.
Modular SDK structure
- The SDK is now modular:
  - @microblink/blinkid-core for scanning logic.
  - @microblink/blinkid-ux-manager for prebuilt UI components.
  - @microblink/camera-manager for camera stream handling.
  - @microblink/blinkid as the all-in-one package.

Simplified initialization & result handling

New SDK initialization method:

import { createBlinkId } from "@microblink/blinkid";

const blinkid = await createBlinkId({
  licenseKey: "your-license-key",
});

Results are now retrieved through structured session-based callbacks.

Enhanced UI customization
- UI settings enable direct customization of typography, colors, and strings.
- The modular architecture allows advanced modifications for branding and accessibility.
Renamed settings for improved clarity
- blurStrictnessLevel → blurDetectionLevel
- enableBlurFilter → skipFramesWithBlur
- glareStrictnessLevel → glareDetectionLevel
- enableGlareFilter → skipFramesWithGlare
- combineFrameResults → enableMultiFrameExtraction
- cardRotation→ documentRotation
- And more...

Plan Your Upgrade

Note that v6 is now considered legacy. Comprehensive documentation is in development - in the meantime, please refer to our example applications in the repository under apps/examples for integration patterns:

blinkid-simple: Minimal integration with default UI
blinkid-core-api: Low-level usage of the core API
blinkid-advanced-setup: Custom UI and advanced configuration
blinkid-preload: Preloading resources for faster startup

For any questions or feedback, reach out to support@microblink.com. We value your input and look forward to hearing how BlinkID v7 improves your app's experience!