> 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/help/resources/faq.md). # FAQ Faceplugin SDK FAQ. Passport OCR, ID verification, Face Recognition API, passive vs active liveness, offline licensing, Flutter, Docker machine codes, and thresholds. ## What can Faceplugin ID Document Recognition (Document Reader) do? On-premise **passport OCR**, **MRZ reading**, ID card and driver license verification, barcode/QR, document type classification (**16,900** templates / **255** countries), and optional document authenticity. See [Document capabilities](/products/id-document-recognition-sdk/capabilities.md) and [Passport OCR & ID verification](/help/resources/passport-ocr-and-id-verification.md). ## Is Faceplugin a passport OCR SDK / MRZ reader? Yes. The ID Document Recognition SDK reads passports and MRZ (when the template includes one), plus national IDs and licenses. HTTP API on port **8082**. ## What is a face recognition SDK? A library that detects faces, extracts a template (embedding), and compares templates. Faceplugin’s commercial SDK runs **on-premise**. You store templates in **your** database. See [Face SDK capabilities](/products/face-recognition-sdk/capabilities.md). ## Is there a Face Recognition API? Yes. Linux Docker and Windows expose an HTTP API on port **8083** (`/api/detect`, `/api/match`, `/api/similarity`). The combined Recognition + Liveness packages also expose `/api/liveness` on the same port. Full reference: [Face Recognition HTTP API](/integration/http-api/face-recognition.md). Overview: [HTTP API](/integration/http-api.md). ## What is passive liveness detection? The engine scores a camera frame or JPEG **without** a smile / turn-head challenge. Faceplugin Face SDK **Liveness** is **passive** anti-spoofing. These docs do **not** claim iBeta certification. Contact Faceplugin if you need a certification statement. See [Face SDK capabilities](/products/face-recognition-sdk/capabilities.md). ## What is the difference between active and passive liveness? **Passive:** no user challenge—used in the Face Liveness SDK and in Face Recognition’s Identify mode. **Active:** separate GitHub demos with smile/turn prompts (`Active-Liveness-Detection-Android` / `-iOS`); they are **not** the Face Liveness SDK. Face Liveness on Linux/Windows is still `POST /api/liveness` on one JPEG. ## Face Recognition liveness vs Face Liveness SDK? Identify on mobile includes **2D liveness** as part of matching. Standalone Face SDK **Liveness** is **anti-spoofing only** (no enroll / 1:N). See [Face SDK capabilities](/products/face-recognition-sdk/capabilities.md). ## Can face recognition work completely offline? Yes. After you activate with a license key bound to the app id (mobile) or machine code (server), matching does not need the internet. ## Can Faceplugin run on-premise? Yes. That is the product model: phone, Windows/Linux host, or Docker on **your** infrastructure. ## Does the Faceplugin SDK require an internet connection? Not for inference after activation. You need a network only to clone GitHub, pull Docker Hub, download Google Drive runtimes, and to contact Faceplugin for a license. ## Does Faceplugin support Flutter? Yes for Face Recognition and ID Document Recognition (`face_recognition_sdk`, `document_reader_sdk`). There is **no** public Face Liveness Flutter SDK — use Face Recognition’s 2D liveness on Identify and/or native Android/iOS Liveness. ## Does Faceplugin support iOS? Yes for Face Recognition, Face Liveness, and ID Document Recognition. Physical iPhone; demo bundle ids are listed on each iOS page. ## How many ID document types are supported? **16,900** templates across **255** countries and territories. Download the [Supported documents PDF](/products/id-document-recognition-sdk/capabilities.md#document-type-classification--worldwide-coverage). ## Docker vs host machine code `GET /api/machinecode` returns machine code. Docker and a native host on the same machine produce **different** codes. License the environment you run in production. See [Request a License](/help/request-a-license-and-support.md). ## Demo license key and my own app id Sample keys are bound to the **demo** application id / bundle id on the platform page. Request a new key for your production id. ## Match and liveness thresholds Mobile Identify default match **0.67**. Face Liveness server: score **≥ 0.5** → Real / pass. Change these defaults only if Faceplugin support gives you different recommended thresholds for your license. ## How large is the Android SDK? The GitHub repo is small. Native models (AAR + `.fpk` / engine) come from Google Drive and are large — that is why they are not on GitHub. Check the Google Drive folder size for the product you licensed. ## Is there a Node.js or C++ SDK? Document Reader has public Node / Go / C++ HTTP options. Face server integration is primarily HTTP (`curl` from any language) or Python `sdk.py` on the same host as `lib/cpu/`. See [Choose a product](/getting-started/choose-a-product.md). ## Where are acronyms defined? See the [Glossary](/help/resources/glossary.md) for MRZ, OCR, eKYC, 1:1 / 1:N, PAD, FRVT, license key, and machine code. ### Related documentation * [HTTP API](/integration/http-api.md) · [Deploy and host](/integration/deploy-and-host.md) * [Glossary](/help/resources/glossary.md) · [Try it](/getting-started/try-it.md) · [Troubleshooting](/help/resources/troubleshooting.md) · [Status codes](/help/resources/status-codes.md) * [Choose a product](/getting-started/choose-a-product.md) · [Passport OCR & ID verification](/help/resources/passport-ocr-and-id-verification.md) * [ID Document capabilities](/products/id-document-recognition-sdk/capabilities.md) · [Face SDK capabilities](/products/face-recognition-sdk/capabilities.md) * [SDK comparison](/help/comparisons.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 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/help/resources/faq.md?ask=&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 `automate deployments from our CI pipeline` 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.