Verify email

Verfiy email address

Verify an email address by providing the token that was sent to that email address.

GET/auth/verify-email/{token}

Path parameters

token*string

The email verification token

Response

200400403

OK

Body

application/json

verified*boolean

Flag to indicate verification succeeded (always true).

passwordTokenstring

If set, the user needs to set their password, because the API got called from an invitation. You can use the token on the setPassword endpoint.

Request

JavaScriptCurl

const response = await fetch('/auth/verify-email/{token}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "verified": false,
  "passwordToken": "text"
}

Re-send verification email

If the verification email never arrived or the previously emailed token has expired, a new verification email can be requested.

POST/auth/verify-email

Body

application/json

email*string (email)

Response

200400422

OK

Body

application/json

sent*boolean

Request

JavaScriptCurl

const response = await fetch('/auth/verify-email', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "[e-mail]"
    }),
});
const data = await response.json();

Response

{
  "sent": false
}