Safestate
Partner API

Get customer breaches

GET
/api/v1/integrations/customer/{customerId}/breaches

Path Parameters

customerId*string

Customer UUID

Formatuuid

Query Parameters

localeCode?string

Locale for breach content (e.g. en-GB)

Default"en-GB"

Header Parameters

SW-PARTNER-ID*string

Partner organization identifier

SW-API-KEY*string

Partner or distributor API key

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/integrations/customer/497f6eca-6276-4993-bfeb-53cbbbba6f08/breaches" \  -H "SW-PARTNER-ID: string" \  -H "SW-API-KEY: string"

{
  "success": true,
  "breachStatus": true,
  "count": 1,
  "breaches": [
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "breachName": "Adobe",
      "title": "Adobe",
      "emails": [
        "user@example.com"
      ],
      "breachDate": "2013-10-04T00:00:00+00:00",
      "breachCategories": [
        "Email addresses",
        "Password hints",
        "Passwords",
        "Usernames"
      ],
      "resolved": false,
      "generatedDescription": "Your email address has been found in a large breach from October 2013.",
      "nextSteps": [
        "Change your passwords",
        "Enable multi-factor authentication",
        "Use a password manager"
      ]
    }
  ]
}

{
  "success": false,
  "error": "Customer ID is required"
}
{
  "success": false,
  "error": "Failed to verify org API key"
}
{
  "success": false,
  "error": "Customer 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 retrieve customer breaches"
}

Prospect customers

Customers with status: "prospect" receive a redacted breach list. The response includes breachStatus, count, and a breaches array. Each breach entry contains uuid, emails, and resolved only. Upgrade the customer to active for full breach detail.

{
  "success": true,
  "breachStatus": true,
  "count": 1,
  "breaches": [
    {
      "uuid": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "emails": ["user@example.com"],
      "resolved": false
    }
  ]
}

See Prospecting for the webhook payload shape.

Update customer info PATCH

Update a customer's non-monitoring details such as contact name, email address, billing configuration, and plan. The customer must belong to the authenticated partner.

Get customer threat score GET

Returns the aggregated dark-web threat score (0–97) for the given customer. The customer must belong to the authenticated partner.