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

BiometricCredentialChallenge

@Serializable
data class BiometricCredentialChallenge(val challenge: String, val challengeId: String, val biometricCredentialId: String? = null, val clientData: String, val expiresAt: Long, val algorithm: String = BiometricCredential.ES256_ALGORITHM)

A server challenge for biometric-credential enrollment, sign-in, or session reverification.

The clientData string must be signed with the local biometric-credential private key and returned to the server exactly as received.

Constructors

Link copied to clipboard
constructor(challenge: String, challengeId: String, biometricCredentialId: String? = null, clientData: String, expiresAt: Long, algorithm: String = BiometricCredential.ES256_ALGORITHM)

Properties

Link copied to clipboard
val algorithm: String

The signature algorithm required for the challenge.

Link copied to clipboard
@SerialName(value = "trusted_device_id")
val biometricCredentialId: String?

The biometric credential ID for sign-in or reverification challenges.

Link copied to clipboard
val challenge: String

The challenge value.

Link copied to clipboard
@SerialName(value = "challenge_id")
val challengeId: String

The unique identifier of the challenge.

Link copied to clipboard
@SerialName(value = "client_data")
val clientData: String

The exact client data string that must be signed.

Link copied to clipboard
@SerialName(value = "expires_at")
val expiresAt: Long

The time when the challenge expires, in milliseconds since epoch.

Generated by Dokka
© 2026 Copyright