Endpoint
Authentication
Requires a developer API key in theAuthorization header.
Request Headers
| Header | Value |
|---|---|
Authorization | Bearer <api_key> |
Content-Type | application/json |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
noticeId | string | Yes | A developer-chosen identifier for the notice (e.g., "privacy-notice") |
version | string | Yes | Version string (e.g., "2.0") |
title | string | Yes | Human-readable notice title |
content | string | Yes | Full consent notice content (HTML or plain text) |
purposes | object[] | Yes | Array of purpose objects ({ code, description }) |
language | string | No | ISO language code (default: "en") |
dataFiduciaryContact | string | No | Contact information for the data fiduciary |
grievanceOfficer | object | No | Grievance officer details ({ name, email, phone? }) |
Example Request
Response — 201 Created
Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Unique internal notice ID |
noticeId | string | Developer-chosen notice identifier |
version | string | Version string |
language | string | ISO language code |
contentHash | string | SHA-256 hash of the notice content |
createdAt | string | ISO-8601 creation timestamp |
Error Responses
| Status | Code | Description |
|---|---|---|
| 400 | BAD_REQUEST | Missing required fields (noticeId, version, title, content, purposes) |
| 401 | UNAUTHORIZED | Invalid or missing API key |
| 409 | CONFLICT | Notice version already exists |