🌐 Company Site - Here
🤗 Hugging Face - Here
🛟 Help Center - Here
🐳 Docker Hub - Here
Unzip
docsdk.framework.zipinto this folder → run on a physical iPhone (~10 min after Xcode is ready). Jump: Quick Start · Get the framework · Run the demo · License · Integrate
Use this for the sample app (check each box in order).
- Clone ID-Document-Recognition-iOS on a Mac
- Xcode 15+ (project compatibility Xcode 14; Swift 5)
- Download
docsdk.framework.zip— Get the framework - Unzip and put
docsdk.frameworknext toDocumentReader.xcodeproj(not the.zip) - Open DocumentReader.xcodeproj
- Set your Signing Team; keep bundle id
com.faceplugin.documentreader.appfor the demo license (until 12 Aug 2027) - Run on a physical iPhone (simulator is not recommended)
- Grant camera when asked
- Home status bar shows Ready → Camera / Gallery / About
Own app? → Setup on your own app. Full integration: https://doc.faceplugin.com
FacePlugin ID Document Recognition SDK for iOS is a fully on-device identity verification engine for ID cards, passports, and driver licenses. It delivers OCR, MRZ reading, barcode and QR extraction, live camera locate overlay, gallery capture (front required, optional back), document classification, image quality checks, extracted portraits and signatures, and authenticity / document liveness (security) checks.
This repository is the standalone iOS demo. The runtime is docsdk.framework (download from Google Drive). No other FacePlugin repository is required.
All processing stays on the iPhone. No biometric data is sent to FacePlugin cloud — built for KYC, eKYC, banking, and mobile onboarding that must stay private.
Native binaries are not on GitHub. Download the framework from the Drive link below.
| Feature | Supported |
|---|---|
| ID Card, Passport, and Driver License recognition | ✓ |
| MRZ, Barcode, QR, and OCR data extraction | ✓ |
| Live camera locate overlay + Capture | ✓ |
| Gallery (front required, back optional) | ✓ |
| Result (fields, Security, images, JSON) | ✓ |
| Authenticity / Security (document liveness) | ✓ |
| About | ✓ |
| Platform | Repository |
|---|---|
| Android | ID-Document-Recognition-Android |
| iOS | ID-Document-Recognition-iOS (this repo) |
| Windows | ID-Document-Recognition-Windows |
| Linux / Docker | ID-Document-Recognition-Docker |
| React Native | ID-Document-Recognition-React-Native |
| Flutter | ID-Document-Recognition-Flutter |
| Ionic Capacitor | ID-Document-Recognition-Ionic-Capacitor |
| Ionic Cordova | ID-Document-Recognition-Ionic-Cordova |
| Linux / Docker (Liveness) | ID-Document-Liveness-Detection-Docker |
| Step | What you need |
|---|---|
| 1 | Xcode 15+ and a physical iPhone (simulator is not recommended) |
| 2 | docsdk.framework in this folder — Get the framework |
| 3 | Demo license is already in the repo (licenseKey for com.faceplugin.documentreader.app, valid until 12 August 2027). Request a new key only if you change the bundle identifier — SDK License |
Camera and Gallery unlock when the status bar shows Ready.
| Item | Minimum | Recommended |
|---|---|---|
| Host | macOS with Xcode 15+, Swift 5.0 | Same |
| iOS | 13.0 (IPHONEOS_DEPLOYMENT_TARGET) |
16 or newer |
| Device | iPhone with A12 or newer | Recent iPhone |
| RAM | 4 GB | 6 GB or more |
| Camera | Rear camera | Auto-focus, 1080p |
| Device | Physical device | Same; simulator is not for camera |
docsdk.framework is a header stub on GitHub because the binary is too large. On Drive it is shipped as docsdk.framework.zip — unzip after you download.
DocumentReader-iOS-App runtime (Google Drive) — file: docsdk.framework.zip
git clone https://github.com/Faceplugin-ltd/ID-Document-Recognition-iOS.git
cd ID-Document-Recognition-iOS- Download
docsdk.framework.zipfrom the Drive folder. - Unzip it (double-click in Finder, or
unzip docsdk.framework.zip). You should get adocsdk.frameworkfolder — not the.zip. - Put
docsdk.frameworkhere (repo root, next toDocumentReader.xcodeproj— not in a nested folder, and not the zip file):
ID-Document-Recognition-iOS/
├── DocumentReader.xcodeproj
├── DocumentReader/
└── docsdk.framework/ ← unzipped (not .zip; engine is nested as Frameworks/dcrcore.framework)
If unzip creates docsdk.framework in Downloads, move that folder into this repo. You can delete the .zip afterward.
- Open DocumentReader.xcodeproj in Xcode.
- Set your Team for signing. Bundle ID is
com.faceplugin.documentreader.app. - Run on a device. The demo already has a valid
licenseKeyforcom.faceplugin.documentreader.app. - Wait for the status bar at the bottom of Home:
Loading native SDK…→ Ready. Camera and From Gallery stay disabled until then.
Home tiles are one row under the title: Camera | Gallery | About.
- Camera — live document locate overlay; tap Capture when the score is ready (≥ 50%) to run on-device OCR, MRZ, barcode, and authenticity checks.
- Gallery — pick Front (required) and Back (optional), then Recognize for two-sided ID processing.
- Result — tabs Result / Security / Images / Raw JSON for fields, liveness, crops, and the full JSON response.
Licenses are offline and bound to your bundle identifier.
The sample app already includes a valid key for com.faceplugin.documentreader.app (until 12 August 2027). You only need a new key if you use a different bundle identifier.
The code below shows how to use the license:
ID-Document-Recognition-iOS/DocumentReader/ViewController.swift
Lines 14 to 15 in be88a3a
ID-Document-Recognition-iOS/DocumentReader/ViewController.swift
Lines 147 to 149 in be88a3a
Please contact us to get a license for your own app.
After activation, getLicenseStatus reports what the key unlocks. Home shows the same summary on the status bar (for example Ready · Recognition + Liveness). About shows License: ….
| Capability | Meaning |
|---|---|
| Recognition | OCR, MRZ, barcode/QR, and document type classification |
| Liveness (authenticity) | Document authenticity: physical document, security patterns, photo origin, barcode format |
Typical labels:
- Recognition + Liveness — full identity verification (Result + Security tabs)
- Recognition — OCR, MRZ, and barcode only; Security stays empty / not checked
- Liveness — authenticity / document liveness only; OCR/MRZ/barcode stays empty / not checked
- Not licensed — until you activate
You need docsdk.framework and DocSDK. You do not need this demo’s ViewController / CameraViewController.
- Copy
docsdk.frameworkinto your project root (Drive). - In Xcode: General → Frameworks, Libraries, and Embedded Content → add it (Embed & Sign).
- Add a bridging header (Swift):
#import <docsdk/DocSDK.h>— Project Navigator → Build Settings → Swift Compiler - General → Objective-C Bridging Header. - Request a license for your bundle identifier, not the demo’s.
- Call
initSDKand all process methods off the main thread.
Full wiring, permissions, and result JSON: https://doc.faceplugin.com
// Bridging header: #import <docsdk/DocSDK.h>Call order (background queue): getMachineCode → setActivation → initSDK → getLicenseStatus → recognize / locateDocument. 0 = DocSDKSuccess. Process methods return JSON.
DispatchQueue.global(qos: .userInitiated).async {
var ret = DocSDK.setActivation("FP1.…")
if ret == 0 {
ret = DocSDK.initSDK()
}
}| Method | Role |
|---|---|
getMachineCode / setActivation / initSDK / deinitSDK |
License + engine lifecycle |
getLicenseStatus |
Recognition / Liveness flags + label |
locateDocument(_:) |
Live corners + score (overlay, no OCR) |
recognize(_:) |
OCR / MRZ / barcode from one image |
recognizeFront(_:back:authenticity:) |
Front + optional back (back may be nil) |
documentAuthenticity(_:) |
Authenticity via Authenticity: "normal" |
| Code | Constant | Status |
|---|---|---|
| 0 | DocSDKSuccess |
Activate / init OK |
| 1 | DocSDKLicenseInvalid |
Invalid license |
| 2 | DocSDKLicenseExpired |
Expired license |
| 3 | DocSDKNotActivated |
Not activated |
| 4 | DocSDKInitFailed |
Init failed |
