shield-fraud-plugin

Cordova Shield Fraud Plugin

Cordova Plugin for Shield Fraud (www.shield.com)

Cordova Shield Fraud Plugin helps developers to assess malicious activities performed on mobile devices and return risk intelligence based on user's behaviour. It collects device's fingerprint, social metrics and network information.

There are four steps to getting started with the SHIELD SDK:

1. Integrate the SDK

2. Initialize the SDK

3. Get Session ID

4. Get Device Results

5. Send Custom Attributes

Integrate the SDK

Run the following command in terminal at your project root directory.

ionic cordova plugin add shield-fraud-plugin

Note: We make continuous enhancements to our fraud library and detection capabilities which includes new functionalities, bug fixes and security updates. We recommend updating to the latest SDK version to protect against rapidly evolving fraud risks.

You can refer to the Changelog to see more details about our updates.

Initialize the SDK

The SDK initialization should be configured at the earliest of the App Lifecycle to ensure successful generation and processing of the device fingerprint. SDK is to be initialised only once and will throw an exception if it is initialised more than once.

You need both the SHIELD_SITE_ID and SHIELD_SECRET_KEY to initialize the SDK. You can locate them at the top of the page.

You can initialize the SDK by calling it inside onDeviceReady() function where Cordova is initialized.

var config = {siteID: "SHIELD_SITE_ID",secretKey: "SHIELD_SECRET_KEY"}
    
ShieldFraudPlugin.initShieldFraud(config);

Note: You can check whether Shield SDK is ready or not by using isShieldInitialized function

ShieldFraudPlugin.isShieldInitialized(callbackSuccess, callbackError);

function callbackSuccess(status) {
    console.log("Shield initilize Callback:", status);
}

function callbackError(status) {
    console.log("Shield initilize Callback:", status);
}

Get Session ID

Session ID is the unique identifier of a user’s app session and acts as a point of reference when retrieving the device result for that session.

Session ID follows the OS lifecycle management, in-line with industry best practice. This means that a user’s session is active for as long as the device maintains it, unless the user terminates the app or the device runs out of memory and has to kill the app.

If you would like to retrieve device results using the backend API, it is important that you store the Session ID on your system. You will need to call the SHIELD backend API using this Session ID.

ShieldFraudPlugin.getSessionID(errorSessionID, successSessionID);

function errorSessionID(message) {
    console.log("Shield SessionID Callback:", message);
}

function successSessionID(error) {
    console.log("Shield SessionID Callback:", error);
}

Get Device Results

SHIELD provides you actionable device intelligence which you can retrieve from the SDK, via the Optimized Listener or Customized Pull method. You can also retrieve results via the backend API.

Warning: Only 1 method of obtaining device results (Optimized Listener or Customized Pull) can be in effect at any point in time.

Retrieve device results via Optimized Listener

SHIELD recommends the Optimized Listener method to reduce number of API calls.

Our SDK will capture an initial device fingerprint upon SDK initialization and return an additional set of device intelligence ONLY if the device fingerprint changes along one session. This ensures a truly optimized end to end protection of your ecosystem.

You can register a callback if you would like to be notified in the event that the device attributes change during the session (for example, a user activates a malicious tool a moment after launching the page).

Add an additional parameter during intialization in order to register a callback.

For example - ShieldFraudPlugin.initShieldFraud(config, callbacks);

var config = {siteID: "SHIELD_SITE_ID", secretKey: "SHIELD_SECRET_KEY"}
   
ShieldFraudPlugin.initShieldFraud(config, onSuccess, onFailure);

function onSuccess(message) {
   // Handle success event here
   console.log("Shield Callback Success:", message);
}

function onFailure(error) {
   // Handle failure event here
   console.log("Shield Callback Error:", error);
}

Retrieve device results via Customized Pull

You can retrieve device results via Customized Pull at specific user checkpoints or activities, such as account registration, login, or checkout. This is to ensure that there is adequate time to generate a device fingerprint.

ShieldFraudPlugin.getDeviceResult(successDeviceResult, errorDeviceResult);

function successDeviceResult(message) {
    // Handle success with the result object
    console.log("DeviceResult Succcess Callback:", message);
}
    
function errorDeviceResult(error) {
    // Handle error with the error object
    console.log("DeviceResult Error Callback:", error);
}

It is possible that getLatestDeviceResult returns null if the device result retrieval is unsuccessful.

Send Custom Attributes

Use the sendAttributes function to sent event-based attributes such as user_id or activity_id for enhanced analytics. This function accepts two parameters:screenName where the function is triggered, and data to provide any custom fields in key, value pairs.

var data = {"key1": "value1", "key2": "value2"}

ShieldFraudPlugin.sendAttributes("Screen_Name", data);