signInWithBiometrics
suspend fun signInWithBiometrics(id: String? = null, identifierHint: String? = null, promptTitle: String? = null, promptSubtitle: String? = null): ClerkResult<SignIn, ClerkErrorResponse>
Signs in with a locally enrolled biometric credential.
The biometric-credential domain owns local credential selection, key access, challenge signing, and stale local credential cleanup.
Return
A ClerkResult containing the SignIn object on success, or a ClerkErrorResponse on failure.
Example usage:
val signIn = clerk.auth.signInWithBiometrics()Content copied to clipboard
Parameters
id
The biometric credential ID to use. When omitted, the available local credential is used.
identifierHint
A local-only user identifier hint used to choose a matching credential.
promptTitle
The title shown in the system authentication prompt.
promptSubtitle
The subtitle shown in the system authentication prompt.