Update breach resolved status
Header Parameters
Partner organization identifier
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
application/json
curl -X POST "https://example.com/api/v1/integrations/breach/status" \ -H "SW-PARTNER-ID: string" \ -H "SW-API-KEY: string" \ -H "Content-Type: application/json" \ -d '{ "breachId": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "resolved": true }'{
"success": true,
"resolved": true
}{
"success": false,
"error": "Request body must be valid JSON"
}{
"success": false,
"error": "Failed to verify org API key"
}{
"success": false,
"error": "Breach not found or does not belong to partner"
}{
"success": false,
"error": "Partner ID and API key are required in headers"
}{
"success": false,
"error": "Failed to update breach status"
}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.
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.