Requirement

Compliance

1.1 According to the user's information protection regulations, before your users start the App for the first time and start collecting information, your company should fully inform the user of the purpose, method, and scope of collecting, using, and sharing the user's personal information with a third party through an interactive interface or design (such as a pop-up window of the privacy policy), and obtain the express consent of the end user.

1.2 To provide business security and risk control services to your company, the TrustDecision SDK will collect, process, and use the identification information IDFA, AndroidID, OAID, MAC address, Wireless IP address, WIFI list, wireless router identification (BSSID, SSID),device type, device model, system type, geographical location(Rough location information, precise location information), login IP address and other device information of the user's device. To ensure compliance with your use of related services, the aforementioned privacy policy should cover the authorization of TrustDecision SDK to provide services and collect, process, and use relevant information. The following terms are for your reference. The specific expression can be determined by your company according to the overall framework and content of your privacy agreement:

TrustDecision SDK: For business security and risk control, our company uses the TrustDecision SDK. The SDK needs to obtain the information of your devices, such as IDFA, AndroidID, OAID, GAID,MAC address, Wireless IP address, WIFI list, wireless router identification (BSSID, SSID),device type, device model, system type, geographical location(Rough location information, precise location information), login IP address, application list, running process, network type,device software version,sensor information(light sensor, gravity sensor, magnetic field sensor, acceleration sensor, gyroscope sensor) and other related device information, for fraud risk identification.

Privacy Policy: https://www.trustdecision.com/legal/privacy-policy

Data Safety Requirements for Google Play

For every app that is uploaded to the Google Play Store, Google requires that the app's privacy and security practices are made available to all its users. For this reason, when an app (or a new version) is uploaded to the Play Store, Google requires app developers to fill out a data safety form. See Provide information for Google Play's Data safety section for more information.

If your app includes our Android SDK, then you can use the table below as a reference to fill out the data safety form:

Environment

Integrate

integrate sample: https://github.com/trustdecision/mobrisk-android-sample

Install

If installing offline, please refer to Offline Install

Add Warehouse

Add the maven library configuration to build.gradle in the project root directory

allprojects {
    repositories {
        ...
        mavenCentral()
    }
}

If your gradle version is 7 or higher, add this configuration to your settings.gradle

repositories {
    ...
    mavenCentral()
}

Add Dependencies

Add dependencies to build.gradle of the main module

dependencies {
    implementation 'com.trustdecision.android:mobrisk:5.2.0'
 }

If you encounter compliance issues, you can exclude the collection of relevant modules

dependencies {
    implementation('com.trustdecision.android:mobrisk:5.2.0'){
        // after removal, sdk does not get the list of installation packages
        exclude group: 'com.trustdecision.android', module: 'packagelist'
        // after removal, sdk will not collect READ_PHONE_STATE related information
        exclude group: 'com.trustdecision.android', module: 'readphone'
       // after removal, sdk will not collect location information
        exclude group: 'com.trustdecision.android', module: 'location'
       // after removal, sdk will not collect sensor information
        exclude group: 'com.trustdecision.android', module: 'sensor'
       // after removal, sdk will not collect wifi information
        exclude group: 'com.trustdecision.android', module: 'wifiinfo'
    }
 }

Abi Configuration

The SDK currently supports four ABI types: armeabi-v7a, arm64-v8a, x86 and x86_64. It is recommended to specify the required architecture type in the app/build.gradle file using the abiFilters configuration.

defaultConfig {
    ...
    ndk {
       abiFilters 'armeabi-v7a', 'arm64-v8a'
    }
}

AndroidManifest.xml

Declare the following permissions in the AndroidManifest.xml file under the application module

<manifest>
   <!-- required -->
   <uses-permission android:name="android.permission.INTERNET"/>
   <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
   <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
  <!-- Outside the Chinese Mainland -->
  <uses-permission android:name="com.google.android.gms.permission.AD_ID"/>

   <!--optional, If not declared, some device information will be abandoned -->
   <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"/>
   <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
   <uses-permission android:name="android.permission.READ_PHONE_STATE" />
   <!-- required for Android 11 and above to obtain the installed packages -->
   <uses-permission android:name="android.permission.QUERY_ALL_PACKAGES"
        tools:ignore="QueryAllPackagesPermission" />
</manifest>

Permissions

Initialization

Cautions

• Ensure that it is initialized after the user agrees to the privacy agreement.
• Ensure that it is initialized in the main process.

Definition

public static void initWithOptions(Context ctx, TDRisk.Builder builder);

@JvmStatic
fun initWithOptions(ctx: Context, builder: TDRisk.Builder)

Get BlackBox

Cautions

• Call getDeviceInfo after initWithOptions.
• Don't cache blackBox returned by getDeviceInfo in the app. Please rely on this function to get blackBox.

Definition

// get by asynchronous callback  
public static void getDeviceInfo(TDDeviceInfoCallbackAdapter callback);
// get by synchronous call  
public static TDDeviceInfo getDeviceInfo();

Best Practices

1. Call initialization in the onCreate method of the application

// onCreate of APPlication
TDRisk.Builder builder = new TDRisk.Builder()
/*************************** required  ***************************/
.partner("Please enter your partner code")        // get from our customer platform
.appKey("Please enter your appKey")           // get from our customer platform		 
.dataCenter("Please enter your data center");

if(agrees to the privacy){
  try {
    TDRisk.initWithOptions(getApplicationContext(), builder);
  } catch (Exception e) {
    Log.e("TD", "init error", e);
  }
}

// onCreate of APPlication
val builder = TDRisk.Builder()
    /*************************** required ***************************/
   .partner("Please enter your partner code") // get from our customer platform
   .appKey("Please enter your appKey") // get from our customer platform	
   .dataCenter("Please enter your data center")  
    /*************************** required ***************************/

if (agrees to the privacy) {
  try {
    TDRisk.initWithOptions(applicationContext, builder)
  } catch (e: Exception) {
    Log.e("TD", "init error", e);
  }
} 

2. Obtain blackBox in actual business scenarios
   1. Recommend using asynchronous methods to obtain without affecting the calling thread.
      Javakotlin

      public void register() {
        ...
        try {
          TDRisk.getDeviceInfo(new TDDeviceInfoCallbackAdapter() {
          @Override
          public void onResult(TDDeviceInfo deviceInfo) {
              // here is in a new thread
              int code = deviceInfo.getApiStatus().getCode();
            	String message = deviceInfo.getApiStatus().getMessage();
      				String blackbox = deviceInfo.getBlackBox();
              Log.e("TD", "code:" + code + ", message:" + message + ", blackBox:" + blackBox);
          	}
      		});
        } catch (Exception e) {
          Log.e("TD", "getDeviceInfo error", e);
        }
        ...
      }

      fun register() {
          ...
          try {
              TDRisk.getDeviceInfo(object : TDDeviceInfoCallbackAdapter() {
                  override fun onResult(deviceInfo: TDDeviceInfo?) {
              				// here is in a new thread
                      val code = deviceInfo?.apiStatus?.code ?: -1
                      val message = deviceInfo?.apiStatus?.message ?: ""
                      val blackbox = deviceInfo?.blackBox ?: ""
                      Log.e("TD", "code:$code, message:$message, blackBox:$blackBox")
                  }
              })
          } catch (e: Throwable) {
              Log.e("TD", "getDeviceInfo error", e)
          }
          ...
      }

   2. If the blackBox has been successfully obtained through asynchronous method before, it can be directly obtained through synchronous method.
      Javakotlin

      public void pay() {
        ...
        try {
      		// May be time-consuming, be cautious when calling in the main thread.
          TDDeviceInfo deviceInfo = TDRisk.getDeviceInfo();
          String blackbox = deviceInfo.getBlackBox();
        } catch (Exception e) {
          Log.e("TD", "getDeviceInfo error", e);
        }
        ...
      }

      fun pay() {
          ...
          try {
      				// May be time-consuming, be cautious when calling in the main thread.
              val deviceInfo = TDRisk.getDeviceInfo()
              val blackbox = deviceInfo.blackBox
          } catch (e: Exception) {
              Log.e("TD", "getDeviceInfo error", e)
          }
          ...
      }

Status Check

1. Log will be printed in logcat while initialization successfully

TD_JAVA: TD sdk load success
TD_JAVA: TD sdk init success

2. getDeviceInfo() will return a 26-bit string while initialization successfully: rGPGX1678775227I9NCwcuVJCb
3. getDeviceInfo() will return a string of around 5000 bits while initialization Failed, please refer to overview-definition

Other

Get SDK Version

TDRisk.getSDKVersion()

TDRisk.getSDKVersion()

Keep Configuration

-keep class com.trustdecision.**{*;}

All Configurations

Response Result

The getDeviceInfo() function returns the response data in callback.

Error Code

The corresponding values of code and message are as follows: