Skip to content
Longport WhaleLongport Whale
Client Group

Client Group Details Query

Query the member details within a credit-management client group, used to see which clients belong to a group and their enrollment information.

Request parameters

  • Combine business filters through filters (optional fields are described below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

  • Data expands the mapping between a client group and its members; each record maps to one client in the group.
  • Records include the group name, client number, securities account, name, and the time and operator that added the client to the group.
  • Client groups are used to apply credit or risk policies uniformly to a batch of clients; this dataset is for verifying a group's membership.
  • Filter by client (aaid) to locate the group membership of a specific client.

Returns

On success, returns the list of matching records with pagination. See the response schema for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/risk_member_group_detail

Authorization

AuthorizationstringheaderRequired

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

Permission

credit_limit.client_group_query

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

Request body application/json

filtersobject

Filters

Child attributes
aaidstring

Client

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.

pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
namestring

Group Name

member_idstring

Member ID

origin_idstring

A/C No.

real_namestring

Name

created_atstring

Create Time

op_userstring

Operator

totalintegerrequired

Total

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