Verify email address

Verify an email

POST/{apiBasePath}/{tenantId}/user/email/verify

Path parameters

apiBasePathstringrequired

Its value depends on the apiBasePath set by the user

Header parameters

ridstring

The email verification recipe ID

Request body

application/json

methodmethod

The method to use for the operation

tokentoken

A security token used for authentication

Responses

200Verify an email

One of:

object

statusstring

Allowed:OKEMAIL_VERIFICATION_INVALID_TOKEN_ERROR

generalErrorResponse

statusstring

Error status code

Allowed:GENERAL_ERROR

messagestring

Error message

404Resource not found error

string

500Internal server error

string

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

apiBasePathpath*Its value depends on the apiBasePath set by the userridheaderThe email verification recipe ID

Bodyapplication/json

methodstringThe method to use for the operationtokenstringA security token used for authentication

Request

curl -X POST "/auth/{tenantId}/user/email/verify" \
  -H "Content-Type: application/json" \
  -d '{
  "method": "token",
  "token": "ZTRiOTBjNz...jI5MTZlODkxw"
}'

const response = await fetch("/auth/{tenantId}/user/email/verify", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "method": "token",
  "token": "ZTRiOTBjNz...jI5MTZlODkxw"
})
});

import requests

response = requests.post(
    "/auth/{tenantId}/user/email/verify",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "method": "token",
  "token": "ZTRiOTBjNz...jI5MTZlODkxw"
},
)

Response

{
  "status": "OK"
}

"Not Found"

"Internal Error"