Install the SDK on Capacitor

In this guide, you will learn how to get started with the Genius Scan SDK for Capacitor.

Package information

• npm package: @thegrizzlylabs/capacitor-plugin-genius-scan
• Supported platforms: iOS 15.0+, Android 23+
• Capacitor: 8+

Setup

Installation

Install the plugin from your Capacitor application:

npm install @thegrizzlylabs/capacitor-plugin-genius-scan@6.0.0-beta11
npx cap sync

Android configuration

Android builds require Java 21. The plugin adds the Genius Scan Maven repository and configures its Android library with minSdkVersion 23.

iOS configuration

Add the required camera permission to your app’s Info.plist:

<key>NSCameraUsageDescription</key>
<string>We use the camera to scan documents</string>

TypeScript projects

If TypeScript reports that SDK 6 scan configuration fields such as skipPostProcessingScreen or requiredReadabilityLevel do not exist on ScanConfiguration with 6.0.0-beta11, add a local declaration file until you upgrade to a package version with updated declarations:

import '@thegrizzlylabs/capacitor-plugin-genius-scan';

declare module '@thegrizzlylabs/capacitor-plugin-genius-scan' {
  export interface ScanConfiguration {
    skipPostProcessingScreen?: boolean;
    requiredReadabilityLevel?: 'lowest' | 'low' | 'medium' | 'high' | 'highest';
  }
}

The Capacitor package declares structuredData as unknown, so TypeScript apps should narrow it to the expected receipt, barcode, or custom shape before reading extracted fields.

What’s Next?

Next, configure a license key. To compare with a working integration, see the sample apps.