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

# Check key identity

> Verify the API key, confirm whether it is a user or organisation key, and inspect the effective scope.



## OpenAPI

````yaml /developer-docs/api/openapi.json get /v1/public/me
openapi: 3.1.0
info:
  title: Everbility Public API
  version: 1.0.0
  description: >-
    Pull reports from Everbility, upload notes and files, poll asynchronous
    jobs, and generate reports from saved templates. Partner endpoints let
    approved platforms connect practices with OAuth 2.0, launch report-writing
    sessions, receive signed lifecycle webhooks, and retrieve completed
    documents.
servers:
  - url: https://api.everbility.com
    description: Production
security:
  - bearerAuth: []
paths:
  /v1/public/me:
    get:
      tags:
        - external
      summary: Check key identity
      description: >-
        Verify the API key, confirm whether it is a user or organisation key,
        and inspect the effective scope.
      operationId: get_external_me_v1_external_me_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalMeResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ExternalMeResponse:
      properties:
        principal_type:
          type: string
          enum:
            - user
            - organization
          title: Principal Type
        created_by_user_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By User Id
      type: object
      required:
        - principal_type
      title: ExternalMeResponse
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Use a Clerk-backed Everbility user or organisation API key directly as
        the bearer token.

````