Access a Mobile Device’s Biometrics Capabilities

A Lightning web component can use a device’s biometrics functionality to prompt a user to confirm their identity. When these biometrics-related actions occur, the result is returned to the Lightning web component that invoked it.

Biometrics checks are managed locally on the mobile device, and don’t need a network connection. However, BiometricsService requires access to platform-specific APIs that are available only within compatible Salesforce mobile apps.

BiometricsService does not and cannot function when running in a web browser, whether on a desktop or mobile device.

Important

BiometricsService User Experience

Your component can deliver any user experience you desire, but there’s a common flow for any component that calls for a biometrics check.
Use the BiometricsService API

To develop a Lightning web component with biometrics-checking features, use the BiometricsService API as your method for accessing a device’s native biometrics functionality.
BiometricsService Example

Here’s a basic example of a Lightning web component that uses a device’s biometrics capabilities to verify device ownership.
Compatibility and Requirements

BiometricsService is a JavaScript module that provides an API to Lightning web components to make mobile hardware and platform (operating system) features available in JavaScript. It requires access to device hardware and device platform APIs. This access is only available when BiometricsService runs within a compatible Salesforce mobile app. It does not and cannot function when running in a standard web browser, whether the browser runs on a desktop or mobile device.
Considerations and Limitations

Consider these guidelines and limitations when developing features that use the BiometricsService API.

See Also

Lightning Web Components Developer Guide: BiometricsService API