Get breach details by name or UUID
Query Parameters
Locale for breach summary content. Defaults to en-GB when omitted.
"en-GB""sv-SE" | "nb-NO" | "fi-FI" | "da-DK" | "en-GB"HIBP breach name (e.g. Adobe). Mutually exclusive with uuid.
Breach record UUID. Mutually exclusive with name.
uuidHeader Parameters
Partner organization identifier
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"
}Update breach resolved status POST
Sets the resolved flag for a customer breach instance identified by its UUID. The breach must belong to a customer in the authenticated partner organization. Use the `uuid` from breach webhook payloads or customer breach listings. Requires valid partner authentication via SW-PARTNER-ID and SW-API-KEY headers.
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.