Refresh Token

POST/web/v1/system/auth/token/refresh None

Secure Channel Required

This endpoint requires Secure Channel v2 encryption. All request and response payloads are encrypted in transit. See Secure Channel Protocol for full protocol details.

Required Gateway Headers

All API requests require gateway headers. See Required Headers for the complete list. In local/test environments, you must also include Cloudflare simulation headers (CF-Connecting-IP, Cf-Ray, cf-ipcountry).

Refreshes an expired access token using a valid refresh token. Returns a new access/refresh token pair.

Required Headers

Header	Example Value	Description
Content-Type	application/json;charset=UTF-8	Request content type
Accept	application/json	Expected response type
X-Client-Hash		Client device fingerprint
X-SC-Session-Id		Secure Channel session ID
X-SC-Version	2	Secure Channel protocol version
Accept-Language	en, zh, zh-Hant, ja, vi	Response language (default: en)

Business Parameters

Name	Type	Required	In	Description
refreshToken	String	Required	body	Current valid refresh token

Business Parameters (before encryption)

The following JSON is what gets encrypted before transmission:

{
  "refreshToken": "eyJhbGciOiJIUzI1NiIs..."
}

How to Call This Endpoint

Step 1: Establish Secure Channel Session (if not already active)

If you don't have an active SC session, create one first:

1. Get server public key: GET /web/v1/secure-channel/public-key
2. Create SC session: POST /web/v1/secure-channel/session — exchanges AES session key, returns sessionId

Step 2: Prepare the Request

Construct the JSON payload with the business parameters:

{
  "refreshToken": "eyJhbGciOiJIUzI1NiIs..."
}

Step 3: Encrypt and Send

1. Encrypt the JSON string using the AES session key (from Step 1)
2. Send the HTTP request with:
   • Header: X-SC-Session-Id: {sessionId}
   • Header: X-SC-Version: 2
   • Header: Content-Type: application/json;charset=UTF-8
   • Body: the encrypted binary payload (SCv2 envelope format)

Step 4: Decrypt the Response

The response body is also encrypted. Decrypt using the same AES session key to get the JSON response.

Success Response

Success 200

{
  "version": "2.0.0",
  "timestamp": 1711929600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJBQ0NfVEVTVF8wMDEiLCJzaWQiOiJTRVNTXzAwMSIsImlhdCI6MTcxMTkyOTYwMH0.new-token",
    "refreshToken": "dGVzdC1uZXctcmVmcmVzaC10b2tlbi1leGFtcGxl",
    "expiresIn": 3600
  }
}

Error Responses

Unauthorized 401

{
  "success": false,
  "code": "AUTH.REFRESH_TOKEN_INVALID",
  "message": "Invalid or expired refresh token"
}

Notes

• The refresh token is single-use; a new refresh token is issued with each refresh.
• Rate limited to 10 requests per window.
• Request body is strictly validated — unknown or unexpected fields will be rejected with HTTP 400.