FacePlugin
Get in Touch
iOS

ID Document Recognition SDK for iOS

An on-device iOS SDK for scanning ID cards, passports, and driver licenses – OCR, MRZ, and barcode/QR recognition, fully on-premise with no document data ever sent to the cloud.

Fully on-deviceSwift SDKNo 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 iOS

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

Host / toolchainmacOS, Xcode 15+ (compatible with Xcode 14), Swift 5.0
Minimum iOS version13.0 (16+ recommended)
DeviceiPhone with an A12 chip or newer, 4 GB RAM min / 6 GB+ recommended
CameraRear camera, 1080p + autofocus recommended
Test deviceA physical iPhone – the simulator is not recommended
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 on a Mac and install Xcode 15+.
  • Download docsdk.framework.zip, unzip it, and place docsdk.framework next to DocumentReader.xcodeproj.
  • Open the project, set your signing team (the demo license is scoped to the com.faceplugin.documentreader.app bundle ID), run on a physical iPhone, and wait for “Ready.”
swift
DispatchQueue.global(qos: .userInitiated).async {
    var ret = DocSDK.setActivation(licenseKey)
    if ret == 0 {
        ret = DocSDK.initSDK()  // 0 = success
    }
}

// recognize(_:) returns OCR / MRZ / barcode data from one document image
Licensing

How Licensing Works

Licenses are offline and bound to your app's bundle ID. The bundled demo key (for com.faceplugin.documentreader.app) is valid until 12 Aug 2027 – contact FacePlugin for a key scoped to your own app.

FAQ

Frequently Asked Questions

Does the iOS 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 iOS 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

Android

Native Kotlin/Java SDK, fully on-device.

Flutter

One plugin for Android and iOS.

ID Document Recognition SDK

The full product overview across every platform.

Ready to Add Document Recognition to Your iOS App?

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