Get user profile

Returns comprehensive user information including all role-specific contexts in a single response. Reduces the need for multiple API calls during session initialization.

get/api-regulated/v1/users/self

Request

Base URL: https://api.currencyguard.com
URL: https://api.currencyguard.com/api-regulated/v1/users/self
Auth: HTTP bearer

Response

Complete user profile retrieved

Example response

{
  "user": {
    "id": "12345678-1234-4001-8000-123456789012",
    "subClaim": "auth0|12345678-1234-4001-8000-123456789012",
    "roleClaims": "ROLE_ADMIN,ROLE_TRADER",
    "status": "ENABLED",
    "onboardedDate": "2024-01-15T00:00:00Z",
    "entitlementsTemplateId": "12345678-1234-4001-8000-123456789012",
    "piiData": {
      "email": "john.doe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "+44 20 7946 0958",
      "jobTitle": "Risk Manager",
      "department": "Trading"
    },
    "preferences": {
      "tables": {
        "guard-book": {
          "pageSize": 50
        }
      }
    },
    "perimeterId": "cccccccc-cc11-4001-8000-000000000000",
    "authType": "OAUTH2_AUTHORIZATION_CODE",
    "eventSequence": 12345,
    "versionNumber": 1,
    "updatedBy": "jbloggs24",
    "updatedAt": "2024-10-18T12:30:40Z",
    "createdAt": "2024-10-18T12:30:40Z"
  },
  "regulatedContext": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "regulatedEntityId": "aaaaaaaa-aa11-4001-8000-000000000000",
    "isActive": true,
    "eventSequence": 12345,
    "versionNumber": 1,
    "updatedBy": "jbloggs24",
    "updatedAt": "2024-10-18T12:30:40Z",
    "createdAt": "2024-10-18T12:30:40Z"
  },
  "salesUserContext": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "regulatedEntityId": "aaaaaaaa-aa11-4001-8000-000000000000",
    "introducingBrokerId": "eeeeeeee-ee55-4001-8000-000000000000",
    "isActive": true,
    "eventSequence": 12345,
    "versionNumber": 1,
    "updatedBy": "jbloggs24",
    "updatedAt": "2024-10-18T12:30:40Z",
    "createdAt": "2024-10-18T12:30:40Z"
  },
  "customerContext": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "regulatedEntityId": "aaaaaaaa-aa11-4001-8000-000000000000",
    "introducingBrokerId": "eeeeeeee-ee55-4001-8000-000000000000",
    "companyId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "isActive": true,
    "eventSequence": 12345,
    "versionNumber": 1,
    "updatedBy": "jbloggs24",
    "updatedAt": "2024-10-18T12:30:40Z",
    "createdAt": "2024-10-18T12:30:40Z"
  },
  "internalContext": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "currencyGuardCompanyId": "00000000-0000-4000-8000-000000000000",
    "isActive": true,
    "eventSequence": 12345,
    "versionNumber": 1,
    "updatedBy": "jbloggs24",
    "updatedAt": "2024-10-18T12:30:40Z",
    "createdAt": "2024-10-18T12:30:40Z"
  }
}

Changes

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