Skip to content
Account Profile & Status

Get Member Information by Login Email

Looks up a user by login email.

Request parameters

  • Required: email (user's login email)
  • See the field definitions for each field's format, allowed values, and business meaning.

Business notes

Locates and returns the user matching the supplied login email.

Returns

On success, returns the user matching the email. See the response definition for field meanings.

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

Authorization

AuthorizationstringheaderRequired

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

Permission

account.search_member

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

Request body application/json

emailstringrequired

Login Email. Login Email

Responses

HTTP 200Success
Standard response envelopecodemessagedata
dataobjectdata structure
memberobjectrequired

Member info. Member info

Child attributes
member_idstringrequired

Member ID. Member ID

email_verifiedbooleanrequired

Login email verification status. Login email verification status

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