Package-level declarations

Types

@Serializable

data class SignUp(val id: String, val status: SignUp.Status, val requiredFields: List<String>, val optionalFields: List<String>, val missingFields: List<String>, val unverifiedFields: List<String>, val verifications: Map<String, Verification?>, val username: String? = null, val emailAddress: String? = null, val phoneNumber: String? = null, val passwordEnabled: Boolean, val firstName: String? = null, val lastName: String? = null, val unsafeMetadata: JsonObject? = null, val createdSessionId: String? = null, val createdUserId: String? = null, val abandonedAt: Long? = null)

The SignUp object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up process. Once a sign-up is complete, a new user is created.

Functions

attemptVerification

suspend fun SignUp.attemptVerification(params: SignUp.AttemptVerificationParams): ClerkResult<SignUp, ClerkErrorResponse>

Attempts to complete the in-flight verification process that corresponds to the given strategy. In order to use this method, you should first initiate a verification process by calling SignUp.prepareVerification.

prepareVerification

suspend fun SignUp.prepareVerification(prepareVerification: SignUp.PrepareVerificationParams.Strategy): ClerkResult<SignUp, ClerkErrorResponse>

The prepareVerification method is used to initiate the verification process for a field that requires it.

update

suspend fun SignUp.update(updateParams: SignUp.SignUpUpdateParams): ClerkResult<SignUp, ClerkErrorResponse>

The update method is used to update the sign-up process with new information. This can be used to add additional fields to the sign-up process, such as a phone number or an email address.