Skip to content


How to install the Regula Face SDK.


  • The latest stable version of Visual Studio.

  • For iOS, the minimum target is iOS 11.0.

  • For Android, the minimum Android API level is 21.


The Face SDK is available on NuGet.

How to add the SDK to the project:


Install-Package Xamarin.Regula.FaceApi.iOS -Version 3.0.798
dotnet add package Xamarin.Regula.FaceApi.iOS --version 3.0.798
<PackageReference Include="Xamarin.Regula.FaceApi.iOS" Version="3.0.798" />
paket add Xamarin.Regula.FaceApi.iOS --version 3.0.798
#r "nuget: Xamarin.Regula.FaceApi.iOS, 3.0.798"
// Install Xamarin.Regula.FaceApi.iOS as a Cake Addin
#addin nuget:?package=Xamarin.Regula.FaceApi.iOS&version=3.0.798

// Install Xamarin.Regula.FaceApi.iOS as a Cake Tool
#tool nuget:?package=Xamarin.Regula.FaceApi.iOS&version=3.0.798


Install-Package Xamarin.Regula.FaceApi.Android -Version 3.0.1234
dotnet add package Xamarin.Regula.FaceApi.Android --version 3.0.1234
<PackageReference Include="Xamarin.Regula.FaceApi.Android" Version="3.0.1234" />
paket add Xamarin.Regula.FaceApi.Android --version 3.0.1234
#r "nuget: Xamarin.Regula.FaceApi.Android, 3.0.1234"
// Install Xamarin.Regula.FaceApi.Android as a Cake Addin
#addin nuget:?package=Xamarin.Regula.FaceApi.Android&version=3.0.1234

// Install Xamarin.Regula.FaceApi.Android as a Cake Tool
#tool nuget:?package=Xamarin.Regula.FaceApi.Android&version=3.0.1234

Huawei Vision

Huawei Vision is used for face detection in video stream using Huawei services.

Devices that do not have Google Mobile Services (GMS) such as Huawei need to include the Huawei Vision library. This means that to run the Face SDK on a Huawei device or any other device that has GMS disabled, it is necessary to integrate the Huawei Vision library. In this case, the Huawei or Honor device is automatically identified, and Huawei Vision is used.

The SetForceToUseHuaweiVision flag is used in the configuration to force the use of the Huawei Vision library, it works only if the library is connected. So, on a device that is not Huawei and does not have Google Mobile Services, the Face SDK can work via the Huawei services.

LivenessConfiguration.Builder builder = new LivenessConfiguration.Builder();
            FaceSDK.Instance().StartLiveness(Android.App.Application.Context, builder.Build(), this);

The same way, you can use SetForceToUseHuaweiVision with PresentFaceCaptureActivity() and MatchFaces() implying FaceCaptureConfiguration.Builder and MatchFaceConfiguration.Builder respectively.