Skip to main content
POST
Identify session

Authorizations

x-interfere-public-key
string
header
required

Public key of the receiving app; preferred for OTel Collector exporters, whose endpoint config cannot carry query strings

Body

application/json

Request body for identifying the consumer associated with a session.

sessionId
string
required
Minimum string length: 1
identifier
string
required
source
object
required

Auth provider that surfaced this identification.

deviceId
string<uuid> | null
fpHash
string | null
visitorId
string<uuid> | null
avatar
string
company
object

Company attributes attached when identifying a session. The tier is a workspace-managed label (1 to 100 characters, trimmed); unknown tiers are created on first use.

email
string<email>
name
string
traits
object

Free-form key/value bag of user attributes attached when identifying a session.

country
string
Maximum string length: 2

Response

Identity attached

SessionResponse

ok
boolean
required