Android

Faceplugin Face Liveness Detection Android SDK. On-premise PAD against photos, screens, masks, and deepfakes. AAR, setActivation, init, faceDetection, detect.

Fully on-premise Face Liveness SDK for Android (presentation-attack detection). The demo does not enroll people or run 1:N search. It scores whether the face is real.

What	Id
Android demo package name	com.faceplugin.faceliveness
Public Java class	com.faceplugin.facelivenesssdk.FaceLivenessSDK

Keep the demo package name com.faceplugin.faceliveness so the sample key works.

Code

GitHub - Faceplugin-ltd/FaceLivenessDetection-Android: Liveness detection SDK Android - iBeta level 2 compliant passive liveness detection engine which can detect printed photos, video replay, 3D masks, and deepfake threatsGitHub

Setup

1. Copy the SDK (libfacesdk folder) to the root folder in your project. Place facelivenessdk.aar from Google Drive inside libfacesdk/.

2. Add SDK to the project in settings.gradle

rootProject.name = "YourProjectName"
include ':app'
include ':libfacesdk'

1. Add dependency to your build.gradle

implementation project(path: ':libfacesdk')

1. minSdk 24, useLegacyPackaging = true, CAMERA permission. Call setActivation → init on a background thread.

Status codes: 0 Success, 1 Invalid license, 2 Expired, 3 Not activated, 4 Init failed.

APIs

setActivation: This API is used to activate the SDK

public static int setActivation(Context context, String license);

Input	context (Context): Android Context license (String): The license string (license key)
Return value	The SDK activation status code. 0: Success 1: Invalid license 2: Expired 3: Not activated 4: Init failed

init: This API is used to initialize the SDK

public static int init(Context context) throws IOException;

getMachineCode: This API is used to retrieve the machine code

public static String getMachineCode(Context context);

getLicenseStatus: This API is used to read license status

public static String getLicenseStatus();
public static boolean allowsLiveness();
public static String lastEngineError();

Use allowsLiveness() before Capture.

faceDetection: This API is used to detect faces and determine if the faces are real or fake

public static List<FaceBox> faceDetection(Bitmap bitmap, FaceDetectionParam param);

Input	bitmap (Bitmap): The Bitmap image param (FaceDetectionParam): Parameters for face detection
Return value	A list of FaceBox objects representing the detected faces and their liveness scores.

FaceDetectionParam

public class FaceDetectionParam {
    public boolean check_liveness = false; // set it to true to check liveness
    public int check_liveness_level = 0; // 0: accurate model, 1: light model
    public boolean check_eye_closeness = false;
    public boolean check_face_occlusion = false;
    public boolean check_pose = true;
    public boolean check_landmarks = true;
    public boolean check_quality = false;
}

FaceBox

public class FaceBox {
    public int x1, y1, x2, y2;
    public float liveness, yaw, roll, pitch;
    public float face_quality, face_luminance, score;
    public int trackId;
    public String livenessLabel;
}

The liveness score ranges from 0.0 to 1.0. If it's greater than the threshold, it's real face. Demo default threshold is 0.5.

detect: This API is used to detect faces and return engine JSON

public static String detect(Bitmap bitmap, boolean crop, int flags);

detect requires a liveness-capable license.

VideoWorker: This API is used for the live camera HUD

The demo does not enroll. VideoWorker match DB is empty. Use it to keep a live track while you still score with faceDetection:

startVideoWorker → addVideoWorkerFrame → stopVideoWorker.

deinit: This API is used to unload the engine

public static int deinit();

Run the demo

1. Place facelivenessdk.aar in libfacesdk/ (see Setup).

2. Keep the demo package name com.faceplugin.faceliveness.

3. Run on a physical phone.

4. Home tiles: Liveness, Settings, About. The demo does not enroll people or run 1:N search.

Screenshots

Home	Liveness	Settings	About

License

Licenses are offline. Request a new license key for your own app. Use allowsLiveness() before Capture.

FaceDetectionParam.check_liveness defaults to false. Set it to true or you will not get a liveness score.

Try it (after the demo compiles)

FaceDetectionParam param = new FaceDetectionParam();
param.check_liveness = true;
param.check_liveness_level = 0; // 0 accurate, 1 light
List<FaceBox> faces = FaceLivenessSDK.faceDetection(bitmap, param);
if (!faces.isEmpty() && faces.get(0).liveness >= 0.5f) {
    // Real
}

Request a License & Support · Contact us

FAQ

Passive or active? Passive anti-spoofing. Score the camera frame; no smile / turn-head challenge on this product.

Threshold? Treat 0.5 or higher as Real / pass unless Faceplugin support gives you a different recommended threshold.

Related documentation

• Faceplugin Face Liveness Detection Mobile SDK · iOS · Glossary

• Face Recognition Android SDK

• ID Document Recognition Android SDK

• Request a License · Status codes

• Combining products (eKYC) · SDK comparison