> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # API para subir rostros a listas biométricas > Sube una imagen facial en base64 a una lista de bloqueo o de permitidos de Didit. Didit extrae el dato biométrico para futuras comparaciones faciales. Prompt de la API para subir un rostro a una lista Copiar el prompt al portapapeles \

\`Upload a face image directly to a Didit face blocklist or allowlist through the Management API.

Endpoint:
POST https://verification.didit.me/v3/lists/{list_uuid}/entries/face-upload/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs workflows: write.

Goal:
\- Add a face to a face blocklist or allowlist when I do not have a verification session to reference. Didit detects the faces in the image, keeps the largest one, stores the image and a crop of that face, computes a biometric face template that new sessions are compared against, and creates the entry.
\- A face blocklist entry declines future sessions whose face matches. A face allowlist entry stops a matching face from triggering the duplicated-face action, but does not override blocklist matches or the other checks.

When NOT to use this:
\- If I am listing a face from an existing verification session, use POST /v3/lists/{list_uuid}/entries/ with reference_session_id instead, so the entry links back to the session.

Path parameter:
\- list_uuid: must be a list with entry_type "face" and list_type "blocklist" or "allowlist". Other lists return 400.

Request body (application/json):
\{
"image": "/9j/4AAQSkZ...",        // required: base64-encoded JPEG or PNG, at most 2 MB once decoded. Do not include a "data:image/..." prefix.
"comment": "Known fraud attempt"  // optional
}

Important constraints:
\- The image must show a clearly visible face. If no face is detected, the API returns 400 and no entry is created. If it shows several faces, Didit uses the largest one.
\- In a sandbox application the image is not analysed or stored: the entry has display_label "Sandbox face entry" and metadata.sandbox true, and matches nothing.

Example call:
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 fraud attempt"}'

Example response (201):
\{
"uuid": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"value": "44444444-5555-6666-7777-888888888888",
"display_label": "Manually uploaded face",
"comment": "Known fraud attempt",
"added_by": "api",
"reference_session_id": null,
"reference_session_number": null,
"reference_session_type": null,
"reference_object_uuid": "44444444-5555-6666-7777-888888888888",
"metadata": { "reference_image_url": "https:///face_reference_image.jpg" },
"created_at": "2026-10-12T10:12:18.904467Z"
}

value and reference_object_uuid are the UUID of the new face. metadata.reference_image_url is a short-lived signed URL (null for a scoped key without media: read).

Failure modes:
\- 400: the list is not a face list ({ "detail": "Face upload is only available for face-type lists." }), the list is a custom face list, image is missing, larger than 2 MB, not valid base64, not a readable JPEG or PNG, or shows no face ({ "image": "No face detected in the image. Please upload a clear photo with a visible face." }).
\- 401: the API key has expired.
\- 403: missing x-api-key (a wrong, revoked or expired key gets 401) ({ "detail": "You do not have permission to perform this action." }), or a scoped key without workflows: write.
\- 404: list not found in this application ({ "detail": "List not found." }).
\- 503: face analysis is temporarily unavailable; no entry was created, retry later.
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects:
\- The face template is added to biometric matching. Future sessions matching a blocklisted face are declined. Future sessions matching an allowlisted face skip the duplicated-face action and include an informational allowlist warning.

For the full integration shape, see /integration/integration-prompt.`

\
Pegar en Sube una imagen de rostro codificada en base64 a una lista de bloqueo o lista de permitidos de rostros. Didit detecta los rostros de la imagen, conserva el más grande, almacena la imagen y un recorte de ese rostro, y calcula la plantilla biométrica facial con la que se comparan las nuevas sesiones. El `value` de la nueva entrada es el UUID de ese rostro.Solo está disponible para listas con `entry_type: face` y `list_type: blocklist` o `list_type: allowlist`.> [!TIP] > > Si vas a añadir a una lista de bloqueo o de permitidos un rostro **de una sesión existente**, usa [Crear entrada](https://docs.didit.me/es/management-api/lists/create-entry.md) con `reference_session_id`: así la entrada queda vinculada a la sesión.> [!WARNING] > > La imagen debe contener un rostro claramente visible y ocupar como máximo 2 MB una vez decodificada. Si no se detecta ningún rostro, la solicitud devuelve `400` y no se crea ninguna entrada. Si el análisis facial no está disponible temporalmente, devuelve `503`: vuelve a intentarlo más tarde.Para quitar el rostro de la lista, [elimina su entrada](https://docs.didit.me/es/management-api/lists/delete-entry.md): dejará de coincidir con nuevas sesiones. ## OpenAPI ````yaml es/openapi-25.json POST /v3/lists/{list_uuid}/entries/face-upload/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: API de verificación de identidad. Autentícate con el encabezado x-api-key. servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/lists/{list_uuid}/entries/face-upload/: post: tags: - Lists summary: Subir un rostro a una lista description: >- Añade un rostro a una lista de bloqueo de rostros o a una lista de permitidos de rostros a partir de una imagen JPEG o PNG codificada en base64, para cuando no tienes una sesión de verificación a la que hacer referencia. Didit detecta los rostros de la imagen, usa el más grande y crea una entrada cuyos `value` y `reference_object_uuid` son el UUID del nuevo rostro. Un rostro en la lista de bloqueo rechaza las nuevas sesiones cuyo rostro coincide; un rostro en la lista de permitidos omite la acción de rostro duplicado y nunca anula una coincidencia con la lista de bloqueo. En una aplicación de sandbox, la imagen no se analiza y la entrada no coincide con nada. Una clave de API con alcance limitado necesita `workflows: write`. Para añadir a una lista un rostro de una sesión existente, usa en su lugar [Crear una entrada de lista](https://docs.didit.me/es/management-api/lists/create-entry) con `reference_session_id`. operationId: upload_list_entry_face parameters: - name: list_uuid in: path required: true description: >- UUID de una lista con `entry_type: face` y `list_type: blocklist` o `allowlist`. schema: type: string format: uuid example: 11111111-2222-3333-4444-555555555555 requestBody: required: true content: application/json: schema: type: object required: - image properties: image: type: string format: byte description: >- Imagen JPEG o PNG codificada en base64, de 2 MB como máximo una vez decodificada, que muestre un rostro claramente visible. Envía solo la cadena base64, sin el prefijo `data:image/...;base64,`. comment: type: string default: '' description: >- Nota opcional en texto libre, como el motivo de la inclusión en la lista. examples: Face image: value: image: /9j/4AAQSkZJRgABAQAAAQABAAD... comment: Known fraud attempt responses: '201': description: Se creó la entrada del rostro. content: application/json: schema: $ref: '#/components/schemas/ComplianceListEntry' examples: Uploaded face: value: uuid: cccccccc-dddd-eeee-ffff-000000000000 value: 44444444-5555-6666-7777-888888888888 display_label: Manually uploaded face comment: Known fraud attempt added_by: api reference_session_id: null reference_session_number: null reference_session_type: null reference_object_uuid: 44444444-5555-6666-7777-888888888888 metadata: reference_image_url: >- https://media.example.com/faces/reference.jpg?expires=1760263938&signature=3f9a1c created_at: '2026-10-12T10:12:18.904467Z' Sandbox application: value: uuid: cccccccc-dddd-eeee-ffff-000000000000 value: 44444444-5555-6666-7777-888888888888 display_label: Sandbox face entry comment: Known fraud attempt added_by: api reference_session_id: null reference_session_number: null reference_session_type: null reference_object_uuid: 44444444-5555-6666-7777-888888888888 metadata: sandbox: true created_at: '2026-10-12T10:12:18.904467Z' '400': description: >- La lista no admite cargas de rostros, o la imagen falta, no es válida, es demasiado grande o no muestra un rostro utilizable. No se creó ninguna entrada. content: application/json: examples: Not a face list: value: detail: Face upload is only available for face-type lists. Custom face list: value: detail: >- Face upload is only available for face blocklists and allowlists. Missing image: value: image: - This field is required. Invalid base64: value: image: - Invalid base64 encoding. Too large: value: image: - Image exceeds maximum size of 2 MB. Unreadable image: value: image: Invalid image. Provide a valid base64-encoded JPG or PNG. No face: value: image: >- No face detected in the image. Please upload a clear photo with a visible face. No usable face: value: image: Could not extract face embedding. Try a different image. '401': description: >- La clave de API con alcance limitado ha expirado. Los demás fallos de autenticación devuelven `403`. content: application/json: examples: Expired API key: value: detail: This API key has expired. '403': description: >- Falta el encabezado `x-api-key` (una clave incorrecta, revocada o expirada recibe `401`), o una clave de API con alcance limitado no tiene `workflows: write` o se usa desde una dirección IP que no está en su lista de permitidas. content: application/json: examples: Missing or invalid API key: value: detail: You do not have permission to perform this action. Scoped key without workflows access: value: detail: This API key has no write access to workflows. '404': description: >- No existe ninguna lista con este UUID en la aplicación de la clave de API, o se eliminó. content: application/json: examples: Not found: value: detail: List not found. '429': $ref: '#/components/responses/RateLimitedWrite' '503': description: >- El análisis facial no está disponible temporalmente. No se creó ninguna entrada; vuelve a intentarlo más tarde. content: application/json: examples: Unavailable: value: detail: Service temporarily unavailable. Please try again later. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X POST 'https://verification.didit.me/v3/lists/11111111-2222-3333-4444-555555555555/entries/face-upload/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d "{\"image\": \"$(base64 < face.jpg | tr -d '\n')\", \"comment\": \"Known fraud attempt\"}" - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.lists.entries.upload_face( "11111111-2222-3333-4444-555555555555", image="/9j/4AAQSkZJRgABAQAAAQABAAD...", comment="Known fraud attempt", ) print(result) - lang: javascript label: Node.js source: >- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY. const didit = new Didit(); const result = await didit.lists.entries.uploadFace("11111111-2222-3333-4444-555555555555", { image: "/9j/4AAQSkZJRgABAQAAAQABAAD...", comment: "Known fraud attempt", }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Entries.UploadFace(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesUploadFaceParams{\n\tImage: \"/9j/4AAQSkZJRgABAQAAAQABAAD...\",\n\tComment: didit.String(\"Known fraud attempt\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import me.didit.Didit; import me.didit.types.ListsEntriesUploadFaceParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.lists().entries().uploadFace("11111111-2222-3333-4444-555555555555", ListsEntriesUploadFaceParams.builder() .image("/9j/4AAQSkZJRgABAQAAAQABAAD...") .comment("Known fraud attempt") .build()); System.out.println(result); - lang: php label: PHP source: >- lists->entries->uploadFace('11111111-2222-3333-4444-555555555555', [ 'image' => '/9j/4AAQSkZJRgABAQAAAQABAAD...', 'comment' => 'Known fraud attempt', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.lists.entries.upload_face( "11111111-2222-3333-4444-555555555555", image: "/9j/4AAQSkZJRgABAQAAAQABAAD...", comment: "Known fraud attempt" ) puts result.to_h - lang: csharp label: .NET source: >- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY. using var client = new DiditClient(); var result = await client.Lists.Entries.UploadFaceAsync("11111111-2222-3333-4444-555555555555", new ListsEntriesUploadFaceParams { Image = "/9j/4AAQSkZJRgABAQAAAQABAAD...", Comment = "Known fraud attempt", }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: ComplianceListEntry: type: object description: Un valor de una lista. required: - uuid - value - display_label - comment - added_by - reference_session_id - reference_session_number - reference_session_type - reference_object_uuid - metadata - created_at properties: uuid: type: string format: uuid description: >- Identificador de la entrada. Úsalo como `entry_uuid` en Eliminar una entrada de lista. value: type: string description: >- El valor incluido en la lista: un número de teléfono en formato E.164, una dirección de correo electrónico, un número de documento, una dirección IP o un rango CIDR, una huella de dispositivo, una dirección de wallet, una cuenta bancaria, un código de país ISO 3166-1 alfa-3, un `vendor_data`, cualquier cadena en una lista `key`, o el UUID del rostro almacenado en una lista de rostros. Los valores que envías se almacenan en minúsculas, excepto los números de teléfono y los códigos de país. La coincidencia no distingue entre mayúsculas y minúsculas. display_label: type: string nullable: true maxLength: 512 description: >- Etiqueta legible. Didit la completa en las entradas tomadas de una sesión (por ejemplo, el nombre del titular y el número de documento) cuando no envías ninguna. comment: type: string description: Nota en texto libre. Cadena vacía cuando no está definida. added_by: type: string nullable: true description: >- Quién añadió la entrada: `api` (una clave de API), el correo electrónico de un usuario de la consola o `console`, `system` o `migration` (entradas creadas por Didit), o `rule` (una acción de una regla de transacciones o de monitorización). reference_session_id: type: string format: uuid nullable: true description: >- Sesión de verificación de la que se tomó la entrada. `null` cuando la entrada se añadió por valor. reference_session_number: type: integer nullable: true description: >- Número de esa sesión dentro de la aplicación, tal como se muestra en la consola. reference_session_type: type: string nullable: true enum: - kyc - kyb - null description: >- `kyc` para una sesión de verificación de una persona, `kyb` para una sesión de verificación de una empresa, `null` cuando no hay sesión. reference_object_uuid: type: string format: uuid nullable: true description: >- El registro que representa la entrada: el registro de rostro, documento, teléfono o correo electrónico leído de una sesión, el rostro creado con Subir un rostro a una lista, o el UUID que enviaste (por ejemplo, el UUID de una transacción o el `didit_internal_id` de un usuario). metadata: type: object nullable: true additionalProperties: true description: >- Contexto adicional. Contiene las claves que establece Didit (enumeradas aquí) combinadas con cualquier `metadata` que enviaste al crear la entrada, devueltas tal como se almacenaron. `null` cuando no hay ninguna. properties: reference_image_url: type: string description: >- Entradas de rostro: URL firmada de corta duración, que se emite de nuevo en cada llamada; `null` para una clave de API con alcance limitado sin `media: read`. No aparece cuando ninguna imagen pertenece a la entrada. front_image_url: type: string description: >- Entradas de documento que incluyen una imagen del anverso del documento: URL firmada de corta duración, que se emite de nuevo en cada llamada; `null` para una clave de API con alcance limitado sin `media: read`. full_name: type: string description: >- Entradas de documento tomadas de una sesión: nombre completo del titular. issuing_state: type: string description: >- Entradas de documento tomadas de una sesión: país emisor en formato ISO 3166-1 alfa-3. document_type: type: string description: >- Entradas de documento tomadas de una sesión: código del tipo de documento, por ejemplo `P`, `ID` o `DL`. region: type: string description: >- Entradas de documento tomadas de una sesión: estado o provincia emisora de un documento de emisión regional; vacío cuando no aplica. No lo establece Añadir elementos de la sesión a la lista de bloqueo. document_number: type: string description: >- Entradas de documento tomadas de una sesión: el número de documento. face_image_source: type: string enum: - front_image_camera_front - back_image_camera_front description: >- Entradas de rostro tomadas de una selfie de captura de documento: qué selfie es. No aparece en los rostros de prueba de vida. reference_node_id: type: string nullable: true description: >- Entradas de rostro tomadas de una selfie de captura de documento: el nodo de verificación de identidad del que procede la selfie. fingerprint_tier: type: string nullable: true enum: - persistent_id - composite_hash - legacy_fp - unknown - null description: >- Entradas de huella digital del dispositivo tomadas de una sesión: indican cómo se derivó la huella. `persistent_id` identifica un único dispositivo; `composite_hash` y `legacy_fp` pueden ser compartidos por dispositivos del mismo modelo. sandbox: type: boolean description: >- `true` en una entrada facial subida en una aplicación de sandbox; esa entrada no coincide con nada. reference_type: type: string enum: - transaction - vendor_user - vendor_business description: >- Lo defines tú: a qué apunta `reference_object_uuid`, para que la consola enlace de vuelta a él. reference_id: type: string description: 'Lo defines tú: identificador del registro de origen.' created_at: type: string format: date-time description: Cuándo se añadió la entrada. responses: RateLimitedWrite: description: >- Se superó el límite de escritura compartido de 300 solicitudes por minuto por clave de API. Respeta `Retry-After` antes de reintentar. content: application/json: schema: type: object required: - detail properties: detail: type: string example: detail: >- Write request rate limit exceeded. You can make up to 300 requests per minute. securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.