FacePlugin
Get in Touch
Linux / Docker

ID Document Liveness Detection SDK for Linux & Docker

Confirm a scanned ID card, passport, or driver license is a genuine physical document – not a screen replay, printed copy, or digitally altered image – in a single Docker container on your own Linux server.

Get in Touch View on GitHub
CPU-only, no GPU requiredREST API via DockerNo per-call fees
PASSPORT• UTOPIA
Passport photo
SURNAME

ANDERSON

GIVEN NAMES

JAMES M.

DATE OF BIRTH

14 MAR 1990

DOCUMENT NO.

P4472109

P<UTOANDERSON<<JAMES<<<<<<<<
P4472109<3UTO9003148M3009122<<<<06
MRZ Verified✓
Barcode Valid✓
OCR Complete✓
Identity Verified
Platform Coverage

Why This Is the Only Platform Page

ID Document Liveness Detection ships as its own dedicated repository on Linux/Docker only. On Windows, Android, iOS, Flutter, React Native, and Ionic, the same document-liveness check is a license-gated feature bundled inside the ID Document Recognition SDK for that platform, rather than a separate product – see that platform's own integration page for the documentLiveness / Authenticity call.

Requirements

What You Need to Run It on Linux

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

Host OSLinux with Docker Engine, Windows, or macOS (Docker); native install needs glibc 2.38+
Architecturelinux/amd64, CPU-only (no GPU build)
RuntimeNative libraries/models downloaded separately into lib/cpu/
Quick Start

Install and Activate

Install the SDK, then activate it with a license key before calling any document-liveness function.

  • Docker: docker pull faceplugin/document-liveness:latest, then run it with --shm-size=2gb --privileged on port 8086 (mount /etc/machine-id on Linux hosts; skip on Docker Desktop).
  • Local (non-Docker): clone the repo, pip install -r requirements.txt, then ./run.sh.
  • Check GET /api/health, get your machine code from the startup log or GET /api/machinecode, then activate with POST /api/activate and your license key.
bash
# Activate with your license key
curl -s -X POST http://127.0.0.1:8086/api/activate \
  -H "Content-Type: text/plain" \
  --data-binary @license.txt

# Check document liveness
curl -s -X POST http://127.0.0.1:8086/api/documentLiveness \
  -H "Content-Type: application/json" \
  -d '{"images": [{"image": "<base64-front>"}, {"image": "<base64-back>"}]}' 
Licensing

How Licensing Works

Licenses are fully offline and bound to a machine code – Docker and local installs get different machine codes, so request a key for whichever environment runs in production. No images or biometric data are sent to FacePlugin as part of activation or inference.

FAQ

Frequently Asked Questions

Does the Linux / Docker SDK send document images to the cloud?

No. Every document-liveness check runs in a Docker container on your own server – images never leave an environment you control.

How is the SDK licensed?

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 – there are no per-call fees once licensed.

What spoof types does it catch?

Screen replays, printed copies, digitally generated forgeries, and portrait substitution, checked across photo origin, physical-document verification, digital-source detection, and security patterns. It works on both the front and back of multi-page documents.

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

The Linux/Docker 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

Ready to Add Document Liveness to Your Linux Stack?

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

Contact Sales Explore the SDKs