Smile ID provides the best solutions for Real Time Digital KYC, Identity Verification, User Onboarding, and User Authentication across Africa.
If you haven’t already, sign up for a free Smile ID account, which comes with Sandbox access.
Please see CHANGELOG.md or Releases for the most recent version and release notes
Full documentation is available at https://docs.usesmileid.com/integration-options/mobile
Javadocs are available at https://javadoc.io/doc/com.smileidentity/android-sdk/latest/index.html
The sample app included in this repo is a good reference implementation
- Android 5.0 (API level 21) and above
- Google Play Services
The SDK is available on Maven Central. To use it, add the following to your build.gradle:
implementation("com.smileidentity:android-sdk:<latest-version>")Please download your smile_config.json file from the
Smile ID Portal and add it to your assets directory (e.g.
app/src/main/assets). You may need to create the directory if it does not already exist.
The SDK should be initialized within your Application class' onCreate:
SmileID.initialize(this) All UI functionality is exposed via either Jetpack Compose or Fragments
All Composables are available under the SmileID object.
e.g.
SmileID.SmartSelfieEnrollment()
SmileID.SmartSelfieAuthentication()
SmileID.DocumentVerification()
SmileID.BiometricKYC()All Fragments are available under the com.smileidentity.fragment package.
(e.g. SmartSelfieEnrollmentFragment)
To customize the theme, you can pass in a custom ColorScheme to the SmileID composable, OR
override the color resources defined in the SDK
To make raw API requests, you can use SmileID.api (requires coroutines)
For detailed documentation, please visit https://docs.usesmileid.com/integration-options/mobile
If you require further assistance, you can file a support ticket or contact us
Bug reports and Pull Requests are welcomed. Please see CONTRIBUTING.md