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

# Eliminação em massa de templates biométricos via API

> POST /v3/biometric-templates/delete/ — elimine templates faciais retidos por lista de IDs ou por filtro. Idempotente por template. Didit.

Purga muitos modelos numa única chamada. Indique uma lista explícita de ids ou `delete_all: true`, opcionalmente restringida pelos mesmos filtros de [Listar templates biométricos](https://docs.didit.me/pt/management-api/biometric-templates/list.md).

## Corpo do pedido

| Campo | Tipo | Descrição |
| - | - | - |
| `template_uuids` | UUID\[] | Modelos a purgar. Obrigatório, exceto se `delete_all` for `true`. Os ids que já foram purgados são indicados como `already_purged`. |
| `delete_all` | boolean | Quando `true`, purga todos os modelos que correspondem aos filtros abaixo (todos os modelos da aplicação, se não for indicado nenhum filtro). `template_uuids` é ignorado. |
| `vendor_data` | string | Apenas com `delete_all`: correspondência por substring, sem distinção entre maiúsculas e minúsculas, com o `vendor_data` do utilizador titular |
| `vendor_user_uuid` | UUID | Apenas com `delete_all`: correspondência exata com o utilizador titular |
| `status` | enum | Apenas com `delete_all`: `pending`, `active`, `expired`, `held_out_of_use`, `purge_pending`, `purge_failed` |
| `source_type` | enum | Apenas com `delete_all`: `session_delete`, `automatic_retention`, `backfill` |
| `retained_from`, `retained_to` | datetime | Apenas com `delete_all`: intervalo de datas de retenção |

> [!WARNING]
>
> `delete_all: true` sem filtros purga todos os templates biométricos da aplicação e não pode ser revertido. Execute primeiro [Contar templates biométricos](https://docs.didit.me/pt/management-api/biometric-templates/count.md) com os mesmos filtros para confirmar o que será purgado.

## Exemplos

> [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] Todos os modelos de um utilizador
>
> ```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] Todos os modelos da aplicação
>
> ```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" }
  ]
}
```

Os modelos são purgados um a um; cada resultado indica `purged` ou `already_purged`. Se um armazenamento biométrico estiver indisponível, a chamada devolve `503` no primeiro modelo que falhar. Os modelos purgados antes no mesmo pedido mantêm-se purgados, o modelo que falhou passa para `purge_failed` (já excluído da correspondência), e repetir o pedido conclui a purga.

## Erros

| Estado | Quando | Corpo |
| - | - | - |
| `400` | Não foram indicados nem `template_uuids` nem `delete_all: true` | `{"template_uuids": ["This field is required unless delete_all is true."]}` |
| `400` | Valor de filtro inválido, ou `retained_to` anterior a `retained_from` | Erros de validação indexados por campo |
| `403` | Token de utilizador da consola não autorizado ou chave de API sem permissão | `{"detail": "You do not have permission to perform this action."}` |
| `503` | Um armazenamento biométrico esteve indisponível; repita o pedido | `{"detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable."}` |


## OpenAPI

````yaml pt/openapi-25.json POST /v3/biometric-templates/delete/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de Verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/biometric-templates/delete/:
    post:
      tags:
        - Biometric Templates
      summary: Eliminar em massa templates biométricos retidos
      description: >-
        Uma aplicação que tenha aderido mantém um template biométrico facial sem
        imagem, gerido separadamente e associado ao Utilizador quando uma sessão
        é eliminada (consulte `DELETE /v3/session/{sessionId}/delete/`). Os
        templates biométricos são dados biométricos com um `expires_at` finito;
        nunca contêm imagens, dados da sessão ou campos de identidade, e são
        purgados aquando da eliminação do Utilizador, apagamento por motivos de
        privacidade, expiração ou uma purga explícita. Estes endpoints aceitam
        apenas chaves de API da aplicação (`x-api-key`); os tokens de utilizador
        da Business Console são rejeitados com `403`.


        Purga vários templates numa única chamada, por lista explícita de id ou
        com `delete_all: true` opcionalmente restringido pelos mesmos filtros
        que o endpoint de listagem. Os templates são purgados um a um e cada
        resultado reporta `purged` ou `already_purged`. Se um armazenamento
        biométrico estiver indisponível, a chamada devolve `503` no primeiro
        template com falha: os templates purgados anteriormente no pedido
        permanecem purgados, o que falhou passa para `purge_failed` (já excluído
        da correspondência) e repetir o pedido conclui a operação.


        **`delete_all: true` sem filtros purga todos os templates biométricos na
        aplicação e não pode ser anulado.** Execute primeiro o endpoint de
        contagem com os mesmos 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: >-
                    Modelos a eliminar definitivamente. Obrigatório, exceto se
                    `delete_all` for `true`. Os IDs já eliminados são reportados
                    como `already_purged`.
                delete_all:
                  type: boolean
                  default: false
                  description: >-
                    Quando `true`, purga todos os modelos correspondentes aos
                    filtros abaixo (todos os modelos da aplicação quando nenhum
                    filtro é fornecido). `template_uuids` é ignorado.
                    Irreversível.
                vendor_data:
                  type: string
                  description: >-
                    Apenas com `delete_all`: correspondência de substring sem
                    distinção entre maiúsculas e minúsculas no `vendor_data` do
                    utilizador proprietário.
                vendor_user_uuid:
                  type: string
                  format: uuid
                  description: >-
                    Apenas com `delete_all`: correspondência exata no utilizador
                    proprietário.
                status:
                  type: string
                  enum:
                    - pending
                    - active
                    - expired
                    - held_out_of_use
                    - purge_pending
                    - purge_failed
                  description: Apenas com `delete_all`.
                source_type:
                  type: string
                  enum:
                    - session_delete
                    - automatic_retention
                    - backfill
                  description: Apenas com `delete_all`.
                retained_from:
                  type: string
                  format: date-time
                  description: Apenas com `delete_all`.
                retained_to:
                  type: string
                  format: date-time
                  description: >-
                    Apenas com `delete_all`. Não pode 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 eliminação por modelo.
          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: Erro de validação — nada é purgado.
          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 utilizador da consola, ou a chave de API não é permitida.
            Estes endpoints aceitam apenas chaves de API de aplicação.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '503':
          description: >-
            Um armazenamento biométrico estava indisponível durante a retenção
            ou eliminação de um template biométrico. Nada é eliminado; repita o
            mesmo pedido. As novas tentativas são idempotentes e convergem para
            um único modelo.
          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: >-
        A chave de API da sua aplicação, a partir de Programadores -> Chaves de
        API na Business Console. A chave principal tem acesso total. Uma chave
        nomeada pode ter o âmbito definido: nenhum, leitura ou escrita por
        recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de
        endereços IP e a uma data de validade. 401 significa que a chave está
        incorreta, revogada ou expirada; 403 significa que nenhuma chave foi
        enviada, que a chave não tem acesso a este recurso ou ação, ou que o
        pedido veio de um endereço fora da sua lista de IP; 404 numa rota de
        sessão significa que a sessão está fora dos fluxos ou estados da chave.
        Uma chave sem acesso a multimédia recebe URLs de imagens, vídeos e PDFs
        como nulos, e uma chave sem permissão de escrita em sessões recebe
        ligações de sessão e tokens como nulos. Consulte
        https://docs.didit.me/console/api-keys.

````

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