Skip to main content
POST
/
pos
/
auth
/
verify-otp
Verify OTP
curl --request POST \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/pos/auth/verify-otp \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '{
  "otp": "<string>",
  "otp_token": "<string>",
  "otp_action": "login"
}'
{
  "message": "<string>",
  "success": true,
  "content": {
    "user": {
      "id": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "phone": "<string>",
      "email": "jsmith@example.com",
      "channel": {
        "id": "<string>",
        "name": "<string>"
      },
      "device": {
        "id": "<string>",
        "name": "<string>"
      },
      "location": {
        "id": "<string>",
        "name": "<string>"
      },
      "roles": [
        {
          "location_id": "<string>",
          "location_name": "<string>",
          "role_id": "<string>",
          "role_name": "<string>"
        }
      ]
    },
    "access_token": "<string>",
    "refresh_token": "<string>"
  }
}

Authorizations

X-Api-Key
string
header
required

API key for your store

Body

application/json
otp
string
required

A string representing the one-time password.

otp_token
string
required

A string representing the OTP token.

otp_action
enum<string>
required

A string indicating the action to be performed.

Available options:
login

Response

OK

message
string
required
success
boolean
required
content
object
required
โŒ˜I