Ionic Cordova

Faceplugin Face Recognition Ionic Cordova SDK. On-premise face matching and liveness. Legacy Cordova plugin. Prefer Capacitor for new Ionic apps.

Fully on-premise Face Recognition SDK for Ionic Cordova. Plugin folder: Faceplugin/. Plugin id: face-recognition-cordova. Prefer Ionic Capacitor for new projects.

Demo package name: com.faceplugin.facerecognitionsdk.

Code

GitHub - Faceplugin-ltd/FaceRecognition-Ionic-Cordova: Face recognition SDK Ionic plugin with 3D passive liveness detection (Face Detection, Face Landmarks, Face Recognition, Face Liveness, Face Pose, Face Expression, Face attributes)GitHub

How to run

✅ Setup Environment

Node 18+, npm, Cordova CLI, JDK 17, Android SDK. iOS: macOS + Xcode 15+, physical iPhone. Put your Apple Team ID in build.json.

1. Install Node.js and npm

node -v
npm -v

2. Get the runtimes

• Android AAR: Google Drive → Faceplugin/src/android/facerecognitionsdk.aar

• iOS frameworks: Google Drive → Faceplugin/src/ios/Frameworks/

---

Running the sample on Android

npm install
ionic cordova plugin add ./Faceplugin
npm run setup:android
npm run android

Add camera permission in platforms/android/app/src/main/AndroidManifest.xml if it is not already present:

<uses-permission android:name="android.permission.CAMERA" />

Running the sample on iOS

npm install
ionic cordova plugin add ./Faceplugin
npm run setup:ios
npm run ios

Add NSCameraUsageDescription in Info.plist. Run on a physical iOS device.

APIs

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

setActivation: This API is used to activate the SDK

setActivation(license: string): Promise<number>

init: This API is used to initialize the SDK

init(): Promise<number>

getMachineCode: This API is used to retrieve the machine code

getMachineCode(): Promise<string>

faceDetection: This API is used to detect faces

faceDetection(image: ImageInput, param?: FaceDetectionParam): Promise<FaceBox[]>

templateExtraction: This API is used to extract face template

templateExtraction(image: ImageInput, faceBox: FaceBox): Promise<string>

similarity: This API is used to calculate similarity between two templates

similarity(feature1: string, feature2: string): Promise<number>

Also: getLicenseStatus, detect, extractFeature, quality, VideoWorker (startVideoWorker, ingestLiveCameraFrame, exportLastLiveFrame), deinit.

Integrate into your own app

Prefer Ionic Capacitor for new projects. For this Cordova plugin:

1. Place facerecognitionsdk.aar in Faceplugin/src/android/ and the three iOS frameworks in Faceplugin/src/ios/Frameworks/.

2. ionic cordova plugin add ./Faceplugin then npm run setup:android or setup:ios.

3. Keep demo id com.faceplugin.facerecognitionsdk or request a key for your id.

4. ionic serve cannot load the engine — run on a physical phone.

Request a License & Support · Contact us

FAQ

Legacy plugin? Yes. Prefer Ionic Capacitor for new apps.

Offline? Yes after activation with a license key bound to the Cordova app id.

Related documentation

• Faceplugin Face Recognition Mobile SDK · Ionic Capacitor · Glossary

• ID Document Recognition Ionic Cordova SDK

• Request a License · Status codes

• Combining products (eKYC) · SDK comparison