FacePlugin
Get in Touch
Windows

ID Document Recognition SDK for Windows

Parse passports, ID cards, and driver licenses on your own Windows server or workstation through a local REST API and Python bindings – OCR, MRZ, and barcode data, with no cloud round-trip.

Local REST API or PythonCPU-only, no GPU requiredNo per-call fees
PASSPORT• AURORIA
Portrait photo extracted from a scanned ID document
SURNAME

WILLIAMS

GIVEN NAMES

ETHAN L.

DATE OF BIRTH

22 SEP 1992

DOCUMENT NO.

X8295147

P<AURWILLIAMS<<ETHAN<L<<<<<<<<
X8295147<7AUR9209226M3205184<<<<03
MRZ Verified✓
Barcode Valid✓
OCR Complete✓
Identity Verified
Requirements

What You Need to Run It on Windows

These are the exact minimum and recommended requirements published in the ID-Document-Recognition-Windows repository — check the repo directly for the latest version, since SDK requirements can change between releases.

OSWindows 10 x64 (min), Windows 11 x64 (recommended)
Python3.10+
CPU / RAM / Disk (min)2 cores / 4 GB / 4 GB
CPU / RAM / Disk (recommended)4 cores / 8 GB / 8 GB
Quick Start

Install and Activate

Install the SDK, then activate it with a license key before calling any recognition function – every platform follows this same activate-then-initialize pattern.

  • Clone the repo and download the Windows runtime into lib\cpu\.
  • pip install -r requirements.txt, then run run.bat to start the API on port 8082.
  • Copy your machine code from the terminal or GET /api/machinecode, then contact FacePlugin for a license key and activate with POST /api/activate.
python
import sdk

machine_code = sdk.get_machine_code()
sdk.activate("license.txt")
sdk.init_sdk()

result = sdk.document_process(
    [{"image": base64_front}], rfid="",
    options={"response": {"OCR": "normal", "MRZ": "normal", "Barcode": "normal", "Authenticity": "normal"}},
)
Licensing

How Licensing Works

Licenses are offline and bound to the PC's machine code. Capability tiers (Recognition / Liveness / both) are reported via GET /api/licenseStatus; set "Authenticity": "none" in a request to turn document-liveness checking off.

FAQ

Frequently Asked Questions

Does the Windows SDK send document data to the cloud?

No. Every stage of document recognition runs on your own server or directly on the device, depending on the platform – scanned documents never leave an environment you control.

How is the SDK licensed?

Licenses are offline and bound to a machine code, application ID, or bundle ID depending on the platform. Contact FacePlugin with that identifier to receive a license key – there are no per-call or per-scan fees once licensed.

Where can I see the full source and open an issue?

The Windows integration is maintained publicly on GitHub at github.com/Faceplugin-ltd, where you can browse the code, file issues, and track releases.

Related

Pairs Well With

Linux / Docker

On-premise REST API via Docker, no GPU required.

Android

Native Kotlin/Java SDK, fully on-device.

ID Document Recognition SDK

The full product overview across every platform.

Ready to Add Document Recognition to Your Windows App?

Talk to our team to get a license key and a 15-day evaluation period started.