Try it

Try Faceplugin SDKs with copy-paste commands. Start with license-free curl health and machine-code checks, then activate the SDK and test face detection, face matching, liveness, and document OCR.

These snippets are meant to be copied as-is. You do not write a UI first. Start with health and machinecode (no license needed), then activate and call one process API. Full endpoint contracts: HTTP API.

Start with the server if you want the quickest test. Docker Hub + curl lets you test the SDK without Android Studio. Mobile snippets assume you have already run the demo once, with the required AAR/framework files in place and the demo license configured for the demo app ID.

1. Server — no license yet

Start any Linux/Windows server product, then:

curl -s http://127.0.0.1:8083/api/health
curl -s http://127.0.0.1:8083/api/machinecode

Change the port: ID Document Recognition (Document Reader) 8082, Face Recognition 8083, Face Liveness 8084, Document Liveness 8086.

health works before you have a key. Copy the server machine code (machine code) from machinecode and request a license.

2. Server — activate once

# license.txt contains one line: license key
curl -s -X POST http://127.0.0.1:8083/api/activate \
  -H 'Content-Type: text/plain' \
  --data-binary @license.txt

Success looks like "Successfully activated". The service also loads the engine on this call.

3. Server — try the main APIs for each product

Face Recognition

IMG=$(base64 -w0 face.jpg)   # macOS: base64 -i face.jpg

curl -s -X POST http://127.0.0.1:8083/api/detect \
  -H 'Content-Type: application/json' \
  -d "{\"image\":\"$IMG\"}"

curl -s -X POST http://127.0.0.1:8083/api/match \
  -H 'Content-Type: application/json' \
  -d "{\"image1\":\"$IMG\",\"image2\":\"$IMG\"}"

Install: Face Recognition Linux SDK. Combined recognition + liveness in one package: Face Recognition + Liveness Linux (same port, adds /api/liveness).

Face Liveness

IMG=$(base64 -w0 face.jpg)

curl -s -X POST http://127.0.0.1:8084/api/liveness \
  -H 'Content-Type: application/json' \
  -d "{\"image\":\"$IMG\"}"

Score ≥ 0.5 is Real / pass. JPEG only. Face Liveness Detection Linux SDK. Combined package on 8083: same body against /api/liveness on Recognition + Liveness Linux.

ID Document

FRONT=$(base64 -w0 passport_front.jpg)

curl -s -X POST http://127.0.0.1:8082/api/documentRecognition \
  -H 'Content-Type: application/json' \
  -d "{\"images\":[{\"image\":\"$FRONT\",\"page_idx\":0}]}"

Combined pipeline: POST /api/documentProcess. Dedicated Document Liveness product: port 8086. ID Document Recognition Linux SDK.

Windows: use Git Bash or WSL for base64, or Python:

import base64, json, urllib.request
img = base64.b64encode(open("face.jpg", "rb").read()).decode()
req = urllib.request.Request(
    "http://127.0.0.1:8083/api/detect",
    data=json.dumps({"image": img}).encode(),
    headers={"Content-Type": "application/json"},
)
print(urllib.request.urlopen(req).read().decode())

4. Mobile — after the demo compiles

Keep the demo application ID so the included license key license works. Call this on a background thread.

Android Face Recognition

Thread {
    FaceRecognitionSDK.getMachineCode(context)
    var code = FaceRecognitionSDK.setActivation(context, "license key") // demo key from the repo
    if (code == FaceRecognitionSDK.SDK_SUCCESS) {
        code = FaceRecognitionSDK.init(context)
    }
    val faces = FaceRecognitionSDK.faceDetection(bitmap, FaceDetectionParam())
    val template = FaceRecognitionSDK.templateExtraction(bitmap, faces[0])
    val score = FaceRecognitionSDK.similarity(template, template)
}.start()

Install: Face Recognition Android SDK.

Flutter Face Recognition

import 'package:face_recognition_sdk/face_recognition_sdk.dart';

Future<void> tryOnce(String imagePath, String license) async {
  await getMachineCode();
  if (await setActivation(license) != sdkSuccess) return;
  if (await init() != sdkSuccess) return;
  final faces = await faceDetection(imagePath);
  final t1 = await templateExtraction(imagePath, faces.first);
  final t2 = await templateExtraction(imagePath, faces.first);
  final score = await similarity(t1, t2);
}

Install: Face Recognition Flutter SDK.

Android ID Document

Thread {
    DocumentReaderSDK.getMachineCode(context)
    var code = DocumentReaderSDK.setActivation(context, "license key")
    if (code == DocumentReaderSDK.SDK_SUCCESS) {
        code = DocumentReaderSDK.init(context)
    }
    val json = DocumentReaderSDK.recognize(frontBitmap, null, "none")
}.start()

locateDocument is overlay-only (no OCR). Install: ID Document Recognition Android SDK.

Related documentation

• HTTP API · Deploy and host · Choose a product

• Glossary · Status codes · Troubleshooting

• Request a License