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

# Obter template biométrico via API

> GET /v3/biometric-templates/{template_uuid}/ na Didit: obtém um template biométrico facial retido com seu usuário, origem, validade e status.

Retorna um template. Use o `biometric_template_uuid` retornado por [Delete Session](https://docs.didit.me/pt-br/sessions-api/delete-session.md), o `biometric_template_id` em uma [correspondência da Busca facial](https://docs.didit.me/pt-br/core-technology/face-search/report-face-search.md) ou um id da [lista](https://docs.didit.me/pt-br/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
}
```

A resposta nunca inclui uma imagem, um vetor, o id da sessão excluída nem dados de identidade. Consulte a [visão geral](https://docs.didit.me/pt-br/management-api/biometric-templates/overview.md#objeto-template) para ver todos os campos.

## Erros

| Status | Quando | Corpo |
| - | - | - |
| `403` | Token de usuário do console, ou a chave de API não tem permissão para realizar esta ação | `{"detail": "You do not have permission to perform this action."}` |
| `404` | Template desconhecido, template de outra aplicação ou template expurgado | `{"detail": "Biometric template not found."}` |


## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/biometric-templates/{template_uuid}/
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/{template_uuid}/:
    get:
      tags:
        - Biometric Templates
      summary: Obter um template biométrico retido
      description: >-
        Uma aplicação que ativou esse recurso mantém um template biométrico
        facial, sem imagens e gerenciado separadamente, vinculado ao usuário
        quando uma sessão é excluída (veja `DELETE
        /v3/session/{sessionId}/delete/`). Os templates são dados biométricos
        com um `expires_at` finito; eles nunca contêm imagens, dados de sessão
        nem campos de identidade, e são expurgados na exclusão do usuário, no
        apagamento por privacidade, na expiração ou em um expurgo explícito.
        Estes endpoints aceitam apenas chaves de API da aplicação (`x-api-key`);
        tokens de usuário do Business Console são rejeitados com `403`.


        Retorna um template. A resposta nunca inclui uma imagem, um vetor, o id
        da sessão excluída nem dados de identidade.
      operationId: get_biometric_template
      parameters:
        - in: path
          name: template_uuid
          required: true
          description: >-
            ID do template, conforme retornado em `biometric_template_uuid`
            pelos endpoints de exclusão de sessão, em `biometric_template_id` em
            uma correspondência da Busca facial ou pelo endpoint de listagem.
          schema:
            type: string
            format: uuid
            example: 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
      responses:
        '200':
          description: O modelo.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid:
                    type: string
                    format: uuid
                    description: >-
                      ID do template. Gerado aleatoriamente; não é derivado da
                      sessão excluída nem do rosto dela.
                  vendor_user_uuid:
                    type: string
                    format: uuid
                    description: O usuário proprietário.
                  vendor_data:
                    type: string
                    nullable: true
                    description: >-
                      O `vendor_data` atual do usuário, resolvido quando você lê
                      o modelo (nunca copiado).
                  source_type:
                    type: string
                    enum:
                      - session_delete
                      - automatic_retention
                      - backfill
                    description: >-
                      Como o modelo foi criado: uma exclusão de sessão (API ou
                      Console), a janela automática de retenção de dados da
                      aplicação ou um preenchimento retroativo (backfill)
                      operado pela Didit sob sua instrução.
                  provenance_reference:
                    type: string
                    format: uuid
                    description: >-
                      Referência opaca que vincula o modelo à sua trilha de
                      auditoria. Não é o id da sessão excluída e não pode ser
                      resolvida para ele.
                  retention_policy:
                    type: string
                    enum:
                      - delete_with_session
                      - retain_until_user_deleted
                    description: A política da aplicação no momento da retenção.
                  retention_override:
                    type: boolean
                    nullable: true
                    description: >-
                      O valor de `retain_face_embeddings` enviado na exclusã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 template expira e é eliminado automaticamente.
                      Sempre definido.
                  retained_by:
                    type: string
                    nullable: true
                    description: >-
                      Principal que deu a instrução: o id da aplicação para
                      chaves de API, o id do membro do Console para ações no
                      Console, 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 exclusão, ou um id gerado
                      pela Didit.
                  held_out_of_use:
                    type: boolean
                    description: >-
                      `true` apenas enquanto houver uma retenção legal. Um
                      template retido é excluído de toda correspondência.
                  status:
                    type: string
                    enum:
                      - pending
                      - active
                      - expired
                      - held_out_of_use
                      - purge_pending
                      - purge_failed
                      - purged
                    description: >-
                      Somente modelos `active` que não estão retidos, que não
                      ultrapassaram `expires_at` e cujo User ainda existe
                      participam da correspondência.
                  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: >-
            Token de usuário do console, 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.
        '404':
          description: >-
            Modelo desconhecido, um modelo de outra aplicação ou (no `GET`) um
            modelo removido definitivamente.
          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: >-
        Chave de API da sua aplicação, em Developers -> API keys no Business
        Console. A chave principal tem acesso total. Uma chave nomeada pode ter
        escopo restrito: nenhum acesso, 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á errada, 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 a requisição veio de um
        endereço fora da sua lista de IPs; 404 em uma rota de sessão significa
        que a sessão está fora dos fluxos ou status da chave. Uma chave sem
        acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave
        sem permissão de escrita em sessões recebe links e tokens de sessão como
        null. Consulte https://docs.didit.me/console/api-keys.

````

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