Scanbot Document Scanner SDK and Data Capture Modules for Capacitor

Table of contents

• About the Scanbot SDK
• How to use the SDK
  • Requirements
  • Install steps
  • Camera permissions
  • SDK initialization
  • Implementing the document scanner
• Overview of the Scanbot SDK
  • Document Scanner SDK
  • Data Capture Modules
    • MRZ Scanner
    • Check Scanner (MICR)
    • Text Pattern Scanner
    • VIN Scanner
    • Document Data Extractor
• Additional information
  • Trial license
  • Free developer support
  • Guides and tutorials

About the Scanbot SDK

The Scanbot SDK provides high-level APIs that let you integrate document scanning and data extraction into your mobile apps and websites. It runs on all common mobile devices entirely offline, without transmitting data to our or third-party servers.

With our Ready-To-Use UI components, you can integrate the Scanbot SDK into your Capacitor app in less than an hour.

💡 For more details about the Scanbot Document Scanner SDK and Data Capture Modules, please check out our documentation or see our example apps (React, Vue.js, and Angular).

Changelog

For a detailed list of changes in each version, see the changelog.

How to use the SDK

Requirements

Check out our documentation for a full overview of our SDK's requirements.

Install steps

To install the Scanbot Document Scanner SDK module, run the following command in your root project folder:

1npm i capacitor-plugin-scanbot-sdk

Camera permissions

Our SDK needs camera access to scan from a live camera stream.

Android

Add camera permission to your android/app/src/main/AndroidManifest.xml:

1<uses-permission android:name="android.permission.CAMERA" />
2
3<uses-feature android:name="android.hardware.camera" />

iOS

Add camera permission to ios/{projectName}/Info.plist inside the element:

1<key>NSCameraUsageDescription</key>
2
3<string>Camera permission is needed to scan documents</string>

SDK initialization

Initialize the SDK before using any features, ideally when your app launches.

Add this import to the top of your file:

1import ScanbotSDK from 'capacitor-plugin-scanbot-sdk';

Initialize the SDK with:

1ScanbotSDK
2.initializeSDK({ licenseKey: "" })
3.then(result => console.log(result))
4.catch(err => console.log(err));

💡 You can test the SDK without a license key for 60 seconds per app session. Need longer testing? Get your free trial license key.

Implementing the document scanner

With our Ready-To-Use UI (RTU UI) components, you can start the document scanner screen with just a few lines of code:

1// Example for launching the Scanbot Document Scanner SDK
2
3import {DocumentScanningFlow, startDocumentScanner} from "capacitor-plugin-scanbot-sdk/ui_v2";
4
5async function startScanning() {
6   try {
7       /** Create the default configuration instance */
8       const configuration = new DocumentScanningFlow();
9
10       /** Start the Document Scanner UI */
11       const documentResult = await startDocumentScanner(configuration);
12
13       /** Handle the document if the status is 'OK' */
14       if (documentResult.status === 'OK') {
15       }
16   } catch (e: any) {
17       console.error(e.message);
18
19   }
20}

Note: This example demonstrates the minimal implementation. For more configuration options or to learn how to integrate our data capture modules, visit our full documentation.

Overview of the Scanbot SDK

Document Scanner SDK

The Scanbot Capacitor Document Scanner SDK includes these key features:

• User guidance: Ease of use is crucial for large user bases. Our on-screen user guidance helps even non-tech-savvy users create perfect scans under any conditions, even in poor lighting conditions. This feature ensures that documents are properly framed and aligned before the scan is taken, ensuring the best quality of the captured image.

• Automatic capture: The SDK automatically captures scans when the device camera is optimally positioned over the document, minimizing blurry or incomplete scans.

• Automatic cropping: Our SDK applies perspective correction and crops scanned documents automatically, ensuring properly cropped images every time.

• Custom image filters: Transform captured images to meet your specific requirements with custom filters, including several color, grayscale, and binarization options.

• Document Quality Analyzer: Automatically rates scanned page quality from "very poor" to "excellent." If quality is low, it prompts users to rescan.

• Export formats: Export digitized documents in several formats (JPG, PDF, TIFF, and PNG).

Data Capture Modules

The Scanbot SDK Data Capture Modules allow you to extract data from structured documents and integrate OCR text recognition. These modules include:

MRZ Scanner

Quickly extract data from machine-readable zones on identity documents. It captures all important MRZ data from IDs and passports and returns it as simple key-value pairs—faster and more accurate than manual data entry.

Check Scanner (MICR)

Extract data from international paper checks, capturing check numbers, routing numbers, and account numbers from MICR codes. This simplifies workflows and reduces errors that frustrate customers and employees.

Text Pattern Scanner

Our Text Pattern Scanner allows quick and accurate extraction of single-line data. It captures information based on customizable patterns tailored to your specific use case. This replaces error-prone manual data entry with automatic capture.

VIN Scanner

The VIN scanner enables instant capture of vehicle identification numbers (VINs) from trucks or car doors. It uses OCR to convert the image of the VIN code into structured data for backend processing. This module integrates into mobile or web-based fleet management applications, enabling you to replace error-prone manual entry with fast, reliable data extraction.

Document Data Extractor

Identify and crop various standardized document types, including German ID cards, passports, driver's licenses, residence permits, and the EHIC. It uses the Scanbot OCR engine for accurate data field recognition without needing additional OCR language files.

Additional information

Trial license

The Scanbot SDK runs for one minute per session without a license. After that, all features and UI components stop working.

To try the Scanbot Document Scanner SDK for Capacitor without the one-minute limit, you can request a free, no-strings-attached 7-day trial license.

Our pricing model is simple: Unlimited document scanning for a flat annual license fee, full support included. There are no tiers, usage charges, or extra fees. Contact our team for your quote.

Free developer support

Need help integrating our Document Scanner SDK in your Capacitor project? We offer free developer support via Slack, MS Teams, or email.

As a customer, you also get access to a dedicated support Slack or Microsoft Teams channel to talk directly to your Customer Success Manager and our engineers.

Guides and tutorials

Want to enable document scanning in your app? You can integrate the Scanbot Capacitor Document Scanner plugin in just minutes.

💡 Check out our developer blog for a collection of in-depth tutorials, use cases, and best practices.