corporate stock register details v2

Returns the customer detail management list of a corporate action, used to track instruction collection and execution status per customer; this is the core data for customer detail management.

Request parameters

Combine business filters through filters (see the filters field reference below), and use page, page_size, and orderBy for pagination and sorting.
Provide the customer account aaid to target a specific customer; results surface abnormal customers and OB-type accounts first.

Business notes

Data is aggregated per customer registration record and covers the announcement code, announcement type, market, underlying security, custodian, sub-account, customer account, and securities account.
Each record also carries the customer status and account sub-type, customer name, record date, election start/end times (CCASS), payable date, exercisable and actually exercised share quantities, the customer's instruction-collection state, execution state, exercise source, operation time, and email-sent time.
Typically used during the instruction-collection and execution phases to reconcile each customer's exercise election and progress and to identify pending or abnormal customers.

Returns

On success, returns the matching record list and pagination info. See the response definition for column meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

lb_hk_corporate.corporate_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

Responses

HTTP 200Paginated list result.

Standard response envelopecodemessagedata

dataobjectdata structure

listarray<object>required

List

Child attributes

origin_counter_idstring

Origin Counter ID

custodian_namestring

Custodian

counterpart_accountstring

Sub A/C

origin_idstring

A/C No.

account_statestring

Client State

account_state_valstring

Raw value behind field account_state: account_state returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

client_detail_typestring

ClientDetailType

real_namestring

Client Name

origin_quantitystring

Eligible Qty

choices_quantitystring

Actual Exercised Qty

notify_statestring

Client Mandate Collection Status

notify_state_valstring

Raw value behind field notify_state: notify_state returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

execute_statestring

Client CA Execution Status

execute_state_valstring

Raw value behind field execute_state: execute_state returns the human-readable display value resolved via a dictionary/join mapping, while this field returns the underlying code/ID before that mapping.

updated_bystring

Mandate Updated By

updated_atstring

Updated At

send_email_atstring

Send Email At

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

Request

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "origin_counter_id": "1000000001",
        "custodian_name": "张三",
        "counterpart_account": "1200",
        "origin_id": "1000000001",
        "account_state": "1",
        "account_state_val": "1",
        "client_detail_type": "1",
        "real_name": "张三",
        "origin_quantity": "1200",
        "choices_quantity": "1200",
        "notify_state": "1",
        "notify_state_val": "1",
        "execute_state": "1",
        "execute_state_val": "1",
        "updated_by": "张三",
        "updated_at": "1789713827",
        "send_email_at": "1789713827"
      }
    ],
    "total": 1
  }
}

Export

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

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

lb_hk_corporate.corporate_query

Export options Export records Download result