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.
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 GET "https://example.com/api/v1/verification/biometrics/face/enrollments/string/"{ "data": { "enrollment_id": "cd8e6b59-f5cf-4894-8850-4dc2dc1aaf8e", "subject_id": "string", "gallery_id": "string", "enrolled_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "liveness_checked": true, "consent_obtained": true, "consent_reference": "string", "metadata": { "property1": null, "property2": null } }, "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 ChannelEnrol a face POST
Stores a person's face in one of your galleries under your own `subject_id`, so they can later be authenticated or identified. You must pass `consent: true`, confirming you hold the person's consent to store their face. Keep your own record of that consent; use `consent_reference` to link it. Set `check_liveness` to reject printed or replayed faces at enrolment. Enrolling a `subject_id` that already exists returns `409` unless you send `overwrite: true`, which replaces the stored face. Use **Erase an enrolled face** to remove one permanently. Billed per successful enrolment and debited from the organisation wallet. Failed calls are never charged. Sandbox keys return a sample response and store nothing.
Erase an enrolled face DELETE
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.