---
title: "Identify session"
method: POST
path: "/v3/session/identify"
tags: ["Sessions"]
---

# Identify session

`POST /v3/session/identify`

## Request

- Base URL: `https://api.interfere.com`
- URL: `https://api.interfere.com/v3/session/identify`
- Auth: one of:
  - API key in header `x-interfere-public-key`
  - API key in query parameter `public_key`

Attaches an application user identity to a session.

## Request body

- IdentifySessionRequest: Request body for identifying the consumer associated with a session.
  - `deviceId` string, uuid, nullable
  - `fpHash` string, nullable
  - `sessionId` string, required
  - `visitorId` string, uuid, nullable
  - `avatar` string
  - `email` string, email
  - `identifier` string, required
  - `name` string
  - `source` union, required: Auth provider that surfaced this identification.
    - ClerkIdentifySource: ClerkIdentifySource
      - `name` 'Clerk', required
      - `type` 'clerk', required
    - Auth0IdentifySource: Auth0IdentifySource
      - `name` 'Auth0', required
      - `type` 'auth0', required
    - WorkOSIdentifySource: WorkOSIdentifySource
      - `name` 'WorkOS', required
      - `type` 'workos', required
    - CustomIdentifySource: CustomIdentifySource
      - `name` string, required
      - `type` 'custom', required
  - `traits` IdentifyTraits: Free-form key/value bag of user attributes attached when identifying a session.
  - `country` string

## Response `200`

Identity attached

- SessionResponse: SessionResponse
  - `ok` boolean, required

## Other responses

- `401`: Missing or invalid public key
- `503`: A dependency failed while accepting the request; retry with backoff after the Retry-After delay

---

[API](https://skmtc.dev/interfere/apis/interfere-api.md) - [All operations](https://skmtc.dev/interfere/apis/interfere-api/llms.txt) - [OpenAPI document](https://skmtc.dev/interfere/apis/interfere-api/revisions/093321c104e6?raw)