Salesforce Docs Portal

Identify a User with a Mobile Device’s Biometrics Capabilities

To access a device’s native biometrics functionality for additional authentication, develop a Lightning web component for your Experience Cloud app that uses BiometricsService API.

You can incorporate biometric ID checks for features of your app that require additional authentication by developing a Lightning web component with BiometricsService API. For example, you can add a component that uses BiometricsService API to a site page that requires authentication before making a payment.

Note
Note The biometric ID check is local to the device and validates the identity of the user, but the biometric ID check doesn’t authenticate the user to the service.

Building biometrics-based functionality using BiometricsService API works only in the mobile app, not in the web version on mobile or desktop.

To allow users to log in to your app with biometric ID credentials, enable biometric ID app unlock. Use BiometricsService API to add biometric ID checks beyond your app’s login page.

Using BiometricsService API in your Experience Cloud app comprises two main tasks.

  1. Develop a Lightning web component that uses BiometricsService API according to your app’s scenarios for biometric ID checks. See Access a Mobile Device’s Biometrics Capabilities in the Mobile and Offline Developer Guide.
  2. In Experience Builder, add the Lightning web component to the applicable pages on your Experience Cloud site. See Edit Pages and Components in Experience Builder for more information.
Note
Note For iOS apps, you can customize the description that’s shown to app users when your app requests permission to use the device’s Face ID. In the iOS App Permissions for Device Capabilities section of your app’s Setup for Mobile Publisher project, you can edit the permission description for Face ID.