Skip to content
Longport WhaleLongport Whale
Corp Action Management

Void Client Register Details

Voids client registration details under a corporate action in bulk. The caller supplies the list of registration-detail IDs ids, and the system marks those details as voided.

Request parameters

  • Required: ids (registration-detail IDs; each item is one client-detail record).
  • Optional: audit_frontend_resource (caller-provided audit context).

Risk warning

This operation voids client registration details and affects downstream corporate-action processing. Confirm the target detail IDs before calling.

Result

On success the specified details are voided; the outcome is in data. Interpret it together with the business code.

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

idsarray<string>required

List of client register-detail IDs to void. Each item identifies one client detail record.

audit_frontend_resourceobject

Caller-provided audit context recording the business information associated with this operation. Typically includes the announcement number, security, and client account identifiers.

Child attributes
ca_codestring

Associated corporate-action announcement number.

origin_counter_idstring

Associated security identifier.

aaidstring

Associated client account identifier.

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.

Responses

HTTP 200The request was processed successfully. The result is returned in data.
Standard response envelopecodemessagedata
dataobjectdata structure

Business result; usually an empty object.

No nested fields

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