Skip to main content
Version: 1.6.0 and above

Overview

The IDnow Android SDK provides native identity verification capabilities for Android applications.

Features​

  • Native Android Integration: Built specifically for Android with Kotlin
  • OCR: Identity document capture.
  • OTP: Phone number verification.
  • Liveness: Liveness check for a secure flow.
  • NFC: NFC chip scanning.
  • Accessibility: Full TalkBack and accessibility support

Requirements​

  • Min SDK Version:
    • without eID: Android 7 (API level 24) or higher
    • with eID: Android 9 (API level 28) or higher
  • Compile SDK Version: Android 16 (API level 36) or higher
  • Target SDK Version: Android 16 (API level 36) or higher
  • Not supported: devices and emulators based on the x86 architecture

UI Customization​

The SDK provides extensive customization options

User interface​

  • Themes: Light, dark, and custom themes
  • Colors: Brand color customization
  • Fonts: Custom font integration

Supported languages​

The SDK supports multiple languages (ISO 639-1). The list of supported languages is provided below:

  • Arabic
  • Bulgarian
  • Croatian
  • Czech
  • Danish
  • Dutch
  • English
  • Estonian
  • Finnish
  • French
  • German
  • Gujarati
  • Hungarian
  • Italian
  • Polish
  • Portuguese
  • Punjabi
  • Romanian
  • Russian
  • Serbian
  • Slovak
  • Spanish
  • Swedish
  • Turkish
  • Ukrainian

Performance Considerations​

  • Memory Usage: Optimized for minimal memory footprint
  • Battery Life: Efficient processing to preserve battery
  • Network Usage: Compressed data transmission
  • Processing Speed: Real-time document and face analysis

Security Features​

  • Data Encryption: End-to-end encryption for all data transmission
  • Local Storage: Secure storage of temporary verification data
  • Certificate Pinning: Protection against man-in-the-middle attacks
  • Biometric Security: Secure biometric template handling

Modules Overview​

The SDK is composed of the following modules:

  • Core — io.idnow.docidv:core — Required — Min SDK 24 — Base module, required by all other modules.

  • AI — io.idnow.docidv:ai — Required* — Min SDK 24 — Document capture, biometric liveness and identity verification. Corresponds to the existing SDK functionality.

  • eID Governikus — io.idnow.docidv:eid-governikus — Optional — Min SDK 28 — German eID chip reading via Governikus.

*In this version, Core + AI are both required as a minimum setup. In a future release, AI will become optional as well.

Note: The eID Governikus module raises the minimum SDK level to 28 (Android 9 Pie) due to a restriction from the Governikus SDK.

Dependency Graph​

┌──────────────────────────┐
│          Core            │  ← Required by all modules
└──────┬──────────┬────────┘
       │          │
       ▼          ▼
┌──────────┐  ┌───────────────────┐
│    AI    │  │  eID Governikus   │
│(required)│  │    (optional)     │
└──────────┘  │ depends on Core   │
              │      + AI         │
              └───────────────────┘

Core Module​

Artifact: io.idnow.docidv:core

The Core module is the foundation of the DOCIDV SDK. It provides the base infrastructure, public API interfaces and shared utilities used by all other modules. Every integration must include this module.

  • Minimum SDK: 24
  • Always required

AI Module​

Artifact: io.idnow.docidv:ai

The AI module provides the main identity verification capabilities including document capture, biometric liveness detection and the overall identification flow. This module corresponds to the existing SDK functionality.

  • Minimum SDK: 24
  • Required in this version (will become optional in a future release)

eID Governikus Module​

Artifact: io.idnow.docidv:eid-governikus

The eID Governikus module enables reading the chip of German electronic identity documents (eID) using the Governikus SDK. This module is entirely optional and can be added when German eID verification is needed.

  • Minimum SDK: 28 (due to a Governikus SDK restriction)
  • Optional
  • Currently depends on both Core and AI. In a future release, it will depend only on Core.

Sample​

Get started quickly by exploring our Android sample application.

Support​