Get Soft OTP Status

Returns the current SmartOTP status of a user's device.

Endpoint

POST /api/v1/saas-sotp/get-status
Content-Type: application/json

{
  "partner_id": "{{partner_id}}",
  "partner_key": "{{partner_key}}",
  "token": "{{token}}"
}

Parameters:

Param	Type	Required	Default	Description
partner_id	string	Yes	—	The partner id.
partner_key	string	Yes	—	The partner key.
token	string	Yes	—	The registration token generated by Register.

Returns: GetStatusResponse

Sample Request

curl --location --request POST '<BASE_URL>/saas-sotp/get-status' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "partner_id": "{{partner_id}}",
    "partner_key": "{{partner_key}}",
    "token": "{{token}}"
  }'

Response

{
  "success": true,
  "code": 1,
  "message": "success",
  "data": {
    "status": "ACTIVATED"
  }
}

Field	Type	Description
success	bool	Request status.
code	int	The status code — 1 on success.
data.status	string	The user's soft OTP status: NON_ACTIVATED, ACTIVATED or TEMPORARY_BLOCKED.

Status values

Field	Type	Description
NON_ACTIVATED	string	Registered but not yet activated, or never registered.
ACTIVATED	string	SmartOTP is live on this device and can generate codes.
TEMPORARY_BLOCKED	string	Temporarily blocked, typically after repeated failed validations.

Errors

Code	Message
103	Thông tin Partner không chính xác — Partner details are incorrect.
190005	SmartOTP đang kích hoạt trên một thiết bị khác — SmartOTP is active on another device.

190005 means the user has SmartOTP on a different device. Call Retire on the old device before registering the new one.

Next Steps

• Register — register a device reporting NON_ACTIVATED
• Retire — release an activation held on another device