Clerk Android API/com.clerk.api.biometriccredential/BiometricCredentials

BiometricCredentials

The main entry point for biometric credential operations.

Enrolling generates a biometric-gated private key in the Android Keystore and registers its public key with Clerk. Signing in signs a server challenge with that key after the user passes the system biometric prompt. The private key never leaves the device.

Example usage:

// Enroll the current device while signed in
Clerk.biometricCredentials.enroll()

// Later, sign in with biometrics
Clerk.biometricCredentials.signIn().onSuccess { signIn ->
  // Session created
}

Properties

deviceSupportsBiometricAuthentication

val deviceSupportsBiometricAuthentication: Boolean

Whether biometric-gated keys can be created and used on this device.

Functions

availability

suspend fun availability(id: String? = null, identifierHint: String? = null): BiometricCredentialAvailability

Returns local biometric sign-in availability.

currentUserAvailability

suspend fun currentUserAvailability(): BiometricCredentialAvailability

Returns biometric sign-in availability for the current signed-in user, reconciling the local credential with the server.

currentUserLocalAvailability

fun currentUserLocalAvailability(): BiometricCredentialAvailability

Returns local biometric sign-in availability for the current signed-in user without reconciling with the server.

enroll

suspend fun enroll(name: String? = null, identifierHint: String? = null, policy: BiometricCredentialPolicy = BiometricCredentialPolicy.BIOMETRY_OR_DEVICE_PASSCODE, promptTitle: String? = null, promptSubtitle: String? = null): ClerkResult<BiometricCredential, ClerkErrorResponse>

Enrolls the current app installation as a biometric credential.

forgetLocalCredentials

fun forgetLocalCredentials(deletedUserId: String): Int

Deletes local biometric credentials and keys belonging to deletedUserId.

forgetLocalCredentialsAfterAccountDeletion

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP])

fun forgetLocalCredentialsAfterAccountDeletion(deletedUserId: String): Int

Deletes account-scoped local credentials, retaining failed cleanup work for the next SDK initialization.

list

suspend fun list(): ClerkResult<List<BiometricCredential>, ClerkErrorResponse>

Lists active biometric credentials for the signed-in user.

localAvailability

fun localAvailability(id: String? = null, identifierHint: String? = null): BiometricCredentialAvailability

Returns local biometric sign-in availability without reconciling with the server.

revoke

suspend fun revoke(id: String): ClerkResult<BiometricCredential, ClerkErrorResponse>

Revokes a biometric credential for the signed-in user.

revokeCurrentBiometricCredential

suspend fun revokeCurrentBiometricCredential(): ClerkResult<Unit, ClerkErrorResponse>

Revokes the available local biometric credential for the current signed-in user, if one exists.

signIn

suspend fun signIn(id: String? = null, identifierHint: String? = null, promptTitle: String? = null, promptSubtitle: String? = null): ClerkResult<SignIn, ClerkErrorResponse>

Signs in with a locally enrolled biometric credential.

validateLocalCredentialIfPossible

suspend fun validateLocalCredentialIfPossible(id: String? = null, identifierHint: String? = null): BiometricCredentialValidationResult

Validates the local biometric credential against the server when possible.