Capabilities
Faceplugin ID Document SDK capabilities: passport OCR / MRZ, document authenticity (Recognition + Liveness license), and authenticity-only Document Liveness on port 8086.
What the Faceplugin ID Document SDK can do — recognition, liveness (authenticity-only), and recognition + liveness — before you pick a platform.
Recognition + Liveness
OCR plus document authenticity in one Document Reader engine
All processing stays on the device or on your server. Document images are not sent to a Faceplugin cloud.
Recognition
Passport OCR and MRZ reading
Faceplugin reads passports (including ePassport data pages) with visual-zone OCR and ICAO-style MRZ parsing (TD1 / TD2 / TD3 style zones where the template supports them).
Typical outputs include document number, names, dates, nationality, and check digits — returned in the same JSON shape on every platform. See Document result JSON.
APIs: mobile recognize / documentProcess; server POST /api/documentRecognition and POST /api/documentProcess on port 8082.
National ID and driver license verification
The same engine classifies and reads national ID cards, driver licenses, and related credentials. You do not pre-select country or series for typical stills — the SDK identifies the document type, then runs OCR / MRZ / barcode as the template allows.
Barcode and QR parsing
Where the document template defines them, Faceplugin decodes 1D/2D barcodes and QR codes and maps payload fields into the result JSON (for example PDF417 on many North American licenses).
Document type classification — worldwide coverage
Faceplugin classifies 16,900 document templates across 255 countries and territories: passports, IDs, licenses, visas, residence permits, and specialized cards.
Confirm an uncommon series with support if needed.
Image quality, crop, and portrait extraction
The engine can assess capture quality, locate the document, and return cropped document images plus portrait (and signature when present) for downstream face match or archival storage in your database.
Recognition API (port 8082)
GET /api/machinecode
Machine code
POST /api/activate
Activate license
POST /api/documentRecognition
OCR / MRZ / barcode
POST /api/documentProcess
Combined pipeline
Images: Linux faceplugin/document-reader, Windows.
Liveness (authenticity only)
Dedicated ID Document Liveness checks whether the image is a physical ID or an attack (screen replay, printout, digital source, substituted portrait). No OCR / MRZ / barcode.
Public SDK today: Linux / Docker on port 8086
Route:
POST /api/documentLivenessafterPOST /api/activateField names: Document security check fields
This is not face anti-spoofing — use the Face SDK for selfies.
Recognition + Liveness
With a Liveness-capable license, the Document Reader engine runs document authenticity alongside OCR on the same process (port 8082 / mobile). Same security field names as Document Liveness.
Prefer authenticity without reading fields? Use dedicated Liveness on 8086.
Which mode to pick
Passport OCR / MRZ / barcode
Recognition
Authenticity gate without reading PII
Liveness (8086)
OCR and authenticity in one Document Reader engine
Recognition + Liveness
eKYC: document then face
Capture ID → Document Recognition (8082 or mobile).
Optional document authenticity (same engine or Document Liveness 8086).
Capture selfie → Face SDK liveness / match (8084 / 8083 / mobile).
Compare portrait crop to selfie with Face Recognition.
See Combining products.
Platforms
Recognition
OCR via Document Reader — install under Recognition + Liveness
Liveness
Server (Linux 8086, authenticity only)
Use cases
Passport OCR / MRZ — read travel documents on-device or on port 8082
ID card and license verification — classify and extract fields for KYC
Authenticity gate — reject screen / print attacks before or with OCR
Split architecture — Document Liveness 8086 + OCR in another service
FAQ
Is this a passport OCR SDK? Yes — on-premise passport OCR and MRZ, plus ID cards and licenses.
Does Faceplugin read the MRZ? Yes, when the document template includes an MRZ.
How many document types are supported? 16,900 templates in 255 countries and territories — see the PDF above.
Does Document Liveness read the MRZ? No. Use Recognition for OCR / MRZ.
Related documentation
Last updated