> ## 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.

# Purga massiva de plantilles biomètriques

> Purga plantilles biomètriques conservades per llista d'ids o per filtre amb Didit (POST /v3/biometric-templates/delete/). Idempotent per plantilla.

Purga moltes plantilles en una sola crida. Proporciona una llista d'identificadors explícita o `delete_all: true`, opcionalment restringida pels mateixos filtres que [Llista les plantilles biomètriques](https://docs.didit.me/ca/management-api/biometric-templates/list.md).

## Cos de la sol·licitud

| Camp | Tipus | Descripció |
| - | - | - |
| `template_uuids` | UUID\[] | Plantilles a purgar. Obligatori tret que `delete_all` sigui `true`. Els identificadors que ja estan purgats s'informen com a `already_purged`. |
| `delete_all` | boolean | Quan és `true`, purga totes les plantilles que coincideixen amb els filtres següents (totes les plantilles de l'aplicació si no s'indica cap filtre). `template_uuids` s'ignora. |
| `vendor_data` | string | Només amb `delete_all`: coincidència de subcadena sense distinció de majúscules i minúscules amb el `vendor_data` de l'usuari propietari |
| `vendor_user_uuid` | UUID | Només amb `delete_all`: coincidència exacta amb l'usuari propietari |
| `status` | enum | Només amb `delete_all`: `pending`, `active`, `expired`, `held_out_of_use`, `purge_pending`, `purge_failed` |
| `source_type` | enum | Només amb `delete_all`: `session_delete`, `automatic_retention`, `backfill` |
| `retained_from`, `retained_to` | datetime | Només amb `delete_all`: interval de dates de conservació |

> [!WARNING]
>
> `delete_all: true` sense filtres purga totes les plantilles biomètriques de l'aplicació i no es pot desfer. Executa primer [Compta les plantilles biomètriques](https://docs.didit.me/ca/management-api/biometric-templates/count.md) amb els mateixos filtres per confirmar què es purgarà.

## Exemples

> [tab] Per identificador
>
> ```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] Totes les plantilles d'un usuari
>
> ```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] Totes les plantilles de l'aplicació
>
> ```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" }
  ]
}
```

Les plantilles es purguen una a una; cada resultat indica `purged` o `already_purged`. Si un magatzem biomètric no està disponible, la crida retorna `503` a la primera plantilla que falli; les plantilles purgades abans en la mateixa sol·licitud continuen purgades, la que ha fallat passa a `purge_failed` (ja exclosa de la comparació), i repetir la sol·licitud acaba la feina.

## Errors

| Estat | Quan | Cos |
| - | - | - |
| `400` | No s'ha enviat ni `template_uuids` ni `delete_all: true` | `{"template_uuids": ["This field is required unless delete_all is true."]}` |
| `400` | Valor de filtre no vàlid, o `retained_to` anterior a `retained_from` | Errors de validació indexats per camp |
| `403` | Token d'usuari de la consola, o la clau d'API no està autoritzada | `{"detail": "You do not have permission to perform this action."}` |
| `503` | Un magatzem biomètric no estava disponible; repeteix la sol·licitud | `{"detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable."}` |


## OpenAPI

````yaml ca/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ó d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/biometric-templates/delete/:
    post:
      tags:
        - Biometric Templates
      summary: Purga massiva de plantilles biomètriques conservades
      description: >-
        Una aplicació adherida manté una única plantilla biomètrica facial
        gestionada per separat i sense imatges, vinculada a l'usuari quan
        s'elimina una sessió (vegeu `DELETE /v3/session/{sessionId}/delete/`).
        Les plantilles són dades biomètriques amb un `expires_at` finit; mai
        contenen imatges, dades de la sessió ni camps d'identitat, i es purguen
        en eliminar l'usuari, per supressió de privadesa, per caducitat o
        mitjançant una purga explícita. Aquests endpoints només accepten claus
        d'API d'aplicació (`x-api-key`); els tokens d'usuari de la Business
        Console es rebutgen amb `403`.


        Purga múltiples plantilles en una sola crida, mitjançant una llista
        explícita d'ID o amb `delete_all: true`, opcionalment acotada pels
        mateixos filtres que l'endpoint de llistat. Les plantilles es purguen
        una per una i cada resultat indica `purged` o `already_purged`. Si un
        magatzem biomètric no està disponible, la crida retorna `503` en la
        primera plantilla fallida: les plantilles purgades prèviament a la
        sol·licitud romanen purgades, la que falla passa a `purge_failed` (ja
        exclosa de la cerca de coincidències), i repetir la sol·licitud completa
        la tasca.


        **`delete_all: true` sense filtres purga totes les plantilles
        biomètriques de l'aplicació i no es pot desfer.** Executa primer
        l'endpoint de recompte amb els mateixos filtres.
      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: >-
                    Plantilles per purgar. Obligatòries tret que `delete_all`
                    sigui `true`. Els identificadors ja purgats s'informen com a
                    `already_purged`.
                delete_all:
                  type: boolean
                  default: false
                  description: >-
                    Quan és `true`, purga totes les plantilles que coincideixin
                    amb els filtres següents (totes les plantilles de
                    l'aplicació si no s'especifica cap filtre). S'ignora
                    `template_uuids`. Irreversible.
                vendor_data:
                  type: string
                  description: >-
                    Només amb `delete_all`: coincidència de subcadena sense
                    distinció entre majúscules i minúscules sobre el
                    `vendor_data` de l'usuari propietari.
                vendor_user_uuid:
                  type: string
                  format: uuid
                  description: >-
                    Només amb `delete_all`: coincidència exacta sobre l'usuari
                    propietari.
                status:
                  type: string
                  enum:
                    - pending
                    - active
                    - expired
                    - held_out_of_use
                    - purge_pending
                    - purge_failed
                  description: Només amb `delete_all`.
                source_type:
                  type: string
                  enum:
                    - session_delete
                    - automatic_retention
                    - backfill
                  description: Només amb `delete_all`.
                retained_from:
                  type: string
                  format: date-time
                  description: Només amb `delete_all`.
                retained_to:
                  type: string
                  format: date-time
                  description: >-
                    Només amb `delete_all`. No ha de 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: Resultats de la purga per 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ó — no es purga res.
          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 d'usuari de la consola, o la clau d'API no està permesa.
            Aquests endpoints només accepten claus d'API d'aplicació.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '503':
          description: >-
            Un magatzem biomètric no estava disponible en conservar o purgar una
            plantilla biomètrica. No s'ha eliminat res; repeteix la mateixa
            sol·licitud. Els reintents són idempotents i convergeixen 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 clau d'API de la teva aplicació, des de Developers -> API keys a la
        Business Console. La clau primària té accés complet. Una clau amb nom
        pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
        limitada a determinats fluxos de treball o a sessions aprovades, a una
        llista d'adreces IP i a una data de caducitat. 401 significa que la clau
        és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
        clau, que la clau no té accés a aquest recurs o acció, o que la
        sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
        ruta de sessió significa que la sessió està fora dels fluxos de treball
        o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
        URL d'imatge, vídeo i PDF com a null, i una clau sense permís
        d'escriptura de sessions rep els enllaços de sessió i els tokens com a
        null. Consulta https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.