> ## 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 de eliminación masiva de plantillas biométricas

> Didit: POST /v3/biometric-templates/delete/ elimina en lote plantillas biométricas faciales por lista de IDs o filtro. Idempotente por plantilla.

Elimina muchas plantillas en una sola llamada. Indica una lista explícita de ID o `delete_all: true`, que puedes acotar con los mismos filtros que [Listar plantillas biométricas](https://docs.didit.me/es/management-api/biometric-templates/list.md).

## Cuerpo de la solicitud

| Campo | Tipo | Descripción |
| - | - | - |
| `template_uuids` | UUID\[] | Plantillas que se eliminan. Obligatorio salvo que `delete_all` sea `true`. Los ids que ya están eliminados se indican como `already_purged`. |
| `delete_all` | boolean | Cuando es `true`, elimina todas las plantillas que coinciden con los filtros siguientes (todas las plantillas de la aplicación si no se indica ningún filtro). `template_uuids` se ignora. |
| `vendor_data` | string | Solo con `delete_all`: coincidencia de subcadena, sin distinguir mayúsculas y minúsculas, con el `vendor_data` del usuario propietario |
| `vendor_user_uuid` | UUID | Solo con `delete_all`: coincidencia exacta con el usuario propietario |
| `status` | enum | Solo con `delete_all`: `pending`, `active`, `expired`, `held_out_of_use`, `purge_pending`, `purge_failed` |
| `source_type` | enum | Solo con `delete_all`: `session_delete`, `automatic_retention`, `backfill` |
| `retained_from`, `retained_to` | datetime | Solo con `delete_all`: rango de fechas de retención |

> [!WARNING]
>
> `delete_all: true` sin filtros elimina todas las plantillas biométricas de la aplicación y no se puede deshacer. Ejecuta antes [Contar plantillas biométricas](https://docs.didit.me/es/management-api/biometric-templates/count.md) con los mismos filtros para confirmar qué se va a eliminar.

## Ejemplos

> [tab] Por id
>
> ```bash theme={null}
> curl -X POST https://verification.didit.me/v3/biometric-templates/delete/ \
>   -H "x-api-key: YOUR_API_KEY" \
>   -H "Content-Type: application/json" \
>   -d '{"template_uuids": ["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"]}'
> ```

> [tab] Todas las plantillas de un usuario
>
> ```bash theme={null}
> curl -X POST https://verification.didit.me/v3/biometric-templates/delete/ \
>   -H "x-api-key: YOUR_API_KEY" \
>   -H "Content-Type: application/json" \
>   -d '{"delete_all": true, "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f"}'
> ```

> [tab] Todas las plantillas de la aplicación
>
> ```bash theme={null}
> curl -X POST https://verification.didit.me/v3/biometric-templates/delete/ \
>   -H "x-api-key: YOUR_API_KEY" \
>   -H "Content-Type: application/json" \
>   -d '{"delete_all": true}'
> ```

```json theme={null}
{
  "results": [
    { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "outcome": "purged" },
    { "uuid": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "outcome": "already_purged" }
  ]
}
```

Las plantillas se eliminan una a una; cada resultado indica `purged` o `already_purged`. Si un almacén biométrico no está disponible, la llamada devuelve `503` en la primera plantilla que falla; las plantillas eliminadas antes en la misma solicitud siguen eliminadas, la que falla pasa a `purge_failed` (ya excluida de las comparaciones) y repetir la solicitud completa el trabajo.

## Errores

| Estado | Cuándo | Cuerpo |
| - | - | - |
| `400` | No se indica ni `template_uuids` ni `delete_all: true` | `{"template_uuids": ["This field is required unless delete_all is true."]}` |
| `400` | Valor de filtro no válido, o `retained_to` anterior a `retained_from` | Errores de validación por campo |
| `403` | Token de usuario de la consola, o la clave de API no tiene permiso | `{"detail": "You do not have permission to perform this action."}` |
| `503` | Un almacén biométrico no estaba disponible; repite la solicitud | `{"detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable."}` |


## OpenAPI

````yaml es/openapi-25.json POST /v3/biometric-templates/delete/
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/biometric-templates/delete/:
    post:
      tags:
        - Biometric Templates
      summary: Purgar en bloque las plantillas biométricas conservadas
      description: >-
        Una aplicación que lo ha activado conserva una plantilla biométrica
        facial, gestionada por separado y sin imágenes, vinculada al usuario
        cuando se elimina una sesión (consulta `DELETE
        /v3/session/{sessionId}/delete/`). Las plantillas son datos biométricos
        con un `expires_at` finito; nunca contienen imágenes, datos de sesión ni
        campos de identidad, y se purgan al eliminar el usuario, con un borrado
        por privacidad, al expirar o mediante una purga explícita. Estos
        endpoints solo aceptan claves de API de la aplicación (`x-api-key`); los
        tokens de usuario de Business Console se rechazan con `403`.


        Purga muchas plantillas en una sola llamada, mediante una lista
        explícita de ids o con `delete_all: true`, opcionalmente acotado con los
        mismos filtros que el endpoint de listado. Las plantillas se purgan una
        a una y cada resultado indica `purged` o `already_purged`. Si un almacén
        biométrico no está disponible, la llamada devuelve `503` en la primera
        plantilla que falla: las plantillas purgadas antes dentro de la
        solicitud siguen purgadas, la que falla pasa a `purge_failed` (ya
        excluida de la coincidencia) y repetir la solicitud completa el trabajo.


        **`delete_all: true` sin filtros purga todas las plantillas biométricas
        de la aplicación y no se puede deshacer.** Ejecuta primero el endpoint
        de recuento con los mismos filtros.
      operationId: bulk_purge_biometric_templates
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                template_uuids:
                  type: array
                  items:
                    type: string
                    format: uuid
                  minItems: 1
                  description: >-
                    Plantillas que se purgarán. Obligatorio salvo que
                    `delete_all` sea `true`. Los ID ya purgados se indican como
                    `already_purged`.
                delete_all:
                  type: boolean
                  default: false
                  description: >-
                    Si es `true`, purga todas las plantillas que coinciden con
                    los filtros siguientes (todas las plantillas de la
                    aplicación si no se indica ningún filtro). Se ignora
                    `template_uuids`. Es irreversible.
                vendor_data:
                  type: string
                  description: >-
                    Solo con `delete_all`: coincidencia de subcadena, sin
                    distinguir mayúsculas y minúsculas, en el `vendor_data` del
                    usuario propietario.
                vendor_user_uuid:
                  type: string
                  format: uuid
                  description: >-
                    Solo con `delete_all`: coincidencia exacta con el usuario
                    propietario.
                status:
                  type: string
                  enum:
                    - pending
                    - active
                    - expired
                    - held_out_of_use
                    - purge_pending
                    - purge_failed
                  description: Solo con `delete_all`.
                source_type:
                  type: string
                  enum:
                    - session_delete
                    - automatic_retention
                    - backfill
                  description: Solo con `delete_all`.
                retained_from:
                  type: string
                  format: date-time
                  description: Solo con `delete_all`.
                retained_to:
                  type: string
                  format: date-time
                  description: >-
                    Solo con `delete_all`. No debe ser anterior a
                    `retained_from`.
            examples:
              By id:
                value:
                  template_uuids:
                    - 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
                    - 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d
              Every template of one User:
                value:
                  delete_all: true
                  vendor_user_uuid: 2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f
              Every template in the application:
                value:
                  delete_all: true
      responses:
        '200':
          description: Resultados de la purga por plantilla.
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        uuid:
                          type: string
                          format: uuid
                        outcome:
                          type: string
                          enum:
                            - purged
                            - already_purged
              examples:
                Mixed:
                  value:
                    results:
                      - uuid: 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
                        outcome: purged
                      - uuid: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d
                        outcome: already_purged
        '400':
          description: 'Error de validación: no se purga nada.'
          content:
            application/json:
              examples:
                Missing selector:
                  value:
                    template_uuids:
                      - This field is required unless delete_all is true.
                Bad range:
                  value:
                    retained_to:
                      - Must be on or after retained_from.
        '403':
          description: >-
            Token de usuario de la consola, o la clave de API no está permitida.
            Estos endpoints solo aceptan claves de API de aplicación.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '503':
          description: >-
            Un almacén biométrico no estaba disponible al conservar o purgar una
            plantilla biométrica. No se elimina nada; repite la misma solicitud.
            Los reintentos son idempotentes y convergen en una única plantilla.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Retryable:
                  value:
                    detail: >-
                      The biometric-template operation could not finish because
                      an external store is unavailable. The operation is
                      retryable.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            https://verification.didit.me/v3/biometric-templates/delete/ \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"delete_all": true, "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.biometric_templates.batch_delete(
                template_uuids=["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"],
            )
            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.biometricTemplates.batchDelete({
              template_uuids: ["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"],
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.BiometricTemplates.BatchDelete(ctx, didit.BiometricTemplatesBatchDeleteParams{\n\tTemplateUUIDs: didit.Some([]string{\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\", \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import java.util.List;

            import me.didit.Didit;

            import me.didit.types.BiometricTemplatesBatchDeleteParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.biometricTemplates().batchDelete(BiometricTemplatesBatchDeleteParams.builder()
                    .templateUuids(List.of("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"))
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->biometricTemplates->batchDelete([
                'template_uuids' => ['9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b', '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d'],
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result = didit.biometric_templates.batch_delete(template_uuids:
            ["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
            "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"])

            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.BiometricTemplates.BatchDeleteAsync(new
            BiometricTemplatesBatchDeleteParams

            {
                TemplateUuids = new string[] { "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d" },
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  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.