Skip to content
Longport WhaleLongport Whale
Bank Account Management

Additional Names

Queries customer additional-name records, used to maintain customer name matching for incoming deposits and to follow up on approvals.

Request parameters

  • Use filters to combine business conditions (see the filters field notes below), and use page, page_size, and orderBy to control pagination and sorting.

Business notes

The data comes from customer additional-name maintenance; each record represents a set of supplementary names submitted for a customer, linked to that customer's KYC information and approval flow.

Each record includes the owning customer member_id, the securities account, the additional-name list, and KYC details such as the customer name, English name, document type and number, date of birth, and nationality, along with the state state, the initiator, the approver, and the creation/update times.

It is typically used to maintain customer aliases for reconciling incoming deposits and to track the approval status of additional names.

Returns

On success, returns the matched record list with pagination. See the response definition for the meaning of each column.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

atm.update_deposit_name_inquiry

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

Request body application/json

filtersobject

Filters

Child attributes
member_idstring

Client

member_id is the customer ID. It differs from the securities account number account_no and the internal securities account ID aaid; one customer can have multiple securities accounts.

statestring

Status

Allowed values: 0 Success, 1 New pending review, 2 Waiting Edit Review, 3 Delete pending approval

Values
0
1
2
3
pageinteger

Page

page_sizeinteger

Page Size

orderByarray<object>

Order By

Responses

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

List

Child attributes
idstring

ID

member_idstring

Client ID

member_id_valstring

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

origin_idsstring

Account NO.

concatenated_namesstring

Extra Client Name

custom_kyc_namestring

KYC Information

real_namestring

KYC:Client Name

en_namestring

KYC:English Name

card_idstring

KYC:Card ID

birth_datestring

KYC:Date of Birth

statestring

Status

state_valstring

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

created_atstring

Created At

updated_atstring

Update Time

ticket_admin_idstring

Initiator

ticket_admin_id_valstring

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

auditor_admin_idstring

Approver

auditor_admin_id_valstring

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

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