Forgot Password

POST/web/v1/system/auth/password/forgot 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).

Initiates the password reset flow by sending a reset link to the user's registered email address.

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
email	String	Required	body	User email address (max 255 chars)

Business Parameters (before encryption)

The following JSON is what gets encrypted before transmission:

{
  "email": "user@example.com"
}

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:

{
  "email": "user@example.com"
}

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": {
    "success": true,
    "message": "If the email exists, a reset link will be sent"
  }
}

Error Responses

Too Many Requests 429

{
  "success": false,
  "code": "REQUEST.RATE_LIMITED",
  "message": "Too many requests, please try again later"
}

Notes

• Rate limited to 3 requests per 300-second window.
• The request body is strictly validated; unknown properties will cause a rejection.