Risk Rules Management

Query the risk-control rule configuration.

Request parameters

Combine business filter conditions through filters (see the filter-field descriptions below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Maintains risk-control rules — rule name, rule group, rule type and applicable account; used to centrally manage the various risk-control rules.

Returns

On success, returns the matching record list with pagination information. See the response schema for the meaning of each returned column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

risk_config.risk_rules_manager_query

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

Request body application/json

filtersobject

Combines business filters. Omit a filter field to disable that filter.

Child attributes

rule_namestring

Filters results by Rule Name.

group_namestring

Filters results by Risk Control Condition.

Allowed values: ignore_margin_call MarginCall Exemption, over_financing_margin_call_ignore OverLimit MarginCall Exemption

Values

ignore_margin_call: MarginCall Exemption
over_financing_margin_call_ignore: OverLimit MarginCall Exemption

rule_typestring

Filters results by Rule Type.

Allowed values: global, personalise

Values

global: Global
personalise: Personalise

aaidstring

Filters results by 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 number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated Risk Rules Management records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

Returned value: List of list.

Child attributes

idstring

Returned value: Unique identifier of the current record.

group_namestring

Returned value: Risk Control Condition.

group_name_valstring

Raw value of group_name. The group_name field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

rule_typestring

Returned value: Rule Type.

rule_type_valstring

Raw value of rule_type. The rule_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

rule_namestring

Returned value: Rule Name.

statusstring

Returned value: Status.

status_valstring

Raw value of status. The status field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

updated_atstring

Returned value: Updated Date. The date or time format follows the value returned by the API.

opt_userstring

Returned value: Operator.

aaidstring

Returned value: A/C No..

aaid_valstring

Raw value of aaid. The aaid field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

totalintegerrequired

Returned value: Total number of matching records, used for pagination.

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

Request

curl --request POST \
  --url 'https://b-api.lbkrs.com/v1/datasets/risk_rules' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "643",
        "group_name": "MarginCall Exemption",
        "group_name_val": "ignore_margin_call",
        "rule_type": "Personalise",
        "rule_type_val": "personalise",
        "rule_name": "test 20260204",
        "status": "Disable",
        "status_val": "2",
        "updated_at": "1770172159",
        "opt_user": "user@example.com",
        "aaid": "H00000000",
        "aaid_val": "10000000"
      }
    ],
    "total": 152
  }
}

Export

The export endpoint uses the same filters as this Dataset query.

POSThttps://b-api.lbkrs.com/v1/datasets/risk_rules/download

risk_config.risk_rules_manager_export

Export options Export records Download result