# Docs

- [ScamVerify™ API](/docs): Threat intelligence API for phone numbers, URLs, text messages, and emails. Powered by 2.79M+ FTC records, carrier data, and AI synthesis.
- **Getting Started**

- Getting Started: undefined
  - [Quickstart](/docs/getting-started/quickstart): Make your first ScamVerify™ API call in under 5 minutes.
  - [Authentication](/docs/getting-started/authentication): Learn how to authenticate with the ScamVerify™ API using Bearer tokens, manage API keys, and follow security best practices.
  - [SDKs and Libraries](/docs/getting-started/sdks): Use the ScamVerify™ API from Python, Node.js, Go, PHP, Ruby, and other languages using standard HTTP clients.
- **API Reference**

- [API Reference](/docs/api-reference): Complete reference for all ScamVerify™ API endpoints with interactive playground.
- Phone: undefined
  - [Phone Number Lookup](/docs/phone/phoneLookup): Look up a U.S. phone number against FTC/FCC complaint databases, carrier records,
robocall detection, community reports, and AI synthesis.

Returns a risk score (0-100), verdict, confidence level, detailed signals,
and an AI-generated plain-English explanation.

**Data sources checked:** FTC Do Not Call (2.79M+ records), FCC Consumer Complaints,
Twilio (carrier, CNAM, line type), Robocall Detection Database, IPQS phone reputation,
community reports, 18 flagged high-risk VoIP carriers.

**Caching:** Results are cached for 24 hours. Use `force_refresh: true` to bypass cache
(still counts toward quota). Cached lookups do not consume quota.
- Url: undefined
  - [URL Lookup](/docs/url/urlLookup): Analyze a URL or domain for fraud indicators including domain age, SSL certificates,
redirect chains, threat feed listings, brand impersonation, and AI synthesis.

**Data sources checked:** WHOIS/RDAP (domain age, registrar), SSL certificate analysis,
Google Web Risk, URLhaus (abuse.ch), ThreatFox (abuse.ch), IPQS URL reputation,
redirect chain analysis, brand impersonation detection, community reports.

**Caching:** Results are cached for 24 hours. Cached lookups do not consume quota.
- Text: undefined
  - [Text Message Analysis](/docs/text/textAnalyze): Analyze a text message (SMS) for scam indicators. Extracts embedded URLs and phone numbers,
performs sub-lookups on each, detects scam patterns via AI, and returns a unified risk score.

**How it works:**
1. AI analyzes message content for scam patterns (urgency, impersonation, social engineering)
2. Extracts up to 3 URLs and 3 phone numbers from the message
3. Performs full Phone and URL lookups on extracted items
4. Combines AI analysis (60% weight) with sub-lookup results (40% weight)

**Quota:** Consumes 1 text quota. Extracted phone/URL sub-lookups do NOT consume additional quota.
- Email: undefined
  - [Email Analysis](/docs/email/emailAnalyze): Analyze email content and headers for phishing, scam patterns, and sender authenticity.
Includes SPF/DKIM/DMARC validation, sender domain analysis, brand impersonation detection,
and embedded URL/phone extraction with sub-lookups.

**Authentication boosts:** SPF/DKIM failures add +15 to risk score.
Return-path mismatch adds +10. Auth failures also trigger verdict floor promotion.

**Quota:** Consumes 1 email quota. Sub-lookups do NOT consume additional quota.
- Batch: undefined
  - [Batch Phone Lookup](/docs/batch/batchPhoneLookup): Look up multiple phone numbers in a single request. Processes up to 100 numbers
with 10 concurrent lookups at a time.

**Quota:** Each successful non-cached lookup consumes 1 phone quota.
If quota is exhausted mid-batch, remaining items return an error object.

**Rate limit:** Batch endpoints have a fixed 5 RPM limit for all tiers.
  - [Batch URL Lookup](/docs/batch/batchUrlLookup): Look up multiple URLs in a single request. Processes up to 100 URLs
with 10 concurrent lookups at a time.

**Quota:** Each successful non-cached lookup consumes 1 URL quota.
If quota is exhausted mid-batch, remaining items return an error object.

**Rate limit:** Batch endpoints have a fixed 5 RPM limit for all tiers.
- Account: undefined
  - [System Status](/docs/account/getStatus): Returns the operational status of all API components.
This endpoint does **not** require authentication and is suitable for health checks.
Response is cached for 30 seconds. Returns HTTP 503 if the database is unreachable.
  - [Usage & Quota](/docs/account/getUsage): Returns your current plan, billing period, per-channel quota usage,
and rate limit configuration.
- **Concepts**

- Concepts: undefined
  - [How Scoring Works](/docs/concepts/how-scoring-works): A deep dive into how ScamVerify™ calculates risk scores, confidence levels, and AI-generated explanations across all verification channels.
  - [Verdicts](/docs/concepts/verdicts): What each ScamVerify™ verdict means, how to interpret them in your application, and how verdict floor promotion works.
  - [Data Sources](/docs/concepts/data-sources): All threat intelligence and reputation data sources used by ScamVerify™, including what each provides, update frequency, and coverage.
  - [Channels](/docs/concepts/channels): The four ScamVerify™ verification channels, what data each returns, when to use them, and how cross-channel intelligence works.
- **Guides**

- Guides: undefined
  - [Guides](/docs/guides): Practical guides for working with the ScamVerify™ API effectively.
  - [Rate Limits](/docs/guides/rate-limits): Understand rate limits for the ScamVerify™ API, including per-tier RPM limits, rate limit headers, and best practices for handling 429 responses.
  - [Quotas](/docs/guides/quotas): Understand per-channel monthly quotas for the ScamVerify™ API, including how quota is tracked, grace buffers, and tips for managing usage.
  - [Caching](/docs/guides/caching): How the ScamVerify™ API caches lookup results, including cache duration, response fields, force refresh, and client-side caching recommendations.
  - [Batch Processing](/docs/guides/batch-processing): Submit up to 100 phone numbers or URLs in a single request using the ScamVerify™ batch API endpoints.
  - [Error Handling](/docs/guides/error-handling): Error response format, error codes, and retry strategies for the ScamVerify™ API.
  - [Testing](/docs/guides/testing): Use test API keys to validate your ScamVerify™ integration before going live, including CI/CD setup and example test scripts.
  - [Webhooks](/docs/guides/webhooks): Real-time notifications for threat intelligence updates from ScamVerify™ (coming soon).
- **Tutorials**

- Tutorials: undefined
  - [Build a Phone Verification Flow](/docs/tutorials/phone-verification-flow): Step-by-step tutorial for building a complete phone verification flow with Node.js and Express using the ScamVerify™ API.
  - [Add URL Scanning to Your App](/docs/tutorials/url-scanner): Step-by-step tutorial for adding URL scanning to a Python Flask application using the ScamVerify™ API.
  - [Screen Emails for Phishing](/docs/tutorials/email-screening): Step-by-step tutorial for building an email phishing screening service with Node.js using the ScamVerify™ API.
  - [Build a Slack Scam Detection Bot](/docs/tutorials/slack-bot): Create a Slack bot that automatically scans phone numbers and URLs posted in channels using the ScamVerify™ API.
  - [Build a Discord Moderation Bot](/docs/tutorials/discord-bot): Auto-scan URLs in Discord messages and warn or delete malicious links using the ScamVerify™ API.
  - [Build a Phone Number Checker Chrome Extension](/docs/tutorials/chrome-extension): Right-click any phone number on a webpage to instantly check its scam risk using the ScamVerify™ API.
  - [Auto-Screen Form Submissions with n8n](/docs/tutorials/n8n-workflow): Build a no-code workflow that automatically checks phone numbers from form submissions using the ScamVerify™ API.
  - [Enrich CRM Leads with Fraud Scores](/docs/tutorials/crm-enrichment): Automatically score new leads in HubSpot with phone number risk data from the ScamVerify™ API.
  - [Build a Fraud Investigation Dashboard in Retool](/docs/tutorials/retool-dashboard): Create an internal tool for ops teams to investigate phone numbers and URLs using the ScamVerify™ API.
  - [Build a WhatsApp Scam Checker Bot](/docs/tutorials/whatsapp-bot): Let users text a phone number to WhatsApp and get an instant risk assessment from the ScamVerify™ API.
  - [Monitor Your Brand for Phone Number Spoofing](/docs/tutorials/brand-monitor): Detect when your company phone numbers appear in scam complaint databases using the ScamVerify™ API.
  - [Generate Scam Report PDFs](/docs/tutorials/pdf-report): Build a service that generates branded PDF reports from ScamVerify™ API results using Puppeteer or WeasyPrint.
- **Integrations**

- Integrations: undefined
  - [Next.js](/docs/integrations/nextjs): Integrate the ScamVerify™ API with your Next.js application using server-side route handlers.
  - [Express.js](/docs/integrations/express): Integrate the ScamVerify™ API with your Express.js application using middleware and route handlers.
  - [Django](/docs/integrations/django): Integrate the ScamVerify™ API with your Django application using views and the requests library.
  - [FastAPI](/docs/integrations/fastapi): Integrate the ScamVerify™ API with your FastAPI application using async endpoints, httpx, and Pydantic models.
- **Use Cases**

- Use Cases: undefined
  - [Fintech KYC](/docs/use-cases/fintech-kyc): Use the ScamVerify™ API to verify customer phone numbers during KYC onboarding, detect VoIP fraud, and flag high-risk carriers.
  - [Contact Center Compliance](/docs/use-cases/contact-center): Use the ScamVerify™ API for TCPA compliance, DNC list checking, lead quality scoring, and inbound call screening in contact center operations.
  - [E-commerce Fraud Prevention](/docs/use-cases/ecommerce-fraud): Use the ScamVerify™ API to prevent e-commerce fraud through URL verification, phone verification for customer contacts, and text/email analysis for support ticket screening.
  - [Insurance Claims Fraud Detection](/docs/use-cases/insurance-claims): Use the ScamVerify™ API to detect fraud in insurance claims through phone number analysis, URL verification for submitted links, and email analysis for phishing in claims communications.
  - [Real Estate Wire Fraud Prevention](/docs/use-cases/real-estate): Protect real estate transactions from wire fraud, listing scams, and agent impersonation.
  - [Gig Economy & Marketplace Fraud](/docs/use-cases/gig-economy): Detect multi-accounting, fake sellers, and fraudulent listings on marketplace and gig platforms.
  - [Dating App Safety](/docs/use-cases/dating-apps): Protect users from romance scams, catfishing, and phishing links in dating platforms.
  - [HR & Recruiting Fraud Prevention](/docs/use-cases/recruiting): Detect fake job postings, fraudulent references, and applicant identity fraud.
  - [Crypto & Web3 Security](/docs/use-cases/crypto): Prevent exchange impersonation, wallet drainer sites, and OTC trading fraud.
  - [Government & Elder Fraud Protection](/docs/use-cases/government): Equip consumer protection agencies and elder fraud hotlines with instant scam verification.
  - [Logistics & Supply Chain Verification](/docs/use-cases/logistics): Prevent double-brokering scams and verify freight broker and supplier identities.
  - [Online Marketplace Trust & Safety](/docs/use-cases/marketplace): Screen sellers, scan listings, and protect buyers on peer-to-peer marketplaces.
- **Troubleshooting**

- Troubleshooting: undefined
  - [Common Issues](/docs/troubleshooting/common-issues): Solutions for common ScamVerify™ API errors and frequently asked troubleshooting questions.
- **Resources**

- Resources: undefined
  - [Pricing](/docs/resources/pricing): ScamVerify™ API pricing tiers, per-channel quotas, rate limits, and billing FAQ.
  - [Security](/docs/resources/security): How ScamVerify™ protects your data, handles API keys, and approaches infrastructure security.
  - [Changelog](/docs/resources/changelog): Release notes and version history for the ScamVerify™ API.
  - [FAQ](/docs/resources/faq): Frequently asked questions about the ScamVerify™ API for developers.
  - [Glossary](/docs/resources/glossary): Definitions of key terms used throughout the ScamVerify™ API documentation.