Onboarding API

Manage the new-user onboarding wizard. Complete the setup, check status, and get compliance program templates.

Endpoints (4)

POST /api/v1/onboarding/complete 🔒

Complete the onboarding wizard with company details and compliance preferences.

Request Body

Field	Type	Required	Description
`companyName`	string	Yes	Company name
`industry`	string	Yes	Industry vertical
`companySize`	string	Yes	`1-10`, `11-50`, `51-200`, `201-500`, `500+`
`frameworks`	string[]	Yes	Framework IDs to enable
`jurisdictions`	string[]	No	Operating jurisdictions

curl -X POST https://api.privabase.com/api/v1/onboarding/complete \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "companyName": "Acme Corp",
    "industry": "technology",
    "companySize": "51-200",
    "frameworks": ["ccpa", "gdpr", "soc2"],
    "jurisdictions": ["US", "EU"]
  }'

GET /api/v1/onboarding/status 🔒

Check onboarding completion status.

curl https://api.privabase.com/api/v1/onboarding/status \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

{
  "success": true,
  "data": {
    "completed": true,
    "completedAt": "2026-03-13T...",
    "companyName": "Acme Corp",
    "selectedFrameworks": ["ccpa", "gdpr", "soc2"]
  }
}

GET /api/v1/onboarding/templates 🔒

Get onboarding templates — pre-built configurations for common industry/framework combinations.

GET /api/v1/onboarding/programs 🔒

Get available compliance programs — curated sets of frameworks for specific goals (e.g. "SOC 2 Readiness", "EU Privacy Bundle").