Get Backup Code Status
GET
/web/v1/system/security/mfa/backup-codes JWTRetrieves the status of the user's backup codes, including the count of remaining unused codes and total originally generated. Does not return the actual backup codes.
Required Headers
| Header | Example Value | Description |
|---|---|---|
| Content-Type | application/json | Request content type |
| Accept | application/json | Expected response type |
| X-Client-Hash | Client device fingerprint | |
| Accept-Language | en, zh, zh-Hant, ja, vi | Response language (default: en) |
| Authorization | Bearer | JWT access token |
Request Parameters
No request parameters required.
Request Example
No request body required.
Success Response
Success 200
{
"version": "1.3.0",
"timestamp": 1709337600000,
"success": true,
"code": "2000",
"message": "SUCCESS",
"data": {
"remainingCount": 10,
"totalGenerated": 10
}
}| Field | Type | Description |
|---|---|---|
remainingCount | integer | Number of unused backup codes remaining |
totalGenerated | integer | Total number of codes originally generated (default 10) |
Error Responses
Unauthorized 401
{
"success": false,
"code": "4010",
"message": "Invalid or expired token"
}Notes
- Returns only the counts, not the actual codes.
totalGeneratedis the number originally generated (default 10).- After each backup code is used,
remainingCountdecreases by 1.