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

# Expurgar template biométrico pela API

> Exclua um template biométrico facial retido na Didit com DELETE /v3/biometric-templates/{template_uuid}/. Sai da correspondência. Idempotente.

Remove um template: ele é retirado de todos os tipos de correspondência e o template armazenado é excluído. A remoção é irreversível e fica registrada na trilha de auditoria com a identidade responsável pela ação.

```bash theme={null}
curl -X DELETE https://verification.didit.me/v3/biometric-templates/9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b/ \
  -H "x-api-key: YOUR_API_KEY"
```

```json theme={null}
{ "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "outcome": "purged" }
```

| `outcome` | Significado |
| - | - |
| `purged` | O template foi removido por esta chamada. |
| `already_purged` | O template já havia sido removido. Repetir uma remoção é seguro. |

## Semântica de novas tentativas

A Didit exclui primeiro o template armazenado e só então marca o template como purgado. Se um armazenamento biométrico estiver indisponível, a chamada retorna `503`, o template passa para `status: purge_failed` e já fica excluído da correspondência. Repita a mesma chamada para concluir a purga.

## Erros

| Status | Quando | Corpo |
| - | - | - |
| `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."}` |
| `404` | Template desconhecido ou template de outra aplicação | `{"detail": "Biometric template not found."}` |
| `503` | Um armazenamento biométrico estava indisponível. O template está em `purge_failed` e excluído da comparação; repita a chamada. | `{"detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable."}` |

## Outros pontos de remoção

Os modelos também são removidos quando você exclui o usuário proprietário com [Excluir usuários em lote](https://docs.didit.me/pt-br/management-api/users/delete.md), quando você exclui qualquer sessão desse usuário com `deletion_instruction: "privacy_erasure"` e automaticamente no momento definido em `expires_at`. Consulte [Pontos de remoção](https://docs.didit.me/pt-br/management-api/biometric-templates/overview.md#pontos-de-expurgo).


## OpenAPI

````yaml pt-br/openapi-25.json DELETE /v3/biometric-templates/{template_uuid}/
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/{template_uuid}/:
    delete:
      tags:
        - Biometric Templates
      summary: Expurgar um template biométrico retido
      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 um template: ele é removido de todo tipo de correspondência e o
        template armazenado é excluído. A operação é irreversível e fica
        registrada no registro de auditoria com o principal que a executou.


        **Semântica de nova tentativa:** a Didit exclui primeiro o template
        armazenado e só depois marca o template como expurgado. Se um
        armazenamento biométrico estiver indisponível, a chamada retorna `503`,
        o template passa para `status: purge_failed` e já fica excluído da
        correspondência; repita a mesma chamada para concluir. Repetir o expurgo
        de um template já expurgado retorna `already_purged`.


        Os templates também são expurgados por `POST /v3/users/delete/` para o
        usuário proprietário, por qualquer exclusão das sessões desse usuário
        com `deletion_instruction: privacy_erasure` e automaticamente em
        `expires_at`.
      operationId: purge_biometric_template
      parameters:
        - in: path
          name: template_uuid
          required: true
          description: >-
            ID do template, conforme retornado em `biometric_template_uuid`
            pelos endpoints de exclusão de sessão, em `biometric_template_id` em
            uma correspondência da Busca facial ou pelo endpoint de listagem.
          schema:
            type: string
            format: uuid
            example: 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
      responses:
        '200':
          description: Resultado do expurgo.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid:
                    type: string
                    format: uuid
                  outcome:
                    type: string
                    enum:
                      - purged
                      - already_purged
              examples:
                Purged:
                  value:
                    uuid: 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
                    outcome: purged
                Already purged:
                  value:
                    uuid: 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
                    outcome: already_purged
        '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.
        '404':
          description: >-
            Modelo desconhecido, um modelo de outra aplicação ou (no `GET`) um
            modelo removido definitivamente.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Biometric template not found.
        '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 DELETE
            https://verification.didit.me/v3/biometric-templates/9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b/
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.biometric_templates.delete(
                "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
            )
            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.delete("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.BiometricTemplates.Delete(ctx, \"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\")\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import me.didit.Didit;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.biometricTemplates().delete("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");

            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->delete('9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b');

            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.biometric_templates.delete("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b")

            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.DeleteAsync("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");

            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.