SafeWeb
Partner API

Check domain breach status

POST
/api/v1/integrations/breach-status/domain

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

application/json

curl -X POST "https://example.com/api/v1/integrations/breach-status/domain" \  -H "SW-PARTNER-ID: string" \  -H "SW-API-KEY: string" \  -H "Content-Type: application/json" \  -d '{    "domain": "example.com"  }'

{  "success": true,  "breached": true}

Check email breach status POST

Returns whether the given email address appears in any known data breach. Requires valid partner authentication via SW-PARTNER-ID and SW-API-KEY headers. Requests are rate limited per partner API key. When the limit is exceeded the endpoint returns 429.

Rate limiting

How Partner API rate limits work, which endpoints are affected, and how to handle 429 responses.