# DeviceConnect: Cordova

Device Connect Cordova SDK is used to collect anonymised non-PII data from the devices of the users after taking explicit user consent.

# Requirements

Device Connect Cordova SDK works on Android 5.0+ (API level 21+), on Java 8+ and AndroidX. In addition to the changes, enable desugaring so that our SDK can run smoothly on Android 7.0 and versions below.

  • Kotlin
  • Groovy
android {
    defaultConfig {
        // Minimum 5.0+ devices
    compileOptions {
        // Flag to enable support for the new language APIs
        coreLibraryDesugaringEnabled = true
        // Sets Java compatibility to Java 8
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    // For Kotlin projects
    kotlinOptions {
        jvmTarget = "1.8"

dependencies {

# Add Plugin

Specify the following in local.properties file:


Add the plugin from the npm package:

cordova plugin add cordova-plugin-finbox-risk-manager


Following will be shared by FinBox team at the time of integration:


# Create User

Call createUser method to create the user. It takes Client Api Key and Customer Id as the arguments.


Please make sure CUSTOMER_ID is not more than 64 characters and is alphanumeric (with no special characters). Also it should never be null or a blank string "".

cordova.plugins.FinBoxRiskManager.createUser("CLIENT_API_KEY", "CUSTOMER_ID", function (response) {
    // User is created successfully
}, function (error) {
    // User is failed to created
    // Log the error

You can read about the errors in the Error Codes section.

# Start Periodic Sync

This is to be called only on a successful response to createUser method's callback. On calling this the syncs will start for all the data sources configured as per permissions. The method below syncs data in the background at regular intervals:


# Forward Notifications to SDK

In certain cases, FinBox server requests critical data from SDK directly (other than scheduled sync period), to make sure this works it is required to forward FCM Notifications to SDK.

Add the following lines inside cordova.plugins.firebase.messaging.onMessage and cordova.plugins.firebase.messaging.onBackgroundMessage method.


# Match Details on Device

Device matching enables additional pattern recognition to match email, phone numbers and name. The matching happens on the device and the user phone numbers, email addresses won't leave the device.

Call setDeviceMatch method before starting the syncs.

cordova.plugins.FinBoxRiskManager.setDeviceMatch("useremail@gmail.com", "Full Name", "9999999999");

# Multi-Process Support

DeviceConnect uses a content provider to auto initialize the SDK. The limitation with the OS is that content providers are only initialized once in a multi-process application and from the main process. For this reason, any calls to the SDK from other processes will lead to unstable behavior.

In case, you want to use the Cordova SDK from a process other than the main process, follow the two steps mentioned below to initialize the SDK.

# Remove the Content Provider

Remove the content provider that auto initializes the SDK from the Android Manifest file using config.xml file. Add the changes inside <platform name="android"> tag.

<config-file parent="/manifest/application" target="AndroidManifest.xml">
    <provider android:authorities="in.finbox.lenderapplication.riskmanagerprovider" android:enabled="true" android:exported="false" android:name="in.finbox.mobileriskmanager.init.AutoInitProvider" tools:node="remove" />

Update the widget tag to include

<widget ... xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools"

# Initialize the SDK

Initialize the FinBox Cordova SDK as soon as the onDeviceReady method is called.


# Cancel Periodic Syncing

If you have already set up the sync for the user data, you can cancel it any time by the following code:


# Handle Sync Frequency

By default sync frequency is set to 8 hours, you can modify it by passing preferred time in seconds as an argument to setSyncFrequency method once the user is created.

cordova.plugins.FinBoxRiskManager.setSyncFrequency(12 * 60 * 60);

# Reset User Data

In case the user data needs to be removed on the device so that you can re-sync the entire data, use the method resetData.


# Forget User

In case the user choose to be forgotten, use the method forgetUser. This will delete the user details in our system.

Last Updated: 6/4/2024, 12:54:58 PM