> ## 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 exclusão em massa de templates biométricos

> POST /v3/biometric-templates/delete/ da Didit: exclua em massa templates biométricos faciais por lista de IDs ou filtro. Idempotente por template.

Remove vários templates em uma única chamada. Informe uma lista explícita de IDs ou `delete_all: true`, com a remoção opcionalmente restrita pelos mesmos filtros de [Listar templates biométricos](https://docs.didit.me/pt-br/management-api/biometric-templates/list.md).

## Corpo da requisição

| Campo | Tipo | Descrição |
| - | - | - |
| `template_uuids` | UUID\[] | Templates a serem removidos. Obrigatório, a menos que `delete_all` seja `true`. IDs que já foram removidos são informados como `already_purged`. |
| `delete_all` | boolean | Quando `true`, remove todos os templates que correspondem aos filtros abaixo (todos os templates da aplicação quando nenhum filtro é informado). `template_uuids` é ignorado. |
| `vendor_data` | string | Somente com `delete_all`: correspondência de substring, sem diferenciar maiúsculas de minúsculas, no `vendor_data` do User proprietário |
| `vendor_user_uuid` | UUID | Somente com `delete_all`: correspondência exata com o User proprietário |
| `status` | enum | Somente com `delete_all`: `pending`, `active`, `expired`, `held_out_of_use`, `purge_pending`, `purge_failed` |
| `source_type` | enum | Somente com `delete_all`: `session_delete`, `automatic_retention`, `backfill` |
| `retained_from`, `retained_to` | datetime | Somente com `delete_all`: intervalo de datas de retenção |

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

## 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 templates de um User
>
> ```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 templates 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 templates são removidos um a um, e cada resultado informa `purged` ou `already_purged`. Se um armazenamento biométrico estiver indisponível, a chamada retorna `503` no primeiro template que falhar. Os templates removidos anteriormente na mesma requisição permanecem removidos; o template que falhou passa para `purge_failed` (já excluído da correspondência), e repetir a requisição conclui o trabalho.

## Erros

| Status | Quando | Corpo |
| - | - | - |
| `400` | Nem `template_uuids` nem `delete_all: true` foram informados | `{"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 usuário do console, ou a chave de API não tem permissão | `{"detail": "You do not have permission to perform this action."}` |
| `503` | Um armazenamento biométrico estava indisponível; repita a requisição | `{"detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable."}` |


## OpenAPI

````yaml pt-br/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: Expurgar em massa templates biométricos retidos
      description: >-
        Uma aplicação que ativou esse recurso mantém um template biométrico
        facial, sem imagens e gerenciado separadamente, vinculado ao usuário
        quando uma sessão é excluída (veja `DELETE
        /v3/session/{sessionId}/delete/`). Os templates são dados biométricos
        com um `expires_at` finito; eles nunca contêm imagens, dados de sessão
        nem campos de identidade, e são expurgados na exclusão do usuário, no
        apagamento por privacidade, na expiração ou em um expurgo explícito.
        Estes endpoints aceitam apenas chaves de API da aplicação (`x-api-key`);
        tokens de usuário do Business Console são rejeitados com `403`.


        Expurga vários templates em uma única chamada, por uma lista explícita
        de ids ou com `delete_all: true`, opcionalmente restrito pelos mesmos
        filtros do endpoint de listagem. Os templates são expurgados um a um e
        cada resultado informa `purged` ou `already_purged`. Se um armazenamento
        biométrico estiver indisponível, a chamada retorna `503` no primeiro
        template que falhar: os templates expurgados antes nessa requisição
        continuam expurgados, o que falhou passa para `purge_failed` (já
        excluído da correspondência) e repetir a requisição conclui o trabalho.


        **`delete_all: true` sem filtros expurga todos os templates biométricos
        da aplicação e não pode ser desfeito.** Execute antes 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: >-
                    Templates a expurgar. Obrigatório, a menos que `delete_all`
                    seja `true`. IDs já expurgados são informados como
                    `already_purged`.
                delete_all:
                  type: boolean
                  default: false
                  description: >-
                    Quando `true`, elimina definitivamente todos os modelos que
                    correspondem aos filtros abaixo (todos os modelos da
                    aplicação quando nenhum filtro é informado).
                    `template_uuids` é ignorado. Irreversível.
                vendor_data:
                  type: string
                  description: >-
                    Somente com `delete_all`: correspondência de substring, sem
                    diferenciar maiúsculas de minúsculas, no `vendor_data` do
                    User proprietário.
                vendor_user_uuid:
                  type: string
                  format: uuid
                  description: >-
                    Somente com `delete_all`: correspondência exata com o
                    usuário proprietário.
                status:
                  type: string
                  enum:
                    - pending
                    - active
                    - expired
                    - held_out_of_use
                    - purge_pending
                    - purge_failed
                  description: Somente com `delete_all`.
                source_type:
                  type: string
                  enum:
                    - session_delete
                    - automatic_retention
                    - backfill
                  description: Somente com `delete_all`.
                retained_from:
                  type: string
                  format: date-time
                  description: Somente com `delete_all`.
                retained_to:
                  type: string
                  format: date-time
                  description: >-
                    Somente 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 da exclusão definitiva 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 é removido definitivamente.'
          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 usuário do console, 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 ficou indisponível durante a retenção ou
            a exclusão de um template biométrico. Nada é excluído; repita a
            mesma requisição. As novas tentativas são idempotentes e convergem
            para um único template.
          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: >-
        Chave de API da sua aplicação, em Developers -> API keys no Business
        Console. A chave principal tem acesso total. Uma chave nomeada pode ter
        escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um
        endereço fora da sua lista de IPs; 404 em uma rota de sessão significa
        que a sessão está fora dos fluxos ou status da chave. Uma chave sem
        acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave
        sem permissão de escrita em sessões recebe links e tokens de sessão como
        null. Consulte https://docs.didit.me/console/api-keys.

````

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