Liveness Detection flutter SDK

A liveness detection Flutter plugin for iOS and Android. (Android V3.6.0, iOS V3.6.1)

Demo

Android

Install CV-Demo.apk on your phone and log in with the test account.

Migration Guide

Starting in version 3.6.0, error codes for the iOS Flutter plugin have been updated. Please ensure your code adapts to the new error codes when upgrading.

Integrate the SDK into your project

Click to download SDK

Android

1. Copy liveness_plugin to the root directory of the project or the existing plugins folder in the project.

2. Open the pubspec.yaml file in the root directory and add a reference to the liveness_plugin plugin under the dependencies node：

   dependencies:
       ...
       liveness_plugin:
           path: plugins/liveness_plugin
   

3. Update the version of the dependency in the build.gradle file located in the liveness directory.

   dependencies {
       ...
       implementation 'ai.advance.mobile-sdk.android:liveness-detection-flutter:3.6.0'
   }
   

iOS

1. Add camera usage description in Info.plist as bellow. Ignore this step if you have added those.

   <key>NSCameraUsageDescription</key>
   <string>Use the camera to detect the face movements</string>
   

2. Open the pubspec.yaml file in the root directory and add a reference to the liveness_plugin plugin under the dependencies node:

   dependencies:
       liveness_plugin:
           path: /path/to/liveness_plugin
   

3. Open your Podfile and specify the SDK name and url:

   ​x
   target 'Runner' do
     flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
   
     # Specify 'AAINetwork' and 'AAILiveness'
     pod 'AAINetwork', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-libraries/AAINetwork/AAINetwork-V1.0.3.tar.bz2', type: :tbz
     pod 'AAILivenessUI', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-liveness-detection/3.6.1/iOS-Liveness-SDK-V3.6.1.tar.bz2', type: :tbz
   
   end
   

Compliance Explanation

Click to view the compliance explanation

Quick Start

1. Declare the plugin.

   import 'package:liveness_plugin/liveness_plugin.dart';
   

2. Initialize the SDK.

   LivenessPlugin.initSDKOfLicense(your Market);
   

   The last parameter must match the category of the country to which your account belongs, otherwise you will not be authorized.

3. Set license (call openAPI to obtain license by your server)

   void _checkLicense() async {
       /*
       // Optional
       // Set SDK detection level, default is NORMAL.
       // Available levels are EASY, NORMAL, HARD
       // Note that this method must be call before "setLicenseAndCheck()", otherwise it won't take effact
       LivenessPlugin.setDetectionLevel(DetectionLevel.EASY)
       */
   
       String license = "";
       String result = await LivenessPlugin.setLicenseAndCheck(license);
       print(result);
       if ("SUCCESS" == result) {// license is valid
           startLivenessDetection();
       } else {
           // license is invalid, expired/format error /appId is invalid
       }
   }
   

4. Set SignatureId (optional feature; if this id is not set or is set to empty, the livenessId method will remain unchanged)

   In the following known situations, the livenessId generated by AAI may not be transmitted to your server, resulting in the loss of these livenessId outcomes. To address this issue, your backend can call the AAI interface to generate a SignatureId and pass it to the SDK. The SignatureId can be used to obtain the liveness score and has equivalent functionality to the livenessId.

   1. During the upload of the liveness image, the user clicks the back button and leaves the page.
   2. After successful liveness, the app encounters an unexpected issue (such as a network error or app crash) and fails to transmit the livenessId to the server.
   

   Please note: SignatureId can be empty but must not be reused

   LivenessPlugin.setSignatureId("the signatureId");
   

5. Get the SDK version number.

   LivenessPlugin.getSDKVersion.then((sdkVersion) {
       print(sdkVersion);
   });
   

6. Start the liveness detection test and obtain the test result.

   Each time the liveness detection is successful, a unique livenessId and a clear photo of 600*600 pixels for this test will be returned.

   • You need to give the livenessId to your server, and the server will call openAPI to get the score of this test.

   • You can get the image directly through the methods provided by the SDK, or you can call the openAPI from the server.

     // Sample code
     class _SomePageState extends State<SomePage> implements LivenessDetectionCallback{
     
         ...
     
         void startLivenessDetection() {
             LivenessPlugin.startLivenessDetection(this);
         }
     
         @override
         void onGetDetectionResult(bool isSuccess, Map resultMap) {
             print(resultMap);
         }   
     }
     

7. Read the latest results at anytime after the completion of the Liveness Detection(This feature is only supported on Android).

   You can get the result in the callback after the Liveness Detection is completed (step 5), or you can get it at any time through the following methods.

   LivenessPlugin.getLatestDetectionResult.then((latestDetectionResult) {
       print(latestDetectionResult);
   });
   

8. 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 encountering problems.

   LivenessPlugin.bindUser("your user id");
   

9. The code of the liveness module(for android) and the code of ios/Classes(for iOS) can be modified to meet the customization needs.

   Currently SDK supports six languages/voice: Chinese, English, Indonesian, Vietnamese,Hendi,Thai. Automatically switch according to the current language of the mobile phone, no code setting is required. If you only support one language, you can delete the resource files of other countries, for iOS side, you also need to modify the method currLanForBundle: to return a specific language.

Android Error Code:

iOS Error Code: