Bad Credit Processing

Queries the latest batch of bad-credit client records, used by the risk team to monitor and follow up on clients with credit risk.

Request parameters

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

Business notes

The data comes from the most recent day's bad-credit archive; each record represents one client and includes the securities account, account type, currency, trading limit, and financing amount.
Each record summarizes the client's credit-risk profile: current Margin Call status, historical Margin Call count, historical force-close count, current bad-credit flag, unsettled days within 30 days, and long-term unsettled count.
Filter by client, current Margin Call status, historical bad credit, and current bad credit.

Returns

On success, returns the matching records with pagination. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_margin_call.margin_call_query

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

Request body application/json

filtersobject

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

Child attributes

aaidstring

Client. 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.

risk_statusstring

Margin Call Status. Filters results by Margin Call Status.

Allowed values: Y Yes, N No

Values

Y: Yes
N: No

history_bad_record_statusstring

Historical Bad Loan Status. Filters results by Historical Bad Loan Status.

Allowed values: Y Yes, N No

Values

Y: Yes
N: No

bad_record_statusstring

Current Bad Loan Status. Filters results by Current Bad Loan Status.

Allowed values: Y Yes, N No

Values

Y: Yes
N: No

pageinteger

Page. Page number to retrieve, starting from 1.

page_sizeinteger

Page Size. Number of records to return per page.

orderByarray<object>

Order By. Array of sorting rules. Each item defines a sort field and direction.

Responses

HTTP 200On success, returns paginated Bad Credit Record records together with pagination metadata such as the page number, page size, and total record count.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List. Returned value: List of list.

Child attributes

idstring

Record ID. Returned value: Record ID (row primary key); write operations on this record take it as their id.

origin_idstring

A/C No. Returned value: A/C No.

account_typestring

Account Type. Returned value: Account Type.

account_type_valstring

Account Type (raw value). Raw value of account_type. The account_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

currencystring

Currency. Returned value: Currency.

trade_creditstring

Trading Limit. Returned value: Trading Limit.

finance_amountstring

Margin Limit. Returned value: Margin Limit.

risk_statusstring

Margin Call Status. Returned value: Margin Call Status.

margin_countstring

No. of Historical Margin Calls. Returned value: No. of Historical Margin Calls.

order_countstring

No. of Historical Forceselling. Returned value: No. of Historical Forceselling.

aaidstring

Historical Bad Loans. Returned value: Historical Bad Loans.

aaid_valstring

Historical Bad Loans (raw value). 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.

bad_record_statusstring

Current Bad Debt Status. Returned value: Current Bad Debt Status.

monthly_bad_credit_countstring

Days Outstanding Within 30 Days. Returned value: Days Outstanding Within 30 Days.

long_term_margin_countstring

No. of Long-Term Outstanding Days. Returned value: No. of Long-Term Outstanding Days.

created_atstring

Created At. Returned value: Created At. The date or time format follows the value returned by the API.

totalintegerrequired

Total. 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_bad_credit_logs' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "filters": {},
  "page": 1,
  "page_size": 20,
  "orderBy": []
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "123",
        "origin_id": "H00000000",
        "account_type": "Margin Client",
        "account_type_val": "M",
        "currency": "HKD",
        "trade_credit": "0",
        "finance_amount": "500,000.00",
        "risk_status": "Y",
        "margin_count": "2",
        "order_count": "0",
        "aaid": "H00000000",
        "aaid_val": "10000000",
        "bad_record_status": "Y",
        "monthly_bad_credit_count": "31",
        "long_term_margin_count": "0",
        "created_at": "1784151134"
      }
    ],
    "total": 6863
  }
}