Capacitor Document Scanner SDK
Add advanced document scanning to your Capacitor-based cross-platform app
Trusted by 250+ industry leaders
Simple to use for everyone
Allow users of all skill levels to create clear and high-quality document scans with features like automatic capture, auto-cropping, and user guidance.
100% offline
No servers, no tracking, complete data security.
Customizable UI components
Our Ready-To-Use UI components cover all document scanning scenarios and are highly customizable.
Technical requirements
The Scanbot Capacitor Document Scanner SDK has the following technical requirements:
- Capacitor CLI: 6+
- Platforms: Android 5.0+ (API Level 22+) and iOS 13.0+
- Hardware: A rear-facing camera with autofocus
- Architectures
- Android: armeabi-v7, arm64-v8a, x86, x86_64
- iOS: arm64, x86_64
Convert mobile devices into high-quality document scanners
The Scanbot Document Scanner SDK for Capacitor provides everything you need to integrate document scanning into your hybrid app. Operating completely offline, it ensures secure data handling in compliance with GDPR and CCPA/CPRA regulations.
The SDK supports live camera scans as well as the processing of imported images, ensuring consistent high-quality results from both. It includes Ready-To-Use UI (RTU UI) components that can be integrated in less than an hour and customized to suit your app’s branding and specific workflow requirements.
We offer dedicated support through Slack, Microsoft Teams, or email, assisting both customers and non-customers during the integration process.
Features
Learn more about our document scanning features
The SDK offers a comprehensive set of features designed to simplify the scanning experience for your users and improve output quality.
-
User Guidance
Intuitive on-screen guidance helps users of all skill levels capture the perfect scan.
-
Automatic Capture
-
Automatic Cropping
-
Document Quality Analyzer
-
Custom Filters
-
Multiple Export Formats
How to integrate the Scanbot Capacitor Document Scanner SDK using Ready-To-Use UI
Document Scanner UI
ScanbotSDK.startDocumentScanner(configuration: DocumentScannerConfiguration)
The Scanbot SDK provides a Ready-To-Use UI screen component for document scanning. Use the ready-to-use Document Scanner for guided, automatic document scanning.
Document Scanner usage example
// Always make sure you have a valid license on runtime via ScanbotSDK.getLicenseInfo()
if (!(await this.isLicenseValid())) {
return;
}
const configuration: DocumentScannerConfiguration = {
// Customize colors, text resources, behavior, etc..
polygonColor: '#00ffff',
bottomBarBackgroundColor: Colors.scanbotRed,
topBarBackgroundColor: Colors.scanbotRed,
cameraBackgroundColor: Colors.scanbotRed,
orientationLockMode: 'PORTRAIT',
pageCounterButtonTitle: '%d Page(s)',
multiPageEnabled: false,
ignoreBadAspectRatio: true,
// see further configs ...
};
try {
const documentResult = await ScanbotSDK.startDocumentScanner(configuration);
if (documentResult.status === 'OK' && documentResult.pages.length > 0) {
// Handle the scanned pages from result
await this.preferencesUtils.savePages(documentResult.pages);
this.router.navigate(['/page-results']);
}
} catch (e: any) {
this.utils.showErrorAlert(e.message);
}Frequently Asked Questions
What is a Capacitor Document Scanner SDK?
A Capacitor Document Scanner SDK is a software development kit that enables developers to add document-scanning functionality to their Capacitor-based hybrid apps. It provides tools for capturing, processing, and exporting document scans, along with advanced features like automatic cropping and real-time edge detection.
How can I ensure high-quality document scans in my Capacitor app?
For high-quality document scans in your Capacitor app, use an SDK with features such as automatic cropping, edge detection, and document quality analysis. The Scanbot Capacitor Document Scanner SDK includes a Document Quality Analyzer that rates scans and prompts users to rescan if necessary, ensuring optimal quality.
How do I integrate document scanning functionality into my Capacitor app?
Integrating document scanning into your Capacitor app is simple with the Scanbot SDK's Ready-To-Use UI (RTU UI). The SDK includes comprehensive documentation, and our dedicated support team is available through Slack, Microsoft Teams, or email to help you complete the integration in less than an hour.
Is there a free Capacitor document scanner SDK?
There are free options, such as those built using libraries like OpenCV, but they generally lack advanced features and a user-friendly UI. The Scanbot SDK provides more comprehensive functionality with built-in user guidance, quality checks, and ready-to-use UI components that simplify integration and enhance user experience.
Which Capacitor Document Scanner SDKs comply with GDPR and other privacy regulations?
Privacy compliance is crucial for any app. The Scanbot Capacitor Document Scanner SDK operates entirely offline, which means sensitive data stays on the device, helping you comply with GDPR, CCPA, and CPRA regulations.
What platforms does the Scanbot Document Scanner SDK support besides Capacitor?
In addition to Capacitor, the Scanbot Document Scanner SDK also supports Android, iOS, and web apps. It’s compatible with other cross-platform frameworks like Flutter, Xamarin, .NET MAUI, Cordova, and React Native, ensuring consistent scanning functionality across platforms.