Verify Email
POST/api/auth/email/verification
Verify the user's email address using the token the user received a email verification email.
You can find more information about this here.
When registering a user and email is enabled in your application an email containing a link is sent to the user's email address. This link should point to the frontend of your application. Your frontend should extract the token from the URL and send it to this endpoint with the token as request parameter. You can find more information about this here.
You can resend this email through the endpoint POST /api/auth/email/verification/send.
Locale
A locale can be specified for this request. The email will be sent in the specified locale. You can learn more about locale in emails here.
If no locale is specified, the applications default locale will be used. You can learn more about configuring the default locale here.
Note: If email is disabled, there is no way to verify a user's email address.
Request
Responses
- 200
- 304
- 401
- 404
- 500
Updated user information.
The following error codes correspond to this status:
EMAIL_ALREADY_VERIFIED: User's email is already verified.
The following error codes correspond to this status:
ACCESS_TOKEN_EXPIRED: Indicates that the access token is expired.ACCESS_TOKEN_INVALID: Indicates that the access token cannot be decoded.EMAIL_VERIFICATION_TOKEN_EXPIRED: Indicates that the email verification token is expired.EMAIL_VERIFICATION_TOKEN_INVALID: Indicates that the email verification token cannot be decoded.EMAIL_VERIFICATION_TOKEN_MISSING: Thrown when the email verification token is missing.
The following error codes correspond to this status:
USER_NOT_FOUND: User not found.
The following error codes correspond to this status:
ACCESS_TOKEN_ALLOWLIST_READING_FAILURE: Represents an exception indicating a failure when reading the allowlist for an access token cache.DATABASE_FAILURE: Exception representing a general failure related to database operations.POST_COMMIT_SIDE_EFFECT_FAILURE: Exception representing a failure to perform a side effect after a successful database operation.INVALID_PRINCIPAL_DOCUMENT: A requested principal document was stored in an invalid format.