Skip to content
Account Profile & Status

Get Account Contact Info

Returns the account contact information for a user.

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

Given the user ID member_id, returns the phone numbers and email addresses bound to that user.

Returns

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

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

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.

Parameters

member_idstringRequired

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.

Responses

HTTP 200Success
Standard response envelopecodemessagedata
dataobjectdata structure
contactobjectrequired

contact

Child attributes
phonesarray<object>required

phones

Child attributes
country_codeintegerrequired

country_code

mobilestringrequired

mobile

defaultedobjectrequired

defaulted

updated_atintegerrequired

updated_at

emailsarray<object>required

emails

Child attributes
emailstringrequired

email

defaultedstringrequired

defaulted

updated_atintegerrequired

updated_at

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