@capgo/capacitor-document-scanner

Native document scanning with edge detection on iOS and Android.

Overview

@capgo/capacitor-document-scanner opens the system document camera (VisionKit on iOS, ML Kit on Android), detects page edges, corrects perspective, and returns cleaned images. Ship receipt capture, ID scanning, or contract onboarding without building a custom camera UI.

Platform support

Platform	Support
iOS	Yes, VisionKit document camera
Android	Yes, ML Kit document scanner
Web	No, `scanDocument()` is unimplemented on web

Core Capabilities

scanDocument - Opens the device camera and starts the document scanning experience.

Public API

Method	Description
`scanDocument`	Opens the device camera and starts the document scanning experience.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-document-scanner.

Keep going from @capgo/capacitor-document-scanner

If you are using @capgo/capacitor-document-scanner to plan native plugin work, connect it with Using @capgo/capacitor-document-scanner for the native capability in Using @capgo/capacitor-document-scanner, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins, and Ionic Enterprise Plugin Alternatives for the product workflow in Ionic Enterprise Plugin Alternatives.