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:

Question in Google Play Console's data safety form	Response
Does your app collect or share any of the required user data types?	Yes.
What type of data is collected?	Device or other identifiers.
Is this data collected, shared, or both?	Collected.
Is this data processed ephemerally?	Yes.
Why is this user data collected?	Fraud Prevention, Security, and Compliance.

Environment

Item	Description
Supported System Versions	Android 5.0 and above
Supported Architectures	armeabi-v7a, arm64-v8a, x86, x86_64

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.1.7.3'
 }

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

dependencies {
    implementation('com.trustdecision.android:mobrisk:5.1.7.3'){
        // 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

Name	Description
INTERNET(required)	Allows the app to access the network connection and send requests to communicate with the server.
ACCESS_NETWORK_STATE(required)	Collect network connection status information.
ACCESS_WIFI_STATE(required)	Collect the current WiFi access status and WLAN hotspot information.
AD_ID(required)	Collect the Google advertising ID, required outside the Chinese Mainland.
ACCESS_COARSE_LOCATION	Get location information, with an accuracy of approximately 30 to 1500 meters.
ACCESS_FINE_LOCATION	Get location information, with positioning accuracy within 10 meters.
READ_PHONE_STATE	Collect information on SIM card
QUERY_ALL_PACKAGES	Collect installed packages

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 getBlackBox after initWithOptions.
Don't cache blackBox returned by getBlackBox in the app. Please rely on this function to get blackBox.

Definition

// get by asynchronous callback  
public static void getBlackBox(TDRiskCallback callback);
// get by synchronous call  
public static String getBlackBox();

// get by asynchronous callback  
@JvmStatic
fun getBlackBox(callback: TDRiskCallback): String 
// get by synchronous call
@JvmStatic
fun getBlackBox(): String

Best Practices

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		 
.country("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	
   .country("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);
  }
}

Obtain blackBox in actual business scenarios

Recommend using asynchronous methods to obtain without affecting the calling thread.

public void register() {
  ...
  try {
    TDRisk.getBlackBox(new TDRiskCallback() {
      @Override
      public void onEvent(String blackbox) {
        // here is in a new thread
        Log.i("TD", "init & get success");
      }  
    });
  } catch (Exception e) {
      Log.e("TD", "getBlackBox error", e);
  }
  ...
}

fun register() {
  // ...
  try {
    TDRisk.getBlackBox(object : TDRiskCallback {
      override fun onEvent(blackbox: String) {
        // here is in a new thread
        Log.i("TD", "init & get success")
      }
    })
  } catch (Exception e) {
    Log.e("TD", "getBlackBox error", e);
  }
  // ...
}

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

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

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

Status Check

Log will be printed in logcat while initialization successfully

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

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

Other

Get SDK Version

TDRisk.getSDKVersion()

TDRisk.getSDKVersion()

Error Listen

Please call setOnErrorCodeListener before the initWithOptions method to listen for error messages. It is recommended to use it only in debug mode.

TDRisk.setOnErrorCodeListener(new TDErrorCodeCallback() {
       @Override
       public void onResult(int errorCode, String errorMsg) {
           Log.d(TAG, "errorCode:" + errorCode + "," + "errorMsg:" + errorMsg);
       }
   });

TDRisk.setOnErrorCodeListener(object : TDErrorCodeCallback {
      override fun onResult(errorCode: Int, errorMsg: String) {
          Log.d("TAG", "errorCode:$errorCode, errorMsg:$errorMsg")
      }
  })

Keep Configuration

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

All Configurations

Key	Description	Sample	Remove Field
partner(required)	Partner code, contact operator to obtain.	builder.partner("partner")
appKey(required)	Application identification, please refer to how to get appKey	builder.appKey("appKey")
country(required)	Data-center: TDRisk.COUNTRY_US (USA) TDRisk.COUNTRY_FRA (Europe) TDRisk.COUNTRY_SG (Singapore) TDRisk.COUNTRY_IDNA (Indonesia) TDRisk.COUNTRY_CN (China)	builder.country(TDRisk.COUNTRY_CN)
appName	Application name, contact operator to obtain	builder.appName("appName")
channel	Channel name, contact operator to obtain	builder.channel("channel")
httpTimeOut	Network timeout configuration, in milliseconds, default 15000ms	builder.httpTimeOut(5000)
collectLevel	You can set M to control the maximum length of blackBox to 2000, default around 5000	builder.collectLevel(TDRisk.COLLECT_LEVEL_M)
disableOptions	Prohibit obtaining specified items	Prohibit obtaining OAID builder.disableOptions(TDRisk.OPTION_OAID) Prohibit obtaining AID builder.disableOptions(TDRisk.OPTION_AID) Prohibit obtaining androidId builder.disableOptions(TDRisk.OPTION_ANDROID_ID)	oaid, aid, androidId
disableDebugger	After configuration, it will terminate running when debugging is detected, default allowed	builder.disableDebugger()
disableRunningTasks	Prohibit obtaining running tasks, default allowed	builder.disableRunningTasks()	running_packages
disableGPS	Prohibit collection of GPS location information, default allowed	builder.disableGPS()	ssid、wifi_list、gps_switch、latitude、longitude、gps_location
disableSensor	Prohibit collecting sensor information, default allowed	builder.disableSensor()	mangetic_field_sensor、gyroscope_sensor、light_sensor、accelerator_data、gravity_data
disableReadPhone	Prohibit collection of READ_PHONE_ STATE permission-related information, default allowed	builder.disableReadPhone()	country_iso、carrier、network_operator、sim_operator、phone_type、radio_type、device_svn
disableInstallPackageList	Prohibit collection of application list information, allowed default	builder.disableInstallPackageList()	installed_packages
customMessage	Custom messages, SDK supports transparent transmission and storage	builder.customMessage(customMessage)

Error Code

code	how to handle
100	Ensure initWithOptions is called before getBlackBox
101	Not affect usage. If you want to obtain a shorter blackBox, you can learn from the best practices mentioned above
102	Not affect usage. If you want to obtain a shorter blackBox, try to use getBlackBox() after a successful callback of getBlackBox (TDRiskCallback)
200	Required parameter exception, adjust parameters according to the error message
201	Please get in touch with our operator to update the validity period of the appKey
301	Please first check if the appKey and partnerCode meet the document requirements. Then check if the appKey fits the package name and sign. At last, check if the setHttpTimeout configuration has been set a too short time, If it still cannot be resolved, please provide the blackBox, code, and error message to the technical for assistance
302	Please check the network status of the current device and App first.
400	Please focus on checking whether the ABI architecture configuration is within the SDK support scope; Is the so file missing
-1	Please provide the blackBox, code, and error message to the technical for assistance