# BiometricManager

Artifact: [androidx.biometric:biometric](https://developer.android.com/jetpack/androidx/releases/biometric) [View Source](https://cs.android.com/search?q=file:androidx/biometric/BiometricManager.java+class:androidx.biometric.BiometricManager) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.0.0)

*** ** * ** ***


```
class BiometricManager
```

<br />

*** ** * ** ***

A class that provides system information related to biometrics (e.g. fingerprint, face, etc.).

On devices running Android 10 (API 29) and above, this will query the framework's version of `https://developer.android.com/reference/android/hardware/biometrics/BiometricManager.html`. On Android 9.0 (API 28) and prior versions, this will query .

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt` | To prompt the user to authenticate with their biometric. |

## Summary

| ### Nested types |
|---|
| `interface https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager.Authenticators` Types of authenticators, defined at a level of granularity supported by `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager` and `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt`. |
| `class https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager.Strings` Provides localized strings for an application that uses `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricPrompt` to authenticate the user. |

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#BIOMETRIC_ERROR_HW_UNAVAILABLE() = 1` The user can't authenticate because the hardware is unavailable. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#BIOMETRIC_ERROR_IDENTITY_CHECK_NOT_ACTIVE() = 20` Identity Check is currently not active. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#BIOMETRIC_ERROR_NONE_ENROLLED() = 11` The user can't authenticate because no biometric or device credential is enrolled. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#BIOMETRIC_ERROR_NO_HARDWARE() = 12` The user can't authenticate because there is no suitable hardware (e.g. no biometric sensor or no keyguard). |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED() = 15` The user can't authenticate because a security vulnerability has been discovered with one or more hardware sensors. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#BIOMETRIC_ERROR_UNSUPPORTED() = -2` The user can't authenticate because the specified options are incompatible with the current Android version. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#BIOMETRIC_STATUS_UNKNOWN() = -1` Unable to determine whether the user can authenticate. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#BIOMETRIC_SUCCESS() = 0` The user can successfully authenticate. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `[canAuthenticate](https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#canAuthenticate())()` **This function is deprecated.** Use `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#canAuthenticate(int)` instead. <br /> |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#canAuthenticate(int)(authenticators: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Checks if the user can authenticate with an authenticator that meets the given requirements. |
| `java-static https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#from(android.content.Context)(context: https://developer.android.com/reference/android/content/Context.html)` Creates a `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager` instance from the given context. |
| `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager.Strings?` | `@https://developer.android.com/reference/kotlin/androidx/annotation/RequiresPermission(value = https://developer.android.com/reference/android/Manifest.permission.html#USE_BIOMETRIC) https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#getStrings(int)(authenticators: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Produces an instance of the `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager.Strings` class, which provides localized strings for an application, given a set of allowed authenticator types. |

## Constants

### BIOMETRIC_ERROR_HW_UNAVAILABLE

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.0.0)

```
const val BIOMETRIC_ERROR_HW_UNAVAILABLE = 1: Int
```

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

### BIOMETRIC_ERROR_IDENTITY_CHECK_NOT_ACTIVE

Added in [1.4.0-beta01](https://developer.android.com/jetpack/androidx/releases/biometric#1.4.0-beta01)

```
const val BIOMETRIC_ERROR_IDENTITY_CHECK_NOT_ACTIVE = 20: Int
```

Identity Check is currently not active. 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.

### BIOMETRIC_ERROR_NONE_ENROLLED

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.0.0)

```
const val BIOMETRIC_ERROR_NONE_ENROLLED = 11: Int
```

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

### BIOMETRIC_ERROR_NO_HARDWARE

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.0.0)

```
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).

### BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.1.0)

```
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.

### BIOMETRIC_ERROR_UNSUPPORTED

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.1.0)

```
const val BIOMETRIC_ERROR_UNSUPPORTED = -2: Int
```

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

### BIOMETRIC_STATUS_UNKNOWN

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.1.0)

```
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.

### BIOMETRIC_SUCCESS

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.0.0)

```
const val BIOMETRIC_SUCCESS = 0: Int
```

The user can successfully authenticate.

## Public functions

### canAuthenticate

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.0.0) Deprecated in [1.1.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.1.0)

```
fun [canAuthenticate](https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#canAuthenticate())(): Int
```

> [!CAUTION]
> **This function is deprecated.**   
>
> Use `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#canAuthenticate(int)` instead.

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

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#BIOMETRIC_SUCCESS()` if the user can authenticate with biometrics. Otherwise, returns an error code indicating why the user can't authenticate, or `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#BIOMETRIC_STATUS_UNKNOWN()` if it is unknown whether the user can authenticate. |

### canAuthenticate

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.1.0)

```
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 `https://developer.android.com/reference/android/app/KeyguardManager.html#isDeviceSecure()`.

| Parameters |
|---|---|
| `authenticators: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | A bit field representing the types of `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager.Authenticators` that may be used for authentication. Value is either `0` or a combination of the following: - `Authenticators.BIOMETRIC_STRONG` - `Authenticators.BIOMETRIC_WEAK` - `Authenticators.DEVICE_CREDENTIAL` - `Authenticators.IDENTITY_CHECK` <br /> |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#BIOMETRIC_SUCCESS()` if the user can authenticate with an allowed authenticator. Otherwise, returns `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager#BIOMETRIC_STATUS_UNKNOWN()` or an error code indicating why the user can't authenticate. |

### from

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/biometric#1.0.0)

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

Creates a `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager` instance from the given context.

| Parameters |
|---|---|
| `context: https://developer.android.com/reference/android/content/Context.html` | The application or activity context. |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager` | An instance of `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager`. |

### getStrings

Added in [1.4.0-beta01](https://developer.android.com/jetpack/androidx/releases/biometric#1.4.0-beta01)

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

Produces an instance of the `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager.Strings` class, which provides localized strings for an application, given a set of allowed authenticator types.

| Parameters |
|---|---|
| `authenticators: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | A bit field representing the types of `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager.Authenticators` that may be used for authentication. Value is either `0` or a combination of the following: - `Authenticators.BIOMETRIC_STRONG` - `Authenticators.BIOMETRIC_WEAK` - `Authenticators.DEVICE_CREDENTIAL` - `Authenticators.IDENTITY_CHECK` <br /> |

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager.Strings?` | A `https://developer.android.com/reference/kotlin/androidx/biometric/BiometricManager.Strings` collection for the given allowed authenticator types. |