# 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)

*** ** * ** ***


```
class AuthenticationRequest.Biometric : AuthenticationRequest
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [androidx.biometric.AuthenticationRequest](https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest) ||
|   | ↳ | [androidx.biometric.AuthenticationRequest.Biometric](https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric) |

*** ** * ** ***

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

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric.Builder` Builder used to create an instance of `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric`. |
| `abstract class https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric.Fallback` Fallback options for the biometric authentication. |
| `class https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric.Fallback.CustomOption : https://developer.android.com/reference/kotlin/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. |
| `object https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric.Fallback.DeviceCredential : https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric.Fallback` Device credential as the fallback. |
| `abstract class https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric.Strength` Types of biometric strength for the prompt. |
| `object https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric.Strength.Class2 : https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric.Strength` Class 2 (formerly Weak). |
| `class https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric.Strength.Class3 : https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric.Strength` Class 3 (formerly Strong). |

| ### Public companion functions |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric#getMaxFallbackOptions()()` Returns the maximum number of fallback options that can be added to the prompt. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric.Fallback>` | `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric#authFallbacks()` The `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric.Fallback` options for the biometric authentication. |
| `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.BodyContent?` | `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric#content()` The optional `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.BodyContent` of the prompt. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric#isConfirmationRequired()` Whether user confirmation should be required for passive biometrics. |
| `https://developer.android.com/reference/android/graphics/Bitmap.html?` | `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric#logoBitmap()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric#logoDescription()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric#logoRes()` |
| `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric.Strength` | `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric#minStrength()` The minimum biometric strength for the authentication. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html?` | `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric#subtitle()` The optional subtitle of the prompt. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/biometric/AuthenticationRequest.Biometric#title()` The title of the prompt. |

## Public companion functions

### getMaxFallbackOptions

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

```
fun getMaxFallbackOptions(): Int
```

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

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | The maximum number of fallback options. |

## Public properties

### authFallbacks

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

```
val authFallbacks: List<AuthenticationRequest.Biometric.Fallback>
```

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

### content

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

```
val content: AuthenticationRequest.BodyContent?
```

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

### isConfirmationRequired

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

```
val isConfirmationRequired: Boolean
```

Whether user confirmation should be required for passive biometrics.

### logoBitmap

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

```
val logoBitmap: Bitmap?
```

### logoDescription

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

```
val logoDescription: String?
```

### logoRes

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

```
val logoRes: Int
```

### minStrength

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

```
val minStrength: AuthenticationRequest.Biometric.Strength
```

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.

### subtitle

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

```
val subtitle: String?
```

The optional subtitle of the prompt.

### title

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

```
val title: String
```

The title of the prompt.