Identity

Get my identity

Returns the identity of the authenticated principal: the account the credential belongs to, the person's email, name, logo and interface language, and a description of the credential itself. Unlike every other operation, it requires no scope — any valid credential resolves, so a 200 confirms the credential works and tells you which account it belongs to, and a 401 that it does not.

  • account_id: identifies who the credential belongs to, not what it is currently pointed at; selecting a different company with BeeL-Active-Company does not change it.
  • name: resolves as trade_name ?? legal_name of the active fiscal profile, and is null until onboarding creates one.
  • credential: describes the credential the call was authenticated with — its type, the environment it operates on and the permissions it holds — so a client can adapt what it offers instead of discovering the limits through a 403.
  • Caching: responses are never cached (Cache-Control: no-store).
get/v1/me/identity

Request

  • Base URL: https://app.beel.es/api
  • URL: https://app.beel.es/api/v1/me/identity
  • Auth: one of:
    • HTTP bearer
    • API key in cookie BEEL_SESSION

Response

Identity of the authenticated principal

successboolean required

Example response

{
  "success": true,
  "data": {
    "account_id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "BeeL.es",
    "email": "user@example.com",
    "logo_url": "https://assets.beel.es/logos/.../profile-logo.jpg",
    "language": "es",
    "credential": {
      "type": "api_key",
      "environment": "PROD",
      "scopes": [
        "invoices:write",
        "customers:read",
        "companies:list"
      ]
    }
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

Changes

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