Email verification
These are all methods on the SignUp class that allow you to verify a user's sign-up request via email.
prepareEmailAddressVerification()
Helper method that allows you to initiate a verification process for an email address. It basically sends a one-time code to the email address already supplied to the current sign-up.
The defaults of this method are equivalent to calling SignUp.prepareVerification('email_code').
function prepareEmailAddressVerification(
params?: PrepareEmailAddressVerificationParams,
): Promise<SignUpResource>- Name
strategy- Type
'email_code' | 'email_link'- Description
The verification strategy to validate the user's sign-up request. The following strategies are supported:
'email_code': Send an email with a unique token to input.'email_link': Send an email with a link which validates sign-up.
- Name
redirectUrl- Type
string- Description
Required if
strategyis set to'email_link'. The full URL that the user will be redirected to when they visit the email link. See the custom flow for implementation details.
attemptEmailAddressVerification()
Helper method that attempts to complete the verification process for an email address. It basically verifies that the supplied code is the same as the one-time code that was sent to the email address during the prepare verification phase.
This is equivalent to calling SignUp.attemptVerification({strategy: 'email_code', ...params}).
function attemptEmailAddressVerification(
params: AttemptEmailAddressVerificationParams,
): Promise<SignUpResource>- Name
code- Type
string- Description
The code that was sent to the user via email.
Feedback
Last updated on