API overview

Use the browser agent to identify visitors, the Server API to retrieve results, and webhooks to receive updates. This reference documents the methods, parameters, response fields and errors for each interface.

JavaScript agent

Load the agent, run an identification and handle its result.

Server API

Retrieve identification history from your backend.

Webhooks

Verify scored-identification and multi-account events.

Domain profile

Read your domain profile and remaining account volume.

Credentials

Interface	Credential
Browser agent	Public Key
History API	Private API Key
Domain profile	Management Secret Key and `X-Shield-Domain`
Webhook verification	Endpoint signing secret

Find them under Integration > API keys or Integration > Webhooks in the analytics dashboard. See API keys for scope and rotation.

Choose the result contract

Result	Identifier	Risk and detection fields
Browser initialization	`requestId`	Retrieve the server result using this ID
History row	`identification_id`	`score` and supported `is_*` fields
Scored webhook	`data.identification_id`	`data.risk_score`, `signals`, `detection_flags`, `hre`
Multi-account event	`data.cluster_id` and revision	Group members, action and confidence

A browser Identification ID can arrive before scoring and storage finish. See Identification flow for pending results and correlation.

Guides and contracts

Quick Start: create an account and complete your first integration
SDKs: browser and server package guides
Data models: response fields and naming differences
Versions and availability: webhook versions and OpenAPI files

Run a check

Get the result

Account

Contracts

JavaScript agent

Server API

Webhooks

Domain profile

Credentials

Choose the result contract

Guides and contracts

JavaScript agent

Server API

Webhooks

Domain profile

​Credentials

​Choose the result contract

​Guides and contracts

Credentials

Choose the result contract

Guides and contracts