Tap2iD SDK for Android - Integration

Get the Tap2iD SDK into your Android project in three steps: add the repository, declare the dependency, and initialize with your license key.

Tap2iD-SDK-Android on GitHub

Prerequisites

Your development environment must meet these requirements:

  • AS Android Studio Panda 4 or latest
  • JDK Version: 17.0.7
  • 🔧 Gradle Wrapper: gradle-8.14.3-bin.zip
  • 📱 Minimum OS Version: Android 10 (API level 29)
01

Add the Credence ID Maven repository

Add the Credence ID Nexus repository to your project's settings.gradle. The SDK packages resolve from this repository during the build.

Place this in your project-level settings.gradle (or settings.gradle.kts), inside dependencyResolutionManagement.
settings.gradle.kts
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        // ...

        maven {
            url = uri("https://nexus.credenceid.com/repository/credenceid-sdk-group/")
        }
    }
}
02

Add the Tap2iD SDK Dependency

Include the SDK dependency in the build.gradle.kts file of your app module.

app/build.gradle.kts
dependencies {
    implementation("com.credenceid:tap2idSdk:2.0.0")
}

Verify SDK in External Dependencies

After syncing, verify this package appears in your app's External Dependencies:

📦
com.credenceid:tap2idSdk:2.0.0 primary
03

Initialize the SDK with your license key

Generate your license key on the Tap2iD SDK License Key page, then pass it when you initialize the SDK. Do not hard-code the key. Store it in local.properties or secure storage.

Kotlin: SdkConfig
val config = SdkConfig(
    context   = applicationContext,
    apiKey    = BuildConfig.TAP2ID_API_KEY,   // read from local.properties
    transport = TransportType.BLE
)
Tap2iDSdk.initSdk(config, object : InitSdkResultListener {
    override fun onSuccess() { /* ready */ }
    override fun onError(error: String) { /* handle */ }
})
⚠️ Store your license key in local.properties or a secrets manager. Do not commit it to source control.
You're all set
Sync the project. The Tap2iD Android SDK APIs are now available in your application.

Next steps