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.

Request

POST /api/v1/integrations/customer/upgrade

Headers

Header	Required	Description
`SW-PARTNER-ID`	Yes	Partner organization identifier
`SW-API-KEY`	Yes	Partner or distributor API key
`Content-Type`	Yes	`application/json`

Body

Field	Type	Required	Description
`customerId`	string	Yes	UUID of the prospect customer to upgrade

Example

curl -X POST https://connect.safestate.com/api/v1/integrations/customer/upgrade \
  -H "Content-Type: application/json" \
  -H "SW-PARTNER-ID: your-partner-id" \
  -H "SW-API-KEY: your-api-key" \
  -d '{
    "customerId": "550e8400-e29b-41d4-a716-446655440000"
  }'

Responses

`200` — Upgraded successfully

{
  "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.

Error responses

Status	Condition	Example `error` message
`400`	Invalid JSON or missing `customerId`	`Validation failed: customerId: Customer ID is required`
`401`	Missing or invalid credentials	`Failed to verify org API key`
`403`	Customer belongs to another partner	`You do not have permission to update this customer`
`404`	Customer not found	`Customer not found`
`409`	Customer is already `active`	`Customer is already active`
`422`	Customer is not a prospect (e.g. `inactive` or `dormant`)	`Customer cannot be upgraded: customer is not a prospect`
`500`	Server error	`Failed to upgrade customer`

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.

Prospecting overview

Workflow, scanning rules, and redacted breach results.

Onboard customer

Create a customer with status prospect.

Reactivate customer

Restore an inactive customer to active — not for prospects.

Upgrade a prospect customer

Prospecting overview

Onboard customer

Reactivate customer

On this page