Installation

Follow these steps to integrate Facephi's official plugin into your Capacitor-based application.

Prerequisites

Before integrating the Facephi plugin for Capacitor, verify that you meet the following:

• Capacitor CLI Version 6 or higher.

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

• Have the camera and internet connection permissions configured.

• Access to your credentials from the Administration Portal.

---

Step 1: Install the plugin

Execute:

npm install @facephi/sdk-<pluginName>-capacitor@<versión>
npm run build
npx cap sync

Replace <Version> with the latest available version that 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, Capacitor searches the Facephi repositories for the latest available version.

---

Step 2: Additional configuration

Native Android Installation Guide:

Android

---

Native iOS Installation Guide:

iOS

---

Next steps

• Review the Usage examples.

• Check the Changelog.

• If you have any questions, contact Technical Support.