Skip to content
Biometry

Delete user enrollments

DELETE
/v2/users/{user_id}/enrollments

Removes the user’s biometric templates for the calling project: face metadata, voice enrollment records and the provider-side voiceprint. Transactions, consents and stored media are left intact — use DELETE /v2/users/{user_id} for a full cascading delete. Idempotent: deleting templates that do not exist returns 200, since the desired end state already holds. Required before re-enrolling a user whose voiceprint should be rebuilt from scratch: enrolling over an existing print adapts it rather than replacing it.

Authorizations

Parameters

Path Parameters

user_id
required
string

Responses

200

Enrollments deleted.

object
data

Endpoint-specific payload; omitted when the operation returns no data.

decision

Scoring decision computed for the request when a scoring system applies.

object
status

Decision status from the scoring engine (e.g. pass, fail, refer).

string
score
number
reasons
Array<string>
meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>
data
object
user_id
string
user-123
face
boolean
voice
boolean

400

Bad Request / Parameter Validation Failed.

object
error
required
object
code
required
string
invalid_request
message
required

Human-readable message; a string, or a field-error array for validation failures.

meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

401

Unauthorized / Missing or Invalid Authentication Credentials.

object
error
required
object
code
required
string
invalid_request
message
required

Human-readable message; a string, or a field-error array for validation failures.

meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

500

Internal Server Error.

object
error
required
object
code
required
string
invalid_request
message
required

Human-readable message; a string, or a field-error array for validation failures.

meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>