Android SDK
Introduction
The HyperVerge Android SDK is a native Android library that enables comprehensive customer onboarding and verification workflows within your android applications. Built specifically for Android using Kotlin, the SDK provides flexible capabilities including identity verification, fraud detection, document processing, face authentication, and compliance checks.
Key Features
- Provides easy implementation with just a few lines of code
- Offers native Android development using Kotlin with full AndroidX support
- Supports document capture, selfie verification, face matching, liveness detection, and operations
- Enables core functionalities like Camera and Geo Location without internet connectivity
- Features modular architecture to exclude unused components and reduce app size
- Allows configurable UI text for multiple languages
- Enables seamless verification continuation across different devices
Implementation Overview
- Add the SDK to your Android project as a standard dependency
- Guide users through verification steps using native Android UI components
- Receive structured results containing status information and extracted data
- Process verification results to determine subsequent steps in user workflows
Prerequisites
Development Requirements:
- Minimum Android Version: Android 5.0 (API level 21) or higher
- Development Environment: Android Studio with Gradle support
- AndroidX Migration: Your project must be fully migrated to AndroidX
- Minimum Kotlin Version: 1.8.0
Required Permissions:
The Android SDK requires specific permissions to function properly, including:
- camera access for document and face capture,
- microphone permissions for video-based workflows, and
- optional location permissions for geo-tagging features.
The SDK automatically declares these permissions in its manifest, but you have the flexibility to remove unused permissions. For a comprehensive list of all required permissions, optional permissions, and detailed instructions on how to remove specific permissions from your app's manifest, see our SDK Permissions Guide.
Play Store Compliance:
- All apps must target Android 15 and comply with permission policies
- 16KB page size compliance (supported from SDK version 2.x.x)
HyperVerge Account Setup:
- Active HyperVerge account with dashboard access
- Set up and configure a specific workflow in your HyperVerge One account dashboard
- Obtain valid appId and appKey credentials from the HyperVerge One dashboard
- Ensure you provide the correct WorkflowID to integrate any workflow provided by HyperVerge
Related Documentation
| Page | Description |
|---|---|
| Quick Start Guide | Get started quickly with the Android SDK using this step-by-step quick start guide |
| Integration Guide | Detailed step-by-step guide for integrating the Android SDK into your web application with code examples |
| SDK Dependencies | Learn about required dependencies, optional dependencies, and how to manage SDK dependencies in your Android project |
| FAQs | Frequently asked questions about permissions, Android 15 compatibility, security warnings, and troubleshooting |
| Changelogs | Track version updates, new features, bug fixes, and breaking changes in the Android SDK |
| SDK Permissions Guide | Learn about required permissions, optional permissions, and how to remove unused permissions from your Android app manifest |