> 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/products/id-document-recognition-sdk.md).

# ID Document SDK

Faceplugin ID Document SDK: passport OCR / MRZ, authenticity-only Document Liveness, and OCR plus authenticity in one Document Reader engine.

### Overview

**Faceplugin ID Document SDK** covers **document recognition** (OCR / MRZ / barcode), **authenticity-only liveness**, and **recognition + liveness** in one Document Reader engine.

**Coverage:** **16,900** document templates across **255** countries and territories. Full list: [Supported documents PDF](/products/id-document-recognition-sdk/capabilities.md#document-type-classification--worldwide-coverage). What the product can do: [Capabilities](/products/id-document-recognition-sdk/capabilities.md).

* [**Recognition**](/products/id-document-recognition-sdk/recognition.md) — OCR / MRZ overview (install via Document Reader platforms)
* [**Liveness**](/products/id-document-recognition-sdk/id-document-liveness-sdk.md) — authenticity only, no OCR (port **8086**)
* [**Recognition + Liveness**](/products/id-document-recognition-sdk/recognition-and-liveness.md) — Document Reader mobile + server (**recommended** for eKYC)

It is **not** a face matching SDK — use the [Face SDK](/products/face-recognition-sdk.md) after you have a selfie.

```mermaid
flowchart LR
  Capture --> Locate
  Locate --> OCR_MRZ
  OCR_MRZ --> Authenticity
  Authenticity --> JSON
```

All processing stays on the device or in your own server — **NO** data leaves your machine.

### Features

* [x] ID card, passport, and driver license recognition
* [x] MRZ, barcode, QR, and OCR
* [x] Document detection and type classification (**16,900** templates)
* [x] Live camera locate overlay on mobile
* [x] Image quality analysis
* [x] Face, portrait, and signature extraction
* [x] Authenticity / document liveness (when licensed)
* [x] On-premise document verification API (port **8082**)

### Passport OCR, ID card verification, MRZ

| Capability                       | Where it runs                                                                                                                                                             |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Passport OCR / MRZ               | `recognize` / `documentRecognition` / `documentProcess` on every platform                                                                                                 |
| ID card and driver license OCR   | Same APIs                                                                                                                                                                 |
| Barcode / QR                     | Same APIs                                                                                                                                                                 |
| Document verification API (HTTP) | Linux / Windows port **8082**                                                                                                                                             |
| Authenticity without OCR         | Dedicated [ID Document Liveness](/products/id-document-recognition-sdk/id-document-liveness-sdk.md) on Linux **8086**, or `documentLiveness` on this engine when licensed |

Every platform returns the same field set: [Document result JSON](/products/id-document-recognition-sdk/document-result-json.md). Authenticity names: [Document security check fields](/products/id-document-recognition-sdk/document-security-check-fields.md). Deep dive: [Capabilities](/products/id-document-recognition-sdk/capabilities.md).

### Supported documents

The engine classifies **passports, national IDs, driver licenses, visas, residence permits**, and many specialized credentials worldwide. Download the customer catalog:

{% file src="/files/Bw9iEbYJuRY2RfdjSTio" %}
Faceplugin Supported Documents (PDF)
{% endfile %}

Coverage: **16,900** templates across **255** countries and territories — full list in the PDF. Confirm a specific series with [support](/help/request-a-license-and-support.md) if needed.

### Modes

Pick **Capabilities**, then a mode.

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td></td><td><strong>Capabilities</strong></td><td>Recognition, authenticity-only liveness, and OCR + authenticity.</td><td><a href="/products/id-document-recognition-sdk/capabilities.md">Capabilities</a></td></tr><tr><td></td><td><strong>Recognition</strong></td><td>OCR / MRZ overview — platforms under Recognition + Liveness.</td><td><a href="/products/id-document-recognition-sdk/recognition.md">Recognition</a></td></tr><tr><td></td><td><strong>Liveness</strong></td><td>Authenticity-only Linux API on port 8086.</td><td><a href="/products/id-document-recognition-sdk/id-document-liveness-sdk.md">Liveness</a></td></tr><tr><td></td><td><strong>Recognition + Liveness</strong></td><td>Document Reader mobile + server — recommended for eKYC.</td><td><a href="/products/id-document-recognition-sdk/recognition-and-liveness.md">Recognition + Liveness</a></td></tr></tbody></table>

### FAQ

**Does Faceplugin read passports?** Yes — on-premise passport OCR, MRZ, and crops. See [Capabilities](/products/id-document-recognition-sdk/capabilities.md) and [Document result JSON](/products/id-document-recognition-sdk/document-result-json.md).

**Is this an ID card verification API?** Yes — `POST /api/documentRecognition` and `POST /api/documentProcess` on port **8082**, or on-device APIs on mobile.

**Does it read the MRZ?** Yes, when the document template includes an MRZ.

**Is document liveness included?** Only with a Liveness-capable license on this engine, or via the dedicated Document Liveness Linux product.

**How many document types?** **16,900** templates in **255** countries — [PDF catalog](/products/id-document-recognition-sdk/capabilities.md#document-type-classification--worldwide-coverage).

### Use cases

* **Passport / ID onboarding** — classify the document, run OCR / MRZ / barcode (`recognize` / `documentRecognition`)
* **Digital KYC** — extract fields and portrait crops for downstream face match
* **Banking & fintech** — verify IDs on-device or via HTTP on port **8082**
* **Government e-services** — read national IDs and licenses from **16,900** templates
* **Fraud prevention** — optional document authenticity when your license includes it (or use [Document Liveness](/products/id-document-recognition-sdk/id-document-liveness-sdk.md))

### Related documentation

* [Capabilities](/products/id-document-recognition-sdk/capabilities.md) · [Recognition](/products/id-document-recognition-sdk/recognition.md) · [Liveness](/products/id-document-recognition-sdk/id-document-liveness-sdk.md) · [Recognition + Liveness](/products/id-document-recognition-sdk/recognition-and-liveness.md) · [Face SDK](/products/face-recognition-sdk.md)
* [Request a License](/help/request-a-license-and-support.md) · [Try it](/getting-started/try-it.md) · [FAQ](/help/resources/faq.md) · [Glossary](/help/resources/glossary.md)
* [Passport OCR & ID verification](/help/resources/passport-ocr-and-id-verification.md) · [Combining products (eKYC)](/getting-started/choose-a-product.md)
* [SDK comparison](/help/comparisons.md) · [Status codes](/help/resources/status-codes.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/products/id-document-recognition-sdk.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.
