Skip to content
Longport WhaleLongport Whale
Account Profile & Status

Update Account State/Disable Account

Changes the state of a securities account.

Request parameters

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

Business notes

Switches the account to the state given by to_state: activate (active), suspend (suspend), or disable/freeze (disable).

Risk warning

This operation directly changes whether the account can trade and be operated; suspending or freezing it disrupts the customer's normal use of the account. Confirm the target securities account and state before calling.

Result

On success, the account switches to the target state. The resulting state is defined by the 200 response.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

account.suspend_accountaccount.unlock_accountaccount.account_cancellation

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.

to_statestringrequired

Target account state; changes the account state (for example, to active)

Responses

HTTP 200Success
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