For the complete documentation index, see llms.txt. This page is also available as Markdown.

Installation

Integrate Facephi biometric solutions into your hybrid Cordova-based applications quickly and with iOS and Android compatibility.

Prerequisites

Before integrating the Plugin from Facephi for Cordova, verify that you meet the following requirements:

  • Cordova CLI Version 11 or higher.

  • Project configured for Android (AGP 8.9.x and Kotlin 2.2.x) and/or iOS (13+).

  • Have camera and internet connection permissions configured.

  • Access your credentials from the Administration Portal.


Plugin installation

Run the following command at the root of your Cordova project:

cordova plugin add @facephi/sdk-<pluginName>-cordova@<versión>

Replace <Version> for the latest available version, which you can check in the Changelog, and <pluginName> with the name of the component to install.

This command downloads and installs the official Facephi Plugin compatible with Android and iOS. If @<Version> is not added, Cordova looks in Facephi's repositories for the latest available version.


Additional configuration

Native installation guide for Android:

Android

Native installation guide for iOS:

iOS

Next steps

  • Check the Usage examples to implement verification flows.

  • See the Changelog to learn about the latest versions and changes.

  • Learn more about the functionality of the SDK in the Components/modules.

  • If you have any questions, contact Technical Support.

Last updated