Base URLs and authentication
Get your keys from Integration > API keys in the analytics dashboard. Keep server credentials on your backend. See API keys.
History API (recommended)
Domain returns the domain id for this key. Search lists identifications or users. Card reads one identification, user, visitor, device, or IP. A list returns{ data, next_page_token }. One record returns { data }.
An immediate lookup can be empty while processing finishes. Use a bounded retry or a server SDK retrieval helper. Bind the result to the expected domain, account and protected action before using it.
The History API allows 15 requests per second per domain. Reads consume no identification quota. See pagination and rate limits.
Read every identification of one account
Useids on the user list and follow page_token. See the pagination example.
Errors
Check the HTTP status before parsing a response. Error shapes depend on the interface.
History
200 with empty data is valid. HTTP 402 applies to identification when included volume is exhausted, not to these reads.
Response contracts
History and webhooks describe identifications using different field names. The webhook column below is relative to the event’sdata object.
On a user, visitor, device or IP card,
risk.band describes that identity’s current history-based category, rather than one check’s score. Read risk.state and risk.as_of. See History card.
The webhook envelope’s created_at is the time the notification was created. It is separate from data.observed_at, the time of the observation.
A History card does not repeat the webhook flag catalog. Use signals from a scored webhook for the contributions recorded for a new check.
A server SDK can present a normalized identification instead of the raw card. Normalization does not supply detections absent from the source response; a missing field does not establish that the check was completed with a negative result.
For per-identification account results, read the hre field. Multi-accounting uses a separate group-change event, which has no identification score. Data models lists the remaining History fields.