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

# Purgar template biométrico: API

> Purgue na Didit um template biométrico facial retido: é removido da correspondência e o template armazenado é apagado. Operação idempotente.

Purga um modelo: ele é removido de todos os tipos de correspondência e o modelo armazenado é eliminado. A purga é irreversível e fica registada no registo de auditoria, com o principal que executou a 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 modelo foi purgado por esta chamada. |
| `already_purged` | O modelo já tinha sido purgado. Repetir uma purga é seguro. |

## Comportamento ao tentar novamente

A Didit elimina primeiro o modelo armazenado e só depois marca o modelo como purgado. Se um repositório biométrico estiver indisponível, a chamada devolve `503`, o modelo passa para `status: purge_failed` e já fica excluído da correspondência. Repita a mesma chamada para concluir a purga.

## Erros

| Estado | Quando | Corpo |
| - | - | - |
| `403` | O token de utilizador da consola ou a chave de API não estão autorizados | `{"detail": "You do not have permission to perform this action."}` |
| `404` | Modelo desconhecido ou modelo de outra aplicação | `{"detail": "Biometric template not found."}` |
| `503` | Um repositório biométrico esteve indisponível. O modelo está em `purge_failed` e excluído da correspondência; repita a chamada. | `{"detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable."}` |

## Outros pontos de purga

Os modelos são também purgados quando o utilizador associado é eliminado através de [Batch Delete Users](https://docs.didit.me/pt/management-api/users/delete.md), quando qualquer sessão desse utilizador é eliminada com `deletion_instruction: "privacy_erasure"`, e automaticamente quando `expires_at` é atingido. Consulte [Pontos de purga](https://docs.didit.me/pt/management-api/biometric-templates/overview.md#pontos-de-eliminação).


## OpenAPI

````yaml pt/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: Purgar um template biométrico conservado
      description: >-
        Uma aplicação que tenha ativado a funcionalidade mantém um template
        biométrico facial sem imagens, gerido separadamente e associado ao
        Utilizador quando uma sessão é eliminada (consulte `DELETE
        /v3/session/{sessionId}/delete/`). Os templates 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 eliminados permanentemente após a eliminação
        do Utilizador, eliminação por privacidade, expiração ou uma eliminação
        permanente 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`.


        Elimina permanentemente um template: é removido de todos os tipos de
        correspondência e o template armazenado é eliminado. Irreversível e
        registado no registo de auditoria com a entidade responsável.


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


        Os templates também são eliminados permanentemente através de `POST
        /v3/users/delete/` para o Utilizador proprietário, por qualquer
        eliminação das sessões desse Utilizador 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 modelo, tal como devolvido em `biometric_template_uuid` pelos
            endpoints de eliminação de sessão, `biometric_template_id` numa
            correspondência da Pesquisa facial, ou pelo endpoint de listagem.
          schema:
            type: string
            format: uuid
            example: 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
      responses:
        '200':
          description: Resultado da purga.
          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 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.
        '404':
          description: >-
            Modelo desconhecido, um modelo de outra aplicação ou (no `GET`) um
            modelo eliminado.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Biometric template not found.
        '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 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: >-
        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.