SafeWeb
Partner API

Check email breach status

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

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/email" \  -H "SW-PARTNER-ID: string" \  -H "SW-API-KEY: string" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'

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

List partner customers GET

Returns a paginated list of customers for the authenticated partner, including customer reference, lifecycle status, breach summary, monitored domains, and monitored asset emails. Optionally filter by customer status.

Check domain breach status POST

Returns whether the domain has known breach exposure. The check covers at most 50 matches and stops when a breach is found. A false result means no breach was found within that limit. 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.