curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/face-upload/" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"image": "/9j/4AAQSkZ...", "comment": "Known fraudster"}'
{
"uuid": "a1b2c3d4-...",
"value": "face-uuid-here",
"display_label": "",
"comment": "Known fraudster",
"added_by": "api",
"reference_session_id": null,
"reference_session_number": null,
"reference_object_uuid": "face-uuid-here",
"metadata": {
"reference_image_url": "https://..."
},
"created_at": "2025-06-09T12:26:54Z"
}
Lists
Upload Face to List
Upload a base64 face image to a Didit face blocklist or allowlist. Didit extracts the biometric and uses it during future face matching.
POST
/
v3
/
lists
/
{list_uuid}
/
entries
/
face-upload
/
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/face-upload/" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"image": "/9j/4AAQSkZ...", "comment": "Known fraudster"}'
{
"uuid": "a1b2c3d4-...",
"value": "face-uuid-here",
"display_label": "",
"comment": "Known fraudster",
"added_by": "api",
"reference_session_id": null,
"reference_session_number": null,
"reference_object_uuid": "face-uuid-here",
"metadata": {
"reference_image_url": "https://..."
},
"created_at": "2025-06-09T12:26:54Z"
}
Upload a base64-encoded face image to a face-type blocklist or allowlist. Didit extracts the biometric data, validates a face is detected, inserts the embedding into the matching database, and creates a list entry.
Only available for lists with
entry_type: face and list_type: blocklist or list_type: allowlist.
If you’re blocklisting or allowlisting a face from an existing session, use Create entry with
reference_session_id instead — the backend links the entry back to the session.Request body
| Field | Type | Required | Description |
|---|---|---|---|
image | string | Yes | Base64-encoded face image (JPG, PNG, or WebP) |
comment | string | No | Comment or reason for adding |
curl -X POST "https://verification.didit.me/v3/lists/{list_uuid}/entries/face-upload/" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"image": "/9j/4AAQSkZ...", "comment": "Known fraudster"}'
{
"uuid": "a1b2c3d4-...",
"value": "face-uuid-here",
"display_label": "",
"comment": "Known fraudster",
"added_by": "api",
"reference_session_id": null,
"reference_session_number": null,
"reference_object_uuid": "face-uuid-here",
"metadata": {
"reference_image_url": "https://..."
},
"created_at": "2025-06-09T12:26:54Z"
}
The image must contain a clearly visible face. If no face is detected, a 400 error is returned.