Developer Portal
Admin APIsAccounts & FundingSessions

Client LoginPOST

Authenticate a client profile with its email and password, and issue an end-user access token for client-facing trading services.

View as Markdown
POST
/trade/login

Authorization

Authorization<token>

Bearer access token issued by the admin login flow.

In: header

Request Body

application/jsonRequired

End-user (client) credentials for issuing a trading access token.

emailstring
passwordstring
curl -X POST "https://example.com/trade/login" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "string",
    "password": "string"
  }'

A successful response.

{
  "accessToken": "string",
  "expiresAt": "string",
  "accounts": [
    {
      "id": "string",
      "gId": "string"
    }
  ]
}

Withdraw Funds

Create a withdrawal transaction that debits funds from the specified trading account. Requires the 'funding:withdraw' permission; callers without it receive 403 AUTH_NO_PERMISSION (onboarding-only tokens do not include funding access).

Create Token

Issue an end-user access token for a client profile without its password, for CRM 'log in as client' handoffs. The token grants the same trading access as Client Login; expiresInSeconds bounds its lifetime and 0 defaults to 30 days. It cannot be revoked once issued, so prefer the shortest lifetime that works. Requires the 'clients-profile:token' permission.