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) · headerrequiredEmitKit API key in the Authorization header as Bearer emitkit_…
or
X-API-KeyAPI key · headerrequiredEmitKit API key beginning with emitkit_.
Path parameters
user_idstringrequiredThe canonical identifier of the person to erase (not an alias).
min length 1
Responses
200
The identity and its aliases were erased.
dataobjectrequiredShow propertiesHide properties
aliasesDeletedintegerrequiredmin 0 · max 9007199254740991
idstringrequiredproductEventsDetachedintegerrequiredAlways 0: events are kept, and the user is hidden when they are read.
min 0 · max 9007199254740991
statusstringrequiredAllowed:
eraseduserIdstringrequiredmin length 1
requestIdstring<uuid>requiredmatches ^([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)$
successbooleanrequired401
Authentication credentials are missing or invalid.
errorstringrequiredmessagestringrequired404
No identity in the Organization has this user_id.
errorstringrequiredmessagestringrequiredrequestIdstring<uuid>requiredmatches ^([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)$
successbooleanrequired429
The authenticated principal exceeded its rate limit.
errorstringrequiredmessagestringrequiredrequestIdstring<uuid>requiredmatches ^([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)$
successbooleanrequired500
The identity could not be erased.
errorstringrequiredmessagestringrequiredrequestIdstring<uuid>requiredmatches ^([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