Permanently removes a subject's stored image and face data. Use it for erasure requests and when a customer leaves.
Erasure is all or nothing: if either store cannot be cleared the call returns 503 and keeps the enrolment, so you can safely retry until it succeeds. To replace a face instead, enrol again with overwrite: true.
Not billed.
Authorization
ApiKeyAuth In: header
Path Parameters
Your own identifier for the person, as supplied when they were enrolled.
Query Parameters
The gallery the subject belongs to. Defaults to default.
Response Body
application/json
curl -X DELETE "https://example.com/api/v1/verification/biometrics/face/enrollments/string/"{ "data": { "subject_id": "string", "gallery_id": "string", "deleted": true }, "status": true, "response_code": "00", "message": "string", "billing_info": { "was_charged": true, "amount": "string", "currency": "string" }}response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.
Join Slack ChannelGet a face enrolment GET
Returns the details of an enrolment: when it was made, whether liveness was checked, and the consent you recorded. The image itself is never returned. Not billed.
Identify a face POST
Searches one of your galleries for a live face (1:N) and returns the closest enrolled subjects. The gallery search ranks candidates by `similarity`. With `confirm: true` (the default) the top three are each compared again against their enrolled image and scored by `confidence`; `best_match` is the highest candidate at or above `confidence_threshold`. With `confirm: false` there is no second check and `best_match` is simply the nearest candidate, so treat it as a lead, not proof. Candidates beyond the top three are never confirmed and have a null `confidence`. Finding nobody is a valid, billed result: `matched` is `false` and `candidates` is empty. Only your own galleries are searched. Billed per completed search and debited from the organisation wallet. Sandbox keys return a sample match.