corporate stock register details

Query the corporate-action client detail management list, showing each corporate action's processing and execution status by client and announcement.

Request parameters

Combine business filters through filters (available fields are listed under the filters field docs), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

Data comes from corporate-action client registration details and can be filtered by client (aaid), announcement type (ann_type), market (market), client execution status (execute_state), announcement execution status (stage_state), instruction-collection status (notify_state), payable date, election end time, underlying (origin_counter_id), announcement number (ca_code), and operation time.

Each record is a client's detail under one announcement, carrying account state, announcement type and number, market, underlying, elected/exercise quantity and holding quantity, client execution status, announcement execution status, instruction-collection status, record date, and payable date.

Typically used by operations to monitor each client's execution progress, instruction collection, and processing status across corporate actions.

Returns

On success, returns the matched record list with pagination info. See the response definitions for column meanings.

POSThttps://b-api.lbkrs.com/v1/datasets/corp_action_register_client_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

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

Child attributes

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.

ann_typestring

Filters results by Ann Type.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values: 3 TM, 4 BE, 5 CA, 6 DS, 7 OO, 8 EO, 9 RS, 10 ER, 11 TU, 12 TC, 13 ADR, 14 SO, 15 IP, 16 VT

Values

3: TM
4: BE
5: CA
6: DS
7: OO
8: EO
9: RS
10: ER
11: TU
12: TC
13: ADR
14: SO
15: IP
16: VT

marketstring

Filters results by Market.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values: US, HK, UK, SH, SZ, SG, KR, JP, AU, DE, CA, TH, ID, MY, TR, NA, OSL, HAS, EU, UT, GTMMF

Values

US: US
HK: HK
UK: UK
SH: SH
SZ: SZ
SG: SG
KR: KR
JP: JP
AU: AU
DE: DE
CA: CA
TH: TH
ID: ID
MY: MY
TR: TR
NA: NA
OSL: OSL
HAS: HAS
EU: EU
UT: UT
GTMMF: GTMMF

execute_statestring

Filters results by Client Execution Status.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values: 1 Not Processed, 2 Success, 3 Failed, 4 Cancelled, 5 Stock Success

Values

1: Not Processed
2: Success
3: Failed
4: Cancelled
5: Stock Success

stage_statestring

Filters results by CA Execution Status.

Allowed values: 1 Initialized, 2 Confrimed, 3 Recoding, 4 Record - Success, 5 Record - Failed, 6 Execution - Pending Approval, 7 Executing, 9 Execution - Success, 10 Execution - Failed, 0 Not Created, 12 Cancelled, 11 Success; Avg cost is updated, 13 Cancelled; Avg cost is updated, 14 Execution - Success, 15 Expired, 1617 In approval

Values

1: Initialized
2: Confrimed
3: Recoding
4: Record - Success
5: Record - Failed
6: Execution - Pending Approval
7: Executing
9: Execution - Success
10: Execution - Failed
0: Not Created
12: Cancelled
11: Success; Avg cost is updated
13: Cancelled; Avg cost is updated
14: Execution - Success
15: Expired
1617: In approval

notify_statestring

Filters results by Client Mandate Collection Status.

Multiple values are supported. Join them with commas (,). Omit the field to disable this filter.

Allowed values: 1 Initialized, 2 Mandate Collection, 3 Processed - Success, 4 Processed - Failed, 5 Submitted to upstream/C.P., 6 Alloted/Completed

Values

1: Initialized
2: Mandate Collection
3: Processed - Success
4: Processed - Failed
5: Submitted to upstream/C.P.
6: Alloted/Completed

payable_dateobject

Filters results by Payable Date.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

in_side_election_toobject

Filters results by Elect. Period to.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

origin_counter_idstring

Filters results by Origin Counter ID.

ca_codestring

Filters results by Announcement NO..

updated_atobject

Filters results by Updated At.

Child attributes

gtestring

Inclusive lower bound of the filter range.

ltestring

Inclusive upper bound of the filter range.

pageinteger

Page number to retrieve, starting from 1.

page_sizeinteger

Number of records to return per page.

Responses

HTTP 200On success, returns paginated corporate stock register details 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

ca_codestring

Returned value: Announcement NO..

ann_typestring

Returned value: Ann Type.

ann_type_valstring

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

marketstring

Returned value: Market.

market_valstring

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

origin_counter_idstring

Returned value: Origin Counter ID.

broker_namestring

Returned value: AE.

origin_idstring

Returned value: A/C No..

real_namestring

Returned value: Client Name.

account_statestring

Returned value: Client State.

account_state_valstring

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

stage_statestring

Returned value: CA Execution Status.

stage_state_valstring

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

client_detail_typestring

Returned value: Client Detail Type.

custodian_namestring

Returned value: Custodian.

counterpart_accountstring

Returned value: Sub A/C.

record_datestring

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

election_fromstring

Returned value: Elect. Period From.

in_side_election_tostring

Returned value: Elect. Period To.

payable_datestring

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

origin_quantitystring

Returned value: Eligible Qty.

choices_quantitystring

Returned value: Actual Exercised Qty.

notify_statestring

Returned value: Client Mandate Collection Status.

notify_state_valstring

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

execute_statestring

Returned value: Client Execution Status.

execute_state_valstring

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

updated_bystring

Returned value: Mandate Updated By.

updated_atstring

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

remarkstring

Returned value: Remark.

send_email_atstring

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

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

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "list": [
      {
        "ca_code": "12140",
        "ann_type": "BE",
        "ann_type_val": "4",
        "market": "HK",
        "market_val": "HK",
        "origin_counter_id": "ST/HK/700",
        "broker_name": "--",
        "origin_id": "",
        "real_name": "",
        "account_state": "Closed",
        "account_state_val": "-1",
        "stage_state": "Record - Success",
        "stage_state_val": "4",
        "client_detail_type": "",
        "custodian_name": "--",
        "counterpart_account": "--",
        "record_date": "1775692800",
        "election_from": "--",
        "in_side_election_to": "--",
        "payable_date": "20260511",
        "origin_quantity": "-7.733",
        "choices_quantity": "-7.733",
        "notify_state": "Initialized",
        "notify_state_val": "1",
        "execute_state": "Not Processed",
        "execute_state_val": "1",
        "updated_by": "",
        "updated_at": "1778491691",
        "remark": "",
        "send_email_at": ""
      }
    ],
    "total": 482933
  }
}

Export

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

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

lb_hk_corporate.corporate_query

Export options Export records Download result