Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to clerk.com

Verification

These are all methods on the SignUp class that allow you to verify a user's sign-up request.

prepareVerification()

function prepareVerification(params: PrepareVerificationParams): Promise<SignUp>;

The prepareVerification is used to initiate the verification process for a field that requires it. As mentioned above, there are two fields that need to be verified:

  • emailAddress: The email address can be verified via an email code. This is a one-time code that is sent to the email already provided to the SignUp object. The prepareVerification sends this email.
  • phoneNumber: The phone number can be verified via a phone code. This is a one-time code that is sent via an SMS to the phone already provided to the SignUp object. The prepareVerification sends this SMS.

PrepareVerificationParams

NameTypeDescription
strategystring The verification strategy to validate the user's sign-up request. The following strategies are supported:
  • phone_code: Send an SMS with a unique token to input.
  • email_code: Send an email with a unique token to input.
  • email_link: Send an email with a link which validates sign-up
  • saml: Authenticate against SAML. Experimental
  • oauth_*: Authenticate against various OAuth providers.
  • web3_*_signature: Authenticate against Web3 signatures.
redirectUrlstring The URL to redirect the user to after the verification process is complete. Only supported on email_link, oauth_*, and saml strategies.

attemptVerification()

function attemptVerification(params: AttemptVerificationParams): Promise<SignUp>;

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.

Depending on the strategy, the method parameters could differ.

AttemptVerificationParams

NameTypeDescription
strategystring The verification strategy to complete the user's sign-up request against. The following strategies are supported:
  • phone_code: Validates an SMS with a unique token to input.
  • email_code: Validates an email with a unique token to input.
  • web3_*_signature: Authenticate against Web3 signatures.
codestring The code that was sent to the user via the phone_code or email_code verification strategies.
signaturestring The signature that was sent to the user via the Web3 verification strategy.

What did you think of this content?

Clerk © 2023