Change Password

POST/web/v1/system/auth/password/change JWT

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).

Changes the authenticated user's password. Requires the current password for verification before setting the new password.

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
Authorization	Bearer	JWT access token
Accept-Language	en, zh, zh-Hant, ja, vi	Response language (default: en)

Business Parameters

Name	Type	Required	In	Description
currentPassword	String	Required	body	Current password (8-128 chars). Encrypted by SecureChannel.
newPassword	String	Required	body	New password (8-128 chars). Encrypted by SecureChannel.

Business Parameters (before encryption)

The following JSON is what gets encrypted before transmission:

{
  "currentPassword": "OldP@ss",
  "newPassword": "NewP@ssw0rd"
}

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:

{
  "currentPassword": "OldP@ss",
  "newPassword": "NewP@ssw0rd"
}

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
   • Header: Authorization: Bearer {accessToken}
   • 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": {
    "success": true,
    "message": "Password changed successfully"
  }
}

Error Responses

Current Password Incorrect 400

{
  "success": false,
  "code": "AUTH.CURRENT_PASSWORD_INCORRECT",
  "message": "The current password is incorrect"
}

Notes

• Requires the current password for verification.
• Rate limited to 5 requests per 300-second window.
• The request body is strictly validated; unknown properties will cause a rejection.