Skip to main content

AI Android SDK Upgrade

This guide walks you through upgrading your Android app from the AutoIdent (AI) SDK to the DocIDV SDK. The upgrade is straightforward — the main changes are the Maven repository, the dependency coordinates, and the package names used in your imports.

What has changed​

Package names​

The AI SDK used the de.idnow.core package. In the DocIDV SDK, all classes are under io.idnow.docidv.android.sdk. You will need to update your imports in any class that references the SDK.

Maven repository​

The DocIDV SDK is published to a new public GitHub Maven repository. You will need to add it to your project and remove the old AI SDK repository if it is no longer needed.

Upgrade steps​

1. Add the DocIDV SDK repository​

Add the IDnow Maven repository to your project. Depending on your setup, do this in one of the following files:

allprojects {
    repositories {
        // ...
        maven {
            url "https://raw.githubusercontent.com/idnow/idnow-android-sdk/main"
        }
        // ...
    }
}

2. Replace the SDK dependency​

Remove the AI SDK dependency and add the DocIDV SDK in your app/build.gradle:

// Import the BOM
implementation(platform(libs.idnow.docidv.bom))

// No need to specify versions — managed by the BOM
implementation(libs.idnow.docidv.core)
implementation(libs.idnow.docidv.ai)

// Optional - German eID (raises minSdk to 28)
implementation(libs.idnow.docidv.eid.governikus)

3. Sync the project​

Sync your Gradle project to resolve and download the new dependency.

4. Update your imports​

In any class where you use the IDnow SDK, remove all imports from de.idnow.core and re-import the equivalent classes from io.idnow.docidv.android.sdk.

Before (AI SDK)

import de.idnow.core.IDnowSDK
import de.idnow.core.IDnowConfig
// ...

After (DocIDV SDK)

import io.idnow.docidv.android.sdk.IDnowDocIDV
import io.idnow.docidv.android.sdk.IDnowDocIDVConfig
// ...

5. Build and run​

Build the project and verify everything works as expected.

tip

For full SDK configuration options and API reference, see the Android SDK documentation.