Get email verification status

Get the verification status for the current user’s primary email

GET /api/v1/user/me/email/status

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "isVerified": true,
    "email": "<string>",
    "otp": {
      "numberOfAttempts": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "isMaxAttempts": true,
      "isExpired": true,
      "expiresAt": "2023-11-07T05:31:56Z"
    }
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Query Parameters

passcode · string

the one-time passcode sent to the user's primary email

Response

200

application/json

Ok

Shows the current verification status of an email address

results · object · required

Verification status of an email address

Show child attributes

status · enum<string> · required

Available options: ok