Migration Guides

Overview

From 4.0.0, we've introduced significant API improvements and feature enhancements. To make upgrading easier, here’s what you need to know:

• AAILivenessResult has been renamed to AAILivenessSuccessResult
• AAILivenessFailedResult has been renamed to AAILivenessFailureResult
• AAIAdditionalConfig has been renamed to AAILivenessConfig
• All audit image settings have been moved from AAIAdditionalConfig to the AAIAuditConfig class
• If using staticKey or ticket for initialization, refer to this FAQ resource for code migration guidance.

Before & After Example

Before 4.0.0, we may using SDK like this:

(Note: Only partial configuration examples are shown here due to the SDK's extensive options)

xxxxxxxxxx
import UIKit
import AAILivenessUI

public class ViewController: UIViewController {

    public override func viewDidLoad() {
        super.viewDidLoad()
        
        self.addButton("SDK Demo", CGRect(x: 40, y: 140, width: 140, height: 40), #selector(tapSDKBtnAction))
       
        // Init SDK
        AAILivenessSDK.initWith(.indonesia)

        // Configure SDK
        /*
        AAILivenessSDK.configResultPictureSize(600)
        */
        
        /*
        // Set whether to detect face occlusion. The default value is false.
        AAILivenessSDK.configDetectOcclusion(true)
        */
        
        /*
        // User binding (strongly recommended).
        // You can use this method to pass your user unique identifier to us,
        // we will establish a mapping relationship based on the identifier.
        // It is helpful for us to check the log when you encountering problems.
        AAILivenessSDK.configUserId("your-user-id")
        */
        
        let additionalConfig = AAILivenessSDK.additionalConfig()
        
        /*
        // Set signature ID for the liveness detection.
        additionalConfig.signatureId = "your-signature-id"
        */
        
        /*
        // Audit image collection configuration
        additionalConfig.enableCollectAuditImages = true
        additionalConfig.auditImageWidth = 300
        additionalConfig.auditImageQuality = 30
        // ... Other audit image configurations
        */
        
        /*
        // Video recording configuration
        let videoConfig = AAIVideoConfig.default()
        videoConfig.recordStage = .prepareAndMotion
        videoConfig.maxRecordDuration = 60
        AAILivenessSDK.configVideo(videoConfig)
        */
        
        /*
        // Set the color of the round border in the avatar preview area. Default is clear color.
        additionalConfig.roundBorderColor = UIColor(red: 0.36, green: 0.768, blue: 0.078, alpha: 1)
        */
        
        /*
        // Set the color of the ellipse dashed line that appears during the liveness detection. Default is white color.
        additionalConfig.ellipseLineColor = .green
        */
        
        // ... Other additional configurations
        
        
    }
    
    @objc func tapSDKBtnAction() {
       let demoLicenseContent = "your-license-content"
       let checkResult = AAILivenessSDK.configLicenseAndCheck(demoLicenseContent)
        if checkResult == "SUCCESS" {
            // license is valid, show SDK page
            let livenessViewController = AAILivenessViewController()
            // other configurations can be set here
            // ...
            livenessViewController.detectionSuccessBlk = {(rawVC, result) in
                // Get livenessId
                let livenessId = result.livenessId
                // Get eventId(You should save this ID in case of tracking problems).
                let eventId = result.eventId
                
                let bestImg = result.img
                let bestImgBase64 = result.getImgBase64Str()
                let size = bestImg.size
                print(">>>>>livenessId: \(livenessId), imgSize: \(size.width), \(size.height)")
                /*
                // Get video record result
                let videoConfig = AAILivenessSDK.videoConfig()
                if let videoConfig = videoConfig, videoConfig.recordStage != .unspecified {
                    if let videoResult = AAILivenessSDK.syncGetLatestVideoRecordResult() {
                        if videoResult.code != .failed {
                            print("Video path is : \(videoResult.videoPath ?? "")")
                        }
                    }
                }
                */
                // Do something... (e.g., call anti-spoofing api to get score)
                
                rawVC.navigationController?.popViewController(animated: true)
            }
            livenessViewController.detectionFailedBlk = {(rawVC, errorInfo) in
                let result = AAILivenessFailedResult(errorInfo: errorInfo)
                // Get eventId(You should save this ID in case of tracking problems).
                let eventId = result.eventId
                print("Detection failed: \(result.errorCode), message: \(result.errorMsg), transactionId: \(result.transactionId), eventId: \(eventId)")
                /*
                // Get video record result
                let videoConfig = AAILivenessSDK.videoConfig()
                if let videoConfig = videoConfig, videoConfig.recordStage != .unspecified {
                    if let videoResult = AAILivenessSDK.syncGetLatestVideoRecordResult() {
                        if videoResult.code != .failed {
                            print("Video path is : \(videoResult.videoPath ?? "")")
                        }
                    }
                }
                */
                rawVC.navigationController?.popViewController(animated: true)
            }
            self.navigationController?.pushViewController(livenessViewController, animated: true)
        }
    }
    
}
 

From 4.0.0, we should using SDK like this:

(Note: Only partial configuration examples are shown here due to the SDK's extensive options)

xxxxxxxxxx
import UIKit
import AAILivenessUI

public class ViewController: UIViewController {

    public override func viewDidLoad() {
        super.viewDidLoad()
        
        self.addButton("SDK Demo", CGRect(x: 40, y: 140, width: 140, height: 40), #selector(tapSDKBtnAction))
    }
    

    @objc func tapSDKBtnAction() {
        /*
         // Init SDK(from 4.0.0)
        AAILivenessSDK.initWith(.indonesia)
         */
        
        // Init SDK(from 4.1.0)
        let licenseConfig = AAILDLicenseModeConfig()
        // Set your market
        licenseConfig.market = .indonesia
        // Set whether the SDK is used as a global service
        licenseConfig.isGlobalService = false
        AAILivenessSDK.initWith(licenseConfig)

        let demoLicenseContent = "your-license-content"
        let checkResult = AAILivenessSDK.configLicenseAndCheck(demoLicenseContent)
        if checkResult == "SUCCESS" {
            // license is valid, show SDK page
            let livenessViewController = AAILivenessViewController()

            // Configure SDK
            let livenessConfig = livenessViewController.livenessConfig

            /*
            livenessConfig.resultPictureSize = 600
            */

            /*
            // Set whether to detect face occlusion. The default value is false.
            livenessConfig.detectOcclusion = true
            */

            /*
            // User binding (strongly recommended).
            // You can use this method to pass your user unique identifier to us,
            // we will establish a mapping relationship based on the identifier.
            // It is helpful for us to check the log when you encountering problems.
            livenessConfig.userId("your-user-id")
            */

            /*
            // Set signature ID for the liveness detection.
            livenessConfig.signatureId = "your-signature-id"
            */

            /*
            // Audit image collection configuration
            let auditImageConfig = AAIAuditImageConfig.default()
            auditImageConfig.imageQuality = 30
            auditImageConfig.enableCollect = true
            auditImageConfig.imageWidth = 300
            // ... Other audit image configurations
            livenessConfig.auditImageConfig = auditImageConfig
            */

            /*
            // Video recording configuration
            let videoConfig = AAIVideoConfig.default()
            videoConfig.recordStage = .all
            videoConfig.maxRecordDuration = 60
            livenessConfig.videoConfig = videoConfig
            */

            /*
            // Set the color of the round border in the avatar preview area. Default is clear color.
            livenessConfig.normalAvatarBorderColor = UIColor(red: 0.36, green: 0.768, blue: 0.078, alpha: 1)
            */
        
            /*
            // Set the color of the ellipse dashed line that appears during the liveness detection. Default is white color.
            livenessConfig.innerEllipseDashedLineColor = .green
            */

            // ... Other livenessConfig configurations
            // ... Other livenessViewController configurations

            livenessViewController.detectionSuccessBlk = {(rawVC, result) in
                // Get livenessId
                let livenessId = result.livenessId
                // Get eventId(You should save this ID in case of tracking problems).
                let eventId = result.eventId
                
                let bestImg = result.img
                let bestImgBase64 = result.getImgBase64Str()
                let size = bestImg.size
                print(">>>>>livenessId: \(livenessId), imgSize: \(size.width), \(size.height)")
                // Do something... (e.g., call anti-spoofing api to get score)
                /*
                // Get video record result
                if let videoRecordResult = result.syncGetVideoRecordResult {
                   if videoRecordResult.code != .failed {
                        print("Video path is : \(videoRecordResult.videoPath ?? "")")
                    }
                }
                */
                rawVC.navigationController?.popViewController(animated: true)
            }

            livenessViewController.detectionFailureBlk = {(rawVC, result) in
                // Get eventId(You should save this ID in case of tracking problems).
                let eventId = result.eventId
                print("Detection failed: \(result.errorCode), message: \(result.errorMsg), transactionId: \(result.transactionId), eventId: \(eventId)")
                /*
                // Get video record result
                if let videoRecordResult = result.syncGetVideoRecordResult {
                   if videoRecordResult.code != .failed {
                        print("Video path is : \(videoRecordResult.videoPath ?? "")")
                    }
                }
                */
                rawVC.navigationController?.popViewController(animated: true)
            }
            self.navigationController?.pushViewController(livenessViewController, animated: true)
        } else if checkResult == "LICENSE_EXPIRE" {
            print("LICENSE_EXPIRE: please call your server's api to generate a new license")
        } else if checkResult == "APPLICATION_ID_NOT_MATCH" {
            print("APPLICATION_ID_NOT_MATCH: please bind your app's bundle identifier on our cms website, then recall your server's api to generate a new license")
        } else {
            print("\(checkResult)")
        }
    }
    
}

Detail API List

APIs in the table below are now unavailable or deprecated since 4.0.0. You’ll need to update your code accordingly. Here we explain some document properties upfront to help you understand the table.

• livenessConfig is an instance of AAILivenessConfig and a property of AAILivenessViewController
• auditImageConfig is an instance of AAIAuditImageConfigand a property of AAILivenessConfig
• livenessSuccessResult is an instance of classAAILivenessSuccessResult
• livenessFailureResult is an instance of class AAILivenessFailureResult
• livenessViewController is an instance of class AAILivenessViewController

errorCode change detail

The following is a detailed list of changed or newly added error codes. Note that this list only includes modified/new errorCode entries. Codes not listed remain unchanged. For a complete reference of all error codes, please consult this documentation.

AAILivenessViewController

AAILivenessSDK

AAILivenessResult

AAILivenessResult has been renamed to AAILivenessSuccessResult.

AAILivenessFailedResult

AAILivenessFailedResult has been renamed to AAILivenessFailureResult, and it has been moved from AAILivenessUI module to AAILivenessSDK module.

AAIAdditionalConfig

AAIAdditionalConfig has been renamed to AAILivenessConfig.

AAILivenessWrapView

AAILivenessWrapDelegate