Description

Purpose and use

Profile gives a signed-in user the context needed to work inside CoreBanq: identity, customer links, available roles, and tray data used by the application shell.

Who uses this. Every authenticated staff or customer user uses profile data indirectly when the application loads their workspace, permissions, and customer context.

How it works. The profile tray combines user identity with customer memberships, role information, and related context needed to decide which records and screens the user can access.

What users do. Users open the application, switch or review customer context where allowed, and rely on profile data to see the correct navigation and operational scope.

Outcomes and side effects. Profile reads are contextual and do not post money or change business records. Incorrect profile context can hide records or expose the wrong workspace, so role and customer links should be reviewed through the user and RBAC manuals.

Related manuals: Users, Roles, RBAC, Customers.

Overview

The Profile API provides functionality for managing user profiles and profile trays, including:

• Profile information retrieval
• Profile tray management
• Status tracking
• Route management

Endpoints

Get Profile Tray

GET /v1/profile/tray

Retrieve the profile tray information for the authenticated user.

Success Response (200):

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Personal Profile",
  "type": "individual",
  "status": "active",
  "route": "/app/profile/personal"
}

Error Codes

Response Status Codes