> For the complete documentation index, see [llms.txt](https://doc.faceplugin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.faceplugin.com/readme.md).

# Welcome

Faceplugin on-premise Face Recognition, Liveness, and ID Document Recognition SDK docs. Offline Android, iOS, Flutter, React Native, Windows, and Linux Docker integration guides.

### Introduction

**Faceplugin** builds **on-premise, offline** biometric SDKs. Processing stays on the phone, your Windows/Linux host, or your Docker host. There is no per-call Faceplugin cloud.

* [**Face Recognition SDK**](/face-recognition-sdk.md) — NIST FRVT evaluated face matching, 1:1 and live 1:N on mobile, Face Recognition API on Linux/Windows.
* [**Face Liveness Detection SDK**](/liveness-detection-sdk.md) — iBeta Level 2 class **passive** PAD / face anti-spoofing against photos, screens, 3D masks, and deepfake-style attacks.
* [**ID Document Recognition SDK**](/id-document-recognition-sdk.md) — passport OCR, ID card verification, MRZ, barcode, and optional document authenticity.
* [**ID Document Liveness SDK**](/id-document-liveness-sdk.md) — document anti-spoofing only (no OCR).

This documentation is the **integration** layer: clone a public GitHub demo, add the Drive runtime or pull Docker Hub, activate a license, then call the APIs that repository actually ships.

### How to use these docs

Pick the product you licensed, then **Mobile SDK** (on-device `setActivation` → `init`) or **Server SDK** (HTTP: `GET /api/machinecode` → `POST /api/activate` → process). Ports: Document **8082**, Face Recognition **8083**, Face Liveness **8084**, Document Liveness **8086**.

1. Open the product that matches what you licensed (Face Recognition, Liveness, ID Document, or Document Liveness).
2. Open **Mobile SDK** or **Server SDK**, then the **platform** page (Android, iOS, Flutter, React Native, Linux, Windows, …).
3. Follow **Setup** / **How to run** to place the Drive runtime and start the **demo**.
4. Copy the **machine code** (`FPMC1.…`) if you run a server SDK, then [request a license](/request-a-license-and-support.md).
5. Use [Try it](/try-it.md) / **APIs** to call the same engine from your app. Store templates and document JSON in **your** database.

Native binaries are **not** on GitHub (too large). Each platform page links the Google Drive folder and the exact copy path.

{% hint style="info" %}
The demo is a full app. You do **not** need the demo screens in production — copy the runtime, call activate → init, then the process APIs.
{% endhint %}

{% hint style="info" %}
After you publish this space, connect the docs domain to **Google Search Console** (GitBook admin: custom domain, sitemap, Open Graph). Markdown in this repo cannot enable Search Console by itself.
{% endhint %}

### Our Products

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Face Recognition SDK</strong></td><td>On-premise face matching, 1:N Identify on mobile, HTTP API on Linux/Windows</td><td><a href="https://raw.githubusercontent.com/Faceplugin-ltd/faceplugin-assets/main/screenshots/face-recognition/android/identify.png">https://raw.githubusercontent.com/Faceplugin-ltd/faceplugin-assets/main/screenshots/face-recognition/android/identify.png</a></td><td></td><td><a href="/face-recognition-sdk.md">Face Recognition SDK</a></td></tr><tr><td><strong>Face Liveness Detection SDK</strong></td><td>Passive PAD / anti-spoofing against photos, screens, 3D models, and deepfakes</td><td><a href="https://raw.githubusercontent.com/Faceplugin-ltd/faceplugin-assets/main/screenshots/face-liveness/mobile/liveness.png">https://raw.githubusercontent.com/Faceplugin-ltd/faceplugin-assets/main/screenshots/face-liveness/mobile/liveness.png</a></td><td></td><td><a href="/liveness-detection-sdk.md">Face Liveness Detection SDK</a></td></tr><tr><td><strong>ID Document Recognition SDK</strong></td><td>Passport OCR, ID card and driver license recognition from 200+ countries</td><td><a href="https://raw.githubusercontent.com/Faceplugin-ltd/faceplugin-assets/main/screenshots/document-reader/mobile/camera.png">https://raw.githubusercontent.com/Faceplugin-ltd/faceplugin-assets/main/screenshots/document-reader/mobile/camera.png</a></td><td></td><td><a href="/id-document-recognition-sdk.md">ID Document Recognition SDK</a></td></tr></tbody></table>

Also: [ID Document Liveness SDK](/id-document-liveness-sdk.md) (Linux / Docker authenticity only) · [Palm Recognition SDK](/palm-recognition-sdk.md).

### Try our SDKs

* [Github Repo](https://github.com/Faceplugin-ltd)
* [Google Play App](https://play.google.com/store/apps/details?id=ai.faceplugin.recognition)
* [Our playground](https://playground.faceplugin.com/)
* [HuggingFace Spaces](https://huggingface.co/FacePlugin-Ltd)
* [Docker Hub](https://hub.docker.com/u/faceplugin)
* [Try it (copy-paste)](/try-it.md)

### Features <a href="#feature" id="feature"></a>

* Fully On Premise, Offline SDK
* Simple and comprehensive API
* Flexible licensing model

### Platforms <a href="#platform" id="platform"></a>

Android, iOS, Flutter, React Native, Ionic (Capacitor and Cordova), Windows and Linux / Docker platforms.

### Usecases <a href="#application" id="application"></a>

* eKYC
* Fintech
* ID verification
* Digital onboarding
* Online banking, Payments
* Self-checkout at shops
* Government e-services
* Fraud detection and prevention

### Related documentation

* [Choose a product](/choose-a-product.md) · [FAQ](/resources/faq.md) · [Troubleshooting](/resources/troubleshooting.md)
* [Request a License & Support](/request-a-license-and-support.md) · [SDK comparison](/resources/comparisons.md)
* [Status codes](/resources/status-codes.md) · [Changelog](/resources/changelog.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.faceplugin.com/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.