The biid Security Provider SDK is the easiest way to integrate authentication by the biid Security Provider in an app. The biid Security Provider SDK library contains a biid Security Provider Client. This client communicates with the biid Security Provider Service.

The developers guide describes how to integrate the biid Security Provider SDK library and use the biid Security Provider Client. For further details please check the javadoc.


Include the biid Security Provider SDK library as a dependency in your Android project:

repositories {


    maven {
        url ""


dependencies {


    compile ('com.biid:sdk-secprov-android:4.0.73'){transitive=true}



biid will provide you with a manifest file. Place this file in the assets directory of your Android project.


Get a reference to the biid Security Provider Client like this:

SecurityProviderClient client = Sdk.getClient();

The first call to the client must be

client.initialize(context, installationId);


Before a user can be registered, their phone number must be verified. Request a verification code with:


The verification code is send over an alternative channel. When received, verify the phoneNumber like this:

client.verifyPhoneNumber(phoneNumber, code);


To register a user in the Security Provider, pass in the user details:

client.register(username, passcode, phoneNumber);


The user can login to the Security Provider with a username and passcode

client.login(username, passcode);

or, if enabled, with their fingerprint

client.loginWithFingerprintAuthentication(context, callback, handler, cancellationSignal);

While logged in, use this access token to authenticate to the biid Identity Service:



Logout of the Security Provider as follows: