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 partner API key or distributor API key

Distributors can call Partner API endpoints on behalf of their partners using SW-PARTNER-ID with a distributor SW-API-KEY as a drop-in replacement for a partner API key. The partner must belong to your distributor.

curl -X POST https://connect.safestate.com/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 '{
    "companyName": "Example Company Inc.",
    "contactEmail": "contact@example.com",
    "customerReference": "CUST-12345",
    "assetsDomains": ["example.com"],
    "alertRecipients": ["alerts@example.com"],
    "price": 99.99,
    "billedFromDate": "2026-07-01T00:00:00.000Z",
    "currencyCode": "USD"
  }'

To onboard a prospect instead, add "status": "prospect" to the request body:

curl -X POST https://connect.safestate.com/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 '{
    "companyName": "Acme Corporation",
    "contactEmail": "contact@acme.co",
    "customerReference": "ACME-PROSPECT-001",
    "assetsDomains": ["acme.co"],
    "alertRecipients": ["sales@yourpartner.com"],
    "price": 0,
    "billedFromDate": "2026-07-01T00:00:00.000Z",
    "currencyCode": "GBP",
    "status": "prospect"
  }'