Skip to main content
Enroll face images into an existing biometric blacklist (watchlist). Enrollment is asynchronous: you submit a batch, get back an upload_id, then poll for the result. Base path: /v3/biometric-blacklists
Scope is automatically limited to the authenticated user’s company. You can only list, upload to, and poll uploads for blacklists owned by your company.

​
Authentication

Use the same authentication as all other v3 endpoints:
  • Bearer token (Sanctum) in the Authorization header
  • HMAC signature headers
See Introduction to the API for how to create an API token.

​
Endpoints

​
Upload status values

Poll the upload status endpoint until status is 2, 3, or 4. For high-volume enrollments (for example, 300k selfies):
1

Get the target blacklist

Call GET /v3/biometric-blacklists and note the blacklist_id you want to enroll into.
2

Chunk images into batches of 50

Split your image set into batches of up to 50 files per request.
3

Upload each batch

For each batch, call POST /v3/biometric-blacklists/{id}/faces and store the returned upload_id.
4

Poll each upload

Poll GET /v3/biometric-blacklists/uploads/{uploadId} every 3 minutes until status is 2, 3, or 4.