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

# ID Document Recognition Windows SDK

Faceplugin ID Document Recognition Windows SDK. Fully on-premise OCR and authenticity HTTP API on port 8082. documentRecognition, documentProcess.

### Code <a href="#setup" id="setup"></a>

{% embed url="<https://github.com/Faceplugin-ltd/ID-Document-Recognition-Windows>" %}

### Setup <a href="#setup" id="setup"></a>

1. Copy the runtime from [Google Drive](https://drive.google.com/drive/folders/1YfHUwnXO0E2NSvS_81nTNO2z3mKVO85g) into `lib\cpu\`.
2. Install and run:

```
pip install -r requirements.txt
run.bat
```

3. Copy `FPMC1.…` from the terminal or `GET /api/machinecode`, request `FP1.…`, then `POST /api/activate`.

No Docker on Windows. API **8082**. Gradio **9002**.

### APIs

Same as [ID Document Recognition Linux SDK](/id-document-recognition-sdk/id-document-recognition-linux-sdk.md):

| Endpoint                        | Purpose                                  |
| ------------------------------- | ---------------------------------------- |
| `GET /api/health`               | Process is listening (no license)        |
| `GET /api/machinecode`          | Machine code `FPMC1.…`                   |
| `GET /api/licenseStatus`        | License status                           |
| `POST /api/activate`            | Activate and `init_sdk()`                |
| `POST /api/documentRecognition` | OCR / MRZ / barcode / image quality only |
| `POST /api/documentLiveness`    | Authenticity only                        |
| `POST /api/documentProcess`     | Combined pipeline                        |
| `POST /api/generalProcess`      | Single-image general process             |

Python: `sdk.document_recognition`, `sdk.document_liveness`, `sdk.document_process`, `sdk.general_process`.

### Try it

Same routes as [ID Document Recognition Linux SDK](/id-document-recognition-sdk/id-document-recognition-linux-sdk.md) on port **8082**. Import `postman/DocumentReader-API.postman_collection.json`. Gradio **9002**. Parse results with [Document result JSON](/id-document-recognition-sdk/document-result-json.md).

Windows also documents authenticity `"strict"` in addition to `"normal"` / `"none"`.

[Request a License & Support](/request-a-license-and-support.md) · [Contact US](/contact-us.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/id-document-recognition-sdk/id-document-recognition-windows-sdk.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.