> ## 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 purge du gabarit biométrique

> DELETE /v3/biometric-templates/{template_uuid}/ : purgez un gabarit facial conservé chez Didit. Retiré de la correspondance, supprimé. Idempotent.

Purge un gabarit : il est retiré de tous les types de correspondance, et le gabarit stocké est supprimé. La purge est irréversible et est consignée dans le journal d'audit avec le principal agissant.

```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` | Signification |
| - | - |
| `purged` | Le gabarit a été purgé par cet appel. |
| `already_purged` | Le gabarit avait déjà été purgé. Répéter une purge est sans risque. |

## Comportement en cas de nouvelle tentative

Didit supprime d'abord le gabarit stocké, puis seulement ensuite marque le gabarit comme purgé. Si un magasin de données biométriques est indisponible, l'appel renvoie `503`, le gabarit passe à `status: purge_failed` et il est déjà exclu des comparaisons. Renouvelez le même appel pour achever la purge.

## Erreurs

| Statut | Quand | Corps |
| - | - | - |
| `403` | Token utilisateur de la console, ou clé API non autorisée | `{"detail": "You do not have permission to perform this action."}` |
| `404` | Gabarit inconnu, ou gabarit d'une autre application | `{"detail": "Biometric template not found."}` |
| `503` | Un magasin de données biométriques était indisponible. Le gabarit est en `purge_failed` et exclu des comparaisons ; renouvelez l'appel. | `{"detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable."}` |

## Autres points de purge

Les gabarits sont aussi purgés lorsque vous supprimez l'utilisateur propriétaire avec [Suppression en lot des utilisateurs](https://docs.didit.me/fr/management-api/users/delete.md), lorsque vous supprimez une session de cet utilisateur avec `deletion_instruction: "privacy_erasure"`, et automatiquement à `expires_at`. Voir [Points de purge](https://docs.didit.me/fr/management-api/biometric-templates/overview.md#points-de-purge).


## OpenAPI

````yaml fr/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 vérification d'identité. Authentifiez-vous avec l'en-tête x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/biometric-templates/{template_uuid}/:
    delete:
      tags:
        - Biometric Templates
      summary: Purger un gabarit biométrique conservé
      description: "Une application ayant activé cette option conserve un gabarit biométrique facial géré séparément et sans image, ancré à l'Utilisateur lorsqu'une session est supprimée (voir `DELETE /v3/session/{sessionId}/delete/`). Les gabarits sont des données biométriques avec une valeur `expires_at` finie\_; ils ne contiennent jamais d'images, de données de session ou de champs d'identité, et ils sont purgés lors de la suppression de l'Utilisateur, d'un effacement pour des raisons de confidentialité, de leur expiration ou d'une purge explicite. Ces endpoints acceptent uniquement les clés API d'application (`x-api-key`)\_; les tokens d'utilisateur de la Business Console sont rejetés avec `403`.\n\nPurge un gabarit\_: il est retiré de tout type de correspondance et le gabarit stocké est supprimé. Irréversible et consigné dans le journal d'audit avec l'identité de l'auteur de l'action.\n\n**Sémantique des réessais\_:** Didit supprime d'abord le gabarit stocké et marque seulement ensuite le gabarit comme purgé. Si un magasin biométrique est indisponible, l'appel renvoie `503`, le gabarit passe à `status: purge_failed` et est déjà exclu des correspondances\_; répétez le même appel pour terminer. Répéter la purge d'un gabarit déjà purgé renvoie `already_purged`.\n\nLes gabarits sont également purgés par `POST /v3/users/delete/` pour l'Utilisateur propriétaire, par toute suppression des sessions de cet Utilisateur avec `deletion_instruction: privacy_erasure`, et automatiquement à `expires_at`."
      operationId: purge_biometric_template
      parameters:
        - in: path
          name: template_uuid
          required: true
          description: >-
            Identifiant du modèle, tel que renvoyé dans
            `biometric_template_uuid` par les endpoints de suppression de
            session, `biometric_template_id` lors d'une correspondance de
            Recherche faciale, ou l'endpoint de liste.
          schema:
            type: string
            format: uuid
            example: 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
      responses:
        '200':
          description: Résultat de la purge.
          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 l'utilisateur de la Console, ou clé API non autorisée. Ces
            endpoints acceptent uniquement les clés API d'application.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Modèle inconnu, modèle appartenant à une autre application, ou (sur
            `GET`) modèle purgé.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Biometric template not found.
        '503':
          description: "Un service de stockage biométrique était indisponible lors de la conservation ou de la suppression définitive d'un gabarit biométrique. Rien n'est supprimé\_; réitérez la même requête. Les nouvelles tentatives sont idempotentes et convergent vers un seul gabarit."
          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: >-
        La clé API de votre application, issue de Développeurs -> Clés API dans
        la Business Console. La clé principale dispose d'un accès complet. Une
        clé nommée peut être restreinte : aucun, lecture ou écriture par
        ressource, limitée à certains workflows ou aux sessions approuvées, à
        une liste d'adresses IP et à une date d'expiration. 401 signifie que la
        clé est incorrecte, révoquée ou expirée ; 403 signifie qu'aucune clé n'a
        été envoyée, que la clé n'a pas accès à cette ressource ou action, ou
        que la requête provient d'une adresse hors de sa liste d'IP ; 404 sur
        une route de session signifie que la session est hors des workflows ou
        des statuts de la clé. Une clé sans accès aux médias reçoit les URL
        d'images, de vidéos et de PDF à null, et une clé sans accès en écriture
        aux sessions reçoit les liens et tokens de session à null. Voir
        https://docs.didit.me/console/api-keys.

````

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