ID Verification:iOS client SDK

Limits

• The SDK supports only iPhones or iPads that run iOS 9 or later.

• The permissions on the network and camera must be granted to the SDK.

Download and configure the SDK

Obtain the SDK

Download the SDK for iOS, decompress the SDK package, and then copy all framework packages to your project folder.

Add the required permissions

Add the required permission in the Info.plist file. The permission description is for reference only.

Add frameworks to Xcode

In the settings of the project, choose Build Settings > Build Phases > Link Binary With Libraries. Then, add frameworks.

• Add all frameworks in the SDK.

  AliyunIdentityFace.framework
  AliyunIdentityPlatform.framework
  AliyunIdentityUtils.framework
  AliyunIdentityOcr.framework
  ToygerService.framework
  AliyunOSSiOS.framework
  faceguard.framework
  DTFUtility.framework
  ToygerNative.framework

• Add system dependencies.

  AudioToolbox.framework
  CoreMedia.framework
  AVFoundation.framework
  SystemConfiguration.framework
  UIKit.framework
  CoreTelephony.framework
  CoreMotion.framework
  Accelerate.framework
  libresolv.tbd
  libsqlite3.tbd
  libc++.tbd
  libz.tbd

Copy resource files

In the settings of the project, choose Build Settings > Build Phases > Copy Bundle Resources. Then, copy resource files.

• AliyunIdentityPlatform.bundle: The resource resides in AliyunIdentityPlatform.framework.

• AliyunIdentityFace.bundle: The resource resides in AliyunIdentityFace.framework.

• AliyunIdentityOCR.bundle: The resource resides in AliyunIdentityOcr.framework.

• ToygerService.bundle: The resource resides in ToygerService.framework.

Configure linker flags

In the settings of the project, choose Other Linker Flags > Build Settings and add the -ObjC flag.

Use the SDK

Import the header file

#import <AliyunIdentityPlatform/AliyunIdentityPlatform.h>

Initialize the SDK

- (void)install;

Obtain metaInfo

- (NSString *)getMetaInfo;

The app server must obtain the metaInfo of a client before the app server can call the Initialize operation.

Therefore, the client must obtain the metaInfo from the local device and then use the metaInfo to complete the subsequent initialization process to obtain a transaction ID.

Perform verification

- (void)verifyWithCertifyId:(NSString *)certifyId
  withCurrentViewController:(UIViewController *)viewController
              withExtParams:(NSDictionary *)extParams
                   complete:(AliyunIdentityVerifyBlock)completeBlock;

Parameters

extParams

Add a language

To add a custom language, perform the following steps:

1. Find the example_face_liveness.strings file in AliyunIdentityPlatform.bundle in AliyunIdentityPlatform.framework.

2. Translate the strings in the example_face_liveness.strings file to the language that you want to use and save the file as language.strings. Replace language in the file name with the language code of the language that you want to use.

3. Specify the language in your code by setting the kIdentityParamKeyLanguage parameter to the language code.

Error codes

Sample code

#import "ViewController.h"
#import <AliyunIdentityPlatform/AliyunIdentityPlatform.h>

@interface ViewController ()
@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
 
    // Initialize the sdk
    [[AliyunIdentityPlatform sharedInstance] install];
 
    [self initUI];
}

// This function needs to be implemented by the user
- (NSString *)sentMetaInfoAndGetTransactionId:(NSString*) metaInfo {
    return @"Get TransactionId from your server."; // replace it.
}

- (void)onClickStart:(id) sender {
    NSString *metaInfo = [[AliyunIdentityPlatform sharedInstance] getMetaInfo];
    NSString *transactionId = [self sentMetaInfoAndGetTransactionId:metaInfo];

    // Set the sdk language
    NSDictionary *extParams = @{
        kIdentityParamKeyLanguage:@"en"
    };
    // start Verify
    [[AliyunIdentityPlatform sharedInstance] verifyWithCertifyId:transactionId
                                       withCurrentViewController:self
                                                   withExtParams:extParams
                                                        complete:^(AliyunIdentityVerifyRes *response) {
        NSString *resContent = [NSString stringWithFormat:@"Code=%d Message=%@", response.code, response.message];
    }];
}

- (void)initUI {
    // ......
}

@end

Demo

You can download the demo for iOS to experience the SDK.