Clerk Android API/com.clerk.api.session/SessionVerification

SessionVerification

@Serializable

data class SessionVerification(val id: String? = null, val status: SessionVerification.Status = Status.UNKNOWN, val level: SessionVerification.Level = Level.UNKNOWN, val session: Session? = null, val supportedFirstFactors: List<Factor>? = null, val supportedSecondFactors: List<Factor>? = null, val firstFactorVerification: Verification? = null, val secondFactorVerification: Verification? = null)

Represents the state of an in-session reverification (step-up) flow.

Constructors

SessionVerification

constructor(id: String? = null, status: SessionVerification.Status = Status.UNKNOWN, level: SessionVerification.Level = Level.UNKNOWN, session: Session? = null, supportedFirstFactors: List<Factor>? = null, supportedSecondFactors: List<Factor>? = null, firstFactorVerification: Verification? = null, secondFactorVerification: Verification? = null)

Types

@Serializable

enum Level : Enum<SessionVerification.Level>

The required level of verification.

@Serializable

enum Status : Enum<SessionVerification.Status>

The status of a session verification attempt.

Properties

firstFactorVerification

@SerialName(value = "first_factor_verification")

val firstFactorVerification: Verification?

The state of the first-factor verification.

val id: String?

The unique identifier for the verification attempt.

val level: SessionVerification.Level

The required verification level.

secondFactorVerification

@SerialName(value = "second_factor_verification")

val secondFactorVerification: Verification?

The state of the second-factor verification.

val session: Session?

The session associated with the verification.

val status: SessionVerification.Status

The current status of the verification.

supportedFirstFactors

@SerialName(value = "supported_first_factors")

val supportedFirstFactors: List<Factor>?

First factors supported for this verification.

supportedSecondFactors

@SerialName(value = "supported_second_factors")

val supportedSecondFactors: List<Factor>?

Second factors supported for this verification.