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

# Obtenir plantilla biomètrica API

> GET /v3/biometric-templates/{template_uuid}/ — obtén una plantilla biomètrica facial conservada a Didit, amb usuari, procedència, caducitat i estat.

Retorna una plantilla.

Utilitza el `biometric_template_uuid` que retorna [Delete Session](https://docs.didit.me/ca/sessions-api/delete-session.md), el `biometric_template_id` d'una coincidència de [Cerca facial](https://docs.didit.me/ca/core-technology/face-search/report-face-search.md), o un id de la [llista](https://docs.didit.me/ca/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
}
```

La resposta mai no inclou cap imatge, cap vector, l'id de la sessió eliminada ni dades d'identitat. Consulta la [visió general](https://docs.didit.me/ca/management-api/biometric-templates/overview.md#objecte-de-plantilla) per a tots els camps.

## Errors

| Estat | Quan | Cos |
| - | - | - |
| `403` | El token d'usuari de la consola, o la clau d'API, no està permès | `{"detail": "You do not have permission to perform this action."}` |
| `404` | Plantilla desconeguda, una plantilla d'una altra aplicació, o una plantilla purgada | `{"detail": "Biometric template not found."}` |


## OpenAPI

````yaml ca/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 verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/biometric-templates/{template_uuid}/:
    get:
      tags:
        - Biometric Templates
      summary: Obtenir una plantilla biomètrica conservada
      description: >-
        Una aplicació que hi ha optat manté una plantilla biomètrica facial
        gestionada per separat i sense imatges ancorada a l'usuari quan se
        suprimeix una sessió (consulta `DELETE
        /v3/session/{sessionId}/delete/`). Les plantilles són dades biomètriques
        amb un `expires_at` finit; mai contenen imatges, dades de sessió ni
        camps d'identitat, i es purguen en suprimir l'usuari, per supressió per
        privadesa, per caducitat o mitjançant una purga explícita. Aquests
        endpoints només accepten claus d'API d'aplicació (`x-api-key`); els
        tokens d'usuari de la Business Console es rebutgen amb `403`.


        Retorna una plantilla. La resposta mai inclou cap imatge, cap vector,
        l'id de la sessió suprimida ni dades d'identitat.
      operationId: get_biometric_template
      parameters:
        - in: path
          name: template_uuid
          required: true
          description: >-
            ID de la plantilla, tal com es retorna a `biometric_template_uuid`
            pels endpoints de supressió de sessions, `biometric_template_id` en
            una coincidència de cerca facial o l'endpoint de llistat.
          schema:
            type: string
            format: uuid
            example: 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
      responses:
        '200':
          description: La plantilla.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid:
                    type: string
                    format: uuid
                    description: >-
                      ID de la plantilla. Generat aleatòriament; no es deriva de
                      la sessió suprimida ni de la seva cara.
                  vendor_user_uuid:
                    type: string
                    format: uuid
                    description: L'usuari propietari.
                  vendor_data:
                    type: string
                    nullable: true
                    description: >-
                      El `vendor_data` actual de l'usuari, resolt en llegir la
                      plantilla (mai es copia).
                  source_type:
                    type: string
                    enum:
                      - session_delete
                      - automatic_retention
                      - backfill
                    description: >-
                      Com es va crear la plantilla: una supressió de sessió (API
                      o Console), la finestra automàtica de conservació de dades
                      de l'aplicació o un emplenament retroactiu operat per
                      Didit segons les teves instruccions.
                  provenance_reference:
                    type: string
                    format: uuid
                    description: >-
                      Referència opaca que vincula la plantilla al seu registre
                      d'auditoria. No és l'id de la sessió suprimida i no es pot
                      utilitzar per resoldre'l.
                  retention_policy:
                    type: string
                    enum:
                      - delete_with_session
                      - retain_until_user_deleted
                    description: La política de l'aplicació en el moment de la conservació.
                  retention_override:
                    type: boolean
                    nullable: true
                    description: >-
                      El valor `retain_face_embeddings` enviat en la supressió,
                      o `null` si s'ha aplicat la política.
                  retained_at:
                    type: string
                    format: date-time
                  expires_at:
                    type: string
                    format: date-time
                    description: >-
                      Quan la plantilla caduca i es purga automàticament. Sempre
                      definit.
                  retained_by:
                    type: string
                    nullable: true
                    description: >-
                      Identitat principal que ha donat la instrucció: l'id de
                      l'aplicació per a claus d'API, l'id de membre de la
                      Console per a accions de la Console o un identificador
                      `service:` per a la conservació automàtica. Mai una adreça
                      de correu electrònic.
                  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` enviat en la supressió, o un id generat
                      per Didit.
                  held_out_of_use:
                    type: boolean
                    description: >-
                      `true` només mentre s'aplica una retenció legal. Una
                      plantilla retinguda s'exclou de totes les coincidències.
                  status:
                    type: string
                    enum:
                      - pending
                      - active
                      - expired
                      - held_out_of_use
                      - purge_pending
                      - purge_failed
                      - purged
                    description: >-
                      Només les plantilles `active` que no estiguin retingudes,
                      no hagin superat `expires_at` i l'usuari de les quals
                      encara existeixi participen en la coincidè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 d'usuari de la consola, o la clau d'API no està permesa.
            Aquests endpoints només accepten claus d'API d'aplicació.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Plantilla desconeguda, una plantilla d'una altra aplicació o (en
            `GET`) una plantilla eliminada.
          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: >-
        La clau d'API de la teva aplicació, des de Developers -> API keys a la
        Business Console. La clau primària té accés complet. Una clau amb nom
        pot tenir l'abast limitat: cap, lectura o escriptura per recurs,
        limitada a determinats fluxos de treball o a sessions aprovades, a una
        llista d'adreces IP i a una data de caducitat. 401 significa que la clau
        és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap
        clau, que la clau no té accés a aquest recurs o acció, o que la
        sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una
        ruta de sessió significa que la sessió està fora dels fluxos de treball
        o estats de la clau. Una clau sense accés a fitxers multimèdia rep els
        URL d'imatge, vídeo i PDF com a null, i una clau sense permís
        d'escriptura de sessions rep els enllaços de sessió i els tokens com a
        null. Consulta https://docs.didit.me/console/api-keys.

````

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