users

Delete user data (GDPR Article 17)

Request account erasure (right to be forgotten). Anonymizes PII and deactivates account with 7-day grace period. Accepts JWT Bearer token (BearerToken). API keys are not supported for this endpoint.

POST/api/users/me/erase

Authentication

Requires JWT

Note

Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Request Body

Confirmation string (DELETE_MY_ACCOUNT) and optional reason for erasure.

json

{
  "confirmation": "DELETE_MY_ACCOUNT",
  "reason": "No longer need the service"
}
{
  "confirmation": "DELETE_MY_ACCOUNT",
  "reason": "No longer need the service"
}

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");
import { MudbaseClient } from "mudbase";

const client = new MudbaseClient();
client.setJWT("eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig");

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const result = await client.users.eraseData({
  confirmation: "bandwidth override",
  reason: "matrix input"
});
const result = await client.users.eraseData({
  confirmation: "bandwidth override",
  reason: "matrix input"
});

Try It Live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

JWT Bearer Token Use the auth endpoints to obtain a JWT.

Request Body (JSON)

No Request Yet

Send a request to see the full inspector

Responses

200Account erasure initiated

json

{
  "message": "Account erasure initiated",
  "details": {
    "dataAnonymized": true,
    "apiKeysDeactivated": true,
    "sessionsDeleted": true,
    "accountDisabled": true,
    "scheduledForDeletion": "2024-12-23T10:00:00Z"
  }
}
{
  "message": "Account erasure initiated",
  "details": {
    "dataAnonymized": true,
    "apiKeysDeactivated": true,
    "sessionsDeleted": true,
    "accountDisabled": true,
    "scheduledForDeletion": "2024-12-23T10:00:00Z"
  }
}

400Bad request or validation error.

401Authentication required or invalid token.

Errors

Code	Meaning
`400`	Bad request or validation error.
`401`	Authentication required or invalid token.

Run in Postman Download OpenAPI

Next steps

Edit this page on GitHub