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
Android | iOS | |
---|---|---|
Supported System Versions | Android 5.0 and above | iOS 9.0 and above |
Supported Architectures | armeabi, armeabi-v7a, arm64-v8a, x86 | armv7,arm64,x86_64 |
Integrate
Install
Plugin Install
Add trustdevice_pro_plugin to pubspec.yaml of your project.
dependencies:
flutter:
sdk: flutter
...
trustdevice_pro_plugin: ^1.2.7
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.
Definition
Future<void> initWithOptions(Map<String, dynamic> config)
Get blackBox
Cautions
- Call
getBlackbox
afterinitWithOptions
. - Don't cache blackBox returned by getBlackBox in the app. Please rely on this function to get blackBox.
Definition
// get by synchronous call
Future<String> getBlackbox()
// get by asynchronous call
Future<String> getBlackboxAsync();
Best Practices
- Call initialization in the
onCreate
method of the application, and obtain blackBox asynchronously
import 'package:trustdevice_pro_plugin/trustdevice_pro_plugin.dart';
class _MyAppState extends State<MyApp> {
final _trustdeviceProPlugin = TrustdeviceProPlugin();
@override
void initState() {
super.initState();
_initWithOptions();
}
Future<void> _initWithOptions() async {
var options = {
"partner": "",
"appKey": "",
"appName": "",
"country": ""
};
//Anti debugging switch, used during development phase
options["debug"] = true;
_trustdeviceProPlugin.initWithOptions(options);
_trustdeviceProPlugin.getBlackboxAsync();
}
}
- Obtain blackBox in actual business scenarios
Future<void> _register() async {
var blackbox = await _trustdeviceProPlugin.getBlackbox();
// ...
}
Status Check
- 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
Future<String> getSDKVersion()
Keep Configuration
-keep class cn.tongdun.**{*;}
-keep class com.trustdecision.**{*;}
All Configuration
Key | Description | 平台 | Sample |
---|---|---|---|
partner(required) | Partner code, contact operator to obtain. | All | options["partner"] = "your partner" |
appKey(required) | Application identification, please refer tohow to get appKey | All | options["appKey"] = "your appKey" |
country(required) | Data-center: cn for China fra for Europe sg for Singapore inda for Indonesia us for the USA | All | options["country"] = "your country" |
appName | Application name, contact operator to obtain | All | options["appName"] = "your appName" |
debug | Allow debugging, default false, must be closed before the application release. | All | options["debug"] = true |
timeLimit | Network timeout configuration, in seconds, default 15s | All | options["timeLimit"] = 5 |
location | whether collecting GPS location information, default allowed | All | options["location"] = true |
collectLevel | You can set M to control the maximum length of blackBox to 2000, default around 5000 | All | options["collectLevel"] = "M" |
IDFA | Whether collecting IDFA information, default allowed | iOS | options["IDFA"] = true |
deviceName | Whether collecting device name, default allowed | iOS | options["deviceName"] = true |
runningTasks | Whether collecting running tasks, default allowed | Android | options["runningTasks"] = true |
sensor | Whether collecting sensor information, default allowed | Android | options["sensor"] = true |
readPhone | Whether collecting READ PHONE STATE permission-related information, default allowed | Android | options["readPhone"] = true |
installPackageList | Whether collecting application list information, default allowed | Android | options["installPackageList"] = true |
Liveness Module
Initial configuration optional parameter list
Key | Definition | Description | Scene | Sample code |
---|---|---|---|---|
language | language type | Liveness detection prompt language | Default: en English Options: en English zh-Hans Simplified Chinese zh-Hant Traditional Chinese es Spanish id Indonesian ar Arabic fil Filipino ko Korean pt Portuguese ru Russian th Thai tr Turkish vi Vietnamese |
options["language"] = "en" |
playAudio | Whether to play audio | The default is NO, no audio will be played | When turned on, the corresponding prompt audio will be played | options["playAudio"] = false |
livenessDetectionThreshold | Difficulty threshold for live detection | Difficulty threshold for live detection, divided into three levels: high, medium, and low The default is medium | Adjust to corresponding difficulty as needed | options["livenessDetectionThreshold"] = "medium" |
livenessHttpTimeOut | SDK network timeout configuration (unit: seconds) | Default is 15s | Customers can set the network timeout according to their needs | options["livenessHttpTimeOut"] = 8 |
showReadyPage | When starting the face, the detection preparation page will pop up | Whether to display the preparation page, the default is YES, which means it will be displayed | After closing, the preparation page will not be displayed, and the identification process will be shorter | options["showReadyPage"] = true |
faceMissingInterval | Timeout when no face is detected (unit: milliseconds) | No face timeout, unit ms, default is 1000ms | Set the timeout period when no face is detected as needed | options["faceMissingInterval"] = 1000 |
prepareStageTimeout | The starting time when preparing to detect the action (unit: seconds) | Preparation phase timeout, in seconds, the default is 0S, that is, it will never time out | Set the preparation phase timeout as needed | options["prepareStageTimeout"] = 0 |
actionStageTimeout | In the action phase, the maximum verification time (unit: seconds) | Action phase timeout, unit second, default is 8S | Set the action phase timeout as needed | options["actionStageTimeout"] = 8 |
Popup Liveness Window
Example Code
String license = "please use your license!!!";
await _trustdeviceProPlugin.showLiveness(license,TDLivenessCallback(onSuccess: (String seqId,int errorCode,String errorMsg,double score,String bestImageString,String livenessId) {
print("Liveness success!seqId: $seqId,livenessId:$livenessId,bestImageString:$bestImageString");
}, onFailed: (String seqId,int errorCode,String errorMsg,String livenessId) {
print("Liveness failed!, errorCode: $errorCode errorMsg: $errorMsg");
}));
Error Code
Code | Message |
---|---|
200 | success (live person) |
20700 | No face detected |
20702 | Person change detected |
20703 | Detection timeout |
20705 | Screen lock or background exit during detection |
20710 | No camera permission |
20711 | User actively cancels detection on the preparation page |
20712 | User actively cancels detection on the detection page |
20749 | Inconsistent action, tilt head down |
60001 | Network issue, failed to retrieve session |
60002 | Network issue, failed to call anti-hack |
11350 | Internal error |