Skip to content
RosettaChat Docs

Verify OTP

POST
/api/v1/auth/web/otp/verify

Verify the One-Time Password and establish a session. Creates a new account if the email is not registered.

Request Body required

Section titled “Request Body required ”
object
email
required

The email address.

string
john@example.com
token
required

The 6-digit OTP code.

string
123456
device_name

Must not be greater than 255 characters.

string
j

Responses

Section titled “ Responses ”

200

Section titled “200 ”
object
user
object
id
integer
1
name
string
john
email
string
john@example.com
message
string
Logged in successfully.
{
  "user": {
    "id": 1,
    "name": "john",
    "email": "john@example.com"
  },
  "message": "Logged in successfully."
}

403

Section titled “403 ”

Account inactive

object
message
string
Account is inactive.
{
  "message": "Account is inactive."
}

422

Section titled “422 ”

Invalid OTP

object
message
string
The given data was invalid.
errors
object
token
Array<string>
[
  "Invalid or expired OTP."
]
{
  "message": "The given data was invalid.",
  "errors": {
    "token": [
      "Invalid or expired OTP."
    ]
  }
}