--- description: Unofficial Capacitor plugin for Google ML Kit Document Scanner SDK to scan documents. With support for Android and iOS. title: ML Kit Document Scanner Plugin for Capacitor - Capawesome image: https://capawesome.io/docs/assets/images/social/plugins/mlkit/document-scanner.png --- [ Skip to content](#capacitor-mlkitdocument-scanner) [ 🎉 Introducing **Capawesome Platform** — one platform for Live Updates, Native Builds, App Store Publishing, and Insider SDKs.](https://capawesome.io) * [ Formbricks ](/docs/plugins/formbricks/) * [ Geocoder ](/docs/plugins/geocoder/) * [ Google Sign-In ](/docs/plugins/google-sign-in/) * [ libSQL ](/docs/plugins/libsql/) * [ Live Update ](/docs/plugins/live-update/) * [ Managed Configurations ](/docs/plugins/managed-configurations/) * [ Media Session ](/docs/plugins/media-session/) * [ ML Kit ](/docs/plugins/mlkit/) * [ Usage ](#usage) * [ API ](#api) * [ Enums ](#enums) * [ Notes ](#notes) * [ Terms & Privacy ](#terms-privacy) * [ Changelog ](#changelog) * [ License ](#license) * [ Face Detection ](/docs/plugins/mlkit/face-detection/) * [ Face Mesh Detection ](/docs/plugins/mlkit/face-mesh-detection/) * [ Selfie Segmentation ](/docs/plugins/mlkit/selfie-segmentation/) * [ Subject Segmentation ](/docs/plugins/mlkit/subject-segmentation/) * [ Translation ](/docs/plugins/mlkit/translation/) * [ NFC ](/docs/plugins/nfc/) * [ OAuth ](/docs/plugins/oauth/) * [ Pedometer ](/docs/plugins/pedometer/) * [ Photo Editor ](/docs/plugins/photo-editor/) * [ PostHog ](/docs/plugins/posthog/) * [ Printer ](/docs/plugins/printer/) * [ Purchases ](/docs/plugins/purchases/) * [ RealtimeKit ](/docs/plugins/realtimekit/) * [ Screen Orientation ](/docs/plugins/screen-orientation/) * [ Screenshot ](/docs/plugins/screenshot/) * [ Secure Preferences ](/docs/plugins/secure-preferences/) * [ Speech Recognition ](/docs/plugins/speech-recognition/) * [ Speech Synthesis ](/docs/plugins/speech-synthesis/) * [ Share Target ](/docs/plugins/share-target/) * [ Square Mobile Payments ](/docs/plugins/square-mobile-payments/) * [ SQLite ](/docs/plugins/sqlite/) * [ Superwall ](/docs/plugins/superwall/) * [ Torch ](/docs/plugins/torch/) * [ Wifi ](/docs/plugins/wifi/) * [ Zip ](/docs/plugins/zip/) * [ Cloud ](/docs/cloud/) * [ Live Updates ](/docs/cloud/live-updates/) * Advanced * Integrations * [ Native Builds ](/docs/cloud/native-builds/) * [ Configuration ](/docs/cloud/native-builds/configuration/) * [ Environments ](/docs/cloud/native-builds/environments/) * Guides * [ Sample Projects ](/docs/cloud/native-builds/sample-projects/) * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ Automations ](/docs/cloud/automations/) * Account * Organizations * [ Organization and User Management ](/docs/cloud/organizations/memberships/) * [ Single Sign-On (SSO) ](/docs/cloud/organizations/sso/) * [ Teams ](/docs/cloud/organizations/teams/) * [ Two-Factor Authentication ](/docs/cloud/organizations/two-factor-authentication/) * [ Integrations ](/docs/cloud/integrations/) * [ License Keys ](/docs/cloud/license-keys/) * [ Webhooks ](/docs/cloud/webhooks/) * [ Pricing ](https://capawesome.io/pricing/) * [ FAQ ](/docs/cloud/faq/) * [ Support ](/docs/cloud/support/) * [ Contributing ](/docs/contributing/) * [ LLMs ](/docs/llms/) * [ Insiders ](/docs/insiders/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/insiders/support/) * [ FAQ ](/docs/insiders/faq/) * [ Blog ](/blog/) * Categories * [ Usage ](#usage) * [ API ](#api) * [ Enums ](#enums) * [ Notes ](#notes) * [ Terms & Privacy ](#terms-privacy) * [ Changelog ](#changelog) * [ License ](#license) # @capacitor-mlkit/document-scanner[¶](#capacitor-mlkitdocument-scanner "Permanent link") Unofficial Capacitor plugin for [ML Kit Document Scanner](https://developers.google.com/ml-kit/vision/doc-scanner).[1](#fn:1) [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Newsletter[¶](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Compatibility[¶](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 8.x.x | \>=8.x.x | Active support | ## Installation[¶](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1)Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-mlkit/document-scanner` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below: `[](#%5F%5Fcodelineno-2-1)npm install @capacitor-mlkit/document-scanner [](#%5F%5Fcodelineno-2-2)npx cap sync ` ### Android[¶](#android "Permanent link") #### Variables[¶](#variables "Permanent link") If needed, you can define the following project variable in your app’s `variables.gradle` file to change the default version of the dependency: * `$mlkitDocumentScannerVersion` version of `com.google.android.gms:play-services-mlkit-document-scanner` (default: `16.0.0`) This can be useful if you encounter dependency conflicts with other plugins in your project. ## Usage[¶](#usage "Permanent link") `[](#%5F%5Fcodelineno-3-1)import { DocumentScanner } from '@capacitor-mlkit/document-scanner'; [](#%5F%5Fcodelineno-3-2) [](#%5F%5Fcodelineno-3-3)const scanDocument = async () => { [](#%5F%5Fcodelineno-3-4) const result = await DocumentScanner.scanDocument({ [](#%5F%5Fcodelineno-3-5) galleryImportAllowed: true, [](#%5F%5Fcodelineno-3-6) pageLimit: 5, [](#%5F%5Fcodelineno-3-7) resultFormats: 'JPEG_PDF', [](#%5F%5Fcodelineno-3-8) scannerMode: 'FULL', [](#%5F%5Fcodelineno-3-9) }); [](#%5F%5Fcodelineno-3-10) [](#%5F%5Fcodelineno-3-11) console.log('Scanned images:', result.scannedImages); [](#%5F%5Fcodelineno-3-12) console.log('PDF info:', result.pdf); [](#%5F%5Fcodelineno-3-13)}; [](#%5F%5Fcodelineno-3-14) [](#%5F%5Fcodelineno-3-15)const isGoogleDocumentScannerModuleAvailable = async () => { [](#%5F%5Fcodelineno-3-16) const result = await DocumentScanner.isGoogleDocumentScannerModuleAvailable(); [](#%5F%5Fcodelineno-3-17) console.log('Is Google Document Scanner module available:', result.available); [](#%5F%5Fcodelineno-3-18)}; [](#%5F%5Fcodelineno-3-19) [](#%5F%5Fcodelineno-3-20)const installGoogleDocumentScannerModule = async () => { [](#%5F%5Fcodelineno-3-21) await DocumentScanner.installGoogleDocumentScannerModule(); [](#%5F%5Fcodelineno-3-22) console.log('Google Document Scanner module installation started.'); [](#%5F%5Fcodelineno-3-23)}; [](#%5F%5Fcodelineno-3-24) [](#%5F%5Fcodelineno-3-25)DocumentScanner.addListener('googleDocumentScannerModuleInstallProgress', (event) => { [](#%5F%5Fcodelineno-3-26) console.log('Installation progress:', event.progress, '%'); [](#%5F%5Fcodelineno-3-27) console.log('Current state:', event.state); [](#%5F%5Fcodelineno-3-28)}); ` ## API[¶](#api "Permanent link") * [scanDocument(...)](#scandocument) * [isGoogleDocumentScannerModuleAvailable()](#isgoogledocumentscannermoduleavailable) * [installGoogleDocumentScannerModule()](#installgoogledocumentscannermodule) * [addListener('googleDocumentScannerModuleInstallProgress', ...)](#addlistenergoogledocumentscannermoduleinstallprogress-) * [removeAllListeners()](#removealllisteners) * [Interfaces](#interfaces) * [Enums](#enums) ### scanDocument(...)[¶](#scandocument "Permanent link") `[](#%5F%5Fcodelineno-4-1)scanDocument(options: ScanOptions) => Promise ` Starts the document scanning process. Only available on Android. | Param | Type | | ----------- | --------------------------- | | **options** | [ScanOptions](#scanoptions) | **Returns:** `Promise<[ScanResult](#scanresult)>` **Since:** 7.3.0 --- ### isGoogleDocumentScannerModuleAvailable()[¶](#isgoogledocumentscannermoduleavailable "Permanent link") `[](#%5F%5Fcodelineno-5-1)isGoogleDocumentScannerModuleAvailable() => Promise ` Check if the Google Document Scanner module is available. If the Google Document Scanner module is not available, you can install it by using `installGoogleDocumentScannerModule()`. Only available on Android. **Returns:** `Promise<[IsGoogleDocumentScannerModuleAvailableResult](#isgoogledocumentscannermoduleavailableresult)>` **Since:** 7.3.0 --- ### installGoogleDocumentScannerModule()[¶](#installgoogledocumentscannermodule "Permanent link") `[](#%5F%5Fcodelineno-6-1)installGoogleDocumentScannerModule() => Promise ` Install the Google Document Scanner module. **Attention**: This only starts the installation. The `googleDocumentScannerModuleInstallProgress` event listener will notify you when the installation is complete. Only available on Android. **Since:** 7.3.0 --- ### addListener('googleDocumentScannerModuleInstallProgress', ...)[¶](#addlistenergoogledocumentscannermoduleinstallprogress "Permanent link") `[](#%5F%5Fcodelineno-7-1)addListener(eventName: 'googleDocumentScannerModuleInstallProgress', listenerFunc: (event: GoogleDocumentScannerModuleInstallProgressEvent) => void) => Promise ` Called when the Google Document Scanner module is installed. Only available on Android. | Param | Type | | ---------------- | -------------------------------------------------------------------------------------------------------------------- | | **eventName** | 'googleDocumentScannerModuleInstallProgress' | | **listenerFunc** | (event: [GoogleDocumentScannerModuleInstallProgressEvent](#googledocumentscannermoduleinstallprogressevent)) => void | **Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>` **Since:** 7.3.0 --- ### removeAllListeners()[¶](#removealllisteners "Permanent link") `[](#%5F%5Fcodelineno-8-1)removeAllListeners() => Promise ` Remove all listeners for this plugin. Only available on Android. **Since:** 7.3.0 --- ### Interfaces[¶](#interfaces "Permanent link") #### ScanResult[¶](#scanresult "Permanent link") Result of a document scan operation. | Prop | Type | Description | Since | | ----------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------- | ----- | | **scannedImages** | string\[\] | An array of URIs for the scanned image pages (JPEG). Present if 'JPEG' or 'JPEG\_PDF' was requested in resultFormats. | 7.3.0 | | **pdf** | [PdfInfo](#pdfinfo) | Information about the generated PDF. Present if 'PDF' or 'JPEG\_PDF' was requested in resultFormats. | 7.3.0 | #### PdfInfo[¶](#pdfinfo "Permanent link") | Prop | Type | Description | Since | | ------------- | ------ | ---------------------------------- | ----- | | **uri** | string | The URI of the generated PDF file. | 7.3.0 | | **pageCount** | number | The number of pages in the PDF. | 7.3.0 | #### ScanOptions[¶](#scanoptions "Permanent link") | Prop | Type | Description | Default | Since | | | ------------------------ | ---------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | ----- | | **galleryImportAllowed** | boolean | Whether to allow importing from the photo gallery. | false | 7.3.0 | | | **pageLimit** | number | The maximum number of pages that can be scanned. | 10 | 7.3.0 | | | **resultFormats** | 'JPEG' \| 'PDF' | 'JPEG\_PDF' | The desired result formats. Can be 'JPEG', 'PDF', or 'JPEG\_PDF'. | 'JPEG\_PDF' | 7.3.0 | | **scannerMode** | 'FULL' \| 'BASE' | 'BASE\_WITH\_FILTER' | The scanner mode. BASE: Basic editing capabilities (crop, rotate, reorder pages, etc.). BASE\_WITH\_FILTER: Adds image filters (grayscale, auto image enhancement, etc.) to the BASE mode. FULL: Adds ML-enabled image cleaning capabilities (erase stains, fingers, etc.) to the BASE\_WITH\_FILTER mode. This mode will also allow future major features to be automatically added along with Google Play services updates, while the other two modes will maintain their current feature sets and only receive minor refinements. | "FULL" | 7.3.0 | #### IsGoogleDocumentScannerModuleAvailableResult[¶](#isgoogledocumentscannermoduleavailableresult "Permanent link") | Prop | Type | Description | Since | | ------------- | ------- | --------------------------------------------------------------- | ----- | | **available** | boolean | Whether or not the Google Document Scanner module is available. | 7.3.0 | #### PluginListenerHandle[¶](#pluginlistenerhandle "Permanent link") | Prop | Type | | ---------- | ------------------- | | **remove** | () => Promise | #### GoogleDocumentScannerModuleInstallProgressEvent[¶](#googledocumentscannermoduleinstallprogressevent "Permanent link") | Prop | Type | Description | Since | | ------------ | ----------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----- | | **state** | [GoogleDocumentScannerModuleInstallState](#googledocumentscannermoduleinstallstate) | The current state of the installation. | 7.3.0 | | **progress** | number | The progress of the installation in percent between 0 and 100. | 7.3.0 | ### Enums[¶](#enums "Permanent link") #### GoogleDocumentScannerModuleInstallState[¶](#googledocumentscannermoduleinstallstate "Permanent link") | Members | Value | Since | | -------------------- | ----- | ----- | | **UNKNOWN** | 0 | 7.3.0 | | **PENDING** | 1 | 7.3.0 | | **DOWNLOADING** | 2 | 7.3.0 | | **CANCELED** | 3 | 7.3.0 | | **COMPLETED** | 4 | 7.3.0 | | **FAILED** | 5 | 7.3.0 | | **INSTALLING** | 6 | 7.3.0 | | **DOWNLOAD\_PAUSED** | 7 | 7.3.0 | ## Notes[¶](#notes "Permanent link") * The ML Kit Document Scanner models, scanning logic, and UI flow are dynamically downloaded by Google Play services. Users might have to wait for these to download before the first use. You can use the isGoogleDocumentScannerModuleAvailable and installGoogleDocumentScannerModule methods to check for and install the module, and listen to the googleDocumentScannerModuleInstallProgress event for progress updates. * This API requires Android API level 21 or above. * It also requires a minimal device total RAM of 1.7GB. If lower, it returns an `MlKitException` with error code `UNSUPPORTED` when calling the API (this plugin will reject the promise). * Consider that generating document files takes time and requires processing power, so only request the output formats (JPEG, or PDF, or both) you actually need via the `resultFormats` option. ## Terms & Privacy[¶](#terms-privacy "Permanent link") This plugin uses the [Google ML Kit](https://developers.google.com/ml-kit): * [Terms & Privacy](https://developers.google.com/ml-kit/terms) * [Android Data Disclosure](https://developers.google.com/ml-kit/android-data-disclosure) * [iOS Data Disclosure](https://developers.google.com/ml-kit/ios-data-disclosure) ## Changelog[¶](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/document-scanner/CHANGELOG.md). ## License[¶](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/document-scanner/LICENSE). --- 1. This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries. [↩](#fnref:1 "Jump back to footnote 1 in the text") September 9, 2025 Back to top