Android 3D Liveness Detection SDK User Guide(For Xamarin)

Development Preparation

1. Contact us to register an account.

Overview

• Minimum Android version：4.4 (API Level:19)

• Compilation Android SDK version：API Level：33

• Additional dependent third-party libraries: None

• Supported CPU architectures：armeabi-v7a，arm64-v8a

• SDK package size: 1.3MB model file + about 1MB per CPU architecture

• Capture image size: default capture image resolution 600px*600px, size is about 300KB, support custom image size range: 300px~1000px

• Supported languages：

  • English
  • Indonesian
  • Vietnamese
  • Chinese
  • Hendi
  • Thai

• Use-permissions:

  xxxxxxxxxx
  <uses-feature android:name="android.hardware.camera" />
  <uses-permission android:name="android.permission.INTERNET" />
  <uses-permission android:name="android.permission.CAMERA" />
  

Demo

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

Installation

1. Add source https://public-n3.advai.net/repository/nuget-hosted/
2. Add package AdvanceAI.Android.Liveness

Usage

1. Initialization SDK.

   xxxxxxxxxx
   // The last boolean value represents whether the Global service is enabled or not, and is set to true if it is, or false if it is not.
   GuardianLivenessDetectionSDK.Init(Application,your market,false);
   

2. Let the SDK handle camera permissions

   xxxxxxxxxx
   GuardianLivenessDetectionSDK.LetSDKHandleCameraPermission();        
   

3. Set movement difficulty level（Called before the setLicenseAndCheck() method, otherwise it does not take effect）

   You can specify the difficulty of the action detection according to your business requirements (Easy，Normal，Hard)，default level is Normal

   xxxxxxxxxx
   GuardianLivenessDetectionSDK.SetDetectionLevel(GuardianLivenessDetectionSDK.DetectionLevel.Normal);
   

4. Check license

   The license is obtained by your server calling our openAPI, you need to check license before starting the liveness detection activity.

   xxxxxxxxxx
   String license = "xxx";
   String checkResult = GuardianLivenessDetectionSDK.SetLicenseAndCheck(license);
   if ("SUCCESS".Equals(checkResult)) {
       // license valid
      startLivenessActivity();
   } else {
     // license is not available, expired/wrong format/appId not filed
   }
   

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

   The camera detection permission is not processed on the live detection page. Please do the permission detection before entering the page.
   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.

     

6. Important Note to Order of Motions

   The default action sequence is [Blink]->[Shake Head]. To customize, you can follow one of the methods:

   xxxxxxxxxx
   // the first boolean value indicates if the given actions should be shuffled.
   GuardianLivenessDetectionSDK.SetActionSequence(true,Detector.DetectionType.PosYaw,Detector.DetectionType.Blink,Detector.DetectionType.Mouth);
   

7. Customize the size of the returned image

   xxxxxxxxxx
   // Settable input range: [300,1000], unit: pixels
   GuardianLivenessDetectionSDK.SetResultPictureSize(600);
   

8. Return multiple images (off by default)

   The SDK supports capturing a separate image for each action. If you turn this switch on, the SDK will run with a higher memory footprint due to the extra images being captured. If your App is already using a lot of memory, turning on this configuration may cause a memory overflow, so please choose carefully.

   xxxxxxxxxx
   GuardianLivenessDetectionSDK.CapturePictureQueue(true);
   

   Obtain image sequence (obtained after successful live detection):

   xxxxxxxxxx
   IList<String> imageSequenceList = LivenessResult.ImageSequenceList;
   

9. Customized action time

   Detection time for custom actions, all actions take effect after setting, unit: Millisecond

   xxxxxxxxxx
   GuardianLivenessDetectionSDK.SetActionTimeoutMills(10000);
   

10. 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.

    xxxxxxxxxx
    GuardianLivenessDetectionSDK.BindUser(String userId)
    

11. Turn on occlusion detection

    If you want to enable occlusion detection, please call the following method after initializing the SDK to set it

    xxxxxxxxxx
    GuardianLivenessDetectionSDK.IsDetectOcclusion(true)
    

Error code

Customizable UI

Not supported.

FAQ

1. Multilingual

   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..

2. Code proguard configuration

   The SDK already has code proguard, no additional configuration is required.