Skip to main content
POST
Erase a direct order (LGPD)

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

orderId
string
required

The direct order's identifier (UUID).

Example:

"0b9b7c2e-4f8a-4d3e-9a51-7c2d1e0f3a44"

Body

application/json
note
string

Optional note (at most 256 characters, no personal data). Stored sealed in the audit trail; never echoed when refused.

Example:

"DPO request routed by the institution."

reason
string

Required: lgpd-subject-request (a data subject's request) or retention-purge (retention ended).

Example:

"lgpd-subject-request"

ticket
string

Required: the request id the erase is filed under (at most 64 characters, no personal data). Stored sealed in the audit trail.

Example:

"LGPD-2026-0042"

Response

OK

erasedAt
string<date-time>
required

Instant of the request (UTC).

erasedBy
string
required

Subject of the platform administrator who made the request.

orderId
string
required

The direct order's identifier.

outcome
enum<string>
required

erased: this request erased the order. noop: it was already erased (audited again).

Available options:
erased,
noop
rows
object
required

Rows shredded beyond the intake.