API DOCUMENTATION

Dark Web Scanner API

Build privacy tools, breach alerts, compliance dashboards, and customer-facing security features on top of our infrastructure. One API, access to 14+ billion breach records, AI-powered analysis, and Australian-specific remediation data.

Authentication

All requests require an API key via header:

X-API-Key: your_api_key_here

# Or via Authorization header:
Authorization: Bearer your_api_key_here

Check an email address against known breach databases. Returns breach details, risk level, and exposed data types.

Request

POST /api/v1/scan
Content-Type: application/json
X-API-Key: your_api_key_here

{
  "email": "user@example.com"
}

Response

{
  "status": "ok",
  "version": "1.0",
  "email_checked": "us***@example.com",
  "scan_timestamp": "2026-05-16T23:00:00.000Z",
  "risk_level": "moderate",
  "total_breaches": 4,
  "exposed_data_types": ["Passwords", "Email addresses", "Phone numbers"],
  "breaches": [
    {
      "name": "LinkedIn",
      "domain": "linkedin.com",
      "breach_date": "2012-05-05",
      "pwn_count": 164611595,
      "data_classes": ["Email addresses", "Passwords"],
      "is_verified": true
    }
  ],
  "deep_report_url": "https://darkwebscanner.com/api/v1/deep-report",
  "attribution": {
    "powered_by": "Dark Web Scanner by Australian Data Removal",
    "abn": "86 921 751 764"
  }
}

Generate a comprehensive Deep Intelligence Report using AI-powered analysis. Covers breach timeline, dark web circulation, connected attack risks, Australian legal rights, and personalised remediation steps. Powered by Sonar Reasoning Pro.

Request

POST /api/v1/deep-report
Content-Type: application/json
X-API-Key: your_api_key_here

{
  "breaches": [
    { "name": "LinkedIn" },
    { "name": "Adobe" }
  ],
  "data_classes": ["Passwords", "Email addresses"]
}

Response

{
  "status": "ok",
  "version": "1.0",
  "report_type": "deep_intelligence",
  "model": "sonar-reasoning-pro",
  "generated_at": "2026-05-16T23:00:00.000Z",
  "report": "# Deep Intelligence Report\n\n## Breach Timeline...",
  "breach_count": 2,
  "disclaimer": "This report provides educational analysis only..."
}