Forgot Password

POST/web/v1/users/self/auth/password/forgot None

Initiates the password reset flow by sending a reset link to the user's registered email address. Requires Turnstile verification to prevent abuse.

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)

Request Parameters

Name	Type	Required	In	Description
rawRequestBody	String	Required	body	Encrypted request payload (parsed server-side)

Success Response

Success 200

{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "sent": true,
    "maskedEmail": "u***@example.com"
  }
}

Error Responses

Unauthorized 401

{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}

Notes

• Requires Cloudflare Turnstile verification via the X-Turnstile-Token header.
• Rate limited to 3 requests per 300-second window.
• The request body is strictly validated; unknown properties will cause a rejection.
• This endpoint now requires @SecureChannel — encrypted channel required.