Sign in
Authentication (Allauth Headless)

Verify an email

Changed on

Complete the email verification process. Depending on the configuration, email addresses are either verified by opening a link that is sent to their email address, or, by inputting a code that is sent. On the API, both cases are handled identically. Meaning, the required key is either the one from the link, or, the code itself.

Note that a status code of 401 does not imply failure. It indicates that the email verification was successful, yet, the user is still not signed in. For example, in case ACCOUNT_LOGIN_ON_EMAIL_CONFIRMATION is set to False, a 401 is returned when verifying as part of login/signup.

post/api/v2/allauth/browser/v1/auth/email/verify

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

client'app' | 'browser' required

The type of client accessing the API.

Headers

X-Session-Tokenstring

Session token. Only needed when client is equal to app.

Request body

keystring required

The email verification key

Example request

{
  "key": "2f-c4nqd4-e07d9bc694f9f28cd4fe92569d495333"
}

Response

The user is authenticated.

status200 required

Example response

{
  "data": {
    "user": {
      "id": 123,
      "display": "Magic Wizard",
      "email": "email@domain.org",
      "has_usable_password": true,
      "username": "wizard",
      "has_validated_password": true
    },
    "methods": [
      {
        "at": 1711555057.065702,
        "email": "email@domain.org",
        "username": "wizard"
      }
    ]
  },
  "meta": {
    "session_token": "ufwcig0zen9skyd545jc0fkq813ghar2",
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdW"
  }
}

Changes

  • v2b147245b3d11Revision changes
    • info

      added the required property // to the response with the status