Get Account Status

Returns the current account-state information for a securities account.

Request parameters

Required: account_no (securities account)
See the field definitions for each field's format, allowed values, and business meaning.

Business notes

Returns the account's securities account number, account state, frozen state, and account type.

Returns

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

POSThttps://b-api.lbkrs.com/v1/whaleapi/account/get

Authorization

AuthorizationstringheaderRequired

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

Permission

kyc.hk_account

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

Request body application/json

account_nostringrequired

Account Number. 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

accountobjectrequired

account

Child attributes

account_nostringrequired

account_no

stateintegerrequired

state

disablebooleanrequired

disable

account_typestringrequired

account_type

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 POST \
  --url 'https://b-api.lbkrs.com/v1/whaleapi/account/get' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json'
  --data '{
  "account_no": "8600000001"
}'

Response

{
  "code": 0,
  "message": "success",
  "data": {
    "account": {
      "account_no": "8600000001",
      "state": 0,
      "disable": false,
      "account_type": "M"
    }
  }
}