Initiate Login

POST/web/v1/system/auth/login/initiate 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 login flow by validating the user's email and returning the available authentication methods. This is the first step in the multi-step login process.

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)
password	String	Required	body	User password (8-128 chars). Encrypted by SecureChannel.

Business Parameters (before encryption)

The following JSON is what gets encrypted before transmission:

{
  "email": "user@example.com",
  "password": "your_password"
}

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",
  "password": "your_password"
}

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": {
    "sessionId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "mfaMethods": [
      {
        "code": "EMAIL",
        "value": 10011001,
        "label": "Email"
      },
      {
        "code": "OTP",
        "value": 10011002,
        "label": "OTP"
      }
    ],
    "expiresIn": 300,
    "accountStatus": null
  }
}

Error Responses

Invalid Credentials 400

{
  "success": false,
  "code": "AUTH.INVALID_CREDENTIALS",
  "message": "Invalid email or password"
}

Notes

• The request body is strictly validated; unknown properties will cause a rejection.
• If the account is pending approval, the response will include isPendingApproval: true with result code ACCOUNT_PENDING_APPROVAL.
• Rate limited to 10 requests per window.