Skip to Content
Clerk logo

Clerk Docs

Ctrl + K
Go to

EmailAddress Verification

These are all methods on the EmailAddress class that allow you to verify a user's email address.


function prepareVerification(params: PrepareEmailAddressVerificationParams): Promise<EmailAddress>;

Kick off the verification process for this email address. An email message with a one-time code or a magic-link will be sent to the email address box.


strategy string The verification strategy. Possible strategy values are:
  • email_link: User will receive an email magic link via email.
  • email_code: User will receive a one-time authentication code via email.
redirectUrlstring | undefinedThe magic link target URL. Users will be redirected here once they click the magic link from their email. This param only applies if strategy is email_link


function attemptVerification(params: AttemptEmailAddressVerificationParams): Promise<EmailAddress>;

Attempts to verify this email address, passing the one-time code that was sent as an email message. The code will be sent when calling the EmailAddress.prepareVerification() method.


codestringThe one-time code that was sent to the user's email address when prepareVerification was called with strategy set to email_code

What did you think of this content?

Clerk © 2023