Plugin.Maui.Biometric

To use biometric authentication, you must declare the necessary permissions in your platform-specific configuration files for Android and iOS/macOS.

Android

Add the following permission to your AndroidManifest.xml:

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

iOS / macOS

Add the following key to your Info.plist to provide a reason for using FaceID:

<key>NSFaceIDUsageDescription</key>
<string>Need your face to unlock! </string>

<!-- Android: AndroidManifest.xml -->
<uses-permission android:name="android.permission.USE_BIOMETRIC" />

<!-- iOS/macOS: Info.plist -->
<key>NSFaceIDUsageDescription</key>
<string>Need your face to unlock! </string>

To add the biometric plugin to your .NET MAUI application, install the NuGet package using the Package Manager Console.

Install-Package Plugin.Maui.Biometric -Version xx.xx.xx

You must declare the necessary biometric permissions in your platform-specific configuration files. No runtime permission requests are required by this plugin.

<!-- Android: Add to AndroidManifest.xml -->
<uses-permission android:name="android.permission.USE_BIOMETRIC" />

<!-- iOS: Add to Info.plist -->
<key>NSFaceIDUsageDescription</key>
<string>Need your face to unlock! </string>

To use the plugin via Dependency Injection, register the BiometricAuthenticationService.Default singleton in your MauiProgram.cs file.

builder.Services.AddSingleton((e) => BiometricAuthenticationService.Default);

The plugin supports the following operating systems and versions: