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

# Identify session

> Attaches an end user identity to a session.



## OpenAPI

````yaml https://api.interfere.com/openapi.json post /v3/session/identify
openapi: 3.0.4
info:
  title: Interfere API
  termsOfService: https://interfere.com/legal/terms-of-service
  contact:
    email: support@interfere.com
    name: Interfere Support
    url: https://interfere.com/~/*/settings/support
  license:
    name: All Rights Reserved
    url: https://interfere.com/legal/terms-of-service
  description: >-
    Register builds, ingest telemetry, and inspect application issues. Build
    operations authenticate with a secret surface key; SDK ingestion uses a
    publishable surface key. Dashboard operations require a Clerk session, and
    investigation endpoints require workload identity. Authentication
    alternatives are listed on each operation. Retry only when the operation
    contract permits it, preserving the original idempotency key.
  version: 3.0.0
servers:
  - url: https://api.interfere.com
    description: This environment
security: []
tags:
  - name: Releases
    description: Build registration and source-map uploads
  - name: Sessions
    description: Session identity, activity, and events
externalDocs:
  url: https://interfere.com/docs
  description: Interfere Documentation
paths:
  /v3/session/identify:
    post:
      tags:
        - Sessions
      summary: Identify session
      description: Attaches an end user identity to a session.
      operationId: identifySession
      requestBody:
        required: true
        content:
          application/json:
            examples:
              customIdentity:
                value:
                  sessionId: 01991111-1111-7111-8111-111111111111
                  identifier: customer-123
                  email: customer@example.com
                  source:
                    type: custom
                    name: account-service
            schema:
              $ref: '#/components/schemas/IdentifySessionRequest'
      responses:
        '200':
          description: Identity attached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionResponse'
        '401':
          description: Missing or invalid public key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthProblem'
        '503':
          description: >-
            A dependency failed while accepting the request; retry with backoff
            after the Retry-After delay
          headers:
            Retry-After:
              schema:
                description: Seconds to wait before retrying
                type: string
              required: true
              description: Seconds to wait before retrying
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionUnavailableProblem'
      security:
        - publicKeyHeader: []
        - publicKey: []
components:
  schemas:
    IdentifySessionRequest:
      properties:
        deviceId:
          format: uuid
          type: string
          nullable: true
        fpHash:
          type: string
          nullable: true
        sessionId:
          minLength: 1
          type: string
        visitorId:
          format: uuid
          type: string
          nullable: true
        avatar:
          type: string
        email:
          format: email
          type: string
        identifier:
          type: string
        name:
          type: string
        source:
          $ref: '#/components/schemas/IdentifySource'
        traits:
          $ref: '#/components/schemas/IdentifyTraits'
        country:
          maxLength: 2
          type: string
      required:
        - sessionId
        - identifier
        - source
      description: Request body for identifying the end user associated with a session.
      type: object
    SessionResponse:
      properties:
        ok:
          type: boolean
      required:
        - ok
      description: SessionResponse
      type: object
    AuthProblem:
      properties:
        code:
          enum:
            - AUTH_MISSING
            - AUTH_PK_INVALID
          type: string
        message:
          type: string
        service:
          enum:
            - collector
            - gateway
            - operation
            - intelligence
            - frontier-auth
            - frontier-drain
            - frontier-runtime
            - frontier-buildtime
            - api-tinybird
            - api-findings
            - api-updates
          type: string
      required:
        - code
      type: object
    SessionUnavailableProblem:
      properties:
        code:
          enum:
            - INGEST_INFRA_UNAVAILABLE
          type: string
        message:
          type: string
        service:
          enum:
            - collector
            - gateway
            - operation
            - intelligence
            - frontier-auth
            - frontier-drain
            - frontier-runtime
            - frontier-buildtime
            - api-tinybird
            - api-findings
            - api-updates
          type: string
      required:
        - code
      type: object
    IdentifySource:
      oneOf:
        - $ref: '#/components/schemas/ClerkIdentifySource'
        - $ref: '#/components/schemas/Auth0IdentifySource'
        - $ref: '#/components/schemas/WorkOSIdentifySource'
        - $ref: '#/components/schemas/CustomIdentifySource'
      discriminator:
        propertyName: type
        mapping:
          clerk:
            $ref: '#/components/schemas/ClerkIdentifySource'
          auth0:
            $ref: '#/components/schemas/Auth0IdentifySource'
          workos:
            $ref: '#/components/schemas/WorkOSIdentifySource'
          custom:
            $ref: '#/components/schemas/CustomIdentifySource'
      description: Auth provider that surfaced this identification.
    IdentifyTraits:
      additionalProperties: {}
      description: >-
        Free-form key/value bag of user attributes attached when identifying a
        session.
      type: object
    ClerkIdentifySource:
      properties:
        name:
          enum:
            - Clerk
          type: string
        type:
          enum:
            - clerk
          type: string
      required:
        - name
        - type
      description: ClerkIdentifySource
      type: object
    Auth0IdentifySource:
      properties:
        name:
          enum:
            - Auth0
          type: string
        type:
          enum:
            - auth0
          type: string
      required:
        - name
        - type
      description: Auth0IdentifySource
      type: object
    WorkOSIdentifySource:
      properties:
        name:
          enum:
            - WorkOS
          type: string
        type:
          enum:
            - workos
          type: string
      required:
        - name
        - type
      description: WorkOSIdentifySource
      type: object
    CustomIdentifySource:
      properties:
        name:
          type: string
        type:
          enum:
            - custom
          type: string
      required:
        - name
        - type
      description: CustomIdentifySource
      type: object
  securitySchemes:
    publicKeyHeader:
      description: >-
        Public key of the receiving surface; preferred for OTel Collector
        exporters, whose endpoint config cannot carry query strings
      in: header
      name: x-interfere-public-key
      type: apiKey
    publicKey:
      description: Public key of the receiving surface
      in: query
      name: public_key
      type: apiKey

````

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