SafeWeb API
Partner API

Check if an email has been breached

POST
/api/v1/integrations/breach/check

Header Parameters

SW-PARTNER-ID*string

Partner organization identifier

SW-API-KEY*string

API authentication key

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/integrations/breach/check" \  -H "SW-PARTNER-ID: string" \  -H "SW-API-KEY: string" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'

{
  "success": true,
  "breach": true
}

{
  "success": false,
  "error": "Request body must be valid JSON"
}
{
  "success": false,
  "error": "Failed to verify org API key"
}

{
  "success": false,
  "error": "Partner ID and API key are required in headers"
}

{
  "success": false,
  "error": "Failed to check breach status"
}

Get customer threat score GET

Returns the aggregated dark-web threat score (0–97) for the given customer. The customer must belong to the authenticated partner.

Retrieve breaches for an email POST

Returns all known breach records for a given email address, including descriptions, categories, and recommended next steps. An optional locale code can be provided for localised content. Requires valid partner authentication via SW-PARTNER-ID and SW-API-KEY headers.