SafeWeb API
Partner API

Get breach details by name or UUID

GET
/api/v1/integrations/breach

Query Parameters

localeCode?string

Locale for breach summary content. Defaults to en-GB when omitted.

Default"en-GB"
Value in"sv-SE" | "nb-NO" | "fi-FI" | "da-DK" | "en-GB"
name?string

HIBP breach name (e.g. Adobe). Mutually exclusive with uuid.

uuid?string

Breach record UUID. Mutually exclusive with name.

Formatuuid

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

application/json

application/json

curl -X GET "https://example.com/api/v1/integrations/breach" \  -H "SW-PARTNER-ID: string" \  -H "SW-API-KEY: string"
{
  "success": true,
  "breach": {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Adobe",
    "title": "Adobe",
    "addedDate": "2013-12-04T00:00:00.000Z",
    "breachCategories": [
      "Email addresses",
      "Password hints"
    ],
    "description": "In October 2013, 153 million Adobe accounts were breached...",
    "nextSteps": [
      "Change your password",
      "Enable two-factor authentication"
    ]
  }
}
{
  "success": false,
  "error": "Invalid query parameters: Either name or uuid must be provided"
}
{
  "success": false,
  "error": "Failed to verify org API key"
}
{
  "success": false,
  "error": "Breach not found"
}
{
  "success": false,
  "error": "Partner ID and API key are required in headers"
}
{
  "success": false,
  "error": "Internal server error"
}