# ShieldLabs

> Visitor identification and abuse-prevention docs for ShieldLabs: snippet, Risk Score, anonymity signals, Patterns, webhooks, and Server API.

- [Visitor identification & abuse-prevention docs](https://docs.shieldlabs.ai/index.md): One JavaScript snippet returns a persistent VisitorID and DeviceID plus an explainable Risk Score your code acts on — up to 99% accuracy, API-first.
- [Overview](https://docs.shieldlabs.ai/overview.md): Detect anonymous visitors, assess traffic quality, and prevent abuse and fraud, with up to 99% accuracy and a 5-minute install.
- [Quick Start](https://docs.shieldlabs.ai/quickstart.md): Get from zero to your first scored visitor in about five minutes: install the snippet, receive the webhook, and act on the Risk Score.
- [Build with AI](https://docs.shieldlabs.ai/build-with-ai.md): Copy-paste prompts that get ShieldLabs working fast in ChatGPT, Claude, or Cursor, plus how to feed the whole docs to your AI tool as context.
- [Planning your implementation](https://docs.shieldlabs.ai/setup/planning.md): The key decisions to settle before you wire ShieldLabs into your product.
- [Using the dashboard](https://docs.shieldlabs.ai/using-the-dashboard.md): A quick tour of the ShieldLabs dashboard and where to find each thing.
- [Identification](https://docs.shieldlabs.ai/features/identification.md): Learn how ShieldLabs recognizes a returning visitor and what each of the six identifiers is for.
- [Anonymity Signals](https://docs.shieldlabs.ai/features/anonymity-signals.md): Learn which anonymity signals ShieldLabs detects, what each one means, and how they add up to a score.
- [Risk Scoring](https://docs.shieldlabs.ai/features/risk-scoring.md): Learn how the Risk Score is built from 0 to 100, what its bands mean, and how each signal is weighted.
- [Acting on the Risk Score](https://docs.shieldlabs.ai/guides/acting-on-risk-score.md): Learn how to turn the Risk Score and its signals into an allow, challenge, review, or block decision.
- [Identification and anonymity-detection accuracy](https://docs.shieldlabs.ai/features/accuracy.md): Learn how ShieldLabs recognizes returning visitors and detects anonymity with up to 99% accuracy, and where the limits are.
- [Patterns](https://docs.shieldlabs.ai/features/patterns.md): Learn how the ready-made patterns surface abuse and fraud across linked identifiers, and how they are graded.
- [Traffic Analytics](https://docs.shieldlabs.ai/features/traffic-analytics.md): Learn how ShieldLabs measures traffic quality and ranks each source by the anonymous traffic it sends.
- [Setup](https://docs.shieldlabs.ai/setup.md): An overview of everything you wire up to run ShieldLabs: the snippet, keys, webhooks, and domains.
- [Install the JS Snippet](https://docs.shieldlabs.ai/setup/snippet.md): Learn how to install the JavaScript snippet and start identifying visitors.
- [Content Security Policy](https://docs.shieldlabs.ai/setup/csp.md): Learn which Content-Security-Policy directives let the ShieldLabs snippet load and report.
- [Public and Secret Keys](https://docs.shieldlabs.ai/setup/keys.md): Public Key, Private API Key, Secret Key, and webhook secrets: what each ShieldLabs credential authenticates and where it belongs.
- [Webhook setup](https://docs.shieldlabs.ai/setup/webhooks.md): Register one or more endpoints per domain, verify the X-Shield-Signature header, and act on the score the moment a visit is scored.
- [Domains](https://docs.shieldlabs.ai/setup/domains.md): Add and manage the domains ShieldLabs identifies visitors on, and find each domain's keys, webhooks, and usage.
- [Environments](https://docs.shieldlabs.ai/setup/environments.md): Separate development and production traffic with per-environment ShieldLabs domains and keys, so test data never mixes with live.
- [Billing & Plans](https://docs.shieldlabs.ai/billing.md): A guide to how ShieldLabs billing works: what counts as a request, what is free, and the plans.
- [Optimize usage and cost](https://docs.shieldlabs.ai/setup/optimizing-usage.md): Learn how to place snippet calls to control cost and how to trace an unexpected usage spike.
- [Rate limits](https://docs.shieldlabs.ai/rate-limits.md): Learn the rate limits ShieldLabs enforces and how to stay within them.
- [Security](https://docs.shieldlabs.ai/security.md): Learn how ShieldLabs protects your data in transit and how to verify what you receive.
- [Privacy & data handling](https://docs.shieldlabs.ai/privacy.md): Learn what ShieldLabs collects, how it is handled, and the controls you have over the data.
- [Troubleshooting](https://docs.shieldlabs.ai/troubleshooting.md): Fixes for the issues you are most likely to hit while integrating ShieldLabs.
- [Errors & Troubleshooting](https://docs.shieldlabs.ai/errors.md): A reference for every HTTP status code ShieldLabs returns and how to fix it.
- [FAQ](https://docs.shieldlabs.ai/faq.md): Answers to common ShieldLabs questions: API keys, request billing, the six identifiers, webhooks, and what a Risk Score of 0 means.
- [Glossary](https://docs.shieldlabs.ai/glossary.md): Plain definitions for the terms used across ShieldLabs docs: identifiers, the Risk Score, anonymity signals, Patterns, and integration.
- [Browser support](https://docs.shieldlabs.ai/browser-support.md): Browsers and platforms the ShieldLabs JS snippet supports, and how it behaves when JavaScript or a secure context is unavailable.
- [Changelog](https://docs.shieldlabs.ai/changelog.md): Latest ShieldLabs changes: new and updated signals, API and webhook changes, and documentation improvements.
- [Support](https://docs.shieldlabs.ai/support.md): Get help with ShieldLabs: docs, direct contact, and our channels.
- [Terms of Service](https://docs.shieldlabs.ai/legal/terms.md): The terms governing use of the ShieldLabs service and API.
- [Privacy Policy](https://docs.shieldlabs.ai/legal/privacy-policy.md): How ShieldLabs processes technical and personal data, as processor and as controller.
- [Cookie & Tracking Policy](https://docs.shieldlabs.ai/legal/cookie-policy.md): The identifiers ShieldLabs uses, why, and how to manage them.
- [Use Case Tutorials](https://docs.shieldlabs.ai/use-case.md): 22 end-to-end tutorials to detect and prevent fraud and abuse, measure traffic quality, and recognize trusted visitors with the snippet, webhook, and API.
- [New Account Fraud (Fake Signups)](https://docs.shieldlabs.ai/use-case/new-account-fraud.md): Learn how to detect and prevent new account fraud and fake signups: catch account farms by linking registrations to a small set of real devices.
- [Multi-Accounting](https://docs.shieldlabs.ai/use-case/multi-accounting.md): Learn how to detect and prevent multi-accounting: link many accounts back to one person through a shared device and network.
- [Account Takeover (ATO)](https://docs.shieldlabs.ai/use-case/account-takeover.md): Learn how to detect and prevent account takeover (ATO): catch a login from a new device or country on a known account and step up before the takeover.
- [Credential Stuffing](https://docs.shieldlabs.ai/use-case/credential-stuffing.md): Learn how to detect and prevent credential stuffing: throttle logins on a durable DeviceID so rotated IPs cannot reset your rate limits.
- [Step-up authentication (risk-based 2FA)](https://docs.shieldlabs.ai/use-case/step-up-authentication.md): Learn how to trigger step-up authentication (risk-based 2FA): score risky logins and require a second factor only when the session looks anonymous.
- [Account Sharing](https://docs.shieldlabs.ai/use-case/account-sharing.md): Learn how to detect and prevent account sharing: spot one login used across many devices and countries, and enforce your seat or sharing policy.
- [Ban Evasion (Ban Enforcement)](https://docs.shieldlabs.ai/use-case/ban-evasion.md): Learn how to detect and prevent ban evasion: key bans to a durable DeviceID so a cleared cookie or a fresh account cannot get a banned user back in.
- [SMS Pumping](https://docs.shieldlabs.ai/use-case/sms-pumping.md): Learn how to detect and prevent SMS pumping and OTP toll fraud: rate-limit verification SMS per durable device so one session cannot flood your bill.
- [Promo Abuse](https://docs.shieldlabs.ai/use-case/promo-abuse.md): Learn how to detect and prevent promo abuse: count promo-code redemptions tied to one device to stop coupon and signup-bonus farming.
- [Bonus Abuse](https://docs.shieldlabs.ai/use-case/bonus-abuse.md): Learn how to detect and prevent bonus abuse: link duplicate accounts claiming the same signup or deposit bonus to one device and one network.
- [Free Trial Abuse](https://docs.shieldlabs.ai/use-case/free-trial-abuse.md): Learn how to detect and prevent free trial abuse: link new accounts cycling one device to re-claim free trials and free-tier quotas.
- [Loyalty Fraud](https://docs.shieldlabs.ai/use-case/loyalty-fraud.md): Learn how to detect and prevent loyalty fraud: catch points and tier rewards farmed across many linked accounts instead of genuine activity.
- [Affiliate Fraud (Click & Lead Inflation)](https://docs.shieldlabs.ai/use-case/affiliate-fraud.md): Learn how to detect and prevent affiliate fraud: rank referral traffic by anonymous-visit share so click and lead inflation never gets paid out.
- [Sybil Attack](https://docs.shieldlabs.ai/use-case/sybil-attack.md): Learn how to detect and prevent Sybil attacks: tie many wallets or identities back to one actor before an airdrop, vote, or quota pays out.
- [Coupon Abuse](https://docs.shieldlabs.ai/use-case/coupon-abuse.md): Learn how to detect and prevent coupon abuse (coupon fraud): enforce one-per-customer codes and catch reuse of leaked or shared single-use discount codes.
- [Payment Fraud at Checkout](https://docs.shieldlabs.ai/use-case/payment-fraud.md): Learn how to detect and prevent payment fraud at checkout: read device and anonymity signals before you charge, and challenge masked orders.
- [Chargeback Fraud and Disputes](https://docs.shieldlabs.ai/use-case/chargeback-fraud.md): Learn how to detect chargeback fraud and build dispute evidence: tie each order to a durable device history for friendly-fraud representment.
- [Paywall Bypass](https://docs.shieldlabs.ai/use-case/paywall.md): Learn how to detect and prevent paywall bypass: meter free views on a DeviceID readers cannot reset by clearing cookies or going incognito.
- [Regional Pricing Abuse](https://docs.shieldlabs.ai/use-case/regional-pricing.md): Learn how to detect and prevent regional pricing abuse: catch VPN-masked region switching from the network country before you grant a discount.
- [Card Testing](https://docs.shieldlabs.ai/use-case/card-testing.md): Learn how to detect and prevent card testing at checkout: anchor each payment attempt to a durable device id and add friction to masked sessions.
- [Traffic Quality: rank sources by anonymous-traffic share](https://docs.shieldlabs.ai/use-case/traffic-quality.md): Learn how to measure traffic quality: rank acquisition sources by anonymous-visit share to find your true cost per real visitor.
- [Returning visitor recognition (trusted-device UX)](https://docs.shieldlabs.ai/use-case/returning-visitor.md): Learn how to recognize a trusted returning device and remove friction: reward a clean, known DeviceID with a lighter, lower-friction path.
- [API Overview](https://docs.shieldlabs.ai/api/overview.md): An overview of how the ShieldLabs API is organized and how to authenticate.
- [Identification Flow](https://docs.shieldlabs.ai/api/identification-flow.md): Learn how a visit becomes a scored result and how the webhook and History API fit together.
- [Webhook reference](https://docs.shieldlabs.ai/api/webhooks.md): A reference for the signed webhook envelope: event types, payload schema, delivery timing, and signature.
- [Server API](https://docs.shieldlabs.ai/api/server-api.md): ShieldLabs Server API reference: read scored visitor-identification results from your backend with the History API, plus your domain profile and keys.
- [Data Models](https://docs.shieldlabs.ai/api/models.md): A reference for every field ShieldLabs returns and what each one means.

## OpenAPI Specs

- [openapi](/references/openapi.yaml)