Overview of Partner API
Partner API
Use this section to access all partner API endpoints for managing customers.
Getting Started
Use the Partner API when working with customer lifecycle, breach intelligence, partner analytics, and event delivery to your infrastructure.
Authentication
All /api/v1/integrations/... endpoints require:
| Header | Description |
|---|---|
SW-PARTNER-ID | Your unique partner identifier |
SW-API-KEY | Your secret API key |
curl -X POST https://connect.safeweb.co/api/v1/integrations/customer/onboard \
-H "Content-Type: application/json" \
-H "SW-PARTNER-ID: your-partner-id" \
-H "SW-API-KEY: your-api-key" \
-d '{ ... }'Platform
Health check
Confirm the API is reachable and returns a health payload.
Partner Analytics
View partner-level metrics and aggregate usage insights.
Outbound events (reference)
HTTPS callback protocol: signatures, payloads, and retries.
Event delivery (API)
Register and manage HTTPS callback URLs.
Customer Management
Onboard Customer
Create a new customer and configure initial monitoring.
Offboard Customer
Deactivate an existing customer from the platform.
Customer Assets
Get or update monitored domains and email addresses.
Customer Breaches
Retrieve breach status and detailed breach records per customer.
Customer Threat Score
Get the aggregated dark-web threat score for a customer.
Breach Intelligence
Breach Check
Run a quick check to see if an email has known breaches.
Breach retrieve (by email)
Fetch full breach details for an email, including categories and next steps.
Update breach status
Mark a customer breach instance as resolved or unresolved by UUID.
Get breach from catalogue
Look up a single global breach record by HIBP name or breach UUID.
Breach Categories
List available breach category metadata used in responses.
Authentication
SSO overview
Customer sign-in options: enterprise SSO and magic link.
Enterprise SSO
Corporate IdP sign-in — configured by SafeWeb on request.
Magic link
Request a one-time login URL for a customer.
Webhooks
Magic link sign-in POST
Request a one-time magic link URL for a customer via the Partner API. The customer opens the URL to sign in to the SafeWeb portal.
Onboard a new customer POST
Creates a new customer account in the SafeWeb platform with specified monitoring assets, billing information, and plan configuration. Requires valid partner authentication via SW-PARTNER-ID and SW-API-KEY headers. At least one of assetsDomains or assetsEmails must be provided. contactEmail is optional; when provided, it is automatically added to assetsEmails if not already present.