@microblink/blinkid-core

@microblink/blinkid-core

This package provides the core BlinkID functionality for browser-based document scanning. It exposes a low-level API for initializing and controlling the BlinkID engine, managing sessions, and processing images. It can be used directly by end users for advanced or custom integrations, or as a dependency of higher-level packages such as @microblink/blinkid.

Overview

• Provides the main API for BlinkID scanning and recognition in the browser.
• Handles initialization, licensing, and session management.
• Can be used directly by end users for advanced use cases.
• Used internally by @microblink/blinkid.

Installation

Install from npm using your preferred package manager:

npm install @microblink/blinkid-core
# or
yarn add @microblink/blinkid-core
# or
pnpm add @microblink/blinkid-core

Usage

You can use @microblink/blinkid-core directly in your project for custom integrations. See the example apps in the apps/examples directory in the GitHub repository for usage details.

Environment & Setup

• ESM-only: Use in browsers with a bundler (e.g., Vite) or via <script type="module">.
• Can also be used via esm.sh for direct HTTP imports.

License key

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

Hosting resources

You must host the dist/resources directory from this package without modification. It contains:

• WebAssembly .wasm and .data files
• Emscripten JS glue code
• The @microblink/blinkid-worker Web Worker script

Hosting requirements

• 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
  

Development

To build the package locally:

• Install dependencies in the monorepo root:

  pnpm install
  

• Build the package:

  pnpm build
  

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