Quickstart

Go from zero to your first compliance check in 5 minutes.

1. Create an Account

   curl -X POST https://api.privabase.com/api/v1/auth/signup \
     -H "Content-Type: application/json" \
     -d '{
       "email": "you@company.com",
       "password": "YourSecurePassword123!",
       "name": "Your Name"
     }'

   You'll receive a JWT token in the response. Save it — you'll need it for authenticated requests.

   {
     "success": true,
     "data": {
       "token": "eyJhbGciOiJIUzI1NiIs...",
       "user": {
         "id": "abc-123",
         "email": "you@company.com"
       }
     }
   }

2. Verify Your Email

   Check your inbox for a verification link. Click it to activate your account. You can also resend verification:

   curl -X POST https://api.privabase.com/api/v1/auth/resend-verification \
     -H "Authorization: Bearer YOUR_TOKEN"

3. List Available Frameworks

   See all 57 supported frameworks:

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

   {
     "success": true,
     "data": {
       "frameworks": [
         { "id": "gdpr", "name": "GDPR", "category": "privacy", "jurisdiction": { "country": "EU" } },
         { "id": "ccpa", "name": "CCPA", "category": "privacy", "jurisdiction": { "country": "US", "region": "California" } },
         { "id": "hipaa", "name": "HIPAA", "category": "industry", "jurisdiction": { "country": "US" } },
         ...
       ],
       "total": 57
     }
   }

4. Run Your First Compliance Check

   Pick a framework and check your business against it. Here's a CCPA check:

   curl -X POST https://api.privabase.com/api/v1/frameworks/ccpa/check \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "businessProfile": {
         "collectsPersonalData": true,
         "sellsData": false,
         "hasPrivacyPolicy": true,
         "hasOptOutMechanism": false,
         "hasDeletionProcess": true,
         "hasDataInventory": false,
         "annualRevenue": "over25m",
         "recordsCount": "over50k"
       }
     }'

   {
     "success": true,
     "data": {
       "frameworkId": "ccpa",
       "frameworkName": "CCPA",
       "overallScore": 58,
       "passed": 7,
       "failed": 5,
       "results": [
         { "checkId": "ccpa-check-001", "rule": "Privacy Policy Required", "status": "pass" },
         { "checkId": "ccpa-check-002", "rule": "Opt-Out Mechanism", "status": "fail", "severity": "critical" },
         { "checkId": "ccpa-check-003", "rule": "Data Inventory", "status": "fail", "severity": "required" },
         ...
       ]
     }
   }

5. Get Remediation Guidance

   For any failed checks, get specific remediation steps:

   curl "https://api.privabase.com/api/v1/frameworks/ccpa/remediation?checkIds=ccpa-check-002,ccpa-check-003" \
     -H "Authorization: Bearer YOUR_TOKEN"

   {
     "success": true,
     "data": {
       "frameworkId": "ccpa",
       "guidance": [
         {
           "checkId": "ccpa-check-002",
           "title": "Implement Opt-Out Mechanism",
           "severity": "critical",
           "steps": [
             "Add a 'Do Not Sell My Personal Information' link to your homepage",
             "Implement a mechanism to process opt-out requests within 15 days",
             "Honor Global Privacy Control (GPC) browser signals"
           ],
           "effort": "medium",
           "timeline": "2-4 weeks"
         },
         ...
       ]
     }
   }

6. Generate a Compliance Policy

   Auto-generate a framework-specific privacy policy:

   curl -X POST https://api.privabase.com/api/v1/frameworks/ccpa/generate-policy \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "companyName": "Acme Corp",
       "website": "https://acme.com",
       "contactEmail": "privacy@acme.com",
       "dataTypes": ["name", "email", "usage_data"]
     }'

Next Steps

• Frameworks API Reference — All 9 framework endpoints in detail
• Supported Frameworks — Browse all 57 frameworks by category
• DSR Management — Handle data subject requests
• Vendor Management — Track third-party compliance
• Integration Guide — Patterns for integrating PrivaBase into your stack