Requirement

Compliance

Please note that when integrating SDK products provided by 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 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

Environment

Integrate

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

Install

If installing offline, please refer to Offline Install

Structure

• TDMobRisk.xcframework（TrustDecision SDK, is a static library）
• TDCorePlugin.xcframework （TrustDecision plugin, is an Embed dynamic library）
• FMDeviceManagerFramework.xcframework （DeviceFingerprint SDK, is a static library）

Install(CocoaPods)

• Add pod 'TrustDecisionPro', '5.3.1.2' to the target in the Podfile
• Execute the pod install --repo-update command in the folder where the Podfile is located. (M series mac computers need to execute arch -x86_64 pod install --repo-update command)

Install(Swift Package Manager)

1. Open your Xcode project
2. Select File -> Add Package Dependencies...
3. Enter the repository URL:

https://github.com/trustdecision/trustdevice-pro-ios.git

4. Set Dependency Rule to Exact Version
5. Enter version:

5.3.1-2

6. Select your app target in Add to Target
7. Click Add Package

Project Configuration

Add -ObjC to the host app target:

1. Select TARGETS -> your app target
2. Select Build Settings
3. Search for Other Linker Flags
4. Add:

-ObjC

Import Header File

#import <TDMobRisk/TDMobRisk.h>

import TDMobRisk

App Privacy Configuration

According to the latest App Store Privacy Policy announced by Apple, starting from the spring of 2024, apps listed on the App Store will need to carry an App privacy list document. Starting May 1, 2024, App Store Connect will not accept apps that do not describe their use of the required reason API in a privacy manifest file.

Adaptation Steps

Please choose a solution based on your actual situation.

1. If the PrivacyInfo.xcprivacy file does not exist in the project directory

• Create a new App Privacy type file through Xcode in the project directory, name it PrivacyInfo, and check the required Targets
• Select the PrivacyInfo.xcprivacy file in the project directory and right-click to open the menu. Open the file through Open As -> Source Code in the menu
• Paste the SDK's PrivacyInfo.xcprivacy below into the PrivacyInfo.xcprivacy file in the project directory

1. If the PrivacyInfo.xcprivacy file already exists in the project directory

• Select the PrivacyInfo.xcprivacy file in the project directory and right-click to open the menu. Open the file through Open As -> Source Code in the menu.
• Added content in the PrivacyInfo.xcprivacy file in the project directory that is mentioned in SDK's PrivacyInfo.xcprivacy but is still missing in the project directory PrivacyInfo.xcprivacy file

SDK's PrivacyInfo.xcprivacy

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
	<key>NSPrivacyCollectedDataTypes</key>
	<array>
		<dict>
			<key>NSPrivacyCollectedDataType</key>
			<string>NSPrivacyCollectedDataTypeDeviceID</string>
			<key>NSPrivacyCollectedDataTypeLinked</key>
			<true/>
			<key>NSPrivacyCollectedDataTypeTracking</key>
			<false/>
			<key>NSPrivacyCollectedDataTypePurposes</key>
			<array>
				<string>NSPrivacyCollectedDataTypePurposeAnalytics</string>
				<string>NSPrivacyCollectedDataTypePurposeAppFunctionality</string>
			</array>
		</dict>
	</array>
	<key>NSPrivacyAccessedAPITypes</key>
	<array>
		<dict>
			<key>NSPrivacyAccessedAPIType</key>
			<string>NSPrivacyAccessedAPICategoryDiskSpace</string>
			<key>NSPrivacyAccessedAPITypeReasons</key>
			<array>
				<string>E174.1</string>
			</array>
		</dict>
		<dict>
			<key>NSPrivacyAccessedAPIType</key>
			<string>NSPrivacyAccessedAPICategoryUserDefaults</string>
			<key>NSPrivacyAccessedAPITypeReasons</key>
			<array>
				<string>CA92.1</string>
			</array>
		</dict>
		<dict>
			<key>NSPrivacyAccessedAPIType</key>
			<string>NSPrivacyAccessedAPICategorySystemBootTime</string>
			<key>NSPrivacyAccessedAPITypeReasons</key>
			<array>
				<string>35F9.1</string>
			</array>
		</dict>
	</array>
</dict>
</plist>

Initialization

Cautions

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

Definition

void (*initWithOptions)(NSDictionary *options);

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 blackBox asynchronously */
void (*getDeviceInfo)(TDDeviceInfoCallback callback);
/* Get blackBox synchronously */
TDDeviceResponse (*getDeviceInfoSync)(void);

Best Practices

1. Call initialization at entry of the application

- (void)initTrustDecisionSDK {
  // Get riskManager
  TDMobRiskManager_t *riskManager = [TDMobRiskManager sharedManager];
  // Initialization Configuration
  NSMutableDictionary *options = [NSMutableDictionary dictionary];

/*************************** Required ***************************/
  // get from our customer platform
  [options setValue:@"[Your partner]" forKey:@"partner"];
  // get from our customer platform
  [options setValue:@"[Your appKey]" forKey:@"appKey"];
  //Data center, Refer to All configuration
  [options setValue:@"[Your data center]" forKey:@"dataCenter"];
  riskManager->initWithOptions(options);
}

func initTrustDecisionSDK() {
  let riskManager = TDMobRiskManager.sharedManager()
  var options = Dictionary<String, Any>()
  /*************************** Mandatory Parameter ***************************/
  // Partner code, Refer to `Required Configuration`
  options.updateValue("[Your partner]" , forKey: "partner")
  // App key, Refer to `Required Configuration`
  options.updateValue("[Your appKey]" , forKey: "appKey")
  // Data center, Refer to `Required Configuration`
  options.updateValue("[Your data center]" , forKey: "dataCenter")
  riskManager?.pointee.initWithOptions(options)
}

1. Obtain blackBox in actual business scenarios

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

      Objective CSwift

      TDMobRiskManager_t *riskManager = [TDMobRiskManager sharedManager];
      riskManager->getDeviceInfo(^(TDDeviceResponse response) {
      // ❗️Attention❗️Must perform NSString type conversion first. Otherwise other threads are not allowed to directly use the response object or its results.
          NSString *blackBox = [NSString stringWithUTF8String:response.blackBox ?: ""];
       		int code = response.apiStatus.code;
        	NSString *message = [NSString stringWithUTF8String:response.apiStatus.message ?: ""];
      		NSLog(@"code:%d,message:%@\nblackBox:%@",code,message,blackBox);
      });
      

      let riskManager = TDMobRiskManager.sharedManager()
      riskManager?.pointee.getDeviceInfo({ response in
          // ❗️Attention❗️Must perform String type conversion first. Otherwise other threads are not allowed to directly use the response object or its results.
          let blackBox = response.blackBox.flatMap { String(cString: $0) } ?? ""
          let code = response.apiStatus.code
          let message = response.apiStatus.message.flatMap { String(cString: $0) } ?? ""
          print("code:\(code),message:\(message)\nblackBox:\(blackBox)")
      })

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

      Objective CSwift

      // May be time-consuming, be cautious when calling in the main thread 
      TDMobRiskManager_t *riskManager = [TDMobRiskManager sharedManager];
      TDDeviceResponse response = riskManager->getDeviceInfoSync();
      // ❗️Attention❗️Must perform NSString type conversion first. Other threads are not allowed to directly use the response object or its results.
      NSString *blackBox = [NSString stringWithUTF8String:response.blackBox ?: ""];

      // May be time-consuming, be cautious when calling in the main thread
      let riskManager = TDMobRiskManager.sharedManager()
      let response = riskManager?.pointee.getDeviceInfoSync()
      // ❗️Attention❗️Must perform String type conversion first. Other threads are not allowed to directly use the response object or its results.
      let blackBox = response?.blackBox.flatMap { String(cString: $0) } ?? ""

Status Check

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

Other

Get SDK Version

TDMobRiskManager_t *riskManager = [TDMobRiskManager sharedManager];
NSString *sdkVersion = riskManager->getSDKVersion();

let riskManager = TDMobRiskManager.sharedManager()
let sdkVersion = riskManager?.pointee.getSDKVersion()

All Configurations

Response Result

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

Status Code

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:

typedef struct TDDeviceAPIStatus_Void {
    /// code
    int code;
    /// message
    NSString *message;
    
} TDDeviceAPIStatus;

The corresponding values of code and message are as follows:

QA

Q1: How to solve the problem of warning "The archive did not include a dSYM for the TDCorePlugin.framework with the UUIDs" after using Archive to package and Distribute on Testflight or AppStore?

A1: It will not have any impact on the current App distribute, please ignore this warning