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

> GET /v3/biometric-templates/{template_uuid}/ — получить шаблон лица Didit: пользователь, происхождение, срок действия, статус.

Возвращает один шаблон. Используйте `biometric_template_uuid`, возвращённый методом [Удаление сессии](https://docs.didit.me/ru/sessions-api/delete-session.md), `biometric_template_id` при совпадении в результате [Поиска по лицу](https://docs.didit.me/ru/core-technology/face-search/report-face-search.md), или идентификатор из [списка](https://docs.didit.me/ru/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
}
```

Ответ никогда не содержит изображения, вектора, идентификатора удалённой сессии или идентификационных данных. Все поля описаны в [обзоре](https://docs.didit.me/ru/management-api/biometric-templates/overview.md#объект-шаблона).

## Ошибки

| Статус | Когда | Тело |
| - | - | - |
| `403` | Токен пользователя консоли или у API-ключа нет необходимых разрешений | `{"detail": "You do not have permission to perform this action."}` |
| `404` | Неизвестный шаблон, шаблон другого приложения или безвозвратно удалённый шаблон | `{"detail": "Biometric template not found."}` |


## OpenAPI

````yaml ru/openapi-25.json GET /v3/biometric-templates/{template_uuid}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: >-
    API верификации личности. Аутентификация выполняется с помощью заголовка
    x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags: []
paths:
  /v3/biometric-templates/{template_uuid}/:
    get:
      tags:
        - Biometric Templates
      summary: Получить сохраненный биометрический шаблон
      description: >-
        Приложение, давшее согласие на участие, сохраняет один отдельно
        управляемый биометрический шаблон лица без изображений, привязанный к
        Пользователю, при удалении сессии (см. `DELETE
        /v3/session/{sessionId}/delete/`). Шаблоны представляют собой
        биометрические данные с ограниченным сроком `expires_at`; они никогда не
        содержат изображений, данных сессии или полей идентификации и очищаются
        при удалении Пользователя, удалении данных в целях конфиденциальности,
        истечении срока действия или явной очистке. Эти endpoint принимают
        только API-ключи приложений (`x-api-key`); токены пользователей Business
        Console отклоняются с кодом `403`.


        Возвращает один шаблон. Ответ никогда не содержит изображения, вектора,
        идентификатора удалённой сессии или идентификационных данных.
      operationId: get_biometric_template
      parameters:
        - in: path
          name: template_uuid
          required: true
          description: >-
            Идентификатор шаблона, возвращаемый в `biometric_template_uuid`
            endpoint'ами удаления сессии, `biometric_template_id` при совпадении
            в Поиске по лицу или endpoint'ом списка.
          schema:
            type: string
            format: uuid
            example: 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
      responses:
        '200':
          description: Шаблон.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid:
                    type: string
                    format: uuid
                    description: >-
                      Идентификатор шаблона. Генерируется случайным образом; не
                      выводится из удаленной сессии или ее лица.
                  vendor_user_uuid:
                    type: string
                    format: uuid
                    description: Пользователь-владелец.
                  vendor_data:
                    type: string
                    nullable: true
                    description: >-
                      Текущие `vendor_data` пользователя, вычисляемые при чтении
                      шаблона (никогда не копируются).
                  source_type:
                    type: string
                    enum:
                      - session_delete
                      - automatic_retention
                      - backfill
                    description: >-
                      Способ создания шаблона: удаление сессии (через API или
                      Console), окно автоматического хранения данных приложения
                      или инициированное вами фоновое заполнение силами Didit.
                  provenance_reference:
                    type: string
                    format: uuid
                    description: >-
                      Непрозрачная ссылка, связывающая шаблон с его журналом
                      аудита. Она не является идентификатором удалённой сессии и
                      не может быть сопоставлена с ним.
                  retention_policy:
                    type: string
                    enum:
                      - delete_with_session
                      - retain_until_user_deleted
                    description: >-
                      Политика приложения на момент применения правил хранения
                      данных.
                  retention_override:
                    type: boolean
                    nullable: true
                    description: >-
                      Значение `retain_face_embeddings`, отправленное при
                      удалении, или `null`, если была применена политика.
                  retained_at:
                    type: string
                    format: date-time
                  expires_at:
                    type: string
                    format: date-time
                    description: >-
                      Время истечения срока действия шаблона и его
                      автоматического удаления. Задаётся всегда.
                  retained_by:
                    type: string
                    nullable: true
                    description: >-
                      Субъект, отдавший распоряжение: ID приложения для
                      API-ключей, ID участника Console для действий в Console
                      или идентификатор `service:` для автоматического хранения
                      данных. Никогда не является адресом электронной почты.
                  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: >-
                      Параметр `instruction_id`, отправленный при удалении, или
                      сгенерированный Didit id.
                  held_out_of_use:
                    type: boolean
                    description: >-
                      `true` только во время действия юридического удержания.
                      Удержанный шаблон исключается из всех сопоставлений.
                  status:
                    type: string
                    enum:
                      - pending
                      - active
                      - expired
                      - held_out_of_use
                      - purge_pending
                      - purge_failed
                      - purged
                    description: >-
                      В сопоставлении участвуют только шаблоны со статусом
                      `active`, которые не приостановлены, чей срок `expires_at`
                      не истёк и чей пользователь всё ещё существует.
                  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: >-
            Токен пользователя Console, либо данный API-ключ не разрешён. Эти
            endpoint принимают только API-ключи приложений.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '404':
          description: >-
            Неизвестный шаблон, шаблон другого приложения или (при `GET`)
            удалённый шаблон.
          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: >-
        API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в
        Business Console. Основной ключ имеет полный доступ. Именованный ключ
        может иметь ограниченную область действия: без доступа, чтение или
        запись для каждого ресурса, ограничение определенными сценариями или
        одобренными сессиями, списком IP-адресов и сроком действия. 401
        означает, что ключ неверен, отозван или его срок действия истек; 403
        означает, что ключ не был передан, у ключа нет доступа к этому ресурсу
        или действию, либо запрос поступил с адреса вне его списка IP-адресов;
        404 на маршруте сессии означает, что сессия не входит в сценарии или
        статусы ключа. Ключ без доступа к медиа получает URL изображений, видео
        и PDF как null, а ключ без прав на запись сессий получает ссылки на
        сессии и токены как null. См. https://docs.didit.me/console/api-keys.

````

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