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

# Get Current Identity

> Retrieve the calling API key's access level and the business the request resolved to, including its `businessId` and tenant key. With a Platform API token, pass `X-MultiTenantKey` to confirm which sub-business your requests operate on.



## OpenAPI

````yaml /openapi/workforce-management.yaml get /v1/me
openapi: 3.0.0
info:
  description: APIs for interacting with Cadana Payroll Platform
  version: 1.0.0
  title: Business Workforce Management
  termsOfService: https://cadanapay.com/terms-and-conditions
  contact:
    email: api@cadanapay.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.cadanapay.com
    description: Prod Server
  - url: https://dev-api.cadanapay.com
    description: Dev Server
security:
  - Authorization: []
tags:
  - name: Custom Auth
    description: APIs for interacting with Custom Authentication
  - name: Persons
    description: APIs for interacting with the HR module
  - name: Milestones
    description: APIs for milestone-based contractor pay
  - name: Instant Pay
    description: APIs for interacting with Instant Pay functionality
  - name: Users
    description: APIs for interacting with employee/contractor Cadana accounts
  - name: Files
    description: APIs for interacting with file uploads
  - name: Payrolls
    description: APIs for interacting with Payroll
  - name: Platform
    description: Platform APIs for interacting with businesses
  - name: Businesses
    description: APIs for interacting with Business
  - name: Treasury
    description: APIs for business balances, funding, and withdrawals
  - name: KYB
    description: APIs for business verification
  - name: Contracts
    description: APIs for interacting with contracts
  - name: Sandbox
    description: APIs for relevant sandbox simulations
  - name: Invoices
    description: APIs for interacting with invoices
  - name: Reimbursements
    description: APIs for interacting with reimbursements
  - name: Entities
    description: >-
      APIs for managing legal sub-entities (subsidiaries, branches) under a
      parent business
paths:
  /v1/me:
    get:
      tags:
        - Businesses
      summary: Get Current Identity
      description: >-
        Retrieve the calling API key's access level and the business the request
        resolved to, including its `businessId` and tenant key. With a Platform
        API token, pass `X-MultiTenantKey` to confirm which sub-business your
        requests operate on.
      operationId: getMe
      parameters:
        - $ref: '#/components/parameters/XMultiTenantKey'
      responses:
        '200':
          $ref: '#/components/responses/GetMeResponse'
        5XX:
          $ref: '#/components/responses/InternalError'
      security:
        - Authorization: []
components:
  parameters:
    XMultiTenantKey:
      name: X-MultiTenantKey
      in: header
      required: false
      schema:
        type: string
      description: >-
        Required when using a Platform API token. The tenant key identifying
        which business to operate on.
  responses:
    GetMeResponse:
      description: get current identity response
      content:
        application/json:
          schema:
            type: object
            properties:
              apiKey:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Identifier of the API key making the request
                  accessLevel:
                    type: string
                    description: 'Level of access of the key: READ, FULL, or PLATFORM'
                  status:
                    type: string
                  description:
                    type: string
                  tenantPrefix:
                    type: string
                    description: Present only on Platform API keys
              business:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: The businessId of the business this request resolved to
                  tenantKey:
                    type: string
                  name:
                    type: string
                  country:
                    type: string
          example:
            apiKey:
              id: ba51f42c-0adc-4a77-8dd1-a03dd4fb955f
              accessLevel: FULL
              status: active
              description: Production key
            business:
              id: 1f7b33d4-45c6-4a66-b58f-2f6b3d3e5a10
              tenantKey: acme-us
              name: Acme Inc.
              country: US
    InternalError:
      description: Internal error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalError'
  schemas:
    InternalError:
      description: Internal server error
      allOf:
        - $ref: '#/components/schemas/Error'
      example:
        code: internal_error
        message: An unexpected error occurred. Please try again later.
    Error:
      type: object
      properties:
        code:
          description: A machine parsable error code
          type: string
          enum:
            - invalid_request_body
            - resource_not_found
            - forbidden
            - internal_error
        message:
          description: A human readable message describing the error
          type: string
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      bearerFormat: API_SECRET_KEY

````