This guide is a work in progress. If you have any questions, please reach
out.
The Android SDK
It is available in maven central (so.prelude.android:android-sdk
) and the code accessible in GitHub at https://github.com/prelude-so/android-sdk .
Usage
The Android SDK allows you to capture certain device signals that will be reported back to Prelude to help fight fraud. It will also allow you to perform silent verification of mobile devices. It is provided as a regular Maven artifact that you can use as a normal dependency in your Android application, just add it as an implementation dependency:Capturing Signals
To capture device signals you just need to configure it with your SDK key and call a single dispatch function: Kotlin:dispatchSignals
function will capture the device signals and report them to Prelude. It will return a dispatchId
string that you should report back to your back-end to enhance the phone number verification process.
As context it is recommended to pass the application context but you can pass any Android context and the library will resolve the correct one.
There is no restriction on when to call this API but it is recommended to perform it early in the onboarding process. The recommended way of integrating it is to call the dispatchSignals
function before displaying the phone number verification screen in your application. This way you can ensure that the device signals are captured and the dispatchId
can be sent to your back-end with the phone number. Your back-end will then perform the verification call to Prelude with the phone number and the dispatch identifier.
This way you can continue the onboarding only when you are sure the signal dispatching is successful.
Silent Verification
The Silent Verification feature allows you to verify a phone number without requiring the user to manually enter a verification code. It is available for certain carriers and requires a server-side service to handle the verification process. For this verification method to work properly, you must collect the device signals mentioned before and report the dispatch identifier to your back-end (usually in your APIs verification endpoint). Please refer to the Silent Verification documentation for more information on how to implement this feature.Proguard
If you use minification in your application (i.e.isMinifyEnabled = true
somewhere in your build.gradle
file), please add the following lines to your Proguard configuration file to avoid runtime issues: