API Documentation

Collect consent from a data principal. Records the consent decision along with purpose, timestamp, and metadata.

{
  "principal_id": "user@example.com",
  "purpose_id": "pur_abc123",
  "decision": "opt_in",
  "metadata": {
    "ip": "203.0.113.1",
    "user_agent": "Mozilla/5.0..."
  }
}

{
  "id": "con_xyz789",
  "principal_id": "user@example.com",
  "purpose_id": "pur_abc123",
  "decision": "opt_in",
  "collected_at": "2025-01-15T10:30:00Z"
}

Check the current consent status for a data principal across one or more purposes.

Query parameters:
  principal_id  (required) — identifier of the data principal
  purpose_id    (optional) — filter to a specific purpose

{
  "principal_id": "user@example.com",
  "consents": [
    {
      "purpose_id": "pur_abc123",
      "decision": "opt_in",
      "collected_at": "2025-01-15T10:30:00Z"
    }
  ]
}

Retrieve consent analytics including opt-in rates, trends, and breakdowns by purpose.

{
  "total_consents": 12450,
  "opt_in_rate": 0.73,
  "by_purpose": [
    {
      "purpose_id": "pur_abc123",
      "name": "Marketing emails",
      "opt_in": 8200,
      "opt_out": 4250
    }
  ]
}

List all consent purposes for your organization.

[
  {
    "id": "pur_abc123",
    "name": "Marketing emails",
    "description": "Send promotional content",
    "is_active": true,
    "created_at": "2025-01-10T08:00:00Z"
  }
]

Create a new consent purpose.

{
  "name": "Marketing emails",
  "description": "Send promotional content and offers"
}

{
  "id": "pur_new456",
  "name": "Marketing emails",
  "description": "Send promotional content and offers",
  "is_active": true,
  "created_at": "2025-01-15T12:00:00Z"
}

Retrieve a single consent purpose by ID.

{
  "id": "pur_abc123",
  "name": "Marketing emails",
  "description": "Send promotional content",
  "is_active": true,
  "created_at": "2025-01-10T08:00:00Z"
}

Update an existing consent purpose.

{
  "name": "Marketing communications",
  "description": "Updated description"
}

{
  "id": "pur_abc123",
  "name": "Marketing communications",
  "description": "Updated description",
  "is_active": true,
  "updated_at": "2025-01-16T09:00:00Z"
}

Delete a consent purpose. This will deactivate it but preserve historical records.

{
  "id": "pur_abc123",
  "deleted": true
}

List all privacy notices for your organization.

[
  {
    "id": "ntc_abc123",
    "title": "Privacy Notice v2",
    "status": "published",
    "version": 2,
    "created_at": "2025-01-10T08:00:00Z"
  }
]

Create a new privacy notice draft.

{
  "title": "Privacy Notice",
  "content": "...",
  "language": "en"
}

{
  "id": "ntc_new456",
  "title": "Privacy Notice",
  "status": "draft",
  "version": 1,
  "created_at": "2025-01-15T12:00:00Z"
}

Retrieve a single privacy notice by ID, including its full content.

{
  "id": "ntc_abc123",
  "title": "Privacy Notice v2",
  "content": "...",
  "status": "published",
  "version": 2
}

Update a draft privacy notice.

{
  "title": "Updated Privacy Notice",
  "content": "..."
}

{
  "id": "ntc_abc123",
  "title": "Updated Privacy Notice",
  "status": "draft",
  "version": 2
}

Publish a draft privacy notice, making it the active version.

{
  "id": "ntc_abc123",
  "status": "published",
  "published_at": "2025-01-16T10:00:00Z"
}

Generate a privacy notice using AI based on your organization profile and selected purposes.

{
  "purpose_ids": ["pur_abc123", "pur_def456"],
  "language": "en",
  "tone": "formal"
}

{
  "id": "ntc_gen789",
  "title": "Auto-generated Privacy Notice",
  "content": "...",
  "status": "draft"
}

Export a published privacy notice as a PDF document.

Binary PDF file (application/pdf)

List all data principal requests (access, correction, erasure, portability).

[
  {
    "id": "dr_abc123",
    "type": "erasure",
    "principal_id": "user@example.com",
    "status": "pending",
    "created_at": "2025-01-14T15:00:00Z"
  }
]

Create a new data principal request.

{
  "type": "access",
  "principal_id": "user@example.com",
  "description": "User requests copy of all personal data"
}

{
  "id": "dr_new456",
  "type": "access",
  "status": "pending",
  "created_at": "2025-01-15T12:00:00Z"
}

Retrieve details of a specific data request.

{
  "id": "dr_abc123",
  "type": "erasure",
  "principal_id": "user@example.com",
  "status": "pending",
  "description": "...",
  "created_at": "2025-01-14T15:00:00Z"
}

Update the status or details of a data request.

{
  "status": "completed",
  "resolution_notes": "All data exported and sent"
}

{
  "id": "dr_abc123",
  "status": "completed",
  "resolved_at": "2025-01-16T09:00:00Z"
}

List all recorded data breach incidents.

[
  {
    "id": "br_abc123",
    "title": "Unauthorized access incident",
    "severity": "high",
    "status": "investigating",
    "discovered_at": "2025-01-13T22:00:00Z"
  }
]

Record a new data breach incident.

{
  "title": "Unauthorized access incident",
  "severity": "high",
  "description": "Unauthorized access to user database detected",
  "discovered_at": "2025-01-13T22:00:00Z"
}

{
  "id": "br_new456",
  "title": "Unauthorized access incident",
  "severity": "high",
  "status": "investigating",
  "created_at": "2025-01-13T22:30:00Z"
}

Retrieve details of a specific breach incident.

{
  "id": "br_abc123",
  "title": "Unauthorized access incident",
  "severity": "high",
  "status": "investigating",
  "description": "...",
  "timeline": []
}

Update a breach incident (status, resolution, timeline entries).

{
  "status": "resolved",
  "resolution": "Credentials rotated, access revoked"
}

{
  "id": "br_abc123",
  "status": "resolved",
  "resolved_at": "2025-01-15T08:00:00Z"
}

Retrieve the 30-point DPDP compliance checklist with current completion status for each control.

{
  "total": 30,
  "completed": 18,
  "score": 0.6,
  "controls": [
    {
      "id": "ctrl_01",
      "title": "Consent collection mechanism",
      "category": "Consent",
      "status": "completed",
      "evidence": "Consent widget deployed"
    }
  ]
}

List all consent widget configurations.

[
  {
    "id": "wgt_abc123",
    "name": "Main website widget",
    "theme": "light",
    "is_active": true
  }
]

Create a new consent widget configuration.

{
  "name": "Main website widget",
  "theme": "light",
  "purposes": ["pur_abc123"]
}

{
  "id": "wgt_new456",
  "name": "Main website widget",
  "embed_code": "<script src=\"...\">"
}

Retrieve a widget configuration. Used by the embeddable widget to load its settings.

{
  "id": "wgt_abc123",
  "name": "Main website widget",
  "theme": "light",
  "purposes": [
    { "id": "pur_abc123", "name": "Marketing emails" }
  ]
}

List all API keys for your organization (keys are partially masked).

[
  {
    "id": "key_abc123",
    "name": "Production key",
    "prefix": "dpdp_***...abc",
    "created_at": "2025-01-10T08:00:00Z"
  }
]

Create a new API key. The full key is only returned once at creation time.

{
  "name": "Production key"
}

{
  "id": "key_new456",
  "name": "Production key",
  "key": "dpdp_live_abc123def456...",
  "created_at": "2025-01-15T12:00:00Z"
}