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

# Caller identity

> Read principal first: other fields differ by principal.

Required scopes: none. Any valid API key can call this endpoint.



## OpenAPI

````yaml /api/openapi.json get /identity
openapi: 3.0.0
info:
  title: Paraform API
  version: v1
servers:
  - url: https://external-api.paraform.com/api/external/v1
security: []
paths:
  /identity:
    get:
      summary: Caller identity
      description: |-
        Read principal first: other fields differ by principal.

        Required scopes: none. Any valid API key can call this endpoint.
      operationId: getIdentity
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      principal:
                        type: string
                        enum:
                          - agency
                      clientId:
                        type: string
                      agencyId:
                        type: string
                      name:
                        type: string
                      access:
                        type: string
                        enum:
                          - ALL
                          - READ_ALL
                          - ALL_READS
                      scopes:
                        type: array
                        items:
                          type: string
                      environment:
                        type: string
                    required:
                      - principal
                      - clientId
                      - agencyId
                      - name
                      - access
                      - scopes
                      - environment
                  - type: object
                    properties:
                      principal:
                        type: string
                        enum:
                          - recruiter
                      referrerUserId:
                        type: string
                      userId:
                        type: string
                      email:
                        type: string
                        nullable: true
                      name:
                        type: string
                      access:
                        type: string
                        enum:
                          - ALL
                          - READ_ALL
                          - ALL_READS
                      scopes:
                        type: array
                        items:
                          type: string
                      environment:
                        type: string
                      eligiblePrincipals:
                        type: array
                        items:
                          type: string
                          enum:
                            - company_user
                            - recruiter
                        description: >-
                          Paraform staff OAuth sign-in only: every principal
                          user may select.
                    required:
                      - principal
                      - referrerUserId
                      - userId
                      - email
                      - name
                      - access
                      - scopes
                      - environment
                  - type: object
                    properties:
                      principal:
                        type: string
                        enum:
                          - company_user
                      companyId:
                        type: string
                      companyUserId:
                        type: string
                      userId:
                        type: string
                      email:
                        type: string
                      name:
                        type: string
                      access:
                        type: string
                        enum:
                          - ALL
                          - READ_ALL
                          - ALL_READS
                      scopes:
                        type: array
                        items:
                          type: string
                      environment:
                        type: string
                      eligiblePrincipals:
                        type: array
                        items:
                          type: string
                          enum:
                            - company_user
                            - recruiter
                        description: >-
                          Paraform staff OAuth sign-in only: every principal
                          user may select.
                    required:
                      - principal
                      - companyId
                      - companyUserId
                      - userId
                      - email
                      - name
                      - access
                      - scopes
                      - environment
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.