Documentation
Start typing to search…

Integration (Flutter)

Integration Documentation for Android Compatible with Liveness Detection V4.x Version.

Overview-Android

  • Minimum Android version:4.4 (API Level:19)
  • Compilation Android SDK version:API Level：35
  • Target Android SDK version:API Level：35
  • Supported CPU architectures:armeabi-v7a,arm64-v8a
  • SDK incremental package size:4.5MB+

    If you have requirements for package size, you can refer to this to reduce the package size by approximately 1.4MB.

  • 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
    • Spanish
  • Use-permissions: 
    <uses-feature android:name="android.hardware.camera" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />

Overview-iOS

SDK requirements and limitations as below:

  • Minimum iOS version: iOS 10.0
  • Additional dependent third-party libraries: None
  • Supported CPU architectures: arm64, x86_64
  • SDK package size: 6.1MB(arm64, disable bitcode)
  • Supported bitcode: NO
  • Supported languages: en, zh-Hans, id, vi, th, es, ms, hi,fil
  • Use-permissions: NSCameraUsageDescription

Compliance Explanation

Click to view the compliance explanation

Release Notes

Click to show release notes

Demo

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

Migration Guides

If you are upgrading from an older version of the Liveness SDK, please refer to this document to understand the changes.

Installation

Add the dependency in your Flutter project’s pubspec.yaml file.

dependencies:
  flutter:
    sdk: flutter
  liveness_plugin:4.0.2

For iOS, you need to do:

  1. specify the SDK name and url in the Podfile.
pod 'AAINetwork', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-libraries/AAINetwork/AAINetwork-V1.0.4.tar.bz2', type: :tbz 

pod 'AAILivenessUI', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-liveness-detection/4.0.0/iOS-Liveness-SDK-V4.0.0.tar.bz2', type: :tbz

pod 'AAILivenessModel', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-libraries/AAILivenessModel/4.0.0/AAILivenessModel-V4.0.0.tar.bz2', type: :tbz

pod 'AAICore', :http => 'https://prod-guardian-cv.oss-ap-southeast-5.aliyuncs.com/sdk/iOS-libraries/AAICore/1.0.0/AAICore-V1.0.0.tar.bz2', type: :tbz
  1. Run pod install to install the dependencies in your project.
  2. 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>

Usage

  1. Initialization SDK.

    LivenessPlugin.initSDKOfLicense(Market.xxx);

  2. Check license

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

    String license = "xxx";
String? result = await LivenessPlugin.setLicenseAndCheck(license);

print("result = " + result.toString());
if ("SUCCESS" == result) {
  startLivenessDetection();
}

The returned values of checkResult:

APPLICATION_ID_NOT_MATCH: The package name is not within the authorized scope, please check your package name.

LICENSE_EXPIRE: The license has expired, please confirm that the user has calibrated the phone time.

ERROR_LICENSE(1): The license parsing succeeded, but necessary authentication information is missing, this case generally will not occur.

ERROR_LICENSE(2): The license parsing succeeded, but the internal format is incorrect, this case also generally will not occur.

ERROR_LICENSE(3): It is highly likely that an incompatible SDK license is being used, such as using an IQA license for liveness detection.

ERROR_LICENSE(4, 5): Parsing failed, please check if the license has issues like mismatched quotes, line breaks, etc.

  3. You can create SDK launch parameters using the method below

    class _MyHomePageState extends State<MyHomePage>
    implements LivenessDetectionCallback {

  @override
  void initState() {
    super.initState();
    LivenessPlugin.getSDKVersion.then((sdkVersion) {
      print("Liveness SDK Version = " + sdkVersion);
    });

  }

  void _incrementCounter() {
    _checkLicense();
  }

  void _checkLicense() async {
    LivenessPlugin.initSDKOfLicense(Market.Indonesia);
    String license = "xxx";
    String? result = await LivenessPlugin.setLicenseAndCheck(license);

    print("result = " + result.toString());
    if ("SUCCESS" == result) {
      startLivenessDetection();
    }
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ), // This trailing comma makes auto-formatting nicer for build methods.
    );
  }

  void startLivenessDetection() {
    // Note: All configuration options listed below are optional. Please set them as needed.
    Map<String, dynamic> config = {
      // Optional
      // Note for iOS side only support CameraType.FRONT
      "cameraType": CameraType.FRONT,

      // Optional
      "detectOcclusion": false,
      
      /*
      // Optional
      "auditImageConfig": {
        "enableCollectSwitch": true,
        "imageWidth": 400,
        "imageQuality": 30,
        "relativeSecondsCaptureAfterCameraLaunched": 3.0,
      },
      */
      
      /*
      // Optional
      "livenessType": "test_more",
      "signatureId": "your_signature_id",
      */

      /*
      // Optional
      "distantNearTimeout": 50000,
      "silentTimeout": 50000,
      "actionTimeout": 10000,
      "prepareMillSeconds": 0,
      */

      /*
      // Optional
      // The size(width) of the resulting image
      "resultPictureSize": 600,
      */

      /*
      // Optional
      // Maximum duration of video recording, in seconds.
      // 0 means do not record video.
      "maxRecordVideoSeconds": 60,
      */
      
      // Optional (strongly recommended)
      // You can use this property 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.
      "userId": "your_unique_user_id",
      
      /*
			// Optional 
      // Note this configuration item only works on android side
      "maskColor": "#000000",
      */

      /*
      // Optional
      // The hightlight state color of the avatar preview area's border
      "ovalColor": "#000000",
      */

      /*
      // Optional
      // The normal state color of the avatar preview area's border
      "ovalNormalColor": "#000000"
      */
    };

    LivenessPlugin.startLivenessDetection(config, this);
  }

  @override
  void onGetDetectionResult(bool isSuccess, Map<dynamic, dynamic>? resultMap) {
    print("onGetDetectionResult called:" + isSuccess.toString());
    print("onGetDetectionResult print result:" + resultMap.toString());
  }
}

Error Code

See Error Code

Updated 6 days ago