# AuthenticationRequest.Biometric

Artifact: [androidx.biometric:biometric](https://developer.android.com/jetpack/androidx/releases/biometric) [View Source](https://cs.android.com/search?q=file:androidx/biometric/AuthenticationRequest.kt+class:androidx.biometric.AuthenticationRequest.Biometric) Added in [1.4.0-beta01](https://developer.android.com/jetpack/androidx/releases/biometric#1.4.0-beta01)

*** ** * ** ***


```
public final class AuthenticationRequest.Biometric extends AuthenticationRequest
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.biometric.AuthenticationRequest](https://developer.android.com/reference/androidx/biometric/AuthenticationRequest) ||
|   | ↳ | [androidx.biometric.AuthenticationRequest.Biometric](https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric) |

*** ** * ** ***

A set of configurable options for how the `https://developer.android.com/reference/androidx/biometric/BiometricPrompt` should appear and behave with biometric authentication with fallbacks.

## Summary

| ### Nested types |
|---|
| `public final class https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Builder` Builder used to create an instance of `https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric`. |
| `public abstract class https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Fallback` Fallback options for the biometric authentication. |
| `public final class https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Fallback.CustomOption extends https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Fallback` Custom Fallback option displayed as the negative button in prompt authentication screen if it is the only option or displayed in a list in the fallback options page if there are more than one. |
| `public static class https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Fallback.DeviceCredential extends https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Fallback` Device credential as the fallback. |
| `public abstract class https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Strength` Types of biometric strength for the prompt. |
| `public static class https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Strength.Class2 extends https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Strength` Class 2 (formerly Weak). |
| `public final class https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Strength.Class3 extends https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Strength` Class 3 (formerly Strong). |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Fallback>` | `https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric#getAuthFallbacks()()` The `https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Fallback` options for the biometric authentication. |
| `final https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.BodyContent` | `https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric#getContent()()` The optional `https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.BodyContent` of the prompt. |
| `final https://developer.android.com/reference/android/graphics/Bitmap.html` | `@https://developer.android.com/reference/androidx/annotation/RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED") https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric#getLogoBitmap()()` |
| `final https://developer.android.com/reference/java/lang/String.html` | `@https://developer.android.com/reference/androidx/annotation/RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED") https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric#getLogoDescription()()` |
| `final int` | `@https://developer.android.com/reference/androidx/annotation/RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED") https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric#getLogoRes()()` |
| `static final int` | `https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric#getMaxFallbackOptions()()` Returns the maximum number of fallback options that can be added to the prompt. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Strength` | `https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric#getMinStrength()()` The minimum biometric strength for the authentication. |
| `final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric#getSubtitle()()` The optional subtitle of the prompt. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric#getTitle()()` The title of the prompt. |
| `final boolean` | `https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric#isConfirmationRequired()()` Whether user confirmation should be required for passive biometrics. |

## Public methods

### getAuthFallbacks

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

```
public final @NonNull List<@NonNull AuthenticationRequest.Biometric.Fallback> getAuthFallbacks()
```

The `https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.Biometric.Fallback` options for the biometric authentication.

### getContent

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

```
public final AuthenticationRequest.BodyContent getContent()
```

The optional `https://developer.android.com/reference/androidx/biometric/AuthenticationRequest.BodyContent` of the prompt.

### getLogoBitmap

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

```
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
public final Bitmap getLogoBitmap()
```

### getLogoDescription

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

```
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
public final String getLogoDescription()
```

### getLogoRes

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

```
@RequiresPermission(value = "android.permission.SET_BIOMETRIC_DIALOG_ADVANCED")
public final int getLogoRes()
```

### getMaxFallbackOptions

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

```
public static final int getMaxFallbackOptions()
```

Returns the maximum number of fallback options that can be added to the prompt.

| Returns |
|---|---|
| `int` | The maximum number of fallback options. |

### getMinStrength

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

```
public final @NonNull AuthenticationRequest.Biometric.Strength getMinStrength()
```

The minimum biometric strength for the authentication. Note that **Class 3** biometrics are guaranteed to meet the requirements for **Class 2** and thus will also be accepted.

### getSubtitle

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

```
public final String getSubtitle()
```

The optional subtitle of the prompt.

### getTitle

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

```
public final @NonNull String getTitle()
```

The title of the prompt.

### isConfirmationRequired

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

```
public final boolean isConfirmationRequired()
```

Whether user confirmation should be required for passive biometrics.