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

# Describe the calling API key

> Return metadata about the API key authenticating this request, including its scopes. The plaintext secret is never returned.



## OpenAPI

````yaml https://withbridge-image1-sv-usw2-monorail-openapi.s3.amazonaws.com/latest.json get /api_keys/whoami
openapi: 3.0.2
info:
  title: Bridge API
  description: APIs to move into, out of, and between any form of a dollar
  version: '1'
servers:
  - url: https://api.bridge.xyz/v0
    description: The base path for all resources
security:
  - ApiKey: []
tags:
  - name: Customers
  - name: Fiat Payout Configuration
  - name: External Accounts
  - name: Transfers
  - name: Prefunded Accounts
  - name: Balances
  - name: Liquidation Addresses
  - name: Developers
  - name: API Keys
  - name: Plaid
  - name: Virtual Accounts
  - name: Static Memos
  - name: Cards
  - name: Funds Requests
  - name: Webhooks
  - name: Lists
  - name: Crypto Return Policies
  - name: Rewards
  - name: Associated Persons
  - name: Sandbox
paths:
  /api_keys/whoami:
    get:
      tags:
        - API Keys
      summary: Describe the calling API key
      description: >-
        Return metadata about the API key authenticating this request, including
        its scopes. The plaintext secret is never returned.
      responses:
        '200':
          description: Metadata describing the calling API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKey'
              examples:
                SuccessfulWhoAmIResponse:
                  $ref: '#/components/examples/SuccessfulWhoAmIResponse'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '500':
          $ref: '#/components/responses/UnexpectedError'
components:
  schemas:
    ApiKey:
      required:
        - id
        - type
        - owner_type
        - owner_id
        - prefix
        - last_4
        - state
        - created_at
        - updated_at
        - scopes
      properties:
        id:
          description: The unique identifier for this API key.
          type: string
          format: uuid
        type:
          description: >-
            Whether the key was created programmatically (Private) or via the
            Dashboard (Public).
          type: string
          enum:
            - Public
            - Private
        owner_type:
          description: The type of entity that owns the key. Always `Developer`.
          type: string
          enum:
            - Developer
        owner_id:
          description: The developer ID that owns the key.
          type: string
          format: uuid
        prefix:
          description: >-
            The environment prefix of the key. `sk-live` in production,
            `sk-test` in sandbox.
          type: string
          enum:
            - sk-live
            - sk-test
        last_4:
          description: >-
            The last four characters of the key, shown alongside the prefix for
            disambiguation in audit logs.
          type: string
        state:
          description: Lifecycle state of the key.
          type: string
          enum:
            - Active
            - Deleted
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        scopes:
          description: >
            The scopes authorized on this key. A single-element list containing
            `bridge:api_unrestricted`

            denotes an unrestricted key (all standard scopes). Any other list
            denotes a scoped key.
          type: array
          items:
            type: string
        name:
          description: >-
            The human-readable label for this key, if one was provided at
            creation.
          type: string
          maxLength: 100
    Error:
      required:
        - code
        - message
      properties:
        code:
          type: string
          minLength: 1
          maxLength: 256
        message:
          type: string
          minLength: 1
          maxLength: 512
        source:
          title: ErrorSource
          required:
            - location
            - key
          properties:
            location:
              type: string
              enum:
                - path
                - query
                - body
                - header
            key:
              type: string
              description: >-
                Comma separated names of the properties or parameters causing
                the error
  examples:
    SuccessfulWhoAmIResponse:
      summary: A successful whoami request for a scoped API key.
      value:
        id: 5f1f5b3a-8c2b-4e5f-9d88-e0b2a7d3a1e8
        type: Private
        owner_type: Developer
        owner_id: e802b3a4-f453-4da8-8a5b-dd50cede1e4f
        prefix: sk-live
        last_4: 9f2c
        state: Active
        created_at: '2026-04-22T15:04:05Z'
        updated_at: '2026-04-22T15:04:05Z'
        name: Customer service key
        scopes:
          - customer:read
          - customer:create
  responses:
    AuthenticationError:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            MissingTokenError:
              summary: No Api-Key header
              description: The header may be missing or misspelled.
              value:
                code: required
                location: header
                name: Api-Key
                message: Missing Api-Key header
            InvalidTokenError:
              summary: Invalid key in Api-Key header
              value:
                code: invalid
                location: header
                name: Api-Key
                message: Invalid Api-Key header
    UnexpectedError:
      description: Unexpected error. User may try and send the request again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            UnexpectedError:
              summary: An unexpected error
              value:
                errors:
                  - code: unexpected
                    message: An expected error occurred, you may try again later
  securitySchemes:
    ApiKey:
      type: apiKey
      name: Api-Key
      in: header

````