> ## Documentation Index
> Fetch the complete documentation index at: https://hevninc.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Introspect the calling API key: user identity, owning app, scope, USDC balance and remaining spend allowance — one call.



## OpenAPI

````yaml /openapi.json get /api/v1/apps/me
openapi: 3.1.0
info:
  title: HEVN API
  description: Backend API for HEVN mobile neobank
  version: 0.1.2
servers: []
security: []
paths:
  /api/v1/apps/me:
    get:
      tags:
        - apps
        - apps-transfer
      summary: >-
        Introspect the calling API key: user identity, owning app, scope, USDC
        balance and remaining spend allowance — one call.
      operationId: get_app_me_api_v1_apps_me_get
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
            title: X-Api-Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppMeResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AppMeResponse:
      properties:
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        email:
          type: string
          title: Email
        balance:
          type: number
          title: Balance
        spendLimit:
          type: number
          title: Spendlimit
        appId:
          type: string
          format: uuid
          title: Appid
        appName:
          type: string
          title: Appname
        scope:
          items:
            $ref: '#/components/schemas/RouteScope'
          type: array
          title: Scope
          default: []
      type: object
      required:
        - email
        - balance
        - spendLimit
        - appId
        - appName
      title: AppMeResponse
      description: |-
        Everything an API-key client needs to know about itself in one call.

        Returned by ``GET /apps/me``. Avoids the older multi-step dance of
        ``GET /user`` + ``GET /apps/{id}`` + ``GET /balance`` for callers (e.g.
        the CLI) that only have an ``X-Api-Key`` and want to introspect.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    RouteScope:
      type: string
      enum:
        - apps
        - apps-transfer
        - balance
        - transfer requests
        - banks
        - cards
        - transactions
        - exports
        - merchant
        - contracts
        - invoices
        - documents
        - user
        - team
        - chat
        - devices
        - referrals
        - public
        - mcp
        - xero
        - admin
        - admin sso
        - kybagent
        - b2b
        - incorporate
        - 2fa
        - auth
        - activity
        - tee
        - tee-local
        - utils
        - webhook
      title: RouteScope
      description: |-
        Allowed values for ``ApiAppAccess.scope``.

        Each entry is the lowercased form of a FastAPI route tag — scope
        enforcement (``_enforce_api_app_scope`` in ``app/dependencies.py``)
        intersects the api-key's scopes with the calling route's tags
        case-insensitively. Stored that way so admins editing an app's
        ``access.scope`` see a stable, predictable set of values.

        Adding a new router tag? Add it here too so issued keys can target it.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````