iOS 2D liveness detection SDK change logs and release history

v2.1.1 (2024.09.25) Download

Fixed

1. Fixed the crash issue that may occurring under some specific conditions.

Update

1. Add PrivacyInfo.xcprivacy.

Migration Guides

• When migrating from older version to this version, you need to:

  1. Change the download link of module AAILiveness and AAINetwork to the following value:

     pod 'AAINetwork', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-libraries/AAINetwork/AAINetwork-V1.0.2.tar.bz2', type: :tbz 
     pod 'AAILiveness', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-liveness-detection/2.1.1/iOS-Liveness-SDK-V2.1.1.tar.bz2', type: :tbz
     

  2. Then run pod install.

v2.1.0 (2024.1.23) Download

Update

• Upgrade the detection model.
• Update the default value of prepareTimeoutInterval from 10s to 50s.

New Features

• Support return the audit image sequence list.

  Each action will generate 2 or 3 audit images, the number of audit images is not fixed because it depends on the user's action. If you enable this feature, the SDK will automatically upload the audit image sequence list to the server after liveness detection complete.

  How to use

  1. First enable the audit image data list feature before present the SDK page.

     // Initialize the SDK
     ...
     
     // Enable the audit image data list feature.
     AAIAdditionalConfig *additionalConfig = [AAILivenessSDK additionalConfig];
     additionalConfig.enableCollectAuditImages = YES;
     
     // The following properties are optional, you can set them according to your needs.
     
     // (Optional) The audit image width, default is 600. Available values in range [50, 1000].
     additionalConfig.auditImageWidth = 300;
     
     // (Optional) The quality of audit image. The higher the quality, the larger the image size, and the longer the upload time.
     // Default is 30. Available values in range [30, 100].
     additionalConfig.auditImageQuality = 30;
     

  2. Then obtain the audit image data list after liveness detection complete. There are two ways to obtain the audit image data list:

     • One way is to get it from the AAILivenessResult object.

       NSArray<AAILivenessImageData *> *auditImageDataSequenceList = [livenessResult auditImageDataList];
       

     • Another way is to parse the auditImageUrl fileld in the liveness-detection openapi response, which is a download link for a zip file. See liveness-detection openapi for more detail.

Migration Guides

• When migrating from 2.0.11 to this version, you need to:

  1. Change the download link of module AAILiveness and AAINetwork to the following value:

     pod 'AAILiveness', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-liveness-detection/2.1.0/iOS-Liveness-SDK-V2.1.0.tar.bz2' , type: :tbz
     

  2. Then run pod install.

v2.0.11 (2023.10.13) Download

1. Support BPS market (AAILivenessMarketBPS).

2. Upgrade AAINetwork to v1.0.2.

3. When migrating from 2.0.x to this version, you need to:

   1. Change the download link of module AAILiveness and AAINetwork to the following value:

      pod 'AAILiveness', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-liveness-detection/2.0.8/iOS-Liveness-SDK-V2.0.8.tar.bz2' , type: :tbz
      pod 'AAINetwork', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-libraries/AAINetwork/AAINetwork-V1.0.2.tar.bz2', type: :tbz
      

   2. Then run pod install.

v2.0.8 (2023.8.7) Download

1. Billing optimization.

2. When migrating from 2.0.x to this version, you need to:

   1. Change the download link of module AAILiveness to the following value:

      pod 'AAILiveness', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-liveness-detection/2.0.8/iOS-Liveness-SDK-V2.0.8.tar.bz2' , type: :tbz
      

   2. Then run pod install.

v2.0.7 (2023.4.20) Download

1. Added AAILivenessFailedResult as a helper class to facilitate handling errorInfo. The usage of this class is as follows:

   vc.detectionFailedBlk = ^(AAILivenessViewController * _Nonnull rawVC, NSDictionary * _Nonnull errorInfo) {
      AAILivenessFailedResult *result = [AAILivenessFailedResult resultWithErrorInfo:errorInfo];
      NSLog(@"Detection failed: %@, message: %@, transactionId: %@", result.errorCode, result.errorMsg, result.transactionId);
      
      // Close SDK page ...
   };
   

2. Added property recordUserGiveUp to the AAILivenessViewController to facilitate recording the user's give up behavior.

   /// Whether to mark the action of tapping back button as "user_give_up". The default is NO. If you set YES, the `detectionFailedBlk`
   /// will be called(if you implement it) when the user taps the top left back button while liveneness detection is running.
   vc.recordUserGiveUp = YES;
   

3. Improve stability.

4. When migrating from 2.0.6 to this version, you need to:

   1. Change the download link of module AAILiveness to the following value:

      pod 'AAILiveness', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-liveness-detection/2.0.7/iOS-Liveness-SDK-V2.0.7.tar.bz2' , type: :tbz
      

   2. Then run pod install.

v2.0.6 (2023.4.06) Download

1. Deprecate the initialization methods initWithAccessKey:secretKey:market: and initWithAccessKey:secretKey:market:isGlobalService:, please use initWithMarket: or initWithMarket:isGlobalService: instead.

2. When migrating from 2.0.5 to this version, you need to:

   1. Change the download link of module AAILiveness to the following value:

      pod 'AAILiveness', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-liveness-detection/2.0.6/iOS-Liveness-SDK-V2.0.6.tar.bz2' , type: :tbz
      

   2. Then run pod install.

v2.0.5 (2023.3.23) Download

1. Support obtaining full face image by calling the API on the server side.

2. When migrating from 2.0.4 to this version, you need to:

   1. Change the download link of module AAILiveness to the following value:

      pod 'AAILiveness', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-liveness-detection/2.0.5/iOS-Liveness-SDK-V2.0.5.tar.bz2' , type: :tbz
      

   2. Then run pod install.

v2.0.4 (2023.3.20) Download

1. Added:

   1. Support return the small square fullface image (AAILivenessResult.fullFaceImg).
   2. Added property showAnimationImg and playAudio for class AAILivenessViewController.

2. Fixed:

   1. Fixed the bug that the best image may not clear.

3. Other minor updates:

   1. Modified the method createVolumeViewof AAILivenessUtil.m to be compatible with SwiftUI.

4. When migrating from 2.0.3 to this version, you need to:

   1. Change the download link of module AAILiveness to the following value:

      pod 'AAILiveness', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-liveness-detection/2.0.4/iOS-Liveness-SDK-V2.0.4.tar.bz2' , type: :tbz
      

   2. Then run pod install.

v2.0.3 (2023.2.10) Download

1. Fix EXC_BAD_ACCESS_KERN_INVALID_ADDRESS bug that may occur in M1 chip devices.

2. Other minor updates.

3. When migrating from 2.0.2 to this version, you need to:

   1. Change the download link of module AAILiveness to the following value:

      pod 'AAILiveness', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-liveness-detection/2.0.3/iOS-Liveness-SDK-V2.0.3.tar.bz2' , type: :tbz
      

   2. Then run pod install.

v2.0.2 (2022.12.23) Download

1. Fix the bug that onDetectionRemainingTime: may not be called sometimes.

2. When migrating from 2.0.1 to this version, you need to:

   1. Change the download link of module AAILiveness to the following value:

      pod 'AAILiveness', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-liveness-detection/2.0.2/iOS-Liveness-SDK-V2.0.2.tar.bz2' , type: :tbz
      

   2. Then run pod install.

v2.0.1 (2022.12.7) Download

1. Breaking changes:

   1. The property configAvatarPreviewPath of AAILivenessWrapView is unavailable, please use configAvatarPreviewPathV2 instead.
   2. Improving enum AAIDetectionType,AAIDetectionResult,AAIActionStatus,AAILivenessMarket declarations for Swift.

2. Other updates:

   1. Disabled phone vertical detection by default. If you want to enable it, do the following setting:

      vc.detectPhonePortraitDirection = YES;
      // Show the AAILivenessViewController
      ... 
      

   2. The number of default actions has been changed from 3 to 2(blink and posYaw).

   3. The color of the round border in the avatar preview area has changed to a clear color. If you want to keep this color consistent with the old version of the SDK, just set the color manually:

      AAIAdditionalConfig *additionalConfig = [AAILivenessSDK additionalConfig];
      additionalConfig.roundBorderColor = [UIColor colorWithRed:0.36 green:0.768 blue:0.078 alpha:1.0];
      
      // Other SDK configurations
      ...
      // Show the AAILivenessViewController
      ... 
      

3. Added:

   1. Added the ellipse dashed line during the liveness detection.

   2. Support to set the detection level.

      AAIAdditionalConfig *additionalConfig = [AAILivenessSDK additionalConfig];
      // Set the color of the ellipse dashed line that appears during the liveness detection. Default is white color.
      additionalConfig.ellipseLineColor = [UIColor greenColor];
      
      // Set the difficulty level of liveness detection. Default is AAIDetectionLevelNormal.
      // Available levels are AAIDetectionLevelEasy, AAIDetectionLevelNormal, AAIDetectionLevelHard
      // The harder it is, the stricter the verification is.
      additionalConfig.detectionLevel = AAIDetectionLevelNormal;
      // Other SDK configurations
      ...
      // Show the AAILivenessViewController
      ... 
      

4. When migrating from older SDK(v1.x.x) to this version, you need to refer the document to reintegrate the SDK.

v1.4.0 (2023.2.10) Download

1. Fix EXC_BAD_ACCESS_KERN_INVALID_ADDRESS bug that may occur in M1 chip devices.

2. When migrating from 1.3.4 to this version, you need to:

   1. Replace ALL of the SDK files("AAILiveness" folder, "AAILivenessSDK.xcframework" folder, "Resource" folder).

v1.3.4 (2022.11.28) Download

1. Fix bugs.

2. When migrating from 1.3.3 to this version, you need to:

   1. Replace ALL of the SDK files("AAILiveness" folder, "AAILivenessSDK.xcframework" folder, "Resource" folder).

v1.3.3 (2022.8.26) Download

1. Fix the global service bug.

2. Compressed images of AAIImgs.bundle.

3. Updated the demo project.

4. When migrating from 1.3.2 to this version, you need to:

   1. Replace ALL of the SDK files("AAILiveness" folder, "AAILivenessSDK.xcframework" folder, "Resource" folder).

v1.3.2 (2022.8.3) Download

1. Updated AAILivenessViewController and AAILivenessUtil.

2. When migrating from 1.3.1 to this version, you need to:

   1. Replace ALL of the SDK files("AAILiveness" folder, "AAILivenessSDK.xcframework" folder, "Resource" folder).

v1.3.1 (2022.7.12) Download

1. Optimizing closed eye detection.

2. Fix EXC_BAD_ACCESS bug that could occur in some cases.

3. Updated AAILivenessViewController.

4. When migrating from 1.3.0 to this version, you need to:

   1. Replace "AAILiveness" folder, "AAILivenessSDK.xcframework" folder.

v1.3.0 Download

1. Optimizing the capture of face image.

2. Support closed eye detection.

3. Add localized string "pls_open_eye".

4. When migrating from 1.2.9 to this version, you need to:

   1. Replace ALL of the SDK files("AAILiveness" folder, "AAILivenessSDK.xcframework" folder, "Resource" folder).

v1.2.9 Download

1. Add market "AAILivenessMarketPhilippines2".

2. Add property language and prepareTimeoutInterval for AAILivenessViewController.

3. Add property language and remove networkChanged: method for AAILivenessResultViewController.

4. Add methods playAudio:lprojName: and localStrForKey:lprojName: for AAILivenessUtil.

5. Add AAITimerWrapper class(in AAILivenessUtil.h and AAILivenessUtil.m).

6. Add localized string key fail_reason_prepare_timeout.

7. When migrating from 1.2.8 to this version, you need to:

   1. Replace ALL of the SDK files(AAILiveness folder, AAILivenessSDK.xcframework folder, Resource folder).

v1.2.8 Download

1. Upgrade network module.

2. Add property actionTimeoutInterval for AAILivenessViewController.

3. When migrating from 1.2.7 to this version, you need to:

   1. Add system libray libz.tdb.
   2. Replace AAILivenessViewController.h and AAILivenessViewController.m.
   3. Replace the xcframework file.

v1.2.7 Download

1. Updated license check feature.
2. When migrating from 1.2.6 to this version, you only need to replace the xcframework file.

v1.2.6 Download

1. Set the width of the image output by the SDK from 300 to 600.
2. When migrating from 1.2.5 to this version, you only need to replace the xcframework file.

v1.2.5 Download

1. Support used as global service. If you need the SDK as a global service, you should use the initialization method initWithMarket:isGlobalService: and pass YES to the isGlobalService parameter.
2. Add other market enum values.
3. When migrating from 1.2.4 to this version, you only need to replace the xcframework file.

v1.2.4 Download

1. Fix EXC_BAD_ACCESS bug that could occur in some cases.
2. When migrating from 1.2.3 to this version, you only need to replace the xcframework file.

v1.2.3 Download

1. Refactored AAILivenessViewController, now you can use the public interfaces of AAILivenessViewController to customize logic without modifing its source code.

2. Support full-screen preview (See how to implement this effect in the demo project).

3. When migrating from 1.2.1 to this version, you need to do:

   1. Replace the xcframework file and AAILivenessViewController.h and AAILivenessViewController.m.
   2. Use the public interfaces of AAILivenessViewController to implement custom logic or UI, it is not recommended to modify its source code directly.

v1.2.1 Download

1. Fix the bug that img of AAILivenessResult may be nil when the onDetectionComplete: method is called.
2. When migrating from 1.2.0 to this version, you only need to replace the xcframework file.

v1.2.0 Download

1. Support face occlusion detection(only in the preparation phase, not in the action detection phase), this feature is off by default, you can turn it on if needed.

   [AAILivenessSDK configDetectOcclusion:YES];
   

2. Support Pakistan, Nigeria, Colombia.

3. Updated Malaysia(ms) audio files.

4. Added the AAIModel.bundle resource and called the [AAILivenessSDK configModelBundlePath:] method in viewDidLoad method of AAILivenessViewController.m.

5. Modified the NSDictionary parameter in the onDetectionComplete method to AAILivenessResult.

v1.1.8 Download

1. Support to initialize SDK with license file.
2. Automatic caching of response data.

v1.1.7 Download

1. Support TLS 1.2.
2. Support Malaysia.
3. Remove property _pre_hold_phone_v_key and property _preResult, add property _pre_key and related logic in AAILivenessViewController.m.
4. Add configActionTimeoutSeconds method to support customizing action detection time interval.

v1.1.6 Download

1. Support Mexico.

v1.1.5 Download

1. Add _pre_hold_phone_v_key property and related logic in AAILivenessViewController.m.
2. Used Xcode 12.4 to rebuild the sdk and replace framework with xcframework.

v1.1.4 Download

1. Add configAvatarPreviewWidth and configAvatarPreviewMarginTop properties to support customizing the width and the margin-top of the avatar preview area. Usage:

   wrapView.configAvatarPreviewWidth = ^CGFloat(CGRect wrapViewFrame) {
       return 300;
   };
   
   wrapView.configAvatarPreviewMarginTop = ^CGFloat(CGRect wrapViewFrame) {
       return 64;
   };
   

v1.1.3

1. Add configAvatarPreviewPath property to the AAILivenessWrapView.h to support customizing the shape of the avatar preview area.
2. Used Xcode 12.2 to rebuild the sdk.

v1.1.2

1. Add configResultPictureSize method to support custom result image size in AAILivenessSDK.h.
2. Add uploadImgCostMillSeconds field in detection result resultInfo.

v1.1.1

1. Add _Nullable for startAuthWithCompletionBlk parameter in AAILivenessWrapView.h.
2. Add _preResult = result; for onFrameDetected:status:forDetectionType in AAILivenessViewController.m.

v1.1.0

1. Modified the default sequence of actions and supports ticket authorization mode.

v1.0.6

1. Support Thailand.

v1.0.5

1. iOS 13 support, upgrade graduallySetBrightness method in AAILivenessUtil.m.

v1.0.4

1. Fix the bug that onDetectionFailed:forDetectionType: method might be called mutiple times.

v1.0.3

1. Improved stability.

v1.0.2

1. Improved the processing logic when the network request error occurs.
2. Improved the multi-language detection logic.

v1.0.1

1. Fix the problem that the Auth request cache cannot be cleared automatically.