Account Management

View User Profile

Retrieve comprehensive user profile information including account restrictions statuses.

get/api/profile

Request

Base URL
https://powered-by-bamboo-sandbox.investbamboo.com
Auth
none declared. Required headers: content-type, accept-language, x-user-id, x-subject-type, x-client-token

Headers

content-typestring required

Acceptable content type

accept-languagestring required

Acceptable language; 'en' for English

x-user-idstring required

Required for user authentication

x-subject-typestring required

For user request -> 'tenant'.

x-client-tokenstring required

API consumer token

Response

Profile

surnamestring required

Surname

streetstring required

Street

provincestring required

Province

postal_codestring required

Postal code

phone_numberstring required

Phone number

next_of_kinstring

Full name of Next of Kin

namestring required

Name

genderstring required

Gender

engagement_status'no_deposit' | 'no_trade' | 'traded' required

The User's engagement status in the system. NOTE - use it only to show banner on main page.

email_verifiedboolean required

Email verified

emailstring required

citystring required

City

citizenshipstring required

Citizenship

carrot_integration_status'not_available' | 'available' | 'authorized' required

Carrot integration status for user

ageinteger required

Age

account_numberstring required

Account number

Example response

{
  "surname": "Doe",
  "street": "4383 Ms. Godspower Savage Squares, Ngaski Lagos",
  "province": "Lagos State",
  "postal_code": "+234",
  "phone_number": "+2347083864023",
  "next_of_kin": "Phil Doe",
  "name": "John",
  "gender": "Man",
  "engagement_status": "no_trade",
  "email": "johndoe@gmail.com",
  "city": "Lekki",
  "citizenship": "Nigeria",
  "carrot_integration_status": "not_available",
  "age": 96,
  "account_restriction": {
    "reason": "Account is under review"
  },
  "account_number": "84861889"
}

Changes

No recorded changes to this operation across all 1 revision of this API.