Skip to content

Verify an email address

POST
/auth/verify-email

Confirms an email address with the token from a verification link. The link opens the web app, which sends the token here. Each token works once and expires an hour after it’s issued.

On success the account is marked as verified and you get its ref, username and email address back. This doesn’t sign the person in, so send them to sign in next.

object
token
required

The token value from the verification link.

string

Email verified.

object
user_ref
required
integer format: int64
username
required
string
email
required
string format: email

The token is missing, unknown, expired or already used.

object
error
required

Human-readable error summary

string
Example
the request could not be completed