Verify email address OTP to authentication

Verifies the OTP code that was sent to the user's email.

post

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Body

application/jsontext/jsonapplication/*+json

This class represents the data transfer object for the user authentication verify OTP request.

tokenstring · min: 1Required

The token to verify. This is the token that was received from the request to send the OTP.

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbiI6IjEzNDU2Nzg5MzIifQ.1J7

otpstring · min: 1Required

The OTP to verify.

Example: 123456

Responses

200

The request was successful.

application/json

400

Token invalid

application/json

429

The user has exceeded the rate limit.

application/json

804

The OTP has expired.

application/json

805

The OTP is invalid.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/users/auth/passwordless/verify-email-otp HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbiI6IjEzNDU2Nzg5MzIifQ.1J7",
  "otp": "123456"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "asdasdcwAqrNxIT0xQdkMvR",
    "username": "user",
    "emailAddress": "[e-mail]",
    "authKey": "8mgBXMwMchIWWlLmvEL9RasdasdcwAqrNxIT0xQdkMvRndmSjh4YmtOcjdZb2taUT09N1J5bVdzRDlUUWhhRFFwdlRhemk4ZDFuaFdHajYzVXlYLy9valkwYXpuQT0="
  },
  "errors": []
}