Skip to content

Developer Documentation

User Profile

Manage your account details and notification settings.

Get User Profile

GET /v1/users/me

Retrieve the profile information for the authenticated user.

Query Parameters
Request Body
{}
Body Parameters
Test Request
Response
{
  "status": "success",
  "data": {
    "user_id": 101,
    "full_name": "John Doe",
    "email": "john@example.com",
    "phone_number": "254700000000",
    "kyc_level": "tier1",
    "compliance_status": "verified"
  }
}

Update User Profile

PATCH /v1/users/me

Update mutable profile fields.

Request Body
{
  "full_name": "Johnathan Doe",
  "phone_number": "254711000000"
}
Body Parameters
  • full_name (string, optional): The user's full name.
  • phone_number (string, optional): The user's phone number.
Test Request
Response
{
  "status": "success",
  "message": "Profile updated successfully."
}

Notifications

Get Preferences

GET /v1/users/notifications

Retrieve current notification settings.

Query Parameters
Request Body
{}
Body Parameters
Test Request
Response
{
  "status": "success",
  "data": {
    "sms_enabled": true,
    "email_enabled": true,
    "marketing_enabled": false
  }
}

Update Preferences

PUT /v1/users/notifications

Update notification channels.

Request Body
{
  "sms_enabled": false,
  "email_enabled": true,
  "marketing_enabled": true
}
Body Parameters
  • sms_enabled (boolean, optional): Enable SMS notifications.
  • email_enabled (boolean, optional): Enable email notifications.
  • marketing_enabled (boolean, optional): Enable marketing communications.
Test Request
Response
{
  "status": "success",
  "message": "Preferences updated"
}