Skip to main content

Installing the Android Data Capture SDK

Specifying the Maven repository​

The Scanbot SDK for Android is distributed through our private Maven repository server (nexus.scanbot.io), which needs to be specified in the settings.gradle.kts file in the root folder of your project:

// settings.gradle.kts in the root of the project:
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()

        // Add Scanbot SDK maven repositories here:
        maven(url = "https://nexus.scanbot.io/nexus/content/repositories/releases/")
        maven(url = "https://nexus.scanbot.io/nexus/content/repositories/snapshots/")
    }
}

Afterward, the dependencies can be added in the dependencies section of your Android application project configuration, usually in the app/build.gradle.kts file.

Adding the main SDK dependency​

To use the Data Capture Modules in your app, you need to add one of the following SDK packages as a dependency. Each package contains different modules, so which one you need depends on which modules you purchased a license for.

Each package also contains the lower-numbered packages. For example, package 3 also contains packages 2 and below.

For OCR features, including the Text Pattern Scanner, MRZ Scanner, and VIN Scanner, add:

implementation("io.scanbot:sdk-package-2:$scanbotSdkVersion")

For the Document Data Extractor and Credit Card Scanner, add:

implementation("io.scanbot:sdk-package-3:$scanbotSdkVersion")

For the Medical Certificate Scanner and Check Scanner, add:

implementation("io.scanbot:sdk-package-4:$scanbotSdkVersion")

For the latest $scanbotSdkVersion, please refer to the SDK's changelog.

Adding the RTU UI dependency​

The SDK's Ready-to-Use UI Components are distributed as a separate package. Therefore, if you plan to use them, also add the following dependency to your project:

implementation("io.scanbot:rtu-ui-v2-bundle:$scanbotSdkVersion")

Want to scan longer than one minute?

Generate a free trial license to test the Scanbot SDK thoroughly.

Get free trial license

On this page