3rd Party Frameworks Guide

Learn how to integrate the FaceTec SDKs with 3rd Party Frameworks.

React Framework

To integrate with the React Framework, we recommend that you first download the FaceTec Browser SDK React JS Babel Sample App, the FaceTec Browser SDK React TypeScript Sample App, or the FaceTec Browser SDK React Next.js Sample App. The React Sample Apps should be your primary reference for gaining an understanding of how to integrate the FaceTec SDKs into an app using the React Framework.

Angular Framework

To integrate with the Angular Framework, we recommend that you first download the FaceTec Browser SDK Angular Sample App. The Angular Sample App should be your primary reference for gaining an understanding of how to integrate the FaceTec SDKs into an app using the Angular Framework.

The FaceTec Angular Sample App imports the FaceTec SDK via the scripts property in its angular.json file. This is the proper way to import the FaceTec SDK into any Angular App.

Important Note: Older versions of Angular allowed the FaceTec SDK to be imported within the Angular App JavaScript files. In 2023, Angular shipped breaking changes that no longer permit the particular import style the FaceTec SDK requires. The FaceTec Angular Sample App demonstrates how to properly import scripts in the angular.json file. The FaceTec SDK should also not be imported in the Processor, Sample App, and Theme Helpers files. Importing the FaceTec SDK in these files will prevent the FaceTec Angular Sample App from building.

Vite Framework

To integrate with the Vite Framework, we recommend that you first download the FaceTec Browser SDK Vite Sample App. The Vite Sample App should be your primary reference for gaining an understanding of how to integrate the FaceTec SDKs into an app using the Vite Framework.

React Native Framework

To integrate with the React Native Framework, FaceTec recommends that you first download the FaceTec Android/iOS SDK React Native Sample App. The React Native Sample App demonstrates the ability to perform 3D Liveness Checks from both iOS and Android Apps using the FaceTec SDKs. It serves as an excellent starting point for a React Native project, but is not an exhaustive implementation. Please see the Android and iOS Sample Apps for additional detailed examples of FaceTec functionality that can be ported to Your App.

The React Native Framework is supported by the FaceTec SDKs via its native plugins system, Native Modules. Native Modules should do a majority of the work needed to make the FaceTec SDKs functional in Your App.

Flutter Framework

Before integrating the FaceTec SDKs into Your App, FaceTec recommends that developers first download the FaceTec Android/iOS SDK Flutter Sample App.

The FaceTec Android/iOS SDK Flutter Sample App demonstrates how to perform 3D Liveness Checks and ID Scans with both iOS and Android Apps using the FaceTec SDKs. It serves as an excellent starting point for a Flutter project, but is not an exhaustive implementation. Please see the Android and iOS Sample Apps for additional detailed examples of FaceTec functionality that can be ported to Your App.

The Flutter Framework is supported by the FaceTec SDKs via its native plugins system involving Platform-Specific Code. The Flutter Plugins should do a majority of the work needed to make the FaceTec SDKs functional in Your App.

Stencil Framework

Before integrating the FaceTec SDKs into Your App, FaceTec recommends that developers first download the FaceTec Browser SDK Stencil Sample App.

The FaceTec Browser SDK Stencil Sample App demonstrates how to perform 3D Liveness Checks with Browser Apps using the FaceTec SDKs. It serves as an excellent starting point for a Stencil project, but is not an exhaustive implementation. Please see the Browser Sample App for additional detailed examples of FaceTec functionality that can be ported to Your App.

Important Note: The Stencil JS Build Process applies some read-only properties to the FaceTec Browser SDK, which will throw read-only errors during execution. The FaceTec Browser SDK can be loaded as a script element to prevent these errors from being thrown.

Cordova Framework

The Cordova Framework is supported by the FaceTec SDKs via its native plugins system, which you can learn more about in the Cordova Plugin Development Guide. The Cordova Plugins should do a majority of the work needed to make the FaceTec SDKs functional in Your App.

FaceTec does not currently provide a Cordova Sample App, and as such, can only provide limited assistance with regards to the Cordova Framework. To learn more about integrating with the Cordova Framework, we recommend going through the Apache Software Foundation Documentation, as well as the multitude of tutorials available online.

Xamarin/.NET Maui Framework

The Xamarin and .NET Maui Frameworks are supported by the FaceTec SDKs via their native plugins system, Native Libraries. Native Libraries should do a majority of the work needed to make the FaceTec SDKs functional in Your App.

FaceTec does not currently provide a Xamarin/.NET Maui Sample App, and as such, can only provide limited assistance with regards to the Xamarin and .NET Maui Frameworks. To learn more about integrating with these frameworks, we recommend going through Microsoft's Xamarin Documentation and .NET Maui Documentation, as well as the multitude of tutorials available online.

Ionic Framework

The Ionic Framework is supported by the FaceTec SDKs via its native plugins system, Native. Native should do a majority of the work needed to make the FaceTec SDKs functional in Your App.

FaceTec does not currently provide an Ionic Sample App, and as such, can only provide limited assistance with regards to the Ionic Framework. To learn more about integrating with the Ionic Framework, we recommend going through the Ionic Framework Documentation, as well as the multitude of tutorials available online.

Unity Framework

The Unity Framework is supported by the FaceTec SDKs via its native plugins system, Native Plug-in for iOS and Native Plug-in for Android. These Native Plugins should do a majority of the work needed to make the FaceTec SDKs functional in Your App.

FaceTec does not currently provide a Unity Sample App, and as such, can only provide limited assistance with regards to the Unity Framework. To learn more about integrating with the Unity Framework, we recommend going through the Unity Documentation, as well as the multitude of tutorials available online.


3rd Party Frameworks Integration & Support

All the 3rd Party Frameworks Sample Apps are verified to build and run, but may only demonstrate a small subset of FaceTec functionalities. FaceTec Partners & Customers are responsible for getting area-experts for these 3rd Party Frameworks to implement any missing FaceTec functionality not present in the Sample Apps.

If you experience problems when integrating, FaceTec recommends building and running the SDK Sample App for the specific platform you are working on (Android, Browser, iOS) and porting the Sample App's Functionality into Your Own Application by making only the minimum changes necessary.