@microblink/blinkcard

The all-in-one BlinkCard browser SDK package. It provides a high-level, easy-to-use API for credit and debit card scanning and recognition in web applications, bundling all required components and resources for a seamless integration experience.

Bundle size

Production consumer bundle sizes for @microblink/blinkcard:

| Entrypoint | Minified | Gzip | | ---------- | --------- | --------- | | root | 522.68 kB | 147.55 kB |

External packages and runtime assets such as workers, WASM, and models are excluded. Shared code is included in each entrypoint that loads it.

Generated automatically. Do not edit manually.

Overview

• Combines the BlinkCard engine, camera management, user experience (UX) management, and all required resources.
• Handles initialization, licensing, camera selection, scanning, and user feedback UI.
• Suitable for most use cases—just add your license key and start scanning.

What's Included

• @microblink/blinkcard-core: Core scanning engine and low-level API.
• @microblink/blinkcard-ux-manager: User experience and feedback UI.
• @microblink/camera-manager: Camera selection and video stream management.

Installation

Install from npm using your preferred package manager:

npm install @microblink/blinkcard
# or
yarn add @microblink/blinkcard
# or
pnpm add @microblink/blinkcard

Usage

A minimal example:

import { createBlinkCard } from "@microblink/blinkcard";

const blinkcard = await createBlinkCard({
  licenseKey: import.meta.env.VITE_LICENCE_KEY,
});

For more advanced usage or integration with your own UI, see the example apps and the documentation for the underlying packages.

Documentation

Full documentation, API reference, and integration guides are available at docs.microblink.com.

Example Apps

Explore example applications in the repository under apps/examples:

• apps/examples/blinkcard-simple for a minimal integration.
• apps/examples/blinkcard-advanced-setup for advanced low-level setup and customization.

Hosting Requirements

• Serve the public/resources directory as-is; it contains all required Wasm, worker, and resource files.

• Must be served in a secure context.

• For multithreaded builds, your site must be cross-origin isolated:

  Cross-Origin-Embedder-Policy: require-corp
  Cross-Origin-Opener-Policy: same-origin

License Key

A valid license key is required. Request a free trial at Microblink Developer Hub.

Development

To build the package locally:

1. Install dependencies in the monorepo root:

   pnpm install

2. Build the package:

   pnpm build

The output files will be available in the dist/, types/, and public/resources/ directories.

Browser Support

BlinkCard supports camera-based scanning in these browser versions and newer:

• Chrome / Chromium 96 (desktop and Android)
• Edge 96
• Opera 84
• Firefox 132 (desktop)
• Safari 16.4 (macOS)
• iOS Safari 16.4

The SDK must run in a secure context because browsers only expose camera APIs such as getUserMedia() on HTTPS or localhost.

WebAssembly runtime

The SDK ships four Wasm build variants (simd, simd-threads, simd-relaxed, and simd-relaxed-threads). The runtime selects the best supported variant automatically: relaxed SIMD variants are preferred when the browser supports relaxed SIMD, and threaded variants are preferred when the browser supports Wasm threads.

simd

Requires the Emscripten-generated Wasm feature set used by the SDK plus fixed-width SIMD.

simd-threads

Requires all simd features plus Wasm threads and atomics. Multithreaded Wasm also requires cross-origin isolation headers (Cross-Origin-Opener-Policy: same-origin and Cross-Origin-Embedder-Policy: require-corp).

Safari is excluded from threaded variants even when it reports Wasm thread support. Emscripten threaded builds use pthreads that spawn workers from inside a worker, and Safari historically lacked reliable nested worker support when Wasm threads shipped in Safari 16. There are also known Safari issues with shared memory in Emscripten pthread builds (emscripten-core/emscripten#19374). For these reasons the runtime falls back to a single-threaded variant on Safari instead of loading simd-threads or simd-relaxed-threads.

simd-relaxed and simd-relaxed-threads

Require all simd (or simd-threads) features plus relaxed SIMD. Relaxed SIMD instructions let the engine pick the fastest hardware implementation for a subset of vector operations. Browsers without relaxed SIMD support fall back to simd or simd-threads.

Firefox for Android

Firefox for Android is not supported for camera-based scanning. The SDK uses @microblink/camera-manager, and Firefox Android can hide video input devices from navigator.mediaDevices.enumerateDevices() before an active camera capture. This makes camera device discovery and permission handling unreliable. Mozilla tracks this behavior as intentional and resolved it as WONTFIX because exposing device information before camera access has fingerprinting implications: Bugzilla 1611998.