API Reference
All endpoints below are relative to:
https://api.bytemonk.co/api/v1/public/cmp
Every request requires an X-Org-Api-Key header — see Authentication. Endpoints
marked 🔒 principal token additionally require an X-Principal-Token header identifying which data principal
the request acts on behalf of — there is no principalId/externalId field to supply in the body for these; the
principal is derived entirely from the token.
There's also a second, separate base path for server-to-server integrations —
https://api.bytemonk.co/api/v1/server/cmp — covered in Server-Side Integration,
not in the table below. It has two endpoints: POST /principals/token (Mode B token issuance) and
POST /principals/rotate-secret (mint a fresh principalSecret for an existing externalId — see
Rotate principalSecret).
Endpoint index
| Method | Path | Purpose | Auth |
|---|---|---|---|
POST | /principals/register | Register or resolve a data principal | Org key |
POST | /principals/token | Exchange a principalSecret for a session token | Org key |
POST | /guardian/register | Register a guardian for a minor principal | 🔒 principal token |
GET | /guardian/status | Check a minor's own guardian record's verification status | 🔒 principal token |
POST | /principals/token/revoke | Invalidate the current session token ahead of its natural expiry | 🔒 principal token |
GET | /notice | Fetch the currently active notice for a groupKey/language | Org key |
GET | /notice/{id} | Fetch a specific (possibly superseded) notice by id | Org key |
POST | /consent/grant | Record a principal's purpose-level consent | 🔒 principal token |
POST | /consent/withdraw | Withdraw a previously granted consent | 🔒 principal token |
GET | /consent/status | Check a principal's current consent status for a notice | 🔒 principal token |
GET | /consent/records | List a principal's current consent state across every notice | 🔒 principal token |
POST | /dsr | Submit a Data Principal Request (DPR) | 🔒 principal token |
GET | /dsr/status/{referenceId} | Check a DSR request's status | 🔒 principal token |
GET | /dsr | List a principal's DSR request history | 🔒 principal token |
POST | /grievances | File a grievance | 🔒 principal token |
GET | /grievances/status/{referenceId} | Check a grievance's status | 🔒 principal token |
GET | /grievances | List a principal's grievance filing history | 🔒 principal token |
Conventions
- All request/response bodies are
application/json. - Every response is wrapped in the same envelope, described in Error Codes —
{ entity, warnings, errors, success }. - Datetimes are ISO-8601 with timezone offset, e.g.
"2026-07-04T04:47:50.649+00:00". - IDs (
noticeId, etc.) are numbers, not strings. Principal identity is never passed as a field — see the 🔒 principal token column above. - Every endpoint returns/accepts a single resource except the three "list mine" endpoints
(
GET /dsr,GET /grievances,GET /consent/records), which are paginated the same way the admin API is —?page=0&size=20query params, responseentityshaped like{ content: [...], number, size, totalElements }. These are scoped strictly to the callingX-Principal-Token's own principal — there's no way to list another principal's records, or list across all principals (that's admin-facing only).