Appearance
Request account deletion
POST /v1/me/delete
- Operation ID:
requestAccountDeletion - Tags: Account
- Base URL:
http://localhost:8787
Step one of two. Generates a single-use confirmation token valid for 15 minutes. The token is delivered out of band and is not part of this response; confirm with POST /v1/me/delete/confirm.
Workflow: Integration guide.
Authentication: Platform user Bearer JWT. Acts only on the caller's own data.
Authentication
- Auth: Platform user Bearer JWT (
Authorization: Bearer <access_token>).
Responses
200
Confirmation requested.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object
| Field | Type | Required | Description |
|---|---|---|---|
expiresInSeconds | integer | yes | - |
Errors
401
Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | Stable machine-readable error code, e.g. forbidden, not_found. |
details | any | no | Optional structured context. For 403 it is { perm }. |
Error response
json
{
"error": "missing_token"
}500
Unexpected server error (internal). No details are returned.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object (ErrorBody), fields as described above.
Error response
json
{
"error": "internal"
}503
Maintenance can refuse this write before authentication (degraded blocks session start and checkout; lockdown blocks other public/user writes).
- Header
x-request-id: Request identifier; quote it when reporting an error. - Header
Retry-After: Maintenance retry delay in seconds; present for panic_mode. Example:30. Content type:application/json
Schema: object (MaintenanceErrorBody)
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes | One of: "panic_mode" |
level | string | yes | One of: "degraded", "lockdown" |
reason | string | null | yes | - |
Maintenance lockdown
json
{
"error": "panic_mode",
"level": "lockdown",
"reason": "Scheduled maintenance"
}Examples
curl
bash
curl -X POST 'http://localhost:8787/v1/me/delete' \
-H "Authorization: Bearer $ACCESS_TOKEN"TypeScript
ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow
const response = await fetch("http://localhost:8787/v1/me/delete", {
method: "POST",
headers: {
"Authorization": `Bearer ${accessToken}`,
},
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
? undefined
: response.headers.get("content-type")?.includes("json")
? await response.json()
: await response.text();