Skip to content
Corp Action Management

notification report

Returns the header summary of instruction collection for a single corporate-action announcement, giving an overview of the eligible exercise scale and the progress of exercise instructions for that announcement.

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 ann_id to target one announcement; the endpoint returns a single aggregated summary at the announcement level.

Business notes

  • Data is aggregated per corporate-action announcement and covers the announcement code, the underlying security, and election cut-off dates (including the CCASS basis).

  • Statistics include the exercisable share quantity, the number of eligible users, and the number of users that have completed an exercise operation, split between customer self-service on the App and back-office operations on the customer's behalf.

  • Typically used during the instruction-collection window to reconcile customer participation and outstanding gaps, and to decide whether follow-up reminders or back-office operations are needed.

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_notification_report

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
ann_idstring

Ann ID

pageinteger

Page

page_sizeinteger

Page Size

Responses

HTTP 200Paginated list result.
Standard response envelopecodemessagedata
dataobjectdata structure
listarray<object>required

List

Child attributes
choices_quantity_totalstring

Eligible Qty

user_totalstring

Eligible Client

backend_totalstring

Selected Via BO (Client Count)

app_totalstring

Selected Via APP (Client Count)

ca_codestring

Announcement NO.

origin_counter_idstring

Origin Counter ID

in_side_election_tostring

Elect. Period To

election_tostring

End date (CCASS).

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