Skip to content
Longport WhaleLongport Whale
Corp Action Management

corporate register aaids

Returns the list of registered eligible customer accounts under a corporate-action announcement, used to scope the target customers for notifications and instruction collection.

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 announcement code ca_code to target an announcement, and aaid to further narrow to a specific customer; only registration records of announcements in a valid stage are matched.
  • filters is required and must include ca_code.

Business notes

  • Data comes from customer registration details under the announcement, with one record per registered eligible customer.

  • Each record returns the customer account (aaid), the owning announcement, the customer name, and the securities account (A/C No.), forming the roster of rights holders for that announcement.

  • Typically used as the base recipient and operation roster when sending corporate-action notifications in bulk to registered customers or collecting their exercise instructions.

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_register_aaids

Authorization

AuthorizationstringheaderRequired

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

Permission

corporate.email_notify

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

Request body application/json

filtersobjectrequired

Filters

Child attributes
ca_codestringrequired

Ca Code. Required.

aaidstring

Aaid

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
idstring

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

aaidstring

Aaid

aaid_valstring

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

ann_idstring

Ann Id

real_namestring

Real Name

origin_idstring

A/C No.

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

Whale Docs