Skip to main content

Android SDK

Getting Started​

Latest Version: SDK Version (Changelog)​

Requirements​

Device Requirement​



Project Requirement​

AndroidX Support

Shufti Pro SDK requires AndroidX 1.0.0 or later. If you haven't switched to AndroidX in your app yet then follow thisguide

Enable Java 8

Shufti Pro SDK requires Java 8 language features to be enabled in your project. If it is not already enabled, add this to your app/build.gradle file under the android section

compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
}

Resources​

Android Image

Integration​


SDK Integration Guide​

Tip

It’s always recommended to use the updated version



Step 1

Go to root-level setting.gradle in your project and add the following:

setting.gradle
dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' } // Add this line 
    }
}
OR
Go toproject > android > build.gradle file and add the following
build.gradle
allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' } // add this line
    }
}

Step 2

In build.gradle(Module) enable dataBinding true.

app/build.gradle
android {
    //Rest of your code
    dataBinding {
        enabled = true
    }
}

Step 3

In build.gradle(Module) add the following implementation

app/build.gradle
implementation 'com.github.shuftipro:android-onsite-sdk:+'
You can find latest version fromhere

Basic Usage​

The following objects are necessary to initialise the SDK:

Note

Make sure you have obtained authorization credentials before proceeding. You can get client id or secret key and generate access token like this.


1. Authorization​

The following code snippet shows how to use the access token in auth object.

JSONObject AuthKeys = new JSONObject();

try{
    AuthKeys.put("auth_type","access_token");
    AuthKeys.put("access_token","sp-accessToken");
} catch (JSONException e) {
    e.printStackTrace();
}

2. Configuration​

The Shufti Pro’s mobile SDKs can be configured on the basis of parameters provided in the config object. The details of parameters can be found here

JSONObject Config=new JSONObject();

try{
    Config.put("base_url",  "api.shuftipro.com");
    Config.put("consent_age",  16);
} catch (JSONException e) {
    e.printStackTrace();
}

3. Request Object​

This object contains the service objects and their settings through which the merchant wants to verify end users. Complete details of service objects and their parameters can be found here

JSONObject requestObject = new JSONObject();

try{ 
    requestObject.put("reference", "Unique-Reference");
    requestObject.put("country", "");
    requestObject.put("language", "");
    requestObject.put("email", "");
    requestObject.put("callback_url", "");
    requestObject.put("verification_mode", "image_only");
    requestObject.put("show_results", "1");
    requestObject.put("allow_retry", "0");
    requestObject.put("show_ocr_form", "0");
    requestObject.put("allow_warnings", "1");

    //Creating Face object
    JSONObject faceObject = new JSONObject();
    faceObject.put("proof", "");
    
    requestObject.put("face", faceObject);

    //Creating Document object
    JSONObject documentObject = new JSONObject();
    
    ArrayList<String> doc_supported_types = new ArrayList<String>();
    doc_supported_types.add("passport");
    doc_supported_types.add("id_card");
    doc_supported_types.add("driving_license");
    doc_supported_types.add("credit_or_debit_card");

    documentObject.put("proof", "");
    documentObject.put("additional_proof", "");

    JSONObject docNameObject = new JSONObject();
    docNameObject.put("first_name", "Johon");
    docNameObject.put("middle_name", "Johsan");
    docNameObject.put("last_name", "Livone");
        
    documentObject.put("name", docNameObject); 
    documentObject.put("dob", "1980-11-12"); 
    documentObject.put("document_number", "19901112");
    documentObject.put("expiry_date", "1996-11-12");
    documentObject.put("issue_date", "1990-11-12");
    documentObject.put("backside_proof_required", "1");
    documentObject.put("supported_types",new JSONArray(doc_supported_types));
        
    requestObject.put("document", documentObject);
     

    //Creating Document Two Object is exactly same as document object. 
    // Add document two to request object like
    ...
    requestObject.put("document_two", documentTwoObject);

    //Creating Address object
    JSONObject addressObject = new JSONObject();
    
    ArrayList<String> address_supported_types = new ArrayList<String>();
    address_supported_types.add("id_card");
    address_supported_types.add("passport");
    address_supported_types.add("bank_statement");

    JSONObject addressNameObject = new JSONObject();
    addressNameObject.put("first_name", "Johon");
    addressNameObject.put("middle_name", "Johsan");
    addressNameObject.put("last_name", "Livone");

    addressObject.put("name", addressNameObject);
    addressObject.put("proof", "");
    addressObject.put("full_address", "ST#2, 937-B, los angles.");
    addressObject.put("supported_types",new JSONArray(address_supported_types));
        
    requestObject.put("address", addressObject);

    //Creating consent object
    JSONObject consentObject = new JSONObject();

    ArrayList<String> consent_supported_types = new ArrayList<String>();
    consent_supported_types.add("handwritten");
    consent_supported_types.add("printed");

    consentObject.put("proof", "");
    consentObject.put("text", "This is my consent. ");
    consentObject.put("supported_types",new JSONArray(consent_supported_types));
        
    requestObject.put("consent", consentObject);

} catch (JSONException e) {
    e.printStackTrace();
}

Initialisation​

Shufti Pro’s mobile SDK can be initialised by using the given method and passing auth, config and request object as the parameters.

Shuftipro shuftipro = Shuftipro.getInstance();
shuftipro.shuftiproVerification(requestObject, AuthKeys, Config, MainActivity.this,
            new ShuftiVerifyListener() {
        @Override
        public void verificationStatus(@NonNull Map<String, ?> responseSet) {

            Log.e("Response",responseSet.toString());
            
        }
    });

Callbacks​

The SDK receive callbacks on termination, whether after the request completion or if the journey is left mid-way.The call backs are received in

 new ShuftiVerifyListener() {
        @Override
       public void verificationStatus(@NonNull Map<String, ?> responseSet) {
        {
            Log.e("Response",responseSet.toString());
            // Handle callback responses here
        }
  }

The complete list of callback events can be foundhere

Callback Handling​

All the callbacks can be handled inside the client’s calling activity. The responses and callback handling can be seen below.


On SDK Completion​

if(responseSet.get("event").equals("verification.accepted")){
    // Verification accepted callback
}
else if(responseSet.get("event").equals("verification.declined")){
    // Verification declined callback
}

On SDK Unauthentication​

if(responseSet.get("event").equals("request.unauthorized")){
    // Verification unauthorized callback. This event occurs when the auth header or its parameters are invalid.
}

On SDK Error​

if(responseSet.get("event").equals("permission.denied")){
    // This callback is returned in case the permissions are declined by the end user.
}
else if(responseSet.get("event").equals("request.timeout")){
    // This callback is returned in case request took too long and is timed out
}
else if(responseSet.get("event").equals("verification.cancelled")){
    // This callback is returned when verification is cancelled midway by the end user
}
else if(responseSet.get("event").equals("request.invalid")){
    // This callback is returned if the request parameters are incorrect.
}
else {
    // Some error has been occured during the verification process
}

Obfuscation​

The ShuftiPro Android SDK already includes the required ProGuard rules, so there's no need to add them separately.
Make sure you have disabled R8 full mode in the gradle.properties file in release mode.

android.enableR8.fullMode=false

Customisation​

ShuftiPro supports a set of customisation options that will influence the appearance of the mobile SDK.

UI Customisation​

To customize the color scheme of the entire ShuftiPro mobile SDK, including the text and background colors of widgets, update the theme settings in the Backoffice theme customization section and use the keys below for detailed modifications.

You can customize the SDK theme to match your application, choosing from Light (default), Dark, or a fully customized theme.



Light Theme

Dark Theme

Custom Theme

JSONObject Config=new JSONObject();

try{
      Config.put("icon_color", "#XXXXXX");
      Config.put("theme_background_color", "#XXXXXX");
      Config.put("theme_color", "#XXXXXX");
      Config.put("card_background_color", "#XXXXXX");
      Config.put("theme_light_color", "#XXXXXX");
      Config.put("loader_color", "#XXXXXX");
      Config.put("loader_text_color", "#XXXXXX");
      Config.put("background_color", "#XXXXXX");
      Config.put("stroke_color", "#XXXXXX");
      Config.put("dark_mode_enabled", true);

      
} catch (JSONException e) {
    e.printStackTrace();
}

Localization​

Shufti Pro offers users the capability to customise the SDK text according to their preferred language. Merchants can modify the SDK language by specifying the language code in the country parameter within the main request object, such as
"language": "en". List of all languages are mention here

NFC verification​

Near Field Communication (NFC) is a set of short-range wireless technologies. NFC allows sharing small payloads of data between an NFC tag and an NFC-supported device. NFC Chips found in modern passports and similar identity documents contain additional encrypted information about the owner. This information is very useful in verifying the originality of a document. NFC technology helps make the verification process simple, quicker and more secure. This also provides the user with contactless and input less verification. ShuftiPro's NFC verification feature detects MRZ from the document to authenticate NFC chips and retrieve data from it, so the authenticity and originality of the provided document could be verified.

Initialisation​

Once the main SDK is integrated successfully, NFC SDK can be integrated easily by adding an additional dependency in app level
build.gradle
app/build.gradle
dependencies {
    implementation 'com.github.shuftipro:nfc-onsite:1.0.5'
}

To check NFC supported documents and countries, please clickhere

info

Nfc verification is allowed only on e-passports under document, document_two and address service only.

All-In-One SDK​

A dynamic and efficient tool designed to transform user verification into a streamlined and effortless process. This powerful SDK enables the integration of multiple verification journeys using just a single line of code, catering to various user events and scenarios Our SDK automatically listens for the Journey you associate with a customer and initiates the verification process immediately.

Client Side​

Step 1

Initialize the ShuftiPro SDK

To initialize the SDK, create a new instance of ShuftiPro and call the init method with initial data

val shuftiPro = Shuftipro.getInstance()
shuftiPro.register(clientId,customerID,configObject(),applicationContext,object : ShuftiVerifyListener {
  override fun verificationStatus(responseSet: Map<String, Any>)    {
            Log.d("RequestResponse", responseSet.toString())
        }
})

The details of parameters can be found [here](/docs/mobile/parameters/all-in-one-parameters).

Step 2

Destroying the SDK Instance

To clean up and destroy the SDK instance, call the destroy method.

shuftiPro.unRegister()

Server Side​

Trigger verification Journey​

This API triggers verification for a given customer (customer_id) with the provided verification journey (journey_id).

API Endpoint: https://api.shuftipro.com/create/customer/journey

Send the following payload to initiate the creation of a customer journey.

{
    "journey_id"  : "ULMTCqye1719840116",
    "customer_id" : "TestingCustomer595"
    "reference"   : "123456789"
}

The details of parameters can be foundhere

You will receive the following response from the API call.

{
    "error": false,
    "message": "customer journey created successfully"
}

The details of parameters can be foundhere