BiometricManager

const val BIOMETRIC_ERROR_HW_UNAVAILABLE = 1: Int

The user can't authenticate because the hardware is unavailable. Try again later.

const val BIOMETRIC_ERROR_IDENTITY_CHECK_NOT_ACTIVE = 20: Int

Identity Check is currently not active. Restrict to library for now. This device either doesn't have this feature enabled, or it's not considered in a high-risk environment that requires extra security measures for accessing sensitive data.

const val BIOMETRIC_ERROR_NONE_ENROLLED = 11: Int

The user can't authenticate because no biometric or device credential is enrolled.

const val BIOMETRIC_ERROR_NO_HARDWARE = 12: Int

The user can't authenticate because there is no suitable hardware (e.g. no biometric sensor or no keyguard).

const val BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED = 15: Int

The user can't authenticate because a security vulnerability has been discovered with one or more hardware sensors. The affected sensor(s) are unavailable until a security update has addressed the issue.

const val BIOMETRIC_ERROR_UNSUPPORTED = -2: Int

The user can't authenticate because the specified options are incompatible with the current Android version.

const val BIOMETRIC_STATUS_UNKNOWN = -1: Int

Unable to determine whether the user can authenticate.

This status code may be returned on older Android versions due to partial incompatibility with a newer API. Applications that wish to enable biometric authentication on affected devices may still call BiometricPrompt#authenticate() after receiving this status code but should be prepared to handle possible errors.

const val BIOMETRIC_SUCCESS = 0: Int

The user can successfully authenticate.

fun canAuthenticate(): Int

Checks if the user can authenticate with biometrics. This requires at least one biometric sensor to be present, enrolled, and available on the device.

fun canAuthenticate(authenticators: Int): Int

Checks if the user can authenticate with an authenticator that meets the given requirements. This requires at least one of the specified authenticators to be present, enrolled, and available on the device.

Note that not all combinations of authenticator types are supported prior to Android 11 (API 30). Specifically, DEVICE_CREDENTIAL alone is unsupported prior to API 30, and BIOMETRIC_STRONG | DEVICE_CREDENTIAL is unsupported on API 28-29. Developers that wish to check for the presence of a PIN, pattern, or password on these versions should instead use isDeviceSecure.

java-static fun from(context: Context): BiometricManager

Creates a BiometricManager instance from the given context.

@RequiresPermission(value = Manifest.permission.USE_BIOMETRIC)
fun getStrings(authenticators: Int): BiometricManager.Strings?

Produces an instance of the Strings class, which provides localized strings for an application, given a set of allowed authenticator types.