Skip to main content
POST
Upload faces for enrollment
Queues up to 50 images per request for background enrollment. Only images that successfully enroll are stored; failed images are discarded. The face name is derived from each image’s filename (without extension).

Error responses

Authorizations

Authorization
string
header
required

Use Bearer {your_api_token} in the Authorization header, plus HMAC signature headers. Same authentication as other v3 endpoints.

Headers

Authorization
string
required
Example:

"Bearer {your_api_token}"

Path Parameters

id
string<uuid>
required

The blacklist UUID (from the list endpoint).

Example:

"b1f2c3d4-0000-0000-0000-000000000000"

Body

multipart/form-data
images[]
file[]
required

1–50 image files. Accepted formats: jpg, jpeg, png. Max 10 MB each.

Required array length: 1 - 50 elements

Response

Face upload accepted and queued for enrollment

success
boolean
message
string
data
object