> ## 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 para listar templates biométricos

> Didit: lista paginada dos templates faciais sem imagem, filtrável por utilizador, estado, origem e data. GET /v3/biometric-templates/

Devolve uma lista paginada dos templates biométricos que a sua aplicação detém neste momento. Os templates eliminados não aparecem na lista.

## Parâmetros de consulta

| Parâmetro | Tipo | Descrição |
| - | - | - |
| `vendor_data` | string | Correspondência de substring, sem distinguir maiúsculas de minúsculas, com o `vendor_data` atual do Utilizador proprietário |
| `vendor_user_uuid` | UUID | Correspondência exata com o Utilizador proprietário |
| `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 retidos nesta data/hora ou posteriormente |
| `retained_to` | datetime | Templates retidos nesta data/hora ou anteriormente. Não pode ser anterior a `retained_from`. |
| `ordering` | enum | `retained_at`, `-retained_at` (predefinido), `expires_at`, `-expires_at` |
| `limit` | integer | Tamanho da página |
| `offset` | integer | Deslocamento da paginação |

## Exemplo

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

Consulte a [visão geral](https://docs.didit.me/pt/management-api/biometric-templates/overview.md#objeto-template) para ver todos os campos.

## Erros

| Estado | Quando |
| - | - |
| `400` | Valor de filtro inválido, ou `retained_to` anterior a `retained_from` |
| `403` | Token de utilizador da consola ou chave de API não autorizada |


## OpenAPI

````yaml pt/openapi-25.json GET /v3/biometric-templates/
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/:
    get:
      tags:
        - Biometric Templates
      summary: Listar templates biométricos retidos
      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`.


        Devolve uma lista paginada dos templates que a aplicação detém
        atualmente. Os templates purgados não são listados.
      operationId: list_biometric_templates
      parameters:
        - in: query
          name: vendor_data
          required: false
          description: >-
            Correspondência de subcadeia insensível a maiúsculas/minúsculas no
            `vendor_data` atual do utilizador titular.
          schema:
            type: string
        - in: query
          name: vendor_user_uuid
          required: false
          description: Correspondência exata no Utilizador proprietário.
          schema:
            type: string
            format: uuid
        - in: query
          name: status
          required: false
          description: Estado do ciclo de vida. Modelos eliminados nunca são listados.
          schema:
            type: string
            enum:
              - pending
              - active
              - expired
              - held_out_of_use
              - purge_pending
              - purge_failed
        - in: query
          name: source_type
          required: false
          description: Como o modelo foi criado.
          schema:
            type: string
            enum:
              - session_delete
              - automatic_retention
              - backfill
        - in: query
          name: retained_from
          required: false
          description: Modelos conservados nesta data/hora ou após a mesma.
          schema:
            type: string
            format: date-time
        - in: query
          name: retained_to
          required: false
          description: >-
            Modelos conservados nesta data/hora ou antes da mesma. Não pode ser
            anterior a `retained_from` (`400`).
          schema:
            type: string
            format: date-time
        - in: query
          name: ordering
          required: false
          description: Ordem de ordenação.
          schema:
            type: string
            enum:
              - retained_at
              - '-retained_at'
              - expires_at
              - '-expires_at'
            default: '-retained_at'
        - in: query
          name: limit
          required: false
          description: Tamanho da página.
          schema:
            type: integer
        - in: query
          name: offset
          required: false
          description: Offset de paginação.
          schema:
            type: integer
      responses:
        '200':
          description: Modelos paginados.
          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 do modelo. Gerado aleatoriamente; não derivado da
                            sessão eliminada nem do respetivo rosto.
                        vendor_user_uuid:
                          type: string
                          format: uuid
                          description: O utilizador titular.
                        vendor_data:
                          type: string
                          nullable: true
                          description: >-
                            Os `vendor_data` atuais do utilizador, resolvidos
                            quando lê o modelo (nunca copiados).
                        source_type:
                          type: string
                          enum:
                            - session_delete
                            - automatic_retention
                            - backfill
                          description: >-
                            Como o modelo foi criado: uma eliminação de sessão
                            (API ou Console), a janela automática de conservação
                            de dados da aplicação ou um preenchimento retroativo
                            operado pela Didit que tenha solicitado.
                        provenance_reference:
                          type: string
                          format: uuid
                          description: >-
                            Referência opaca que associa o modelo ao seu registo
                            de auditoria. Não é o id da sessão eliminada e não
                            pode ser resolvido para o mesmo.
                        retention_policy:
                          type: string
                          enum:
                            - delete_with_session
                            - retain_until_user_deleted
                          description: A política da aplicação no momento da conservação.
                        retention_override:
                          type: boolean
                          nullable: true
                          description: >-
                            O valor de `retain_face_embeddings` enviado na
                            eliminação, ou `null` quando a política foi
                            aplicada.
                        retained_at:
                          type: string
                          format: date-time
                        expires_at:
                          type: string
                          format: date-time
                          description: >-
                            Quando o modelo expira e é eliminado
                            automaticamente. Sempre definido.
                        retained_by:
                          type: string
                          nullable: true
                          description: >-
                            Identidade principal que deu a instrução: o id da
                            aplicação para chaves de API, o id do membro da
                            consola para ações na consola ou um identificador
                            `service:` para retenção automática. Nunca um
                            endereço de e-mail.
                        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: >-
                            O `instruction_id` enviado na eliminação, ou um id
                            gerado pela Didit.
                        held_out_of_use:
                          type: boolean
                          description: >-
                            `true` apenas enquanto for aplicável uma retenção
                            legal. Um modelo retido é excluído de todas as
                            correspondências.
                        status:
                          type: string
                          enum:
                            - pending
                            - active
                            - expired
                            - held_out_of_use
                            - purge_pending
                            - purge_failed
                            - purged
                          description: >-
                            Apenas os modelos `active` que não estejam retidos,
                            que não tenham ultrapassado `expires_at` e cujo
                            Utilizador ainda exista participam na
                            correspondência.
                        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: >-
            Valor de filtro inválido ou `retained_to` anterior a
            `retained_from`. Erros de validação organizados por campo.
          content:
            application/json:
              examples:
                Bad range:
                  value:
                    retained_to:
                      - Must be on or after retained_from.
        '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.
      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: >-
        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.