Skip to main content
POST

Body

application/json

At least one identity signal is required: email, email_sha256, email_md5, phone, phone_sha256, phone_md5, external_id, session_code, device_id, or device_global_id. A payload naming none of them is rejected, because it would mint an identity that nothing can ever resolve back to. Any field not listed here is rejected outright: the schema is closed.

workspace_code
string
required

Your workspace's public code. Required.

Maximum string length: 100
video_code
string

The video this identity is associated with. Send it along with a raw email to also tee a lead into the workspace's lead list.

Maximum string length: 100
session_code
string

The tracker's session ID, if you have one.

Maximum string length: 100
device_id
string

The tracker's local device ID, if you have one.

Maximum string length: 100
device_global_id
string
Maximum string length: 100
email
string

A raw email address. Hashed on arrival to both SHA-256 and MD5, and never stored raw.

Maximum string length: 255
email_sha256
string

A pre-hashed email, lowercase hex, if you hash client-side instead of sending it raw.

Pattern: ^[0-9a-f]{64}$
email_md5
string
Pattern: ^[0-9a-f]{32}$
phone
string

A raw phone number. Normalized to E.164 and hashed on arrival.

Maximum string length: 64
phone_sha256
string
Pattern: ^[0-9a-f]{64}$
phone_md5
string
Pattern: ^[0-9a-f]{32}$
external_id
string

Your own customer ID, if you already have one for this viewer.

Maximum string length: 120
page_url
string
Maximum string length: 2000

Response

Resolved or minted.

ok
boolean
profile_id
string | null

The resolved or newly minted profile ID. null only in the failure paths, never on a 200.