Ionic Document Scanner SDK
Add advanced document scanning functionality to your Ionic app
Trusted by 300+ industry leaders
Simple scanning for all users
Empower users of all technical levels to capture high-quality document scans with automatic capture, 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 Ionic 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
Turn mobile devices into a document scanner with Ionic
The Scanbot Ionic Document Scanner SDK transforms any mobile device into a robust document scanner while ensuring data privacy by operating completely offline. This guarantees compliance with global privacy regulations, such as GDPR and CCPA.
Whether users capture documents using the device’s camera or upload images from their library, the SDK ensures high-quality scans with its advanced image processing features. Additionally, the SDK includes ready-to-use UI components, allowing you to integrate document scanning into your Ionic app in just a few minutes. These components are customizable, enabling you to match the look and feel of your app seamlessly.
For developers, our support team is available via Slack, Microsoft Teams, or email to assist with integration, ensuring a smooth setup process.
Features
Explore our document scanning features
The Scanbot Ionic Document Scanner SDK offers a comprehensive set of features that make document scanning efficient and user-friendly:
-
User Guidance
Built-in on-screen guidance helps users capture perfectly aligned scans, ensuring high-quality output every time.
-
Automatic Capture
-
Automatic Cropping
-
Document Quality Analyzer
-
Custom Filters
-
Multiple Export Formats
How to integrate the Scanbot Ionic Document Scanner SDK using Ready-To-Use 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 an Ionic Document Scanner SDK?
An Ionic Document Scanner SDK allows developers to integrate document scanning functionality into their Ionic apps. It provides tools for capturing, processing, and exporting documents, with features such as automatic cropping, edge detection, and quality analysis.
How can I ensure high-quality document scans in my Ionic app?
To guarantee high-quality scans, use an SDK with features like automatic cropping, edge detection, and image quality analysis. The Scanbot Ionic Document Scanner SDK offers all of these features, ensuring that your app consistently delivers clear and perfectly aligned scans.
How do I integrate document scanning into my Ionic app?
The Scanbot Ionic Document Scanner SDK comes with Ready-To-Use UI components, allowing you to add document scanning functionality in just a few minutes. Detailed documentation and support through Slack, Microsoft Teams, or email are available to assist with any integration challenges.
Is there a free Ionic document scanner SDK?
Some free solutions exist for basic document scanning in Ionic apps, but they often lack advanced features like automatic capture, user guidance, and custom UI components. The Scanbot SDK provides a commercial-grade solution with powerful features for a superior scanning experience.
Does the Scanbot Ionic Document Scanner SDK comply with GDPR and CCPA regulations?
Yes, the Scanbot Ionic Document Scanner SDK operates completely offline, ensuring that no data is transmitted to external servers. This makes it fully compliant with privacy regulations like GDPR and CCPA.
Does the Scanbot Document Scanner SDK support platforms other than Ionic?
Yes, the Scanbot SDK supports iOS, Android, and web-based applications. Additionally, it can be integrated into other frameworks like Flutter, React Native, Xamarin, and more for consistent functionality across all platforms.