API Reference
中文

ReactNative

Only supports Android and iOS

Integrated Requirement

Compliance Explanation

Please note that when integrating SDK products provided by the TrustDecision in the APP of your company:

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(IMEI/IDFA), AndroidID, IMSI, MEID, MAC address, SIM card serial number, device type, device model, system type, geographical location, login IP address, application list, running process, sensor information(light sensor, gravity sensor, magnetic field sensor, acceleration sensor, gyroscope sensor) 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 (IMEI/IDFA), AndroidID, IMSI, MAC address, SIM card serial number, device type, device model, system type, geographic location, login IP address, application list, running process, sensor information(light sensor, gravity sensor, magnetic field sensor, acceleration sensor, gyroscope sensor) and other related device information, for fraud risk identification.

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

Environment

AndroidiOS
Supported System VersionsAndroid 5.0 and aboveiOS 9.0 and above
Supported Architecturesarmeabi, armeabi-v7a, arm64-v8a, x86armv7,arm64,x86_64

Integrate

Install

Plugin Install

Please execute in your react native project root directory

  npm install --save [email protected]

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

Cautions

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

Definition

   async function initWithOptions(options: {[key: string]: any})

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 synchronous call 
  async function getBlackBox();
  // get by asynchronous call
  async function getBlackBoxAsync();

Best Practices

  1. Get TrustDevice Module
  const TrustDevice = NativeModules.TrustDevice;
  1. Initialize and get blackBox
  async function initWithOptions() {

    var options = {
      "partner": "[Your partner]",
      "appKey": "[Your appKey]",
      "appName": "[Your appName]",
      "country": "[Your country code]",
      "debug": false, 
    }

    const isDebugMode = __DEV__;
    // !!! If not set this parameter in DEBUG mode, the app will terminate
    if (isDebugMode) {
      options["debug"] = true;
    }

     TrustDevice.initWithOptions(options);
     const blackBox = await TrustDevice.getBlackboxAsync()
  }
  1. Obtain blackBox in actual business scenarios
  async function register() {
    const blackBox = await TrustDevice.getBlackBox()
    // ...
  }

Status Check

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

Other

Get SDK Version

  async function getSDKVersion();

Keep Configuration

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

All Configuration

KeyDescription平台Sample
partner(required)Partner code, contact operator to obtain.Alloptions["partner"] = "your partner"
appKey(required)Application identification, please refer tohow to get appKeyAlloptions["appKey"] = "your appKey"
country(required)Data-center: cn for China fra for Europe sg for Singapore inda for Indonesia us for the USAAlloptions["country"] = "your country"
appNameApplication name, contact operator to obtainAlloptions["appName"] = "your appName"
debugAllow debugging, default false, must be closed before the application release.Alloptions["debug"] = true
timeLimitNetwork timeout configuration, in seconds, default 15sAlloptions["timeLimit"] = 5
locationwhether collecting GPS location information, default allowedAlloptions["location"] = true
collectLevelYou can set M to control the maximum length of blackBox to 2000, default around 5000Alloptions["collectLevel"] = "M"
IDFAWhether collecting IDFA information, default allowediOSoptions["IDFA"] = true
deviceNameWhether collecting device name, default allowediOSoptions["deviceName"] = true
runningTasksWhether collecting running tasks, default allowedAndroidoptions["runningTasks"] = true
sensorWhether collecting sensor information, default allowedAndroidoptions["sensor"] = true
readPhoneWhether collecting READ PHONE STATE permission-related information, default allowedAndroidoptions["readPhone"] = true
installPackageListWhether collecting application list information, default allowedAndroidoptions["installPackageList"] = true