Fraud Detection:Device Risk SDK iOS Integration

1. Initialize (initDevice)

This function initializes the SDK and collects information. Call this function as early as possible in risk detection scenarios, provided that compliance requirements are met. You need to call this function only once per app launch.

• Function prototype

@interface SecurityDevice : NSObject
/**
 * Initialize the device fingerprint SDK.
 */
- (void)initDevice:(NSString *)userAppKey :(void (^)(int))initCallback;

/**
 * Initialize the SDK with options.
 */
- (void)initDevice:(NSString *)userAppKey withOptions:(NSMutableDictionary *)options callback:(void (^)(int))initCallback;

@end

Parameters

• userAppKey: identifies your application. You can apply for the AppKey in Device App Management in the Alibaba Cloud Management Console.

• initCallback: the initialization callback listener. You can use the callback to check whether initialization succeeds. Default value: nil. For the valid values of the code field, see Status return values.

• options: the optional information collection parameters. Default value: nil. The following table describes the available options.

DataType parameter

CustomUrl and CustomHost parameters

To report data to a specific site, set CustomUrl and CustomHost to a specific region. You do not need to configure these parameters by default.

• Example

NSMutableDictionary *options = [[NSMutableDictionary alloc] init];
[options setValue:@"0" forKey:@"IPv6"];       // Use IPv4
// Specify a custom region to which data is reported
// [options setValue:@"xxx" forKey:@"CustomUrl"];  Set the reporting URL
// [options setValue:@"xxx" forKey:@"CustomHost"]; Set the reporting host

// Standard call (recommended)
[[SecurityDevice sharedInstance] initDevice:@"<your AppKey>" withOptions:options callback:nil];

// Call with a callback
[[SecurityDevice sharedInstance] initDevice:@"<your AppKey>" withOptions:options callback:^(int code) {
    NSString * initResult = [NSString stringWithFormat: @"Initialization result: %d", code];
    NSLog(@"%@", initResult);

    if (SC_SUCCESS != code) {
        NSLog(@"Initialization failed");
    } else {
        NSLog(@"Initialization succeeded");
    }
}];

2. Obtain the client token (getDeviceToken)

Obtain the client token and report it to your business server. The server then calls the fraud detection API to query device risk information.

• Make sure that the interval between the initDevice call and the getDeviceToken call is at least 3 seconds, or call getDeviceToken in the callback that indicates successful initialization.

• (Recommended) Specify the bizId parameter when you call getDeviceToken. This binds the token to a unique business ID. Pass the same ID when you query the result on the server to verify that the token has not been tampered with.

• (Recommended) Call getDeviceToken on a non-main thread of the app to avoid crashes that a long-running call may cause.

• Function prototype

@interface SecurityDevice : NSObject
- (SecurityToken *)getDeviceToken;
- (SecurityToken *)getDeviceToken:(NSString *)bizId;
@end

• Example

// Specify bizId to prevent deviceToken from being tampered with. Replace the example value with your business ID.
NSString *bizId = @"1234567890abcdef******";
SecurityToken *deviceToken = [[SecurityDevice sharedInstance] getDeviceToken:bizId];

if (deviceToken == nil || SC_SUCCESS != deviceToken.code) {
    NSLog(@"Failed to obtain the token. Code: %d", deviceToken.code);
} else {
    NSLog(@"The token is obtained. You can query risk tags. Token: %@", deviceToken.token);
}

Pass deviceToken together with other parameters to the fraud detection API as described in Device Fraud Detection event parameters.

3. Send the token to your business server

After you obtain the deviceToken, pass it as a parameter to your business server. The server calls the Alibaba Cloud Device Fraud Detection API with the deviceToken to query and verify device risk information.