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

# Biometrisches Template abrufen (Management API)

> GET /v3/biometric-templates/{template_uuid}/ – Didit liefert ein gespeichertes Template mit Benutzer, Herkunft, Ablaufdatum und Status.

Gibt eine Vorlage zurück. Verwenden Sie die `biometric_template_uuid` aus [Sitzung löschen](https://docs.didit.me/de/sessions-api/delete-session.md), die `biometric_template_id` eines [Gesichtssuche-Treffers](https://docs.didit.me/de/core-technology/face-search/report-face-search.md) oder eine ID aus der [Liste](https://docs.didit.me/de/management-api/biometric-templates/list.md).

```bash theme={null}
curl -X GET 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",
  "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f",
  "vendor_data": "user-42",
  "source_type": "session_delete",
  "provenance_reference": "6b1e8d2f-4a3c-4f9e-8c7d-1a2b3c4d5e6f",
  "retention_policy": "retain_until_user_deleted",
  "retention_override": null,
  "retained_at": "2026-08-28T10:15:42.318402Z",
  "expires_at": "2027-08-28T10:15:42.318402Z",
  "retained_by": "3c9e2b1f-7d4a-4e8b-9c1d-5f6a7b8c9d0e",
  "retained_by_type": "API_KEY",
  "instruction_class": "operational_session_delete",
  "instruction_source": "api",
  "instruction_id": "post-approval-cleanup-2026-08",
  "held_out_of_use": false,
  "status": "active",
  "purged_at": null
}
```

Die Antwort enthält niemals ein Bild, einen Vektor, die ID der gelöschten Sitzung oder Identitätsdaten. Alle Felder finden Sie in der [Übersicht](https://docs.didit.me/de/management-api/biometric-templates/overview.md#vorlagenobjekt).

## Fehler

| Status | Wann | Inhalt |
| - | - | - |
| `403` | Console-Benutzer-Token oder der API-Schlüssel ist nicht berechtigt | `{"detail": "You do not have permission to perform this action."}` |
| `404` | Unbekanntes biometrisches Template, ein Template einer anderen Anwendung oder ein endgültig gelöschtes Template | `{"detail": "Biometric template not found."}` |


## OpenAPI

````yaml de/openapi-25.json GET /v3/biometric-templates/{template_uuid}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API für Ausweisverifizierung. Authentifizierung über den x-api-key-Header.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/biometric-templates/{template_uuid}/:
    get:
      tags:
        - Biometric Templates
      summary: Gespeichertes biometrisches Template abrufen
      description: >-
        Eine Anwendung, die sich dafür entschieden hat, behält ein separat
        verwaltetes, bildfreies biometrisches Template für das Gesicht, das dem
        Benutzer zugeordnet ist, wenn eine Sitzung gelöscht wird (siehe `DELETE
        /v3/session/{sessionId}/delete/`). Templates sind biometrische Daten mit
        einem endlichen `expires_at`; sie enthalten niemals Bilder,
        Sitzungsdaten oder Identitätsfelder und werden bei Benutzerlöschung,
        Datenschutz-Löschung, Ablauf oder einer expliziten Bereinigung gelöscht.
        Diese Endpoints akzeptieren ausschließlich Anwendungs-API-Schlüssel
        (`x-api-key`); Business Console-Benutzertoken werden mit `403`
        abgelehnt.


        Gibt ein Template zurück. Die Antwort enthält niemals ein Bild, einen
        Vektor, die ID der gelöschten Sitzung oder Identitätsdaten.
      operationId: get_biometric_template
      parameters:
        - in: path
          name: template_uuid
          required: true
          description: >-
            Template-ID, wie in `biometric_template_uuid` von den Endpoints zum
            Löschen von Sitzungen, `biometric_template_id` bei einem Treffer der
            Gesichtssuche oder dem Listen-Endpoint zurückgegeben.
          schema:
            type: string
            format: uuid
            example: 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
      responses:
        '200':
          description: Die Vorlage.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid:
                    type: string
                    format: uuid
                    description: >-
                      Vorlagen-ID. Zufällig generiert; nicht aus der gelöschten
                      Sitzung oder deren Gesicht abgeleitet.
                  vendor_user_uuid:
                    type: string
                    format: uuid
                    description: Der besitzende Benutzer.
                  vendor_data:
                    type: string
                    nullable: true
                    description: >-
                      Die aktuellen `vendor_data` des Benutzers, aufgelöst, wenn
                      Sie die Vorlage lesen (werden nie kopiert).
                  source_type:
                    type: string
                    enum:
                      - session_delete
                      - automatic_retention
                      - backfill
                    description: >-
                      Wie die Vorlage erstellt wurde: eine Sitzungslöschung (API
                      oder Console), das automatische Datenaufbewahrungsfenster
                      der Anwendung oder eine von Didit durchgeführte
                      nachträgliche Datenauffüllung, die Sie beauftragt haben.
                  provenance_reference:
                    type: string
                    format: uuid
                    description: >-
                      Opake Referenz, die die Vorlage mit ihrem Audit-Log
                      verknüpft. Sie ist nicht die ID der gelöschten Sitzung und
                      kann nicht zu dieser aufgelöst werden.
                  retention_policy:
                    type: string
                    enum:
                      - delete_with_session
                      - retain_until_user_deleted
                    description: >-
                      Die Anwendungsrichtlinie zum Zeitpunkt der
                      Datenaufbewahrung.
                  retention_override:
                    type: boolean
                    nullable: true
                    description: >-
                      Der bei der Löschung gesendete Wert
                      `retain_face_embeddings` oder `null`, wenn die Richtlinie
                      angewendet wurde.
                  retained_at:
                    type: string
                    format: date-time
                  expires_at:
                    type: string
                    format: date-time
                    description: >-
                      Wann die Vorlage abläuft und automatisch bereinigt wird.
                      Immer gesetzt.
                  retained_by:
                    type: string
                    nullable: true
                    description: >-
                      Prinzipal, der die Anweisung erteilt hat: die
                      Anwendungs-ID für API-Schlüssel, die Mitglieds-ID der
                      Console für Console-Aktionen oder eine `service:`-Kennung
                      für die automatische Aufbewahrung. Niemals eine
                      E-Mail-Adresse.
                  retained_by_type:
                    type: string
                    enum:
                      - API_KEY
                      - CONSOLE_USER
                      - SYSTEM
                  instruction_class:
                    type: string
                    enum:
                      - operational_session_delete
                      - privacy_erasure
                  instruction_source:
                    type: string
                    enum:
                      - api
                      - console
                      - automatic_retention
                      - backfill
                      - privacy_erasure
                      - explicit_template_purge
                      - vendor_user_delete
                      - expiry
                      - reconciliation
                      - migration
                      - system
                  instruction_id:
                    type: string
                    description: >-
                      Die bei der Löschung gesendete `instruction_id` oder eine
                      von Didit generierte ID.
                  held_out_of_use:
                    type: boolean
                    description: >-
                      `true` nur, solange ein Legal Hold gilt. Ein gesperrtes
                      Template wird von jeglichem Abgleich ausgeschlossen.
                  status:
                    type: string
                    enum:
                      - pending
                      - active
                      - expired
                      - held_out_of_use
                      - purge_pending
                      - purge_failed
                      - purged
                    description: >-
                      Nur `active` Vorlagen, die nicht zurückgehalten werden,
                      deren `expires_at` nicht überschritten ist und deren
                      Benutzer noch existiert, nehmen am Abgleich teil.
                  purged_at:
                    type: string
                    format: date-time
                    nullable: true
              examples:
                Active template:
                  value:
                    uuid: 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
                    vendor_user_uuid: 2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f
                    vendor_data: user-42
                    source_type: session_delete
                    provenance_reference: 6b1e8d2f-4a3c-4f9e-8c7d-1a2b3c4d5e6f
                    retention_policy: retain_until_user_deleted
                    retention_override: null
                    retained_at: '2026-08-28T10:15:42.318402Z'
                    expires_at: '2027-08-28T10:15:42.318402Z'
                    retained_by: 3c9e2b1f-7d4a-4e8b-9c1d-5f6a7b8c9d0e
                    retained_by_type: API_KEY
                    instruction_class: operational_session_delete
                    instruction_source: api
                    instruction_id: post-approval-cleanup-2026-08
                    held_out_of_use: false
                    status: active
                    purged_at: null
        '403':
          description: >-
            Console-Benutzertoken, oder der API-Schlüssel ist nicht zulässig.
            Diese Endpoints akzeptieren ausschließlich Anwendungs-API-Schlüssel.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Unbekannte Vorlage, Vorlage einer anderen Anwendung oder (bei `GET`)
            eine gelöschte Vorlage.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: Biometric template not found.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            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.retrieve(
                "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.retrieve("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.Retrieve(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().retrieve("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->retrieve('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.retrieve("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.RetrieveAsync("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Der API-Schlüssel Ihrer Anwendung, aus Entwickler -> API-Schlüssel in
        der Business Console. Der Primärschlüssel hat Vollzugriff. Ein benannter
        Schlüssel kann im Geltungsbereich eingeschränkt werden: keine, Lese-
        oder Schreibberechtigung pro Ressource, beschränkt auf bestimmte
        Workflows oder genehmigte Sitzungen, auf eine Liste von IP-Adressen und
        auf ein Ablaufdatum. 401 bedeutet, dass der Schlüssel falsch, widerrufen
        oder abgelaufen ist; 403 bedeutet, dass kein Schlüssel gesendet wurde,
        der Schlüssel keinen Zugriff auf diese Ressource oder Aktion hat oder
        die Anfrage von einer Adresse außerhalb seiner IP-Liste stammte; 404 bei
        einer Sitzungsroute bedeutet, dass die Sitzung außerhalb der Workflows
        oder Status des Schlüssels liegt. Ein Schlüssel ohne Medienzugriff
        erhält Bild-, Video- und PDF-URLs als null, und ein Schlüssel ohne
        Schreibberechtigung für Sitzungen erhält Sitzungslinks und Token als
        null. Siehe https://docs.didit.me/console/api-keys.

````

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