Bank Securities Account Opening

Queries Bank Securities Account Opening 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/atm_bank_sec_applications

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

Authorizationstringheaderlb_hk_banksec.banksec_queryRequired

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

Query parameters

filtersobject

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

Child attributes

aaidstring

Client. Filters results by Client.

user_bank_card_nostring

Client's Linked Bank Card No.. Filters results by Client's Linked Bank Card No..

lb_bank_account_namestring

Bank Name. Filters results by Bank Name.

Values are dynamic. Call GET /v1/datasets/refs/receiving_bank_accounts_with_names to retrieve the current data dictionary, and use the returned entry's key as this parameter's value.

statestring

Status. Filters results by Status.

Allowed values:

0 - Pending Review
1 - Activating
2 - Activated
3 - Denied
4 - Closed
5 - Expired
8 - Canceled

0123458

bank_sec_agr_nostring

Agreement No.. Filters results by Agreement No..

created_atobject

Created At. Filters results by Created At.

Child attributes

gtestring

Greater Than or Equal. Inclusive lower bound of the filter range.

ltestring

Less Than or Equal. Inclusive upper bound of the filter range.

busi_typestring

Approval Status. Filters results by Approval Status.

Allowed values:

0 - Initial
46 - Approved Pending
45 - Activate Pending
50 - Rejected Pending
49 - Deactivate Pending

046455049

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 Bank Securities Account Opening 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.

bank_sec_agr_nostring

Agreement No.. Returned value: Agreement No..

lb_bank_account_namestring

Bank Name. Returned value: Bank Name.

member_idstring

Client ID. Returned value: Client ID.

member_account_idstring

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

account_channelstring

Account Channel. Returned value: Account Channel.

bank_card_numstring

Linked Bank Card No.. Returned value: Linked Bank Card No..

currencystring

Client's Linked Bank Card Type. Returned value: Client's Linked Bank Card Type.

statestring

Status. Returned value: Status.

state_valstring

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

bank_sec_fail_reasonstring

Reason For Activation Failure. Returned value: Reason For Activation Failure.

created_atstring

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

audit_atstring

Approval Time. Returned value: Approval Time. The date or time format follows the value returned by the API.

audit_namestring

Auditor. Returned value: Auditor.

remarkstring

Remark. Returned value: Remark.

bank_account_user_namestring

User Name. Returned value: User Name.

mainland_credentials_typestring

Client Mainland Document Type. Returned value: Client Mainland Document Type.

mainland_credentials_type_valstring

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

mainland_credentials_nostring

Client Mainland Document No.. Returned value: Client Mainland Document No..

hk_credentials_typestring

Client HK Document Type. Returned value: Client HK Document Type.

hk_credentials_type_valstring

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

hk_credentials_nostring

Client HK Document No.. Returned value: Client HK Document No..

bank_account_card_numstring

Document No.. Returned value: Document No..

bank_account_doc_typestring

Client's Document Type. Returned value: Client's Document Type.

bank_account_doc_type_valstring

Client's Document Type (raw value). Raw value of bank_account_doc_type. The bank_account_doc_type field contains the display value resolved through a dictionary or related record; this field contains the underlying code or ID.

busi_typestring

Approval Status. Returned value: Approval Status.

busi_type_valstring

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

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 --get \
  --url 'https://b-api.longbridge.xyz/v1/datasets/atm_bank_sec_applications' \
  --header 'Authorization: Bearer <token>' \
  --data-urlencode 'filters={}' \
  --data-urlencode 'page=1' \
  --data-urlencode 'page_size=20' \
  --data-urlencode 'orderBy=[]'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "id": "25464",
        "bank_sec_agr_no": "cmbc1784058401677",
        "lb_bank_account_name": "示例用户",
        "member_id": "1000000000000000000",
        "member_account_id": "H00000000",
        "account_channel": "lb",
        "bank_card_num": "****0000",
        "currency": "ALL",
        "state": "Activated",
        "state_val": "2",
        "bank_sec_fail_reason": "",
        "created_at": "1784058402",
        "audit_at": "",
        "audit_name": "",
        "remark": "autotest",
        "bank_account_user_name": "示例用户",
        "mainland_credentials_type": "Chinese Resident ID Card",
        "mainland_credentials_type_val": "CD",
        "mainland_credentials_no": "716676478319784",
        "hk_credentials_type": "HKCD",
        "hk_credentials_type_val": "HKCD",
        "hk_credentials_no": "888888",
        "bank_account_card_num": "****0000",
        "bank_account_doc_type": "示例用户",
        "bank_account_doc_type_val": "示例用户",
        "busi_type": "Initial",
        "busi_type_val": "0"
      }
    ],
    "total": 22
  }
}