Get in Touch

Solutions Biometric Authentication ID Verification & eKYC Products All SDKs Face Recognition SDK Face Liveness Detection SDK Deepfake Detection SDK ID Document Recognition SDK ID Liveness Detection SDK ID Verification SDK Suite Pricing Resources Blogs Documentation About Us

Linux

ID Document Recognition SDK for Linux & Docker

Run OCR, MRZ, and barcode document recognition in a single Docker container on your own Linux server, exposed as a local REST API. No document images or extracted data ever leave your infrastructure.

Get in Touch View on GitHub

CPU-only, no GPU requiredREST API via DockerNo per-call fees

PASSPORT• AURORIA

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 Linux

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

Host OSUbuntu 20.04+ x86_64 (min), Ubuntu 22.04 / 24.04 (recommended)

CPU / RAM / Disk (min)2 cores / 4 GB / 4 GB

CPU / RAM / Disk (recommended)4 cores / 8 GB / 8 GB

Architecturelinux/amd64, CPU-only (local non-Docker install needs glibc 2.38+)

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.

Pull and run the Docker image: docker pull faceplugin/document-reader:latest.
Run the container with --shm-size=2gb --privileged on port 8082, mounting /etc/machine-id (skip this mount on Docker Desktop).
Check GET /api/health to confirm it's up, then send your machine code to FacePlugin for a license key and activate with POST /api/activate.

bash

# Health check
curl -s http://127.0.0.1:8082/api/health

# Activate with your license key
curl -s -X POST http://127.0.0.1:8082/api/activate \
  -H "Content-Type: text/plain" \
  --data-binary @license.txt

# Recognize a document
curl -s -X POST http://127.0.0.1:8082/api/documentRecognition \
  -H "Content-Type: application/json" \
  -d '{"images": [{"image": "<base64-jpeg>"}]}'

Licensing

How Licensing Works

Licenses are offline and bound to a machine code – Docker and local-host installs get different machine codes, so request a key for whichever environment runs in production. License tiers cover Recognition, Liveness, or both. Unlimited on-premises inference, no per-call fees.

FAQ

Frequently Asked Questions

Does the Linux 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 Linux integration is maintained publicly on GitHub at github.com/Faceplugin-ltd, where you can browse the code, file issues, and track releases.

Ready to Add Document Recognition to Your Linux App?

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

Contact Sales Explore the SDKs