SafeWeb API
Partner API

Retrieve breaches for an email

POST
/api/v1/integrations/breach/retrieve

Header Parameters

SW-PARTNER-ID*string

Partner organization identifier

SW-API-KEY*string

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

curl -X POST "https://example.com/api/v1/integrations/breach/retrieve" \  -H "SW-PARTNER-ID: string" \  -H "SW-API-KEY: string" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "localeCode": "da-DK"  }'
{
  "success": true,
  "email": "user@example.com",
  "breaches": [
    {
      "title": "Facebook Breach",
      "description": "Your Facebook account was breached in 2021.",
      "breachDate": "2021-01-01",
      "breachCategories": [
        "Data Breach",
        "Password Leak"
      ],
      "nextSteps": [
        "Change your password",
        "Enable two-factor authentication"
      ],
      "resolvedStatus": false
    }
  ]
}
{
  "success": false,
  "error": "Request body must be valid JSON"
}
{
  "success": false,
  "error": "Failed to verify org API key"
}

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

{
  "success": false,
  "error": "Failed to retrieve breaches"
}

Check if an email has been breached POST

Returns whether the given email address has appeared in any known data breach. Requires valid partner authentication via SW-PARTNER-ID and SW-API-KEY headers. Optionally include `resolved` in the JSON body to filter by whether matching breaches are marked resolved.

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.