SafeWeb API

Get breach categories

GET
/api/integrations/breach-categories

Header Parameters

SW-PARTNER-ID*string

Partner organization identifier

SW-API-KEY*string

API authentication key

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://connect.safeweb.co/api/integrations/breach-categories" \  -H "SW-PARTNER-ID: string" \  -H "SW-API-KEY: string"
{
  "success": true,
  "breachCategories": [
    {
      "id": 1,
      "name": "Passwords",
      "description": "Compromised passwords",
      "tooltip": "Password data was exposed in this breach",
      "link": "knowledge-base/passwords",
      "isBlacklist": false,
      "createdAt": "2024-01-15T10:00:00.000Z"
    }
  ]
}

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

{
  "success": false,
  "error": "Partner ID and API key are required in headers"
}
{
  "success": false,
  "error": "Failed to retrieve breach categories"
}

Update customer monitored assets PATCH

Replaces the monitored domains and/or email addresses for the given customer. Only the fields provided in the request body are updated — omitting a field leaves that set unchanged. The customer must belong to the authenticated partner.

Get partner analytics GET

Retrieve high-level analytics about your partner account including total customers, active monitors, and breach statistics. Requires valid partner authentication via SW-PARTNER-ID and SW-API-KEY headers.