---
title: "View User Profile"
method: GET
path: "/api/profile"
tags: ["Account Management"]
---

# View User Profile

`GET /api/profile`

## Request

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

Retrieve comprehensive user profile information including account restrictions statuses.

## Headers

- `content-type` string, required
- `accept-language` string, required
- `x-user-id` string, required
- `x-subject-type` string, required
- `x-client-token` string, required

## Response `200`

Profile

- ProfileResponse
  - `surname` string, required: Surname
  - `street` string, required: Street
  - `province` string, required: Province
  - `postal_code` string, required: Postal code
  - `phone_number` string, required: Phone number
  - `next_of_kin` string: Full name of Next of Kin
  - `name` string, required: Name
  - `gender` string, 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_verified` boolean, required: Email verified
  - `email` string, required: Email
  - `city` string, required: City
  - `citizenship` string, required: Citizenship
  - `carrot_integration_status` 'not_available' | 'available' | 'authorized', required: Carrot integration status for user
  - `age` integer, required: Age
  - `account_restriction` object
    - `restricted` boolean: true if account is restricted, false if not
    - `reason` string: reason of account restriction
  - `account_number` string, required: Account number

## Other responses

- `401`: Token have expired or invalid token
- `404`: Resource not found

---

[API](https://skmtc.dev/investbamboo/apis/investbamboo-bamboo-api.md) - [All operations](https://skmtc.dev/investbamboo/apis/investbamboo-bamboo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/investbamboo/apis/investbamboo-bamboo-api/revisions/063521e8d924?raw)
