Skip to content
Longport WhaleLongport Whale
Account Profile & Status

Update PI Status

Updates a user's Professional Investor (PI) status.

Request parameters

  • Required: member_id (member ID), pi_status (PI status)
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

Sets the member's PI status to the supplied value. Passing an empty string for pi_status resets it to the default empty state.

Risk warning

This operation changes the user's Professional Investor certification status, which may affect the products and services they can access. Confirm the target member and status before calling.

Result

On success, the PI status is updated. The resulting state is defined by the 200 response.

POSThttps://b-api.lbkrs.com/v1/whaleapi/member/update_pi_status

Authorization

AuthorizationstringheaderRequired

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

Permission

customer.pi_app_record

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

Request body application/json

member_idintegerrequired

member_id

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.

pi_statusstringrequired

pi_status

Responses

HTTP 200Successful response
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