Confirm OTP Login

This endpoint is used to confirm the login process by verifying the OTP (from SMS or Google Authenticator).

📍 Endpoint

POST {base_url}/api/acl/auth/confirm_otp

🧾 Headers

Key	Value
Content-Type	application/json

📤 Request Body

{
  "token": "your-temporary-token",
  "otp": "otp-code"
}

📝 Parameters

Parameter	Type	Description
token	string	The temporary token received from the Login API
otp	string	The OTP received via SMS or generated from Google Authenticator

✅ Success Response

{
  "data": {
    "token": "22c392ffebe7286ee8021cfef7d7cad5",
    "method": "login"
  },
  "meta": {
    "status": true,
    "message": "انجام شد",
    "message_parameters": [],
    "message_code": "200-1"
  }
}

🎉 The returned token is the final token that can be used to access authorized APIs.

⏱ Valid for: 10 hours

Next Steps After Receiving the Token

Once you receive the token at this step, you have two options to allow the user to continue working with the platform:

Option 1: Use Your Own Frontend

If you have implemented your own frontend using our APIs, simply use the returned token in the Authorization header for all subsequent API calls. This way, you manage the user experience entirely within your own application.

Option 2: Redirect to Our Frontend

Alternatively, you can redirect the user to our frontend, and let them continue directly in our panel. To do this, just redirect the user to the following URL with the token obtained in this step:

https://sms.your-domain/external-login?token={userToken}

If the token is valid, the user will be automatically logged in and will have full access to the panel.

❌ Error Response — Invalid or Expired Token or OTP (401)

{
  "data": null,
  "meta": {
    "status": false,
    "message": "اطلاعات وارد شده صحیح نمی باشد",
    "message_parameters": [],
    "message_code": "400-1",
    "errors": {}
  }
}

❌ Error Response — Validation Error (422)

{
  "data": null,
  "meta": {
    "status": false,
    "message": "تکمیل گزینه otp الزامی است",
    "message_parameters": [],
    "message_code": "400-2",
    "errors": {
      "otp": [
        "تکمیل گزینه otp الزامی است"
      ]
    }
  }
}

🧪 Example Request

curl --location '{base_url}/api/acl/auth/confirm_otp' \
--header 'Content-Type: application/json' \
--data '{
  "token": "your-login-step-token",
  "otp": "otp-code"
}'