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

# Biometrische Templates per API auflisten

> GET /v3/biometric-templates/ listet paginiert gespeicherte bildfreie Gesichts-Templates in Didit, filterbar nach Benutzer, Status, Quelle, Datum.

Gibt eine paginierte Liste der biometrischen Templates zurück, die Ihre Anwendung aktuell speichert. Gelöschte Templates werden nicht aufgelistet.

## Abfrageparameter

| Parameter | Typ | Beschreibung |
| - | - | - |
| `vendor_data` | string | Groß- und Kleinschreibung wird nicht beachtet. Sucht nach einem Teilstring im aktuellen `vendor_data` des zugehörigen Benutzers |
| `vendor_user_uuid` | UUID | Exakte Übereinstimmung mit dem zugehörigen Benutzer |
| `status` | enum | `pending`, `active`, `expired`, `held_out_of_use`, `purge_pending`, `purge_failed` |
| `source_type` | enum | `session_delete`, `automatic_retention`, `backfill` |
| `retained_from` | datetime | Templates, die zu diesem Zeitpunkt oder danach aufbewahrt wurden |
| `retained_to` | datetime | Templates, die zu diesem Zeitpunkt oder davor aufbewahrt wurden. Darf nicht früher liegen als `retained_from`. |
| `ordering` | enum | `retained_at`, `-retained_at` (Standard), `expires_at`, `-expires_at` |
| `limit` | integer | Seitengröße |
| `offset` | integer | Pagination-Offset |

## Beispiel

```bash theme={null}
curl -X GET "https://verification.didit.me/v3/biometric-templates/?vendor_data=user-42&status=active" \
  -H "x-api-key: YOUR_API_KEY"
```

```json theme={null}
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "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
    }
  ]
}
```

Alle Felder finden Sie in der [Übersicht](https://docs.didit.me/de/management-api/biometric-templates/overview.md#vorlagenobjekt).

## Fehler

| Status | Wann |
| - | - |
| `400` | Ungültiger Filterwert oder `retained_to` liegt früher als `retained_from` |
| `403` | Token eines Konsolenbenutzers oder der API-Schlüssel ist nicht berechtigt |


## OpenAPI

````yaml de/openapi-25.json GET /v3/biometric-templates/
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/:
    get:
      tags:
        - Biometric Templates
      summary: Aufbewahrte biometrische Templates auflisten
      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 eine paginierte Liste der Templates zurück, die die Anwendung
        derzeit hält. Bereinigte Templates werden nicht aufgeführt.
      operationId: list_biometric_templates
      parameters:
        - in: query
          name: vendor_data
          required: false
          description: >-
            Teilstring-Übereinstimmung ohne Berücksichtigung von
            Groß-/Kleinschreibung im aktuellen `vendor_data` des zugehörigen
            Benutzers.
          schema:
            type: string
        - in: query
          name: vendor_user_uuid
          required: false
          description: Exakte Übereinstimmung mit dem zugehörigen Benutzer.
          schema:
            type: string
            format: uuid
        - in: query
          name: status
          required: false
          description: Lebenszyklusstatus. Bereinigte Vorlagen werden niemals aufgeführt.
          schema:
            type: string
            enum:
              - pending
              - active
              - expired
              - held_out_of_use
              - purge_pending
              - purge_failed
        - in: query
          name: source_type
          required: false
          description: Wie die Vorlage erstellt wurde.
          schema:
            type: string
            enum:
              - session_delete
              - automatic_retention
              - backfill
        - in: query
          name: retained_from
          required: false
          description: Vorlagen, die zu oder nach diesem Zeitpunkt aufbewahrt wurden.
          schema:
            type: string
            format: date-time
        - in: query
          name: retained_to
          required: false
          description: >-
            Vorlagen, die zu oder vor diesem Zeitpunkt aufbewahrt wurden. Darf
            nicht vor `retained_from` liegen (`400`).
          schema:
            type: string
            format: date-time
        - in: query
          name: ordering
          required: false
          description: Sortierreihenfolge.
          schema:
            type: string
            enum:
              - retained_at
              - '-retained_at'
              - expires_at
              - '-expires_at'
            default: '-retained_at'
        - in: query
          name: limit
          required: false
          description: Seitengröße.
          schema:
            type: integer
        - in: query
          name: offset
          required: false
          description: Paginierungs-Offset.
          schema:
            type: integer
      responses:
        '200':
          description: Paginierte Vorlagen.
          content:
            application/json:
              schema:
                type: object
                properties:
                  count:
                    type: integer
                  next:
                    type: string
                    nullable: true
                  previous:
                    type: string
                    nullable: true
                  results:
                    type: array
                    items:
                      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:
                One active template:
                  value:
                    count: 1
                    next: null
                    previous: null
                    results:
                      - 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
        '400':
          description: >-
            Ungültiger Filterwert oder `retained_to` liegt vor `retained_from`.
            Nach Feldern aufgeschlüsselte Validierungsfehler.
          content:
            application/json:
              examples:
                Bad range:
                  value:
                    retained_to:
                      - Must be on or after retained_from.
        '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.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/biometric-templates/?vendor_data=user-42&status=active'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            for item in client.biometric_templates.list():
                print(item)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            for await (const item of didit.biometricTemplates.list()) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.BiometricTemplates.ListAutoPaging(ctx, didit.BiometricTemplatesListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            for (var item : client.biometricTemplates().list()) {
                System.out.println(item);
            }
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            foreach ($didit->biometricTemplates->list() as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            didit.biometric_templates.list.auto_paging_each do |item|
              puts item.to_h
            end
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            await foreach (var item in await
            client.BiometricTemplates.ListAsync())

            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
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.