Get Account Bcan Information

Returns the BCAN (Broker-to-Client Assigned Number) information for a securities account.

Request parameters

This endpoint has no required parameters; see the field definitions for optional parameters.
See the field definitions for each field's format, allowed values, and business meaning.

Business notes

Returns the account's CE number ce_no, BCAN bcan_no, China Connect consent status, HKIDR consent status, and the effective status of both.

Returns

On success, returns the account BCAN information. See the response definition for field meanings.

GEThttps://b-api.lbkrs.com/v1/whaleapi/account/bcan_info

Authorization

AuthorizationstringheaderRequired

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

Permission

account.bcan_code_list

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

Parameters

account_nostringRequired

Account Number

account_no is the securities account number (such as L6VQEU00121996). It differs from the customer ID member_id and the internal securities account ID aaid.

Responses

HTTP 200Success

Standard response envelopecodemessagedata

dataobjectdata structure

ce_nostringrequired

ce_no

bcan_nostringrequired

bcan_no

is_agreebooleanrequired

is_agree

hk_is_agreebooleanrequired

hk_is_agree

stateintegerrequired

state

hk_stateintegerrequired

hk_state

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 GET \
  --url 'https://b-api.lbkrs.com/v1/whaleapi/account/bcan_info' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "ce_no": "SN20250101000001",
    "bcan_no": "SN20250101000001",
    "is_agree": false,
    "hk_is_agree": false,
    "state": 0,
    "hk_state": 0
  }
}