Clerk Android/com.clerk.phonenumber/PhoneNumber

PhoneNumber

@Serializable

data class PhoneNumber(val id: String, val phoneNumber: String, val verification: Verification? = null, val reservedForSecondFactor: Boolean = false, val defaultSecondFactor: Boolean = false, val createdAt: Long? = null, val updatedAt: Long? = null, val linkedTo: List<String>? = null, val backupCodes: List<String>? = null)

The PhoneNumber object is a model around a phone number entity.

Phone numbers can be used as a proof of identification for users, or simply as a means of contacting users.

Phone numbers must be verified to ensure that they can be assigned to their rightful owners. The PhoneNumber object holds all the necessary state around the verification process.

The verification process always starts with the prepareVerification() method, which will send a one-time verification code via an SMS message.
The second and final step involves an attempt to complete the verification by calling the attemptVerification(code:) method, passing the one-time code as a parameter.

Finally, phone numbers can be used as part of multi-factor authentication. During sign-in, users can opt in to an extra verification step where they will receive an SMS message with a one-time code. This code must be entered to complete the sign-in process.

Constructors

constructor(id: String, phoneNumber: String, verification: Verification? = null, reservedForSecondFactor: Boolean = false, defaultSecondFactor: Boolean = false, createdAt: Long? = null, updatedAt: Long? = null, linkedTo: List<String>? = null, backupCodes: List<String>? = null)

Types

object Companion

Properties

val backupCodes: List<String>? = null

A list of backup codes in case of lost phone number access.

val createdAt: Long? = null

The date when the phone number was created.

defaultSecondFactor

val defaultSecondFactor: Boolean = false

A boolean indicating whether this phone number is the default second factor.

The unique identifier for this phone number.

val PhoneNumber.isPrimary: Boolean

Convenience function for telling whether or not the phone number is the primary one

val PhoneNumber.isVerified: Boolean

Convenience function for telling whether or not the phone number is verified

val linkedTo: List<String>? = null

An object containing information about any other identification that might be linked to this phone number.

val phoneNumber: String

The phone number value.

reservedForSecondFactor

val reservedForSecondFactor: Boolean = false

A boolean indicating whether this phone number is reserved for second factor authentication.

val updatedAt: Long? = null

The date when the phone number was last updated.

val verification: Verification? = null

An object holding information on the verification of this phone number.

Functions

attemptVerification

suspend fun PhoneNumber.attemptVerification(code: String): ClerkResult<PhoneNumber, ClerkErrorResponse>

Attempts to verify this phone number using the provided verification code.

suspend fun PhoneNumber.delete(): ClerkResult<DeletedObject, ClerkErrorResponse>

Deletes this phone number from the user's account.

prepareVerification

suspend fun PhoneNumber.prepareVerification(): ClerkResult<PhoneNumber, ClerkErrorResponse>

Initiates the phone number verification process by sending a verification code via SMS.

suspend fun PhoneNumber.update(reservedForSecondFactor: Boolean? = null, defaultSecondFactor: Boolean? = null): ClerkResult<PhoneNumber, ClerkErrorResponse>

Updates the properties of this phone number.