CorebanqCorebanq Developer Docs
Usersv1Registration

List Users

GET
/v1/users/list

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/users/list"
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "description": "string",
    "active": true,
    "lang": "string",
    "mfa_mode": "off",
    "last_login_attempt_at": "2019-08-24T14:15:22Z",
    "context_id": "string",
    "context_type": "string",
    "metadata": {},
    "avatar": "string",
    "persona": {
      "id": "string",
      "first_name": "string",
      "last_name": "string",
      "date_of_birth": "2019-08-24",
      "date_of_death": "2019-08-24",
      "nationality": "string",
      "active": true,
      "metadata": {}
    },
    "customer": {
      "id": "string",
      "name": "string"
    },
    "link": {
      "id": "string",
      "metadata": {}
    },
    "role": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
      "title": "string",
      "subtitle": "string",
      "details": "string",
      "active": true,
      "created_at": "2019-08-24T14:15:22Z",
      "modified_at": "2019-08-24T14:15:22Z",
      "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
      "modified_by": "e8d4374d-93a1-4e98-a6c6-fdcf00c5059f",
      "metadata": {}
    },
    "user_role_id": "1e7e45a3-9003-4195-97ed-60c09c31207c",
    "created_at": "2019-08-24T14:15:22Z",
    "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4"
  }
]
{
  "status": 400,
  "message": "Invalid user input",
  "code": "users_m.invalid_user_input",
  "class": "validation"
}
{
  "status": 401,
  "message": "Unauthorized",
  "code": "common.unauthorized",
  "class": "business"
}
{
  "status": 403,
  "message": "No access to the record",
  "code": "common.rbac_no_rec_access",
  "class": "business"
}

{
  "status": 429,
  "message": "Rate limit for 203.0.113.10 to 456e1234-e89b-12d3-a456-426614174111 exceeded.",
  "code": "rate_limits_m.exceeded",
  "class": "temporary",
  "retryable": true
}

{
  "status": 500,
  "message": "Internal server error",
  "code": "common.server_error",
  "class": "business"
}

{
  "overall_status": "unhealthy",
  "message": "Service is shutting down",
  "timestamp": "2026-08-27T15:04:05Z"
}

GETGet Credential

Previous Page

GETVerify invitation token

AUTHENTICATED BY X-API-Key, not by a bearer token. auth.APIKeyMiddleware REPLACES the usual chain on this route, so there is no user context, no RBAC check and no licence check — and the refusals are common.api_key_required / common.invalid_api_key rather than common.unauthorized / common.rbac_no_rec_access. An OPTIONS request skips the key check entirely. Validate invitation token and return invitation type for activation flow (public endpoint, API key only)