Install the SDK on Flutter

This guide will teach you how to get started with the Genius Scan SDK for Flutter.

Package Information

• pub.dev package: flutter_genius_scan
• Supported platforms: iOS 15.0+, Android 23+
• Flutter: 3.22.0+
• Dart: 3.4.0 or later, below 4.0.0

Android builds additionally require Flutter 3.44 or later with the legacy Kotlin Gradle plugin, or Flutter 3.47 or later with built-in Kotlin. See Android Configuration.

Setup

Installation

Add flutter_genius_scan to your pubspec.yaml:

dependencies:
  flutter_genius_scan: 6.6.0

Then run:

flutter pub get

Android Configuration

Use Android Gradle Plugin 9.1.0 or later with a compatible Gradle wrapper. AGP 9.1 requires Gradle 9.3.1 or later. The released demo uses AGP 9.4.1 with Gradle 9.7.1. Flutter projects normally set the AGP version in android/settings.gradle or android/settings.gradle.kts and the Gradle version in android/gradle/wrapper/gradle-wrapper.properties.

For the released demo configuration, use this Gradle wrapper:

distributionUrl=https\://services.gradle.org/distributions/gradle-9.7.1-bin.zip

Add the legacy DSL compatibility flag to android/gradle.properties:

android.newDsl=false

If your existing app applies kotlin-android or org.jetbrains.kotlin.android, use Flutter 3.44 or later and also add this flag until the app and its plugins have migrated:

android.builtInKotlin=false

Follow Flutter’s AGP 9 built-in Kotlin migration guide. Flutter 3.47 or later is required before enabling built-in Kotlin.

Set compileSdkVersion to 37 or later and minSdkVersion to 23 or later. For a Groovy android/app/build.gradle file, use:

android {
    compileSdkVersion 37

    defaultConfig {
        minSdkVersion 23
    }
}

For a Kotlin android/app/build.gradle.kts file, use:

android {
    compileSdk = 37

    defaultConfig {
        minSdk = 23
    }
}

iOS Configuration

1. Add the required camera permission to your ios/Runner/Info.plist:

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

1. Set the Runner deployment target to at least 15.0 in Xcode. Open ios/Runner.xcworkspace, select the Runner target, and update Build Settings > iOS Deployment Target. If your Flutter template or another plugin already requires a higher value, keep the higher value.

2. Update your ios/Podfile to set the platform version:

platform :ios, '15.0'

1. Run pod install from the ios folder:

cd ios && pod install

What’s Next?

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