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

# Elenco modelli biometrici API

> Didit: elenco paginato dei modelli biometrici facciali senza immagini, filtrabile per utente, stato, origine e data (GET /v3/biometric-templates/).

Restituisce un elenco paginato dei modelli biometrici che la tua applicazione conserva al momento. I modelli eliminati definitivamente non vengono elencati.

## Parametri di query

| Parametro | Tipo | Descrizione |
| - | - | - |
| `vendor_data` | string | Corrispondenza parziale, senza distinzione tra maiuscole e minuscole, sul `vendor_data` attuale dell'utente proprietario |
| `vendor_user_uuid` | UUID | Corrispondenza esatta sull'utente proprietario |
| `status` | enum | `pending`, `active`, `expired`, `held_out_of_use`, `purge_pending`, `purge_failed` |
| `source_type` | enum | `session_delete`, `automatic_retention`, `backfill` |
| `retained_from` | datetime | Modelli conservati a partire da questo momento o successivamente |
| `retained_to` | datetime | Modelli conservati a questo momento o prima. Non deve essere anteriore a `retained_from`. |
| `ordering` | enum | `retained_at`, `-retained_at` (predefinito), `expires_at`, `-expires_at` |
| `limit` | integer | Dimensione della pagina |
| `offset` | integer | Offset di paginazione |

## Esempio

```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
    }
  ]
}
```

Consulta la [panoramica](https://docs.didit.me/it/management-api/biometric-templates/overview.md#oggetto-modello) per ogni campo.

## Errori

| Stato | Quando |
| - | - |
| `400` | Valore di filtro non valido, oppure `retained_to` anteriore a `retained_from` |
| `403` | Token dell'utente della console, oppure la chiave API non è autorizzata |


## OpenAPI

````yaml it/openapi-25.json GET /v3/biometric-templates/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API di verifica dell'identità. Autenticati con l'intestazione x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/biometric-templates/:
    get:
      tags:
        - Biometric Templates
      summary: Elenca i modelli biometrici conservati
      description: >-
        Un'applicazione che ha aderito mantiene un modello biometrico facciale
        gestito separatamente e privo di immagini, ancorato all'utente quando
        una sessione viene eliminata (vedere `DELETE
        /v3/session/{sessionId}/delete/`). I modelli sono dati biometrici con un
        `expires_at` finito; non contengono mai immagini, dati di sessione o
        campi di identità e vengono eliminati definitivamente all'eliminazione
        dell'utente, alla cancellazione per motivi di privacy, alla scadenza o
        tramite un'eliminazione definitiva esplicita. Questi endpoint accettano
        solo chiavi API dell'applicazione (`x-api-key`); i token utente della
        Business Console vengono rifiutati con `403`.


        Restituisce un elenco impaginato dei modelli attualmente conservati
        dall'applicazione. I modelli eliminati definitivamente non sono
        elencati.
      operationId: list_biometric_templates
      parameters:
        - in: query
          name: vendor_data
          required: false
          description: >-
            Corrispondenza di sottostringhe senza distinzione tra maiuscole e
            minuscole sul `vendor_data` corrente dell'Utente proprietario.
          schema:
            type: string
        - in: query
          name: vendor_user_uuid
          required: false
          description: Corrispondenza esatta sull'utente proprietario.
          schema:
            type: string
            format: uuid
        - in: query
          name: status
          required: false
          description: >-
            Stato del ciclo di vita. I modelli eliminati definitivamente non
            vengono mai elencati.
          schema:
            type: string
            enum:
              - pending
              - active
              - expired
              - held_out_of_use
              - purge_pending
              - purge_failed
        - in: query
          name: source_type
          required: false
          description: Come è stato creato il modello.
          schema:
            type: string
            enum:
              - session_delete
              - automatic_retention
              - backfill
        - in: query
          name: retained_from
          required: false
          description: Modelli conservati a partire da questa data e ora o successivamente.
          schema:
            type: string
            format: date-time
        - in: query
          name: retained_to
          required: false
          description: >-
            Modelli conservati entro questa data e ora o precedentemente. Non
            deve essere anteriore a `retained_from` (`400`).
          schema:
            type: string
            format: date-time
        - in: query
          name: ordering
          required: false
          description: Ordinamento.
          schema:
            type: string
            enum:
              - retained_at
              - '-retained_at'
              - expires_at
              - '-expires_at'
            default: '-retained_at'
        - in: query
          name: limit
          required: false
          description: Dimensione della pagina.
          schema:
            type: integer
        - in: query
          name: offset
          required: false
          description: Offset di paginazione.
          schema:
            type: integer
      responses:
        '200':
          description: Modelli impaginati.
          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: >-
                            ID del modello. Generato casualmente; non derivato
                            dalla sessione eliminata o dal relativo volto.
                        vendor_user_uuid:
                          type: string
                          format: uuid
                          description: L'Utente proprietario.
                        vendor_data:
                          type: string
                          nullable: true
                          description: >-
                            Il `vendor_data` corrente dell'Utente, risolto al
                            momento della lettura del modello (mai copiato).
                        source_type:
                          type: string
                          enum:
                            - session_delete
                            - automatic_retention
                            - backfill
                          description: >-
                            Come è stato creato il modello: l'eliminazione di
                            una sessione (API o Console), la finestra di
                            conservazione dei dati automatica dell'applicazione
                            o un backfill gestito da Didit su tua istruzione.
                        provenance_reference:
                          type: string
                          format: uuid
                          description: >-
                            Riferimento opaco che collega il modello al suo
                            registro di audit. Non è l'ID della sessione
                            eliminata e non può essere ricondotto ad esso.
                        retention_policy:
                          type: string
                          enum:
                            - delete_with_session
                            - retain_until_user_deleted
                          description: >-
                            La policy dell'applicazione al momento della
                            conservazione dei dati.
                        retention_override:
                          type: boolean
                          nullable: true
                          description: >-
                            Il valore `retain_face_embeddings` inviato
                            all'eliminazione, oppure `null` quando è stata
                            applicata la policy.
                        retained_at:
                          type: string
                          format: date-time
                        expires_at:
                          type: string
                          format: date-time
                          description: >-
                            Quando il modello scade e viene eliminato
                            automaticamente. Sempre impostato.
                        retained_by:
                          type: string
                          nullable: true
                          description: >-
                            Soggetto che ha impartito l'istruzione: l'ID
                            applicazione per le chiavi API, l'ID membro della
                            Console per le azioni della Console, oppure un
                            identificatore `service:` per la conservazione
                            automatica. Mai un indirizzo email.
                        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: >-
                            L'`instruction_id` inviato all'eliminazione, oppure
                            un id generato da Didit.
                        held_out_of_use:
                          type: boolean
                          description: >-
                            `true` solo quando si applica un vincolo di
                            conservazione legale. Un modello soggetto a tale
                            vincolo è escluso da qualsiasi corrispondenza.
                        status:
                          type: string
                          enum:
                            - pending
                            - active
                            - expired
                            - held_out_of_use
                            - purge_pending
                            - purge_failed
                            - purged
                          description: >-
                            Partecipano al confronto solo i modelli `active` che
                            non sono sospesi, non hanno superato `expires_at` e
                            il cui utente esiste ancora.
                        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: >-
            Valore del filtro non valido o `retained_to` antecedente a
            `retained_from`. Errori di validazione indicizzati per campo.
          content:
            application/json:
              examples:
                Bad range:
                  value:
                    retained_to:
                      - Must be on or after retained_from.
        '403':
          description: >-
            Token utente della Console, oppure la chiave API non è consentita.
            Questi endpoint accettano solo chiavi API dell'applicazione.
          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: >-
        La chiave API della tua applicazione, da Developers -> API keys nella
        Business Console. La chiave primaria ha accesso completo. Una chiave con
        nome può avere un ambito definito: nessuno, lettura o scrittura per
        risorsa, limitata ad alcuni workflow o a sessioni approvate, a un elenco
        di indirizzi IP e a una data di scadenza. 401 indica che la chiave è
        errata, revocata o scaduta; 403 indica che non è stata inviata alcuna
        chiave, che la chiave non ha accesso a questa risorsa o azione, oppure
        che la richiesta proviene da un indirizzo non incluso nel suo elenco IP;
        404 su una route di sessione indica che la sessione non rientra nei
        workflow o negli stati previsti dalla chiave. Una chiave senza accesso
        ai media riceve gli URL di immagini, video e PDF come null, e una chiave
        senza permessi di scrittura sulle sessioni riceve link e token di
        sessione come null. Consulta https://docs.didit.me/console/api-keys.

````

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