Skip to navigation
Identity verification APIEvents and Signals

Record a device or session signal

Stores a device or session signal against a customer. The signal is stored only: it is not scored, raises no alert, fires no webhook and is not billed. The call is not idempotent, so each request stores a new signal.

Error codes

errorStatusMeaning
invalid_request400The body failed validation. details carries the field-level breakdown.
secret_key_required403A publishable key was used. This API accepts secret keys only.
environment_mismatch403The key belongs to an environment this host does not serve.
rate_limited429The request rate limit for this key was reached. Retry after a short wait.
rate_limit_store_unavailable503Rate limiting is temporarily unavailable. Retry shortly.

A missing or unknown key returns 401 with a plain sentence in error rather than a code.

Requires a secret (sk_) key. A publishable key receives 403 secret_key_required.

Authentication

AuthorizationBearer
Send the API key as a Bearer token. Each operation states whether a publishable key is enough or a secret key is required.

Request

This endpoint expects an object.
externalUserIdstringRequired>=1 character
Your own reference for the customer the event belongs to.
typestringRequired>=1 character

A free-form name for the signal, such as device.

datamap from strings to anyOptional

Free-form details of the signal.

Response

The signal was stored.
idstring
The identifier of the stored signal.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
503
Service Unavailable Error