Android SDK Overview¶

Biometrid Android SDK provides identity verification capabilities for native Android applications. Available in two variants to fit different integration needs.

SDK Variants¶

Core SDK¶

com.biometrid:core

Headless integration - Full API access without UI components

Complete API access with custom UI development
Smaller binary size
Maximum flexibility for custom integrations

UI SDK¶

com.biometrid:full

Complete solution - Pre-built UI components included

Ready-to-use Material Design interface
Quick integration
Accessibility compliant

Requirements¶

Requirement	Minimum
Android Studio	Ladybug or later
Minimum SDK	26 (Android 8)
Target SDK / Compile SDK	36
Kotlin	2.2.0
Gradle	8.13
Android Gradle Plugin	8.12.0
Java compatibility	11

Installation¶

Add Maven Repositories¶

In your settings.gradle.kts, add the following repositories:

dependencyResolutionManagement {
    repositories {
        maven { url = uri("https://dl.cloudsmith.io/public/biometrid/mobile/maven/") }
        maven { url = uri("https://dl.cloudsmith.io/public/biometrid/face01-liveness/maven/") }
        maven { url = uri("https://jitpack.io") }
        maven { url = uri("https://raw.githubusercontent.com/iProov/android/master/maven/") }
    }
}

Repository	Purpose
`biometrid/mobile`	Core and UI SDK packages
`biometrid/face01-liveness`	Liveness detection module
`jitpack.io`	Third-party dependencies
`Face06/android`	Face06 liveness library

Add the Dependency¶

Core SDK¶

Using Version Catalog (libs.versions.toml):

[versions]
biometridstandard = "3.2.1"

[libraries]
biometridstandard = { module = "com.biometrid:biometridstandard", version.ref = "biometridstandard" }

Then in your app/build.gradle.kts:

dependencies {
    implementation(libs.biometridstandard)
}

Without Version Catalog:

dependencies {
    implementation("com.biometrid:biometridstandard:3.2.1")
}

UI SDK¶

Using Version Catalog (libs.versions.toml):

[versions]
biometrid = "3.3.0"

[libraries]
biometrid-full = { group = "com.biometrid", name = "full", version.ref = "biometrid" }

Then in your app/build.gradle.kts:

dependencies {
    implementation(libs.biometrid.full)
}

Without Version Catalog:

dependencies {
    implementation("com.biometrid:full:3.3.0")
}

Configure Android Manifest Permissions¶

Add the following to your AndroidManifest.xml:

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />

<uses-feature
    android:name="android.hardware.camera"
    android:required="true" />

Permission / Feature	Required	Purpose
`INTERNET`	Yes	API communication
`CAMERA`	Yes	Document and face capture
`android.hardware.camera`	Yes	Declares camera hardware requirement

Register SDK Activities¶

Inside the <application> block of your AndroidManifest.xml, register the following activities:

<activity
    android:name="com.biometrid.sdk.camera.CameraActivity"
    android:exported="false"
    android:screenOrientation="portrait"
    android:theme="@style/Theme.AppCompat.Light.NoActionBar" />

<activity
    android:name="com.biometrid.sdk.camera.SimpleCameraActivity"
    android:exported="false"
    android:screenOrientation="portrait"
    android:theme="@style/Theme.AppCompat.Light.NoActionBar" />

Configure Build Options¶

In your app/build.gradle.kts, set Java and Kotlin compatibility:

android {
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_11
        targetCompatibility = JavaVersion.VERSION_11
    }
    kotlinOptions {
        jvmTarget = "11"
    }
}

Add the following flags to your gradle.properties:

android.useAndroidX=true
android.enableJetifier=true

Features¶

Native Android experience: Material Design and Compose support
Secure: End-to-end encryption and Android Keystore integration
Accessibility: TalkBack and large text support
Multi-language support: English, Portuguese, Spanish

Documentation¶

Core SDK - API reference and custom integration
UI SDK - Components and customization