scanbot-web-sdk
Advanced tools
The Scanbot SDK is a set of high-level APIs that lets you integrate barcode and document scanning, as well as data extraction functionalities, into your website. It runs in all common web browsers, such as Chrome, Safari, Firefox, or Edge, and operates entirely on the user's device. No data is transmitted to our or third-party servers.
The SDK can be implemented into your web app with just a few lines of code and comes with Ready-To-Use UI components.
💡 For more details about the Scanbot Web SDK, please visit our Barcode Scanner or Document Scanner documentation, or download our example app.
For a detailed list of changes in each version, see the changelog for our Web Barcode Scanner or Web Document Scanner SDK.
Check out our barcode scanner or document scanner documentation for a full overview of our SDK's requirements and complete installation guide.
Add a reference to Scanbot SDK via CDN link/script. Make sure it's before your main script.
<html>
<head>
<title>ScanbotSDK Quickstart</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
</head>
<body>
<div id="document-scanner-container" style="width: 100%; height: 100%;"></div>
</body>
<script src="https://cdn.jsdelivr.net/npm/scanbot-web-sdk@7.1.0/bundle/ScanbotSDK.ui2.min.js"></script>
<script src="./main.js"></script>
</html>
Note: We strongly recommend AGAINST using jsdelivr for your production environment. Please download the SDK and host it on your server. We only use it for the quickest proof-of-concept implementation.
Since most environments still do not allow top-level await, you need to wrap your code in an async function.
(async function() {
const sdk = await ScanbotSDK.initialize({
licenseKey: "", // Empty string is the default value for trial mode
enginePath: "https://cdn.jsdelivr.net/npm/scanbot-web-sdk@7.1.0/bundle/bin/complete/"
});
})();
💡 You can test the SDK without a license key for 60 seconds per app session. Need longer testing? Get your free trial license key.
With just a few lines of code, you can integrate the barcode scanning or document scanning UI into your application's workflow using the Scanbot Web SDK's ready-to-use UI.
Remember to wrap the scanner creation into the same async block as initialization.
// Configure the scanner as needed
const config = new ScanbotSDK.UI.Config.BarcodeScannerScreenConfiguration();
// Create the scanner with the config object
const result = await ScanbotSDK.UI.createBarcodeScanner(config);
// Configure the scanner as needed
const config = new ScanbotSDK.UI.Config.DocumentScanningFlow();
// Create the scanner with the config object
const result = await ScanbotSDK.UI.createDocumentScanner(config);
To integrate the Scanbot Web SDK's data capture modules, visit our full documentation.
The Scanbot Barcode Scanner SDK for the web allows you to integrate fast and accurate barcode scanning capabilities into your web apps. On fast devices, barcodes might scan in as little as 0.04 seconds, and scans remain precise even under challenging conditions, including damaged, small, or distant barcodes and low-light environments.
The Scanbot Barcode Scanner SDK offers the following scan modes, available out-of-the-box in our ready-to-use UI:
 |  |  |
|---|
The Scanbot Web Barcode Scanner SDK also supports still images, enabling you to scan barcodes and QR Codes from JPG and other image files. It supports single-image and multi-image detection and returns a list of the recognized barcodes.
The Web Barcode Scanner library supports all common 1D or 2D barcodes and multiple postal symbologies, including:
| Barcode type | Barcode symbologies |
|---|---|
| 1D Barcodes | EAN, UPC, Code 128, GS1-128, Code 39, Codabar, ITF, Code 25, Code 32, Code 93, Code 11, MSI Plessey, Standard 2 of 5, IATA 2 of 5, Databar (RSS), GS1 Composite |
| 2D Barcodes | QR Code, Micro QR Code, Aztec Code, PDF417 Code, Data Matrix Code, GiroCode, NTIN Code, PPN, UDI, Royal Mail Mailmark, MaxiCode |
| Postal Symbologies | USPS Intelligent Mail Barcode (IMb), Royal Mail RM4SCC Barcode, Australia Post 4-State Customer Code, Japan Post 4-State Customer Code, KIX |
💡 Please visit our docs for a complete overview of the supported barcode symbologies.
The Scanbot Web Barcode Scanner SDK supports a variety of data parsers that extract structured information from 2D barcodes such as QR Codes and Data Matrix. These include parsers for documents such as driving licences (AAMVA), boarding passes, medical certificates, SEPA forms, Swiss QR codes, and vCard business cards.
The Scanbot Web Document Scanner SDK offers the following 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.
Automatic capture: The SDK automatically captures the document when the device is optimally positioned over the document. This reduces the risk of blurry or incomplete document scans compared to manually triggered capture.
Automatic cropping: Our document scanning SDK automatically straightens and crops scanned documents, ensuring high-quality document scan results.
Document Quality Analyzer: This feature automatically rates the quality of the scanned pages from “very poor” to “excellent.” If the quality is below a specified threshold, the SDK prompts the user to rescan.
Export formats: The SDK supports various image formats for exporting and processing documents (JPG, PDF, TIFF, and PNG). This ensures your downstream solutions receive the best format to store, print, or share the digitized document, or to process it further.
 |  |  |
|---|
The Scanbot SDK Data Capture Modules allow you to extract data from a wide range of documents, including MRZ codes on identity documents, Checks, U.S. and German driver’s licenses, EHICs, German ID cards, and German residence permit cards, and to integrate OCR text recognition capabilities.
The Scanbot SDK will run for one minute per session without a license. After that, all functionalities and UI components will stop working. To try Scanbot Web SDK without the one-minute limit, you can request a free, no-strings-attached 7-day trial license.
Our pricing model is simple: Unlimited scanning for a flat annual license fee, full support included. There are no tiers, usage charges, or extra fees. Contact our team to receive your quote.
Need help integrating or testing our Web SDK in your 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.
Do you want to enable your app to scan barcodes or documents? Integrating the Web SDK into your web app takes just a few minutes.
💡 Check out our developer blog for a collection of in-depth tutorials, use cases, and best practices.
FAQs
Scanbot Web Document and Barcode Scanner SDK
The npm package scanbot-web-sdk receives a total of 2,813 weekly downloads. As such, scanbot-web-sdk popularity was classified as popular.
We found that scanbot-web-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious Ruby gems typosquat Fastlane plugins to steal Telegram bot tokens, messages, and files, exploiting demand after Vietnam’s Telegram ban.
Research
Security News
Socket uncovered four malicious npm packages that exfiltrate up to 85% of a victim’s Ethereum or BSC wallet using obfuscated JavaScript.
Security News
TC39 advances 9 JavaScript proposals, including Array.fromAsync, Error.isError, and Explicit Resource Management, which are now headed into the ECMAScript spec.