Lấy trạng thái Soft OTP
Trả về trạng thái SmartOTP hiện tại của một thiết bị người dùng.
Endpoint
http
POST /api/v1/saas-sotp/get-status
Content-Type: application/jsonjson
{
"partner_id": "{{partner_id}}",
"partner_key": "{{partner_key}}",
"token": "{{token}}"
}Tham số:
| Tham số | Kiểu | Bắt buộc | Mặc định | Mô tả |
|---|---|---|---|---|
partner_id | string | Có | — | Partner ID. |
partner_key | string | Có | — | Partner key. |
token | string | Có | — | Token đăng ký được tạo bởi Đăng ký. |
Trả về: GetStatusResponse
Ví dụ request
bash
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
json
{
"success": true,
"code": 1,
"message": "success",
"data": {
"status": "ACTIVATED"
}
}| Trường | Kiểu | Mô tả |
|---|---|---|
success | bool | Trạng thái của request. |
code | int | status code — 1 khi thành công. |
data.status | string | Trạng thái soft OTP của người dùng: NON_ACTIVATED, ACTIVATED hoặc TEMPORARY_BLOCKED. |
Các giá trị trạng thái
| Trường | Kiểu | Mô tả |
|---|---|---|
NON_ACTIVATED | string | Đã đăng ký nhưng chưa kích hoạt, hoặc chưa từng đăng ký. |
ACTIVATED | string | SmartOTP đang hoạt động trên thiết bị này và có thể tạo mã. |
TEMPORARY_BLOCKED | string | Tạm thời bị chặn, thường sau nhiều lần xác minh thất bại liên tiếp. |
Lỗi
| Mã | Thông báo |
|---|---|
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 nghĩa là người dùng đã có SmartOTP trên một thiết bị khác. Hãy gọi Hủy kích hoạt trên thiết bị cũ trước khi đăng ký thiết bị mới.
Bước tiếp theo
- Đăng ký — đăng ký một thiết bị đang báo
NON_ACTIVATED - Hủy kích hoạt — giải phóng một lần kích hoạt đang giữ trên thiết bị khác