API Reference
中文

Android

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 formResponse
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

ItemDescription
Supported System VersionsAndroid 5.0 and above
Supported Architecturesarmeabi-v7a, arm64-v8a, x86, x86_64

Integration steps

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

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

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

NameDescription
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_LOCATIONGet location information, with an accuracy of approximately 30 to 1500 meters.
ACCESS_FINE_LOCATIONGet location information, with positioning accuracy within 10 meters.
READ_PHONE_STATECollect information on SIM card
QUERY_ALL_PACKAGESCollect installed packages

Initialization

The SDK can be initialized at app startup without collecting any data.

Definition

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

Get device information

Cautions

  • Call getDeviceInfo after initWithOptions

Definition

public static void getDeviceInfo(TDDeviceInfoCallback callback);

Best Practices

  1. Call initialization in the onCreate method of the application
// onCreate of APPlication
TDDeviceManager.Builder builder = new TDDeviceManager.Builder()
/*************************** required ***************************/
.partner("demo")        // get from our customer platform
.appKey("appKey")           //get from our customer platform		 
.country(TDDeviceManager.COUNTRY_CN); 
/*************************** required ***************************/

TDDeviceManager.initWithOptions(getApplicationContext(), builder);
  1. Obtain device information at the actual business node
TDDeviceManager.getDeviceInfo(new TDDeviceInfoCallback() {
    @Override
    public void onResult(String fpVersion,
                  String blackBox,
                  String anonymousId,
                  int deviceRiskScore,
                  TDDeviceAPIStatus apiStatus,
                  String sealedResult) {
        // Note: callbacks are executed in child threads, please do not operate the UI here
        // fpVersion: SDK version number
        // blackBox: The blackBox collected this time
        // anonymousId: The anonymous ID of the current device
        // deviceRiskScore: Device Risk Score
        // apiStatus: API status information
        // sealedResult: sealing result
        int code = apiStatus.getCode();
        // success
        if (code == 0) {
          //...
        }
        // fail
        else {
          //...
        }      
    }
});

Status Check

  1. Log will be printed in logcat while initialization successfully;
TD_JAVA: TD sdk load success
TD_JAVA: TD sdk init success
  1. When the code of getDeviceInfo() callback == 0, it means that the device information is obtained successfully;

Response results

The getDeviceInfo() function returns the response data in callback , which contains the following information. sealedResult is returned only when client-side sealed results are enabled.

KeyDescription
anonymousIdDevice anonymous ID, device identification
blackBoxCall log query identifier
fpVersionSDK Version
deviceRiskScoreCurrent device risk score
sealedResultEncrypted device information, binary Base64 encoded string, returned only when the client seal result is turned on. The decrypted result is consistent with the information obtained by device information query. For reference: Device Call Log

Other

Get SDK Version

TDDeviceManager.getSDKVersion();

Keep Configuration

If developers need to use proguard for obfuscation packaging, please add the following code to the proguard configuration file:

-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 tohow 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)

channel

Channel name, contact operator to obtain

builder.channel("channel")

httpTimeOut

Network timeout configuration, in milliseconds, default 15000ms

builder.httpTimeOut(5000)

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

enableWifiMac

Enable collection of WIFI MAC addresses, default not

builder.enableWifiMac()

wifi_mac

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)

Status code description

Call the TDDeviceManager getDeviceInfo() method. The parameter of type TDDeviceAPIStatus in the callback stores the status information of the SDK. Its definition is as follows:

public class TDDeviceAPIStatus {
    public TDDeviceAPIStatus(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public int getCode() {
        return code;
    }

    public String getMessage() {
        return message;
    }

    private int code;
    private String message;
}

The corresponding values of code and message are as follows:

CodeMessageRemarks
0Success.Success
1000Invalid parameters.The parameter passed in is invalid
1001SDK error.SDK exception occurs, possible reasons: Initialization function not called
1002Network error.Network Error
1003API error.The server returns an error
1004Traffic limit.Gateway current limiting return