Skip to content
EmitKitDocs
Esc
↑↓navigate↵open⌘Jpreview

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_…

or
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.

errorstringrequired
messagestringrequired
404

No identity in the Organization has this user_id.

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.

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.

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
Authorization
Parameters
Request
curl -X DELETE "https://api.emitkit.com/v1/identities/string" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "data": {
    "aliasesDeleted": 0,
    "id": "string",
    "productEventsDetached": 0,
    "status": "erased",
    "userId": "string"
  },
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "success": true
}