SafeWeb API
Partner API

Offboard a customer

POST
/api/v1/integrations/customer/offboard

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

curl -X POST "https://example.com/api/v1/integrations/customer/offboard" \  -H "SW-PARTNER-ID: string" \  -H "SW-API-KEY: string" \  -H "Content-Type: application/json" \  -d '{    "customerId": "550e8400-e29b-41d4-a716-446655440000"  }'
{
  "success": true,
  "message": "Customer offboarded successfully"
}

{
  "success": false,
  "error": "Invalid JSON in request body"
}

{
  "success": false,
  "error": "Partner ID and API key are required in headers"
}

{
  "success": false,
  "error": "Partner ID and API key are required in headers"
}
{
  "success": false,
  "error": "Failed to offboard customer"
}

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.

Get customer monitored assets GET

Returns the list of domains and email addresses monitored for the given customer. The customer must belong to the authenticated partner.