Skip to content
Longport WhaleLongport Whale
Client Group

Add Client to Client Group

Add a client account to a client group.

Request parameters

  • Required: client_group_id (client group ID), aaid (securities account).
  • Use the id of a client group returned by risk_member_groups as client_group_id.
  • See the field descriptions for the format, value range, and business meaning of each field.

Business notes

Adds the client account identified by aaid to the target client group; once added, the account inherits the group's risk-control rules.

Risk warning

This operation changes client-group membership and may affect the risk-control classification of the account. Confirm the securities account before calling.

Result

On success, the account is added; subsequent state and returned data follow the 200 response definition.

POSThttps://b-api.lbkrs.com/risk/v1/client_group_detail/reset

Authorization

AuthorizationstringheaderRequired

Send the Broker ACCESS_TOKEN as Authorization: Bearer <token>.

Permission

credit_limit.client_group_operation

The Broker ACCESS_TOKEN must be granted the permission above, or the call will be rejected.

Request body application/json

client_group_idstringrequired

Client Group ID. The id of the target client group returned by risk_member_groups.

aaidstringrequired

A/C No.

Pass the internal numeric ID of the customer's securities account (aaid), not the securities account number account_no (such as H00000000) or the customer ID member_id. One customer can have multiple aaid values.

Responses

HTTP 200OK
Standard response envelopecodemessagedata
dataobjectdata structure

On success data is an empty object.

No nested fields

HTTP 400Bad request. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 401The user is not authenticated, or the login session has expired.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 403The current account is not authorized to use this feature. Grant the required permission to the account in User Permission.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

HTTP 408The request timed out. Check the business error code in code and the error details in message.
Standard response envelopecodemessagedata
dataobjectdata structure

No nested fields

Whale Docs