Docs / API reference

Deletion & lineage

Create and track deletion requests, report cascade outcomes, and record or query lineage — the metadata trail showing where a user's data actually went. See the deletion guide for how these pieces fit into the state machine.

Read the deletion lifecycle guide
POST/deletion-requestsAuthenticated

Creates a new deletion request, starting the six-state lifecycle for a user.

GET/deletion-requests/:deletionRequestIdAuthenticated

Returns a deletion request's current state, including per-destination cascade progress.

NameInTypeRequiredDescription
deletionRequestIdpathstringYesThe deletion request to look up.
POST/deletion-requests/:deletionRequestId/advanceAuthenticated

Manually advances a deletion request to its next state.

POST/janitor-eventsAuthenticated

Callback endpoint data planes use to report the outcome of a downstream cleanup — e.g. a SaaS-side wipe succeeding or failing.

Request
{
  "deletionRequestId": "del_9f21ab",
  "destination": "hubspot",
  "status": "SAAS_WIPE_SUCCEEDED",
  "attemptNumber": 1
}
POST/lineage/eventsAuthenticated

Records that encrypted data moved from a source to a destination. Metadata only — payloads never contain raw PII or ciphertext.

  • Also used for warehouse-discovery events and ghost-data findings, using userId: "UNKNOWN" for resource-level (non-user-linked) events.
GET/lineage/user/:userIdAuthenticated

Lists every downstream destination currently holding data for a user.

GET/lineage/deletion-plan/:userIdAuthenticated

Previews the impact of shredding a user before you actually do it — which destinations and stores would be affected.

Keep reading