Skip to content
Blacklist

Blacklist

Queries Risk Blacklist data. Combine business filters in filters, and use page, page_size, and orderBy to control pagination and sorting.

Response

On success, the API returns the matching records and pagination metadata. See each filter field for its purpose, allowed values, and dynamic value source.

GEThttps://b-api.longbridge.xyz/v1/datasets/risk_block_lists

Dataset endpoints are available on the Test host only (https://b-api.longbridge.xyz); the Production host returns 404.

This Dataset query is read-only. Use GET by default. If the encoded query parameters are too large, send the same parameters as a JSON body with POST to the same path.

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_credit_limit.credit_block_list_query

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

Query parameters

filtersobject

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

Child attributes
dimensionstring

Parameter. Filters results by Parameter.

0 · A/C No1 · Member ID

valuestring

Value. Filters results by Value.

block_typestring

Business Tag. Filters results by Business Tag.

1 · Credit2 · Assets Transfer3 · Dynamic Credit Limit Adjustment4 · Auto Forcesell

statusstring

Status. Filters results by Status.

0 · Enabled1 · Disabled

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 Risk Blacklist 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

ID. Returned value: Unique identifier of the current record.

dimensionstring

Parameter. Returned value: Parameter.

dimension_valstring

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

valuestring

Value. Returned value: Value.

block_typestring

Business Tag. Returned value: Business Tag.

block_type_valstring

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

statusstring

Status. Returned value: Status.

status_valstring

Status (raw value). 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.

account_channelstring

Channel. Returned value: Channel.

created_atstring

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

operatorstring

Operator. Returned value: Operator.

remarkstring

Remarks. Returned value: Remarks.

updated_bystring

Updated By. Returned value: Updated By.

updated_atstring

Updated At. Returned value: Updated 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

Whale Docs