DOCSEARCHbyAlgolia
Submit Docs

Scanbot SDK Documentation

website·Indexed 36 days ago

https://docs.scanbot.io/

Developer documentation for the Scanbot SDK, part of the Apryse SDK product family. It provides tools for document scanning, barcode scanning, and data capture across multiple platforms including Web, iOS, Windows, React Native, Capacitor, and Xamarin (deprecated). Key features include the Document Quality Analyzer, Document Enhancer, VIN scanner, credit card scanner, and ready-to-use UI components.

Tokens
560.6K
Snippets
1.7K
Records
5.4K
Agent score
63%

What's inside Scanbot SDK

  1. Overview of Scanbot Ready-to-Use UI (RTU UI) Barcode Scanner

    The Ready-to-Use UI (RTU UI) components allow developers to integrate barcode scanning into React Native applications with minimal code. It provides a pre-built UX that is customizable to match brand identity. If the RTU UI does not meet specific requirements, developers can implement their own logic using the SDK's Custom UI Components.

  2. Overview of Scanbot Barcode Scanner Ready-to-Use (RTU) UI

    The Ready-to-Use UI (RTU UI) allows developers to integrate barcode scanning into Android apps with minimal code using pre-designed UX components. It supports three primary scanning modes:

    • Single Scanning: Optimized for detecting one barcode at a time; includes an optional confirmation screen.
    • Batch & Multi Scanning: Allows scanning multiple barcodes in succession without closing the screen, capturing multiple barcodes simultaneously from the camera view, or counting scanned items.
    • Find & Pick: Highlights and scans specific pre-defined barcode values automatically from the camera feed.

    Customization options include a palette feature for brand-consistent coloring, adaptable on-screen user guidance (text, position, color), configurable top bar styles (transparent or filled), and a built-in action bar containing zoom, camera switch, and flashlight controls.

  3. Overview of the iOS VIN Scanner

    The iOS VIN Scanner is designed to detect, read, and extract Vehicle Identification Numbers (VINs) from both printed text (via OCR) and barcodes. It operates within a user-defined rectangular area of interest across consecutive video frames. The scanner includes a customizable closure to filter raw strings against OCR noise and unwanted characters, ensuring accurate data extraction even in challenging conditions like poor lighting or tilted surfaces.

  4. Overview of Scanbot Barcode Scanner Ready-to-Use (RTU) UI

    The Ready-to-Use UI (RTU UI) components allow developers to integrate barcode scanning into an app with minimal code. It provides a pre-built UX that is customizable to match brand identity. For developers requiring total control over business logic and UI, the SDK also offers Custom UI Components.

  5. Overview of Scanbot SDK Data Capture Modules

    The Scanbot SDK for Flutter provides several specialized modules for extracting structured data from documents and OCR text recognition:

    • Text Pattern Scanner: Extracts single-line data based on customizable patterns.
    • MRZ Scanner: Extracts data from machine-readable zones on identity documents (IDs and passports) as key-value pairs.
    • Document Data Extractor: Detects and crops standardized documents (German ID cards, passports, driver's licenses, residence permits, and EHIC) and recognizes data fields using the Scanbot OCR Engine.
    • VIN Scanner: Converts vehicle identification numbers (VINs) from images into structured data.
    • Credit Card Scanner: Extracts card number, cardholder name, and expiry date from Visa, Mastercard, and American Express cards.
    • Check Scanner (MICR): Extracts check numbers, routing numbers, and account numbers from international paper checks using MICR codes.

    Developers can implement these using Ready-to-Use UI Components (RTU UI) for fast integration with standard UX, or Custom UI Components for full control over the scanner's appearance.

  6. Overview of the VIN Scanner Ready-to-Use UI

    The Ready-to-Use UI (RTU UI) for Vehicle Identification Number (VIN) scanning provides a pre-built interface to detect, read, and extract data from VINs (both text and barcodes). It is optimized for accuracy in challenging conditions like low light or tilted surfaces. While designed for quick integration, it offers extensive customization for branding and workflow. For developers requiring total control over business logic and UI, Custom UI Components are available as an alternative.

  7. Overview of iOS Document Scanner SDK features

    The iOS Document Scanner SDK allows developers to integrate high-quality document scanning into iOS apps. Key features include:

    • User Guidance: On-screen instructions to help users capture perfect scans.
    • Automatic Capture: Automatically triggers the shutter when the device is optimally positioned to prevent blur.
    • Automatic Cropping: Automatically straightens and crops scanned documents.
    • Image Filters: Custom filters including grayscale and multiple binarization options to optimize output for backend systems.
    • Document Quality Analyzer: Rates scan quality from "very poor" to "excellent" and can prompt users to rescan if quality falls below a threshold.
    • Multiple Export Formats: Supports JPG, PDF, and TIFF.

    Developers can choose between Ready-to-Use UI Components (RTU UI) for fast integration with minimal code, or Custom UI Components for full control over the scanner's appearance.

  8. Overview of the Document Data Extractor Ready-to-Use UI

    The Ready-to-Use UI (RTU UI) for the Document Data Extractor provides a pre-built interface for detecting, reading, and extracting structured data from documents. It is designed for fast integration and high performance in challenging conditions (e.g., poor lighting or tilted documents). While highly customizable, developers requiring total control over business logic and UI can use the Custom UI Components instead.

  9. Overview of Scanbot Document Data Extractor for Android

    The Document Data Extractor is a Scanbot SDK feature used to detect, read, and extract structured data (such as names, dates, and identification numbers) from documents. It is designed to handle challenging conditions like poor lighting, tilted documents, or complex backgrounds. The tool allows for field exclusion for privacy/security and provides type-specific document wrappers for the extracted data.

    Supported document types include:

    • German ID card (front and back)
    • German passport
    • German driver's license (front and back)
    • German residence permit (front and back)
    • German health insurance card (front side)
    • European health insurance card

  10. Overview of Web Document Scanner SDK features

    The Web Document Scanner SDK allows developers to integrate document scanning capabilities into web applications for smartphones and tablets. Key features include:

    • User Guidance: On-screen instructions to help users capture high-quality scans.
    • Automatic Capture: Automatically triggers the scan when the device is optimally positioned to prevent blur.
    • Automatic Cropping: Automatically straightens and crops the scanned document.
    • Image Filters: Custom filters including grayscale and binarization to optimize output for backend systems.
    • Document Quality Analyzer: Rates scan quality from 'very poor' to 'excellent' and can prompt users to rescan if a threshold is not met.
    • Multiple Export Formats: Supports JPG, PDF, and TIFF.

  11. Overview of the Capacitor MRZ Scanner

    The Machine Readable Zone (MRZ) Scanner for Capacitor is designed to detect, read, and extract standardized alphanumeric data from travel documents, including passports, visas, and ID cards. It uses advanced recognition algorithms to ensure accurate data extraction from document numbers, expiration dates, and personal details, even in challenging conditions like poor lighting or tilted documents. The extracted data is provided in a structured format for application processing and verification.

  12. Overview of Ready-to-Use (RTU) UI Components for Document Scanner SDK

    The Ready-to-Use (RTU) UI Components for the Document Scanner SDK provide a pre-built, customizable scanning interface. This interface simplifies integration by including built-in document management and quality assurance features, such as:

    • Reviewing scanned documents
    • Rotating, cropping, and reordering pages
    • Retaking specific pages or deleting pages
    • Animation feedback and document acknowledgment to verify scan quality before proceeding.