SafeWeb
Partner API

Upgrade a prospect customer

Upgrades a customer from prospect to active status. Use this when a sales prospect converts and should receive full dark-web monitoring.

For the prospecting workflow and redaction rules, see Prospecting.

POST
/api/v1/integrations/customer/upgrade

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

application/json

curl -X POST "https://example.com/api/v1/integrations/customer/upgrade" \  -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 upgraded successfully",  "customerId": "550e8400-e29b-41d4-a716-446655440000",  "status": "active"}

After upgrade, the customer is scheduled for ongoing monitoring. Breach API responses and webhook payloads change from the redacted prospect format — limited to uuid, emails, and resolved per breach — to the full detail available for active customers.

Behaviour notes

  • Only customers with status: "prospect" can be upgraded through this endpoint.
  • Customers in inactive status should use Reactivate customer instead.
  • Upgrade is idempotent in intent but returns 409 if the customer is already active.
  • Billing, assets, and plan configuration set at onboard time are preserved; upgrade only changes monitoring status and scan behaviour.