Clerk Android/com.clerk.network.model.factor/Factor

Factor

@Serializable
data class Factor(val strategy: String, val emailAddressId: String? = null, val phoneNumberId: String? = null, val web3WalletId: String? = null, val safeIdentifier: String? = null, val primary: Boolean? = null)

The Factor type represents the factor verification strategy that can be used in the sign-in process.

Constructors

Link copied to clipboard
constructor(strategy: String, emailAddressId: String? = null, phoneNumberId: String? = null, web3WalletId: String? = null, safeIdentifier: String? = null, primary: Boolean? = null)

Properties

Link copied to clipboard
@SerialName(value = "email_address_id")
val emailAddressId: String? = null

The ID of the email address that a code or link will be sent to.

Link copied to clipboard
@SerialName(value = "phone_number_id")
val phoneNumberId: String? = null

The ID of the phone number that a code will be sent to.

Link copied to clipboard
val primary: Boolean? = null

Whether the factor is the primary factor.

Link copied to clipboard
@SerialName(value = "safe_identifier")
val safeIdentifier: String? = null

The safe identifier of the factor.

Link copied to clipboard
val strategy: String

The strategy of the factor.

Link copied to clipboard
val web3WalletId: String? = null

The ID of the Web3 wallet that will be used to sign a message.