POST
/api/v1/verification/biometrics/face/enroll/

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.

Authorization

ApiKeyAuth
X-API-Key<token>

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/api/v1/verification/biometrics/face/enroll/" \  -H "Content-Type: application/json" \  -d '{    "subject_id": "cust-1042",    "image": "<base64 face image>",    "consent": true,    "consent_reference": "consent-2026-10-12-1042",    "check_liveness": true  }'
{  "reference_id": "VER-BIOMETRIC_FACE_ENROLL-K3X9ZP2QMA",  "enrollment_id": "0b6c0d52-6c0c-4d3f-9f0a-6d3a1d8c2e11",  "subject_id": "cust-1042",  "gallery_id": "default",  "replaced": false,  "liveness_checked": true,  "enrolled_at": "2026-10-12T14:30:00Z"}
Response Codes & Statuses: Prembly API responses include custom response_code values (e.g., 00 Success, 01 Not Found, 02 Unavailable).
View Response Codes Guide
Prembly Slack Community

Join our developer Slack channel for real-time integration support, engineering updates, and direct Q&A with the Prembly team.

Join Slack Channel