TRANSUNION TRUVALIDATE DEVICE RISK ANDROID SDK LIBRARY

What is TruValidate Device Risk?

FraudForce is now Device Risk. Our device-based products, such as Device Risk and Device-Based Authentication (formerly ClearKey), are critical components of our fraud and identity solutions; the new names make it easy to quickly understand our extensive capabilities. We have united these solutions under the TransUnion TruValidate brand. We have taken care not to update anything that might affect your implementations; as a result you'll still see legacy names in some places.

Overview

Follow these steps to implement the TruValidate Device Risk SDK for Android.

About Mobile Integration

TransUnion identifies devices through information collected by the Device Risk SDK run on an end-user’s mobile device. The Device Risk SDK inspects the device to generate a blackbox that contains all device information available. This blackbox must then be transmitted to your servers to be used in a risk check.

The Device Risk SDK integrates with native and hybrid apps. Hybrid apps mix native code with content that runs inside a web view.

Android Integration Files and Requirements


SDK Filename	fraudforce-lib-release-5.2.2.aar
Version	5.2.2
Package	com.iovation.mobile.android.FraudForce
Android SDK Dependencies	Android SDK 5.0 or higher (SDK level 21)
Library Dependencies	None
Required Permissions	None
Optional Permissions	BLUETOOTH (up to Android 11), BLUETOOTH_CONNECT (starting on Android 12), CAMERA, ACCESS_WIFI_STATE,
	READ_PHONE_STATE, ACCESS_FINE_LOCATION, ACCESS_BACKGROUND_LOCATION,
	GET_ACCOUNTS, ACCESS_NETWORK_STATE
Supported NDK Architectures	x86, x86_64, arm64-v8a, armeabi-v7a

NOTE Android 12 introduced the BLUETOOTH_CONNECT permission, protected at the dangerous level. Refer to the official Android documentation on how to include it.

NOTE Regarding Android 11 background location changes: The Device Risk SDK neither requires nor requests location when the application is in a background state.

NOTE If the permissions listed are not required by the application, the values collected using those permissions will be ignored. The permissions are not required to obtain a usable blackbox, but they do help obtain some unique device information.

NOTE Android 10 introduced the ACCESS_BACKGROUND_LOCATION permission, protected at the dangerous level as is the case for ACCESS_FINE_LOCATION. Refer to the official Android documentation for when to incorporate this permission.

Version 5.2.2 of the TruValidate Device Risk SDK for Android supports Android 5.0 or higher.

Installing the Device Risk SDK for Android

Download iovation-android-sdk-5.2.2.zip from here: iovation Mobile SDK for Android.
Unzip iovation-android-sdk-5.2.2.zip.
Depending on your IDE, do one of the following:
- In Maven, deploy the AAR file to your local Maven repository, using maven-deploy. For more information, see Guide to installing 3rd party JARs.
- If you are using Gradle, add the fraudforce-lib-release-5.2.2.aar file to your application module's libs directory. Then, edit the build.gradle file in order to add the libs directory as a flat-file repository to the buildscript and repository sections. This makes the fraudforce-lib-release-5.2.2.aar file accessible to Gradle.
```
buildscript {
    repositories {
        flatDir {
            dirs 'libs'
        }
    }
}

repositories {
    flatDir {
        dirs 'libs'
    }
}
```
  Also in the application module's build.gradle file, make sure that fraudforce-lib-release-5.2.2 is included as a dependency:
```
dependencies {
    ...
    implementation(name:'fraudforce-lib-release-5.2.2', ext:'aar')
}
```
  Alternatively, you can include the dependency without exposing your libs folder as a repository by declaring it in the module's build.gradle file as follows:
```
dependencies {
    ...
    implementation files('libs/fraudforce-lib-release-5.2.2.aar')
}
```
  Save the build.gradle file.

If you are not already using Java 8 in your project, please include the following code into your application's 'build.gradle' file.

android {
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

Integrating into Native Apps

NOTE If you are using an older version of the Android Gradle Plugin and encounter UnsatisfiedLinkErrors in the course of your testing, you may need to add the following to your ProGuard configuration: -keep public class com.iovation.mobile.android.details.RP { public native java.lang.String a(); public native java.lang.String b(); }

To integrate into native apps:

In your Application class, import the FraudForceManager and FraudForceConfiguration objects.

Java

import com.iovation.mobile.android.FraudForceConfiguration;
import com.iovation.mobile.android.FraudForceManager;

Kotlin

import com.iovation.mobile.android.FraudForceConfiguration
import com.iovation.mobile.android.FraudForceManager

Create a configuration object with your subscriber key, and enable or disable network calls to TransUnion servers. Entering the subscriber key is strongly recommended for all integrations, and it is required for network connections.

NOTE Please review the Network Calls section of this document before enabling network calls.

IMPORTANT Please contact your TransUnion customer success team representative to receive your subscriber key.

Java
```
FraudForceConfiguration configuration = new FraudForceConfiguration.Builder()
    .subscriberKey([YOUR-SUBSCRIBER-KEY-HERE])
    .enableNetworkCalls(true) // Defaults to false if left out of configuration
    .build();
```
Kotlin
```
val configuration = FraudForceConfiguration.Builder()
        .subscriberKey([YOUR-SUBSCRIBER-KEY-HERE])
        .enableNetworkCalls(true)
        .build()
```

Initialize the FraudForceManager class using the generated FraudForceConfiguration object, and the application context.

Java

FraudForceManager fraudForceManager = FraudForceManager.INSTANCE;
fraudForceManager.initialize(configuration, context);

Kotlin

FraudForceManager.initialize(configuration, applicationContext)

Call the refresh() method in the same Activity/Fragment/ViewModel where getBlackbox() will be called. The integrating application only needs to call this method on the Fragments where the getBlackbox() method will be called.

NOTE: This method calls updates the geolocation and network information, if enabled.

NOTE: As with initialization, pass the application context when refreshing.

Java
```
FraudForceManager.INSTANCE.refresh(context);
```
Kotlin
```
FraudForceManager.refresh(applicationContext)
```
To generate the blackbox, call the getBlackbox(Context context) function on an instance of FraudForceManager. This method is a blocking call so it is recommended to call it on a background thread/coroutine.

Java
```
String blackbox = FraudForceManager.INSTANCE.getBlackbox(context);
```
Kotlin
```
val blackbox : String = FraudForceManager.getBlackbox(applicationContext)
```
To generate the blackbox using a coroutine, declare the desired scope and call the getBlackbox(Context context) function on an instance of FraudForceManager. You can use the withContext(context: CoroutineContext) suspend function to utilize the blackbox data in another scope.

Kotlin Coroutines Example
```
private val uiScope = CoroutineScope(Dispatchers.IO)

uiScope.launch {
    ...
    val blackbox : String = FraudForceManager.getBlackbox(applicationContext)
    withContext(Dispatchers.Main) {
        ...
        useBlackbox(blackbox)
    }
}
```

Integrating into Hybrid Apps

Hybrid App Workflow Overview

Integrate into hybrid apps by implementing the following workflow for collecting and sending blackboxes:

An HTML page loads in a WebView.
The user submits a transaction on the HTML page by submitting a form or completing another action.
This calls the inject_bb function, which creates a hidden iframe that calls the iov:// URL. The iframe then deletes itself.
The shouldOverrideUrlLoading function inside of the WebView object in Java is called. This function detects the iov://blackbox/fill#dom_id URL.The dom_id is the ID of the object on the HTML page where the blackbox will be written, such as a hidden form field.
The shouldOverrideUrlLoading function runs JavaScript that automatically injects the blackbox into that object.

Implementing Hybrid App Support

In your Application class, import the FraudForceManager and FraudForceConfiguration objects.

import com.iovation.mobile.android.FraudForceConfiguration;
import com.iovation.mobile.android.FraudForceManager;

Create a configuration object with your subscriber key, and enable or disable network calls to TransUnion servers. Entering the subscriber key is strongly recommended for all integrations, and it is required for network connections.

NOTE Please review the Network Calls section of this document before enabling network calls.
```
FraudForceConfiguration configuration = new FraudForceConfiguration.Builder()
    .subscriberKey([YOUR-SUBSCRIBER-KEY-HERE])
    .enableNetworkCalls(true) // Defaults to false if left out of configuration
    .build();
```

Initialize the FraudForceManager class using the generated FraudForceConfiguration object, and the application context.

FraudForceManager fraudForceManager = FraudForceManager.INSTANCE;
fraudForceManager.initialize(configuration, context);

In your WebView Activity's onCreate() function, set your WebView's shouldOverrideUrlLoading() function, as well as the onPageStarted() function.

wv.setWebViewClient(new WebViewClient() {
    @Override
    public void onPageStarted(WebView view, String url, Bitmap favicon) {
        FraudForceManager.INSTANCE.refresh(getContext());
        super.onPageStarted(view, url, favicon);
    }

    @Override
    public boolean shouldOverrideUrlLoading(WebView view, String url) {
        String[] ref = url.split("#");
        if (url.startsWith("iov://") && ref.length > 1 && ref[1] != null) {
        String injectedJavascript="javascript:(function() { " +
            "document.getElementById('" + ref[1] + "').value = '"
            + FraudForceManager.INSTANCE.getBlackbox(wv.getContext())
            + "';})()";
            wv.loadUrl(injectedJavascript);
            return true;
        }
        return false;
    }
});

On your HTML page, include a javascript function called inject_bb that injects an iframe with a call to the iov:// URL.

function inject_bb(id) {  
	var iframe = document.createElement('IFRAME');  
	iframe.setAttribute('src', 'iov://blackbox/fill#' + id);  
	iframe.name="ioOut";  
	document.documentElement.appendChild(iframe);  
	iframe.parentNode.removeChild(iframe);  
	iframe = null;  
}

You must inject the blackbox into a DOM object for collection. To do this, call the inject_bb function with the ID of the DOM object, which will automatically call the shouldOverrideUrlLoading() function. For example, set ID to a hidden form field where the blackbox will be stored. When the form containing the field is submitted, the blackbox is returned to your server back-end, and can then be sent to TransUnion to evaluate along with the transaction.

Network Calls

The SDK includes the ability to make a network call to TransUnion TruValidate's service. This enables additional functionality in the Device Risk SDK, including:

Collect additional network information
Configuration updates to root detection
Collect information on potential high-risk applications on the device

By default this functionality is disabled and will need to be enabled in the configuration object. Usage of this feature requires a subscriber key be provided. Please contact your TransUnion client representative to acquire a subscriber key.

Compiling The Sample App in Android Studio

1 In Android Studio, select File | Open or click Open Existing Android Studio Project from the quick-start screen.

From the directory where you unzipped fraudforce-lib-release-5.2.2.zip or cloned the repo, open the android-studio-sample-app directory.
In the project navigation view, open app/src/main/java/com/iovation/mobile/android/sample/MainActivity.java to run the Java sample app. To run the Kotlin sample app, open kotlinApp/src/main/java/com/iovation/mobile/android/sample/MainActivity.kt.
Right-click the file editing view and select Run Main Activity.
- IMPORTANT! If the option to run the module does not appear, select FILE -> PROJECT STRUCTURE and open the Modules panel. From there, set the Module SDK drop-down to your target Android SDK version.
Alternatively, you can right-click on the build.gradle file, and select Run 'build'.
Select either an attached physical device, or an Android virtual device to run the app on. The app should now compile and launch.
When the app compiles successfully, you will see a view with a button that allows you to display a blackbox.

Changelog

5.2.2

Bug fix to handle abstract method exception.

5.2.1

Update target SDK to 33.
Adjusted collection details.
Bug fix for collection issue.

5.1.0

Adjusted collection details.

5.0.0

Java 8 is now required.
The SDK has migrated to Kotlin (1.5.30).
- If your application does not already include the Kotlin standard library (i.e. your application
- is written entirely in Java), then you must include the kotlin stdlib as a dependency.
FraudForceManager can be accessed as a Kotlin object or via FraudForceManager.INSTANCE when using Java).
Targeting Android 12 (API 31).
Changes to cryptography uses.
Adjusted collection details.
Improvements to detail caching.
Fixed Proguard rules.

4.3.2

Adjusted root detection.

4.3.1

Update target and compilation SDK versions to 31.
Adjusted collection details.
Compatible with the new bluetooth changes/permissions in Android 12.
Fixed crashes on devices running below SDK version 24.

4.3.0

Minimum supported Android version updated, from 16 to 21.
Update target and compilation SDK versions to 30.
Bug fixes for NPEs sometimes encountered during asynchronous calls to initialize and/or refresh.

4.2.0

Several obfuscation-related updates/fixes, including preservation of base package.
Update target SDK to 29

4.1.1

Updated compileSdkVersion to 29.
Behavioral changes for apps targeting API 29.

4.1.0

Adjusted recognition details.

4.0.0

Enhanced support for Android 9.0 Pie.
Further improvements to location data collection process.
Resolved Google Play alerts regarding encryption methods.

3.1.0

Support for Android 9.0 Pie.
Fix for issue related to the Turkish character set.
Improved location data collection process.

3.0.1

Improved blackbox data collection performance.
More efficient network calls to iovation.

3.0.0

New API objects, FraudForceConfiguration and FraudForceManager. Prior API objects have been removed.
Compatibility with Android 8.0.
Introduced network calls back to iovation service for additional functionality.
Dropped support for Android API level 8 through API level 15.

2.3.3

Compatibility with Android 7.0.

2.3.2

Improved error handling.

2.3.1

Improved permission checking.
Fixes crash with invalid locale.
Fixes error with Bluetooth permission.
More robust error handling.

2.3.0

Compatibility with Android 6.0 permission system.
Enhanced recognition with additional details added in Android 6.0.
Enhanced geolocation services with mock location detection capabilities.
Enhanced carrier detection and home carrier detection.

2.2.0

Compatibility with older versions of Android build-tools.

2.1.0

Enhanced recognition with the collection of additional details.

2.0.1

Fix bug with permissions that would crash applications.

2.0.0

New API method, getBlackbox, handles low-priority asynchronous collection of device data. The ioBegin method remains for backwards compatibility.
Expanded the android-studio-sample-app with a WebView integration example.
Added WebView integration instructions.

Name		Name	Last commit message	Last commit date
Latest commit History 28 Commits
.github/workflows		.github/workflows
android-studio-sample-app		android-studio-sample-app
.gitignore		.gitignore
LICENSE		LICENSE
LICENSE.html		LICENSE.html
README.html		README.html
README.md		README.md
fraudforce-lib-release-5.2.2.aar		fraudforce-lib-release-5.2.2.aar
release-notes.md		release-notes.md

License

iovation/deviceprint-SDK-Android

Folders and files

Latest commit

History

Repository files navigation