Post
/api/v1/users.verifyEmail
Verifies a user's email address using the token embedded in the verification sent to their email.
Changelog
| Version | Description |
|---|---|
| 9.0.0 | Removed the anonymous role swap on verification. |
| 8.7.0 | Added |
Body parameters
Example
{
"token": "hf5Wf4Kj9R3mR7cQ2xkPd"
}object
token
string Required
The email verification token the user received by email.
Examplehf5Wf4Kj9R3mR7cQ2xkPd
Responses
200
OK
Success
{
"success": true
}object
success
boolean
400
Bad Request
Missing token
{
"success": false,
"error": "must have required property 'token' [error-invalid-params]",
"errorType": "error-invalid-params"
}Verification link expired
{
"success": false,
"error": "Verify email link expired"
}object
success
boolean
error
string
errorType
string