Skip to content

doo/scanbot-sdk-maui-example

Repository files navigation

Example app for the Scanbot Document Scanner SDK and Data Capture Modules for .NET MAUI

This example app shows how to integrate the Scanbot Document Scanner SDK and Scanbot Data Capture Modules for MAUI and .NET.

What is the Scanbot SDK?

The Scanbot SDK is a set of high-level APIs that lets you integrate document scanning as well as data extraction functionalities into your mobile apps and websites. It runs on all common mobile devices and operates entirely offline on the user's mobile device. No data is transmitted to our or third-party servers.

The SDK can be integrated into your app within minutes and comes with Ready-To-Use UI components. These allow you to customize the scanner to your needs and ensure full functionality.

💡 For more details about the Scanbot Document Scanner SDK and Data Capture Modules, please check out our documentation.

How to run this example app?

Requirements

Microsoft Visual Studio Developing native, cross-platform .NET Multi-platform App UI (.NET MAUI) apps requires Visual Studio 2022 17.3 or greater, or Visual Studio 2022 for Mac 17.4 or greater.

Build Instructions

Assuming you already have your development machine setup, the following commands will help you build and debug our projects:

.NET

iOS

To build the iOS example project for both net7.0-ios and net8.0-ios, forcing packages to be restored and everything to be compiled from scratch:

dotnet build NET/ReadyToUseUI.iOS --force --no-incremental -r ios-arm64

To run the project on a real device, specify a target framework with -f net8.0-ios and the Run target via -t:Run, yielding the following:

dotnet build NET/ReadyToUseUI.iOS -r ios-arm64 -f net8.0-ios -t:Run --force --no-incremental

The Classic Component has its own project. Run it with:

dotnet build NET/ClassicComponent.iOS -r ios-arm64 -f net8.0-ios -t:Run --force --no-incremental

Android

To build the Android example project for both net7.0-android and net8.0-android, forcing packages to be restored and everything to be compiled from scratch:

dotnet build NET/ReadyToUseUI.Droid --force --no-incremental

To run the project on a real device, specify a target framework with -f net8.0-android and the Run target via -t:Run, yielding the following:

dotnet build NET/ReadyToUseUI.Droid -f net8.0-android -t:Run --force --no-incremental

The Classic Component has its own project. Run it with:

dotnet build NET/ClassicComponent.Droid -f net8.0-android -t:Run --force --no-incremental

MAUI

To build the MAUI example project for all supported target frameworks (net7.0-android, net7.0-ios, net8.0-android and net8.0-ios) and forcing packages to be restored and everything to be compiled from scratch, execute:

dotnet build MAUI/ReadyToUseUI.Maui --force --no-incremental

To run the project on a real iOS device, specify a target framework with -f net8.0-ios and the Run target via -t:Run, yielding the following:

dotnet build MAUI/ReadyToUseUI.Maui -f net8.0-ios -t:Run --force --no-incremental

To run the project on a real Android device, specify a target framework with -f net8.0-android and the Run target via -t:Run, yielding the following:

dotnet build MAUI/ReadyToUseUI.Maui -f net8.0-android -t:Run --force --no-incremental

Overview of the Scanbot SDK

Document Scanner SDK

The Scanbot .NET MAUI Document Scanning SDK offers the following 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 high-quality scans. The SDK provides a consistent user interface that ensures a smooth and intuitive experience for all users.

  • Automatic capture: The SDK automatically captures the scan when the device is optimally positioned over the document. This reduces the risk of blurry or incomplete scans from manual capture and ensures that the final images are suitable for further processing. 

  • Automatic cropping: Our document scanning SDK automatically straightens and crops scanned documents, ensuring high-quality document scan results.

  • Custom filters: Every use case has specific image requirements. With the SDK’s custom filters, you can turn the scanned images into optimal input for your backend systems. They include grayscale options, multiple binarizations, and other settings to optimize your document scanning for various document types.

  • 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 Scanbot .NET MAUI Document Scanner SDK supports various formats for exporting and image processing (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.

User guidance Automatic capture Automatic cropping

Data Capture Modules

The Scanbot SDK Data Capture Modules allow you to extract data from a wide range of structured documents and to integrate OCR text recognition capabilities. They include:

This module allows quick and accurate data extraction from the machine-readable zones on identity documents. It captures all important MRZ data from IDs and passports and returns it in the form of simple key-value pairs. This is much simpler, faster, and less mistake-prone than manual data entry.

The MICR Scanner offers reliable data extraction 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.

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.

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

Through this feature, our SDK offers document detection and data capture capabilities for a wider range of documents. It accurately identifies and crops 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 requiring additional OCR language files.

MRZ Scanner VIN Scanner Check Scanner

Additional information

Free integration support

Need help integrating or testing our .NET MAUI Document Scanner SDK? 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.

Trial license and pricing

The Scanbot SDK examples will run one minute per session without a license key. After that, all functionalities and UI components will stop working.

To try the Scanbot SDK for .NET MAUI without the one-minute limit, you can request a free, no-strings-attached 7-day trial license for your project.

Alternatively, check out our demo apps to test the SDK.

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 to receive your quote.

Other supported platforms

Besides .NET MAUI, the Scanbot SDK is also available on:

Our Barcode Scanner SDK additionally also supports Compose Multiplatform / KMP, UWP (Windows), and Linux.