> 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/getting-started/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.

### What you can build

* **Passport OCR & ID verification** — classify and read **16,900** document templates from **255** countries (MRZ — the machine-readable zone on passports — plus barcode and optional authenticity). Start: [ID Document capabilities](/products/id-document-recognition-sdk/capabilities.md) · [Passport OCR guide](/help/resources/passport-ocr-and-id-verification.md)
* **Face recognition & liveness** — offline 1:1 match, mobile 1:N Identify, standalone face anti-spoofing, or recognition + liveness in one server process. Start: [Face SDK capabilities](/products/face-recognition-sdk/capabilities.md)

Product hubs: [Face SDK](/products/face-recognition-sdk.md) · [ID Document SDK](/products/id-document-recognition-sdk.md) · [Palm Recognition](/products/palm-recognition-sdk.md)

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

### How to use these docs

1. Read **Capabilities** for the product you need (what it can do).
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 Google Drive runtime package and start the **GitHub sample app** for that product.
4. Copy the **machine code** if you run a server SDK, then [request a license](/help/request-a-license-and-support.md).
5. Use [Try it](/getting-started/try-it.md) and the [HTTP API](/integration/http-api.md) to call the same server APIs from your app. Store templates and document JSON in **your** database.

Ports: Document **8082**, Face Recognition **8083**, Face Liveness **8084**, Document Liveness **8086**.

For topology and sizing, see [Deploy and host](/integration/deploy-and-host.md).

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

{% hint style="info" %}
Each GitHub sample app is a complete application for testing. In production, use the runtime directly: copy the runtime, call `activate` → `init`, then call the processing APIs.
{% 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 SDK</strong></td><td>Recognition, liveness, and recognition + liveness — mobile and server</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="/products/face-recognition-sdk.md">Face SDK</a></td></tr><tr><td><strong>ID Document SDK</strong></td><td>Passport OCR, authenticity-only liveness, and OCR + authenticity — 16,900 templates</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="/products/id-document-recognition-sdk.md">ID Document SDK</a></td></tr><tr><td><strong>Palm Recognition SDK</strong></td><td>Open-source RGB-camera palm matching sample</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="/products/palm-recognition-sdk.md">Palm Recognition SDK</a></td></tr></tbody></table>

### Try our SDKs

* [GitHub repos](https://github.com/Faceplugin-ltd)
* [Playground](https://playground.faceplugin.com/)
* [Hugging Face Spaces](https://huggingface.co/Faceplugin-Ltd)
* [Docker Hub](https://hub.docker.com/u/faceplugin)
* [Try it (copy-paste)](/getting-started/try-it.md)

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

* Offline after license activation — no Faceplugin cloud inference
* HTTP APIs on ports **8082** (documents), **8083** (face recognition), **8084** (face liveness), **8086** (document liveness)
* Mobile SDKs for Android, iOS, Flutter, React Native, and Ionic (platform support varies by product)

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

Platforms vary by product. **Face Recognition** and **ID Document Recognition** include Android, iOS, Flutter, React Native, Ionic, Windows, and Linux/Docker. **Face Liveness** is Android, iOS, Windows, and Linux/Docker (no public Flutter or React Native SDK).

### Use cases <a href="#application" id="application"></a>

* **eKYC / digital onboarding** — ID OCR + optional authenticity + selfie liveness + face match ([Architecture](/integration/deploy-and-host/architecture.md))
* **Banking and fintech** — passport / ID verification and face anti-spoofing on your infrastructure
* **Access control and attendance** — mobile 1:N Identify with templates you store
* **Fraud prevention** — reject presentation attacks and document spoofs before enrollment

### Related documentation

* [Choose a product](/getting-started/choose-a-product.md) · [Try it](/getting-started/try-it.md) · [HTTP API](/integration/http-api.md) · [Deploy and host](/integration/deploy-and-host.md)
* [Glossary](/help/resources/glossary.md) · [FAQ](/help/resources/faq.md)
* [Request a License & Support](/help/request-a-license-and-support.md) · [SDK comparison](/help/comparisons.md)
* [Status codes](/help/resources/status-codes.md) · [Troubleshooting](/help/resources/troubleshooting.md) · [Changelog](/help/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 following URL with the `ask` and `goal` query parameters:

```
GET https://doc.faceplugin.com/getting-started/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

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.