SafeWeb API Documentation

Overview

The SafeWeb Partner API allows you to programmatically manage customers on the SafeWeb dark web monitoring platform. Through the API you can onboard and offboard customers, manage their monitored assets, retrieve breach data and breach categories, and access account-level analytics.

Quick Start

Get your credentials — contact SafeWeb to receive your Partner ID and API key
Test in staging — use the staging environment to onboard a test customer
Verify — confirm the customer is created and monitoring has started
Go live — switch to the production base URL

Authentication

All requests require two headers:

Header	Description
`SW-PARTNER-ID`	Your unique partner identifier
`SW-API-KEY`	Your secret API key

curl -X POST https://connect.safeweb.co/api/integrations/customer/onboard \
  -H "Content-Type: application/json" \
  -H "SW-PARTNER-ID: your-partner-id" \
  -H "SW-API-KEY: your-api-key" \
  -d '{ ... }'

Environments

Environment	Base URL
Staging	`https://staging-connect.safeweb.co`
Production	`https://connect.safeweb.co`

Use the staging environment for development and testing. Both environments behave identically.

API Reference

Customer Lifecycle

Onboard a customer

Create a new customer with monitoring assets, billing, and plan configuration.

Offboard a customer

Cancel a customer's account and stop all active monitoring.

Customer Management

Update customer assets

Add or remove monitored domains and email addresses for an existing customer.

Update customer info

Update contact details, billing configuration, plan, and other non-monitoring fields.

Get customer assets

Retrieve the list of monitored domains and email addresses for a customer.

Get customer breaches

Retrieve breach status, count, and detailed breach list for a customer.

Breach Categories

Get breach categories

Retrieve the list of breach categories used to classify types of data exposed in breaches.

Analytics

Partner analytics

Retrieve account-level metrics including customer counts, active monitors, and breach statistics.

Webhooks

List webhook endpoints

Retrieve all webhook endpoints registered for your organization.

Create a webhook endpoint

Update a webhook endpoint

Update the URL, subscribed events, or active status of an existing webhook.

Delete a webhook endpoint

Permanently remove a webhook endpoint and its event logs.

Core Concepts

Customers

A customer represents an end user being monitored. Each customer record includes:

Contact details — name and email address
Monitored assets — one or more domains, email addresses, or both
Plan — determines features and monitoring level
Billing configuration — currency, billing date, and pricing tier

Once onboarded, SafeWeb handles email discovery, breach scanning, alerts, and reporting automatically.

Plans

Plan	Description
`safeweb-basic`	Dark web monitoring with breach alerts
`safeweb-plus`	Everything in Basic, plus a customer self-service portal and monthly security reports

Monitored Assets

SafeWeb monitors two types of assets per customer:

Domains — associated email addresses are discovered automatically and monitored for breaches
Email addresses — monitored directly against breach databases

At least one domain or email address must be provided when onboarding a customer. Monitoring runs on a daily schedule and requires no further API interaction once configured.