Session
Create a short-lived sessionId from collect, then bind an account on check.
Store collect payload under a sessionId (24h TTL). Send probes / TLS / attribution at the top level (not nested under payload). Later call POST /api/v1/check with sessionId + account fields.
x-api-key<token>
Workspace secret key (sk_test_… / sk_live_…). Prefer test keys in these docs. Create keys in the console — never commit real values.
In: header
Header Parameters
X-Request-Id?string
Optional client correlation id. Echoed on the response; minted when omitted.
Length
8 <= length <= 128Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/api/v1/session" \ -H "Content-Type: application/json" \ -d '{ "fingerprint": "fp_demo_visitor_001", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36" }'{ "sessionId": "sess_demo_example", "expiresAt": "2026-07-20T22:00:00.000Z"}