Stytch Consumer SDK/com.stytch.sdk.consumer.biometrics/BiometricsClient

BiometricsClient

Biometric authentication methods.

Functions

abstract suspend fun authenticate(parameters: BiometricsParameters): BiometricsAuthenticateResponse

Authenticates the user using a previously registered biometric credential. Performs a two-step flow: calls POST /sdk/v1/biometrics/authenticate/start to get a challenge, prompts the user for biometric authentication, then calls POST /sdk/v1/biometrics/authenticate to complete.

getAvailability

abstract suspend fun getAvailability(parameters: BiometricsParameters): BiometricsAvailability

Returns the biometric availability status for the current device and user. This is a local-only operation — it does not make a network call.

abstract suspend fun register(parameters: BiometricsParameters): BiometricsRegisterResponse

Registers the device's biometric credential (fingerprint, face, etc.) for the current user. Performs a two-step flow: calls POST /sdk/v1/biometrics/register/start to get a challenge, prompts the user for biometric authentication, then calls POST /sdk/v1/biometrics/register to complete registration. Requires an active session.

removeRegistration

abstract suspend fun removeRegistration(): Boolean

Removes the locally stored biometric registration keypair from this device. This is a local-only operation — it does not make a network call and does not remove the registration from the Stytch backend. Requires an active session.