iOS

Faceplugin ID Document Recognition iOS SDK. On-premise OCR, MRZ, and authenticity. docsdk.framework, setActivation, initSDK, locateDocument, recognize.

Fully on-premise ID Document Recognition SDK for iOS. Native class: DocSDK. Demo bundle: com.faceplugin.documentreader.app.

Code

GitHub - Faceplugin-ltd/ID-Document-Recognition-iOS: On-device ID document recognition SDK for iOS — scan ID cards, passports, and driver licenses with OCR, MRZ, barcode, and QR recognition. Fully on-premise with no biometric data sent to the cloud.GitHub

Setup

1. Unzip docsdk.framework.zip from Google Drive next to DocumentReader.xcodeproj. Engine may nest as Frameworks/dcrcore.framework inside docsdk.framework.

2. Add docsdk.framework to the project in Xcode (Embed & Sign). Bridging: #import <docsdk/DocSDK.h>.

3. Set your Signing Team. Physical iPhone, iOS 13+, Xcode 15+.

Status codes: 0 Success, 1 Invalid license, 2 Expired, 3 Not activated, 4 Init failed.

APIs

setActivation: This API is used to activate the SDK

+(int)setActivation:(NSString*)license;

initSDK: This API is used to initialize the SDK

+(int)initSDK;

getMachineCode: This API is used to retrieve the machine code

+(NSString*)getMachineCode;

getLicenseStatus: This API is used to read recognition and authenticity flags

+(NSString*)getLicenseStatus;
+(NSString*)lastLicenseError;

locateDocument: This API is used to find document corners on a preview frame

+(NSString*)locateDocument:(UIImage*)image;

No OCR. Overlay only.

recognize: This API is used to run FullProcess

+(NSString*)recognize:(UIImage*)image;
+(NSString*)recognize:(UIImage*)image authenticity:(BOOL)authenticity;
+(NSString*)recognize:(UIImage*)image authenticityMode:(NSString*)mode;
+(NSString*)recognizeFront:(UIImage*)front back:(UIImage*)back authenticityMode:(NSString*)mode;

documentRecognition: This API is used to run OCR / MRZ / barcode / image quality only

+(NSString*)documentRecognition:(UIImage*)image;
+(NSString*)documentRecognitionFront:(UIImage*)front back:(UIImage*)back;

documentLiveness: This API is used to run authenticity / security only

+(NSString*)documentLiveness:(UIImage*)image;
+(NSString*)documentLivenessFront:(UIImage*)front back:(UIImage*)back;

startNewSession: This API is used to open a FullProcess session before recognize

+(NSString*)startNewSession:(NSString*)optionsJson;

deinitSDK: This API is used to unload the engine

+(NSString*)deinitSDK;

Run the demo

1. Unzip docsdk.framework.zip next to DocumentReader.xcodeproj. Engine may nest as Frameworks/dcrcore.framework inside docsdk.framework.

2. Keep demo bundle com.faceplugin.documentreader.app.

3. Physical iPhone, iOS 13+, Xcode 15+.

4. Home: Camera, Gallery, About. Result JSON matches Document result JSON.

License

Licenses are offline. Request a new license key for your own app.

Request a License & Support · Contact us

FAQ

Passport OCR on iOS? Yes. recognize returns OCR, MRZ, barcode, and crops.

Offline? Yes after setActivation / initSDK for bundle com.faceplugin.documentreader.app (or your own license key).

Related documentation

• Faceplugin ID Document Recognition Mobile SDK · Android · Glossary

• Face Recognition iOS SDK

• Face Liveness Detection iOS SDK

• Document result JSON

• Request a License · Status codes

• Combining products (eKYC) · SDK comparison