For the complete documentation index, see llms.txt. This page is also available as Markdown.

Choose a product

Choose a Faceplugin product and platform. Public GitHub repos, Docker images, ports, and how to combine Face Recognition, Liveness, and ID Document SDKs in an eKYC flow.

Use this page as a catalog: which GitHub repository to clone, what the package or Docker image is called, and which HTTP port each server product listens on.

Always clone the public GitHub repository name shown in the tables below (for example ID-Document-Recognition-Android).

Need a vendor comparison? See SDK comparison.

Which product?

You need
Use

Passport OCR / MRZ / ID card verification

Match faces 1:1 or 1:N / Face Recognition API

Face anti-spoofing only

Recognition and anti-spoofing together

For recognition plus liveness on one server, use Face Recognition + Liveness Linux or Windows (port 8083, includes /api/liveness). Or run separate services on 8083 and 8084—never mix their runtime folders.

Document authenticity without OCR

ID Document Recognition

Scan passports, national IDs, and driver licenses on the device or over HTTP (16,900 templates, 255 countries). Document authenticity (anti-spoofing of the ID itself) needs a license that includes that feature, unless you use the dedicated Document Liveness Linux product (authenticity only). Overview: Document capabilities.

Platform
Clone
Package / image
Port

Android

documentreadersdk.aar

—

iOS

docsdk.framework

—

Flutter

document_reader_sdk

—

React Native

document-reader-sdk

—

Ionic Capacitor

document-reader-capacitor

—

Ionic Cordova

Cordova plugin

—

Windows

sdk.py + app.py

API 8082, demo 9002

Linux / Docker

faceplugin/document-reader

API 8082, demo 9002

Node.js HTTP

HTTP API (optional native lib)

API 8082

Go / C++ HTTP

HTTP API

API 8082

JavaScript client

Browser + Node client

→ 8082

React / Vue / Angular

Web demos (HTTP)

→ 8082

Face Recognition

Detect faces, read attributes, extract templates, and match 1:1. Mobile demos also support live 1:N Identify (VideoWorker) and a local person database. Server APIs currently expose still-image detect / quality / feature / match / similarity — not a gallery-based 1:N identification endpoint. Capability overview: Face SDK capabilities.

Platform
Clone
Package / image
Port

Android

facerecognitionsdk.aar

—

iOS

facerecognitionsdk + engine + onnxruntime

—

Flutter

face_recognition_sdk

—

React Native

face-recognition-sdk

—

Ionic Capacitor

face-recognition-capacitor

—

Ionic Cordova

Cordova plugin

—

Windows (recognition)

sdk.py + app.py

API 8083, demo 9003

Linux / Docker (recognition)

faceplugin/face-recognition

API 8083, demo 9003

Windows (recognition + liveness)

sdk.py + app.py

API 8083 (+ /api/liveness), demo 9003

Linux / Docker (recognition + liveness)

faceplugin/face-recognition-liveness-sdk

API 8083 (+ /api/liveness), demo 9003

Face Liveness

Standalone presentation-attack detection (anti-spoofing). Mobile uses a live camera plus VideoWorker. The server scores a single RGB JPEG. Capability overview: Face SDK capabilities (Liveness section).

Platform
Clone
Package / image
Port

Android

facelivenessdk.aar

—

iOS

facelivenessdk + engine + onnxruntime

—

Windows

sdk.py + app.py

API 8084, demo 9004

Linux / Docker

faceplugin/face-liveness

API 8084, demo 9004

Face Recognition mobile apps already include 2D liveness on Identify. Use the standalone Face Liveness product when you need anti-spoofing without enrollment / 1:N.

ID Document Liveness

Authenticity / anti-spoofing only (no OCR, MRZ, or barcode API). For OCR plus authenticity on one engine, use Document Reader with a Liveness-capable license.

Platform
Clone
Image
Port

Linux / Docker

faceplugin/document-liveness

API 8086, demo 9006

Combining products (eKYC)

eKYC means electronic know-your-customer / digital identity onboarding.

Faceplugin does not offer one all-in-one identity-verification app. You combine Document Reader, Face Liveness, and Face Recognition in your mobile app or backend.

Run one process or container per product (for eKYC: Document on 8082 and Face Recognition + Liveness on 8083). Do not dump a second product’s Google Drive runtime into another product’s lib/cpu/ — use two servers instead.

Full topology, responsibility split, and HTTP vs sdk.py: Architecture.

Sizing and Docker flags: Hosting requirements.

Last updated