Windows

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

Fully on-premise ID Document Recognition HTTP API for Windows. Default port 8082. Gradio 9002. No Docker on Windows — use Linux SDK for Docker.

Reads ID cards, passports, and driver licenses. Same routes as ID Document Recognition Linux SDK. Parse results with Document result JSON.

Code

GitHub - Faceplugin-ltd/ID-Document-Recognition-Windows: On-premise Windows ID Document Recognition SDK for parsing passports, ID cards, and driver licenses. Extracts OCR, MRZ, barcode, and QR data with document detection and face extraction. Local HTTP REST API + Python bindings. No cloud, full data privacy.GitHub

Setup

Sizing: Hosting requirements.

1

Copy the runtime

Copy the CPU libraries from Google Drive into lib\cpu\.

2

Install and run

pip install -r requirements.txt
run.bat

Demo UI: run_demo.bat after the API is up.

3

Copy the machine code and activate

curl -s http://127.0.0.1:8082/api/machinecode
curl -s -X POST http://127.0.0.1:8082/api/activate \
  -H 'Content-Type: text/plain' \
  --data-binary @license.txt

APIs

Same as ID Document Recognition Linux SDK:

Endpoint	Purpose
GET /api/health	Process is listening (no license)
GET /api/machinecode	Machine code
GET /api/licenseStatus	License status
GET /api/backend	"cpu"
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 OCR + optional authenticity
POST /api/generalProcess	Single-image general process

Full reference: Document Reader HTTP API. Shared control routes: Shared endpoints.

Some routes wrap the result in a small JSON object (an envelope). Process POSTs return engine JSON as the body.

Try it

curl -s http://127.0.0.1:8082/api/health
IMG=$(base64 -w0 id-front.jpg)

curl -s -X POST http://127.0.0.1:8082/api/documentProcess \
  -H 'Content-Type: application/json' \
  -d "{\"images\":[{\"image\":\"$IMG\",\"page_idx\":0}],\"response\":{\"OCR\":\"normal\",\"Authenticity\":\"normal\"}}"

Postman: import postman/DocumentReader-API.postman_collection.json from the repo. Base URL http://127.0.0.1:8082. Gradio 9002. Authenticity names: Document security check fields.

Request a License & Support · Contact us

FAQ

API? Same routes as Linux on port 8082. No Docker on Windows.

Authenticity? documentLiveness / documentProcess when the license includes it.

Related documentation

• Faceplugin ID Document Recognition Server SDK · Linux · Glossary

• Face Recognition Windows SDK

• Face Liveness Detection Windows SDK

• Document result JSON

• Request a License · Status codes

• Combining products (eKYC) · SDK comparison