Android 3D liveness SDK change logs and release history

V3.4.1（2024.10.9）

New Features

• fix bug

Migration Guides

1. Change the dependency version number to3.4.1:

   xxxxxxxxxx
   dependencies {
     ...
     implementation 'ai.advance.mobile-sdk.android:liveness-detection:3.4.1'
   }
   

V3.4.0（2024.9.4）

New Features

• Adjusted UI interactions and prompts to enhance the user experience.
• Optimized the performance of the liveness near image collection process by providing appropriate prompts when no face or multiple faces are detected, resulting in customers no longer receiving FACE_MISSING and MULTIPLE_FACE error codes.
• Improved the speed of the liveness collection process by eliminating the 3-second wait time and reducing image upload duration.
• Strengthened protection against hook injection attacks.
• targetSdk upgraded to 34.

Migration Guides

1. Change the dependency version number to3.4.0:

   xxxxxxxxxx
   dependencies {
     ...
     implementation 'ai.advance.mobile-sdk.android:liveness-detection:3.4.0'
   }
   

V3.3.1（2024.7.22）

New Features

1. Fix crashes caused by Bluetooth issues on Android 12 and above.

Migration Guides

1. Change the dependency version number to3.3.1:

   xxxxxxxxxx
   dependencies {
     ...
     // version log:https://public-n3.advai.net/repository/maven-releases/ai/advance/mobile-sdk/android/liveness-detection/maven-metadata.xml
     implementation 'ai.advance.mobile-sdk.android:liveness-detection:3.3.1'
   }
   

V3.3.0（2024.5.31）

New Features

1. Fixed warnings from some detection platforms on VirusTotal.

   The Liveness SDK is falsely reported as containing viruses by some platforms on VirusTotal . If your app promotion relies on VirusTotal 's detection results, it is recommended that you upgrade to this version

   • If you have integrated certain versions due to SDK virus issues, and you have modified the imported SDK class path to adapt to these versions, when integrating 3.3.0, you can revert these changes and the SDK class path will be fixed toaai.liveness.**
   • If you have previously integrated a specific version that changed LivenessViewthe name of , when integrating 3.3.0, please revert the name of this class toLivenessView
   • 3.3.0 is a standard general version. Although we have completely modified the names of internal classes and encryption algorithms, we still cannot completely avoid being marked in the future. Starting from version 3.3.0, we support packaging exclusive versions for you. The internal classes of exclusive versions will not be repeated with other customers, which can avoid being marked to a greater extent. In addition, there is no other integration difference between the exclusive version and the standard version except for the difference in version number.

2. The performance of the livenesss collection process has been optimized, and the user pass rate has been significantly improved.

3. UI interaction adjustments

   Currently, the ellipses in the entire 3D liveness detection process are the same color. We have adjusted the status during detection, maintaining green in the stationary state and gray in other states.

   If you want to maintain the previous interaction effect, you can call the following methods to set the ellipse color in these two states:

   xxxxxxxxxx
   mLivenessView.setOvalColor(Color.parseColor("#5BC413"));
   mLivenessView.setOvalNormalColor(Color.parseColor("#5BC413"));
   

4. Supports capturing an audit graph at a specified time

   xxxxxxxxxx
   // Added setRelativeSecondsCaptureAfterCameraLaunched(2.3f) configuration to the original audit image configuration. You can specify the screenshot time relative to the camera opening, in seconds. If this setting is not called, the image will not be captured.
   // The newly added image exists in the original image array
   GuardianLivenessDetectionSDK.setAuditImageConfig(new AuditImageConfig
           .AuditImageConfigBuilder()
           .setEnableCollectSwitch(true)
           .setImageCaptureInterval(400)
           .setImageMaxNumber(10)
           .setImageWidth(400)
           .setImageQuality(30)
           .setRelativeSecondsCaptureAfterCameraLaunched(2.3f)
           .build());
   

5. Added uploading timestamps for near and far view images

   Starting from version 3.3.0, when you call the backend score interface, farImageTime and nearImageTime will be returned additionally, representing the timestamp for the capture of the far and near images respectively.

Migration Guides

1. Change the dependency version number to3.3.0:

   xxxxxxxxxx
   dependencies {
     ...
     // version log:https://public-n3.advai.net/repository/maven-releases/ai/advance/mobile-sdk/android/liveness-detection/maven-metadata.xml
     implementation 'ai.advance.mobile-sdk.android:liveness-detection:3.3.0'
   }
   

V3.2.0（2024.5.17）

New Features

• Video Recording Encoding Optimization: Optimized the video recording encoding process and fixed several encoding issues on various devices. This enhancement ensures smoother and more reliable video capture across all supported devices.
• Device Intelligence Update: device intelligence module has been updated for improved performance and accuracy. If you wish to remove this module, please contact our tech support team for assistance and guidance
• Enhanced Security Against Hook Injection Attacks:strengthened our defenses against hook injection attacks by implementing watermarking and additional environment checks. These measures provide an extra layer of security to protect against fraudulent activities.

Migration Guides

1. Change the dependency version number to3.2.0:

   xxxxxxxxxx
   dependencies {
     ...
     // version log:https://public-n3.advai.net/repository/maven-releases/ai/advance/mobile-sdk/android/liveness-detection/maven-metadata.xml
     implementation 'ai.advance.mobile-sdk.android:liveness-detection:3.2.0'
   }
   

V3.1.5（2024.3.27）

New Features

• Remove the LivenessResult.getLivenessScore() method.
• Delete the outdated class LivenessCameraView.java and integrate it into LivenessResult.
• Optimize image processing and significantly reduce the package size of the image upload interface.

Migration Guides

1. Change the dependency version number to3.1.5:

   xxxxxxxxxx
   dependencies {
     ...
     // version log:https://public-n3.advai.net/repository/maven-releases/ai/advance/mobile-sdk/android/liveness-detection/maven-metadata.xml
     implementation 'ai.advance.mobile-sdk.android:liveness-detection:3.1.5'
   }
   

V3.1.4（2024.3.25）

New Features

• Bug fix

Migration Guides

1. Change the dependency version number to3.1.4:

   xxxxxxxxxx
   dependencies {
     ...
     // version log:https://public-n3.advai.net/repository/maven-releases/ai/advance/mobile-sdk/android/liveness-detection/maven-metadata.xml
     implementation 'ai.advance.mobile-sdk.android:liveness-detection:3.1.4'
   }
   

V3.1.1（2024.1.23）

New Features

• Add functionality to return an audit image list.

• Video recording feature optimization:

  1. Significant reduction in video size.
  2. Improved compatibility.
  3. Enhanced video smoothness.
  4. Fixed video size to 300px*300px.

Migration Guides

1. Change the dependency version number to3.1.1:

   xxxxxxxxxx
   dependencies {
     ...
     // version log:https://public-n3.advai.net/repository/maven-releases/ai/advance/mobile-sdk/android/liveness-detection/maven-metadata.xml
     implementation 'ai.advance.mobile-sdk.android:liveness-detection:3.1.1'
   }
   

2. Capture audit images.

   When this feature is enabled, we will capture multiple images during the user's movement based on your configuration.

   xxxxxxxxxx
   GuardianLivenessDetectionSDK.setAuditImageConfig(new AuditImageConfig
                   .AuditImageConfigBuilder()
                   .setEnableCollectSwitch(true)// The function open switch,default value is false
                   .setImageCaptureInterval(400)// Minimum interval time for capturing images,default interval is 400ms
                   .setImageMaxNumber(10)// Maximum number of captured images,default number is 10
                   .setImageWidth(400)// The image width,default width is 400px
                   .setImageQuality(30)// The image compress quality,must in [30,100],the default value is 30
                   .build());
   

   Get audit images

   xxxxxxxxxx
   List<LivenessImageData> auditImageList = LivenessResult.getAuditImageList();
   // data structure
   public class LivenessImageData {
     public final String base64Image;// Base64 format image
     public final long timestamp;// Timestamp of image capture.
   }
   

3. Video recording feature.

   By enabling this feature, the SDK will activate video recording. After the completion of the liveness process, you can retrieve the video file using SDK methods. The video file format is .mp4. Please note that this video can only be obtained through the SDK and cannot be obtained from the backend. After using the video, it is up to you to decide whether to delete the local file.

   xxxxxxxxxx
   GuardianLivenessDetectionSDK.setRecordVideoSwitch(true);
   GuardianLivenessDetectionSDK.setMaxRecordVideoSeconds(60);// Maximum recording duration, in seconds, valid range [2,60], default is 60 seconds.
   

   Get video file

   xxxxxxxxxx
   File videoFile = LivenessResult.getVideoFile(this);
   

V3.1.0（2023.12.22）

New Features

• Add blink detection feature
• Add eventId to troubleshoot logs

Migration Guides

1. Change the dependency version number to3.1.0:

   xxxxxxxxxx
   dependencies {
     ...
     // version log:https://public-n3.advai.net/repository/maven-releases/ai/advance/mobile-sdk/android/liveness-detection/maven-metadata.xml
     implementation 'ai.advance.mobile-sdk.android:liveness-detection:3.1.0'
   }
   

2. Add eventIdto track the whole liveness detection process and debug,Please make sure to save this ID for contacting us for troubleshooting purposes

   xxxxxxxxxx
   // After the liveness process is completed, we store this ID regardless of success or failure.
   String eventId = LivenessResult.getEventId();
   

V3.0.9（2023.12.1）

Fixed

• Fixed all warnings from some detection platforms on VirusTotal.

Migration Guides

Fllow this link

V3.0.7，V3.0.8

V3.0.6（2023.10.11）

New Features

• Support cert-pinning

Migration Guides

1. Change the dependency version number to 3.0.6:

   xxxxxxxxxx
   dependencies {
       ...
       // version log:https://public-n3.advai.net/repository/maven-releases/ai/advance/mobile-sdk/android/liveness-detection/maven-metadata.xml
       implementation 'ai.advance.mobile-sdk.android:liveness-detection:3.0.6'
     }
   

    

2. When the server requests the auth-license API, an additional parameter called "openCertPinning" is included. Here is an example:

   xxxxxxxxxx
   {
       "licenseEffectiveSeconds":600,
       "applicationId":"appId1,appId2",
       "openCertPinning":true
   }
   

V3.0.5（2023.9.5）

New Features

• Delete the GuardianLivenessDetectionSDK.capturePictureQueue() method, no longer supporting the return of image sequences.

• Delete the static method IMediaPlayer.isPlayEnable() and use mLivenessView.isSoundPlayEnable() instead.

• Add a method to return the near Image

  xxxxxxxxxx
  Bitmap nearBitmap = LivenessResult.getNearBitmap();
  String nearBase64Str = LivenessResult.getNearBase64Str();
  

Migration Guides

1. Change the dependency version number to3.0.5:

   xxxxxxxxxx
   dependencies {
       ...
       // version log:https://public-n3.advai.net/repository/maven-releases/ai/advance/mobile-sdk/android/liveness-detection/maven-metadata.xml
       implementation 'ai.advance.mobile-sdk.android:liveness-detection:3.0.5'
     }
   

V3.0.4（2023.8.1）

Fixed

• bug fix

Migration Guides

1. Change the dependency version number to3.0.4:

   xxxxxxxxxx
   dependencies {
       ...
       // version log:https://public-n3.advai.net/repository/maven-releases/ai/advance/mobile-sdk/android/liveness-detection/maven-metadata.xml
       implementation 'ai.advance.mobile-sdk.android:liveness-detection:3.0.4'
     }
   

V3.0.3（2023.7.26）

New Features

• Algorithm upgrade to improve the quality of collected images.

Migration Guides

1. Change the dependency version number to3.0.3:

   xxxxxxxxxx
   dependencies {
       ...
       // version log:https://public-n3.advai.net/repository/maven-releases/ai/advance/mobile-sdk/android/liveness-detection/maven-metadata.xml
       implementation 'ai.advance.mobile-sdk.android:liveness-detection:3.0.3'
     }
   

V3.0.1，V3.0.2

V3.0.0（2023.7.17）

New Features

• New 3D detection to guard against screen replay attacks
• Enhanced network security to protect against interface simulation attacks

Migration Guides

1. Change the dependency version number to3.0.2:

   xxxxxxxxxx
   dependencies {
       ...
       // version log:https://public-n3.advai.net/repository/maven-releases/ai/advance/mobile-sdk/android/liveness-detection/maven-metadata.xml
       implementation 'ai.advance.mobile-sdk.android:liveness-detection:3.0.2'
     }
   

2. SDK adds the following optional permissions. If you do not want these permissions to appear in your app manifest, remove the permission item in your app module's AndroidManifest.xml file. Taking ACCESS_FINE_LOCATION as an example: <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" tools:node="remove"/>.

   xxxxxxxxxx
   <uses-permission android:name="android.permission.READ_PHONE_STATE" />
     <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
     <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
     <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
     <uses-permission android:name="android.permission.READ_PHONE_STATE" />
     <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
     <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
     <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
   

3. It is recommended to place the prompt text at the position shown in the image below (above the LivenessView) for easy user access to the prompt content:

   

4. It is recommended to shorten the prompt text length as follows for easy user comprehension of the prompt information:

   • FACENOTCENTER:Center your face in the frame
   • FACENOTSTILL&FACECAPTURE:Hold steady
   • FACENOTFRONTAL:Please look straight
   • FACEMISSING:Position your face in the frame
   • FACESMALL:Move closer
   • FACELARGE:Move away

5. Set the background color of the livenessView(do not overlay a mask image on the LivenessView, if you have, please remove it)

   xxxxxxxxxx
   mLivenessView.setMaskColor(getResources().getColor(R.color.xxx);
   

6. Set the color of the oval frame in the livenessView:

   xxxxxxxxxx
   mLivenessView.setOvalColor(getResources().getColor(R.color.xxx));
   

Please refer to 2D liveness. Android-SDK-Liveness Detection Upgrade (2D)