API reference/Endpoints
Data Breaches (GDPR Art. 33/34)
POST /breach-notifications
Registers a personal data breach. Authentication by API key.
Body (main fields):
{
"title": "Envio de lista de clientes a destinatário errado",
"description": "...",
"severity": "HIGH",
"detectedAt": "2026-10-20T08:30:00+01:00",
"awareAt": "2026-10-20T14:00:00+01:00",
"notifyCNPD": true,
"notifyCNCS": false
}
detectedAtis required;awareAtis optional. Both are ISO 8601 dates with an offset (Zor+01:00).awareAtis the moment the organization became aware of the breach (GDPR Art. 33 and NIS2). The notification deadlines to the CNPD (72 h) and the CNCS (24 h) run fromawareAt ?? detectedAt: withoutawareAt, they run fromdetectedAt.- Deadlines are only calculated for the authorities that are flagged (
notifyCNPD,notifyCNCS).
PUT /breach-notifications/:id
Updates a breach (the method in the code is PUT, as in the index at the end). It accepts, among others, status (DETECTED | ASSESSING | NOTIFYING | NOTIFIED | CLOSED), severity, the notification dates and awareAt.
awareAtaccepts an ISO date with an offset ornull(to go back to counting fromdetectedAt).- When
awareAtchanges, the active deadlines (deadlineCNPD,deadlineCNCS) are recalculated. - Response:
{ "data": { id, title, status, updatedAt } }.
Coming soonThis page will be available soon.