Delete Identity

Erases the Organization’s identity for a user, deleting its properties and aliases. Events already recorded are kept under their 90-day retention, but no longer show the user when they are read. Pass the canonical user_id; an alias is not accepted.

DELETE/v1/identities/{user_id}

Authorization

AuthorizationBearer token (EmitKit API key) · headerrequired

EmitKit API key in the Authorization header as Bearer emitkit_…

X-API-KeyAPI key · headerrequired

EmitKit API key beginning with emitkit_.

Path parameters

user_idstringrequired

The canonical identifier of the person to erase (not an alias).

min length 1

Responses

200

The identity and its aliases were erased.

dataobjectrequired

Show properties

aliasesDeletedintegerrequired

min 0 · max 9007199254740991

idstringrequired

productEventsDetachedintegerrequired

Always 0: events are kept, and the user is hidden when they are read.

min 0 · max 9007199254740991

statusstringrequired

Allowed:erased

userIdstringrequired

min length 1

requestIdstring<uuid>required

matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

successbooleanrequired

401

Authentication credentials are missing or invalid.

codestringrequired

Stable: switch on this, not on error or message.

errorstringrequired

messagestringrequired

requestIdstring<uuid>required

matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

successbooleanrequired

403

The API key lacks this operation's scope (a read-only key can only read), isn't bound to a Project, or its Project was deleted.

codestringrequired

Stable: switch on this, not on error or message.

errorstringrequired

messagestringrequired

What's missing, e.g. the scope the operation needs.

requestIdstring<uuid>required

matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

successbooleanrequired

404

No identity in the Organization has this user_id.

codestringrequired

Stable: switch on this, not on error or message.

errorstringrequired

messagestringrequired

requestIdstring<uuid>required

matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

successbooleanrequired

429

The authenticated principal exceeded its rate limit.

codestringrequired

Stable: switch on this, not on error or message.

errorstringrequired

messagestringrequired

requestIdstring<uuid>required

matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

successbooleanrequired

500

The identity could not be erased.

codestringrequired

Stable: switch on this, not on error or message.

errorstringrequired

messagestringrequired

requestIdstring<uuid>required

matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

successbooleanrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (EmitKit API key)Remember on this deviceInclude my values in samples

Parameters

user_idpath*The canonical identifier of the person to erase (not an alias).

Request

curl -X DELETE "https://api.emitkit.com/v1/identities/string" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.emitkit.com/v1/identities/string", {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.delete(
    "https://api.emitkit.com/v1/identities/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "data": {
    "aliasesDeleted": 0,
    "id": "string",
    "productEventsDetached": 0,
    "status": "erased",
    "userId": "string"
  },
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "success": true
}

{
  "code": "unauthorized",
  "error": "Unauthorized",
  "message": "Invalid or missing authentication credentials",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "success": false
}

{
  "code": "forbidden",
  "error": "Forbidden",
  "message": "string",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "success": false
}

{
  "code": "not_found",
  "error": "Not found",
  "message": "No External Identity matches the supplied user_id",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "success": false
}

{
  "code": "rate_limited",
  "error": "Rate limit exceeded",
  "message": "Too many requests. Please try again later.",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "success": false
}

{
  "code": "internal_error",
  "error": "Failed to delete identity",
  "message": "The identity could not be erased",
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "success": false
}