Before you start
An existing React 18 or 19 application and a Public Key. The examples use Vite and TypeScript. Register and verify the website domain in your analytics dashboard. Use credentials from the same domain and environment as the browser check. For a fresh account, start with Quick Start.Get your credentials
Copy the Public Key for your domain from Integration > API keys. A public frontend environment variable may contain this key, but never a Private API Key or webhook signing secret.Install the SDK
yarn add or pnpm add with the same package names if your project uses that package manager. Framework packages remain the application’s responsibility.
Add the integration
The snippets use Vite with TypeScript; other bundlers expose environment variables their own way. Put the Public Key of your domain in.env (the value below is a placeholder):
ShieldLabsProvider once, near the root of your app, around the components that identify:
requestId with it:
identify() never rejects: it resolves the result, or null with the reason in error. A second
submit while the identification runs gets the same one, so a double click costs one identification.
On your server, read the verdict for requestId with a server SDK, for example
identifications.get(requestId) in @shieldlabs-ai/node,
which waits until the identification has been scored. The History row appears about 1-3 seconds
after identify() resolves and can be refined for up to about 10 seconds as follow-up checks
finish, so starting the identification when the user begins the action (see
Protect a form ) gets your server the verdict sooner. Accept each request ID once
and only within your freshness window (the examples use 5 minutes): one identification authorizes
one protected action.
Keep the page alive afteridentify()resolves. The agent posts the identification right after it hands over the request ID. Sending your request withfetch(), as above, keeps the page open. If you navigate right after the submit (a full-page form post or a redirect), start the identification early instead (see Protect a form ).
Test on a registered domain. ShieldLabs records identifications only for the domains registered in your account. Onlocalhostthe page still receives arequestId, but the identification is rejected with401and your backend never finds it. Test on a development domain with its own keys, as described in Environments.
Test the complete flow
- Run the application on the registered HTTPS domain with its Public Key.
- Trigger the protected form once and check that a Request ID is sent to your own backend.
- Retrieve that same ID using a server SDK or locate it in the analytics dashboard.
- Test a missing ID and an agent load failure: your backend must treat the action as unverified.
/api/signup routes shown in examples belong to your application; they are not ShieldLabs API endpoints. Connect one of the server quick starts before testing the full action. A successful browser call does not prove scoring is complete.
Troubleshooting
- No History row: confirm the registered domain, credential/environment match and that the browser remained open while collectors posted.
- Missing or pending verdict: scoring is asynchronous. The server helper waits within a bounded budget; handle a missing result and API errors explicitly.
- Authentication error: use the Private API Key for History, not a Public Key, Management Secret Key or MCP OAuth token.
- Invalid webhook signature: verify the original raw bytes with the endpoint’s full signing secret, before trusting parsed JSON.