SafeWeb API
Partner API

Get partner analytics

GET
/api/v1/integrations/partner/analytics

Header Parameters

SW-PARTNER-ID*string

Partner organization identifier

SW-API-KEY*string

API authentication key

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/integrations/partner/analytics" \  -H "SW-PARTNER-ID: string" \  -H "SW-API-KEY: string"
{
  "success": true,
  "data": {
    "totalCustomers": 150,
    "activeCustomers": 142,
    "newCustomerLast30Days": 10,
    "totalMonitoredDomains": 310,
    "totalMonitoredEmails": 875,
    "totalBreachesDetected": 47
  }
}
{
  "success": false,
  "error": "Failed to verify org API key"
}
{
  "success": false,
  "error": "Failed to verify org API key"
}

Get breach details by name or UUID GET

Look up one breach in the global catalogue. Provide exactly one of `name` (HIBP breach name) or `uuid` (breach row UUID). Optional `localeCode` selects the localised text (default `en-GB`). Requires partner authentication via SW-PARTNER-ID and SW-API-KEY headers.

Outbound webhooks

How SafeWeb delivers signed HTTP POST notifications to your receiver, what each event type contains, and how to verify responses. Management APIs live under the Partner API (per partner organization) and Distributor API (distributor-scoped webhook URLs and signing secrets).