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

> POST /v3/biometric-templates/delete/ — удаляет сохранённые биометрические шаблоны лиц по списку id или по фильтру. Идемпотентно для каждого шаблона. Didit.

Выполняет пакетную очистку многих шаблонов за один вызов. Укажите либо явный список идентификаторов, либо `delete_all: true`, при необходимости сузив выборку теми же фильтрами, что и в [списке биометрических шаблонов](https://docs.didit.me/ru/management-api/biometric-templates/list.md).

## Тело запроса

| Поле | Тип | Описание |
| - | - | - |
| `template_uuids` | UUID\[] | Шаблоны для очистки. Обязательно, если только `delete_all` не равен `true`. Идентификаторы уже очищенных шаблонов возвращаются со статусом `already_purged`. |
| `delete_all` | boolean | Если `true`, очищаются все шаблоны, которые соответствуют фильтрам ниже (все шаблоны приложения, если фильтры не заданы). `template_uuids` игнорируется. |
| `vendor_data` | string | Только с `delete_all`: поиск подстроки без учёта регистра в поле `vendor_data` пользователя-владельца |
| `vendor_user_uuid` | UUID | Только с `delete_all`: точное совпадение с идентификатором пользователя-владельца |
| `status` | enum | Только с `delete_all`: `pending`, `active`, `expired`, `held_out_of_use`, `purge_pending`, `purge_failed` |
| `source_type` | enum | Только с `delete_all`: `session_delete`, `automatic_retention`, `backfill` |
| `retained_from`, `retained_to` | datetime | Только с `delete_all`: диапазон дат хранения |

> [!WARNING]
>
> `delete_all: true` без фильтров очищает все биометрические шаблоны в приложении, и это действие нельзя отменить. Сначала выполните [Подсчёт биометрических шаблонов](https://docs.didit.me/ru/management-api/biometric-templates/count.md) с теми же фильтрами, чтобы убедиться, что именно будет очищено.

## Примеры

> [tab] По идентификатору
>
> ```bash theme={null}
> curl -X POST https://verification.didit.me/v3/biometric-templates/delete/ \
>   -H "x-api-key: YOUR_API_KEY" \
>   -H "Content-Type: application/json" \
>   -d '{"template_uuids": ["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"]}'
> ```

> [tab] Все шаблоны одного пользователя
>
> ```bash theme={null}
> curl -X POST https://verification.didit.me/v3/biometric-templates/delete/ \
>   -H "x-api-key: YOUR_API_KEY" \
>   -H "Content-Type: application/json" \
>   -d '{"delete_all": true, "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f"}'
> ```

> [tab] Все шаблоны в приложении
>
> ```bash theme={null}
> curl -X POST https://verification.didit.me/v3/biometric-templates/delete/ \
>   -H "x-api-key: YOUR_API_KEY" \
>   -H "Content-Type: application/json" \
>   -d '{"delete_all": true}'
> ```

```json theme={null}
{
  "results": [
    { "uuid": "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "outcome": "purged" },
    { "uuid": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d", "outcome": "already_purged" }
  ]
}
```

Шаблоны очищаются по одному; каждый результат содержит `purged` или `already_purged`. Если биометрическое хранилище недоступно, вызов возвращает `503` на первом шаблоне, который не удалось очистить. Шаблоны, очищенные раньше в том же запросе, остаются очищенными, а проблемный шаблон переходит в `purge_failed` (уже исключён из сопоставления). Повторный запрос завершит очистку.

## Ошибки

| Статус | Когда | Тело |
| - | - | - |
| `400` | Не переданы ни `template_uuids`, ни `delete_all: true` | `{"template_uuids": ["This field is required unless delete_all is true."]}` |
| `400` | Недопустимое значение фильтра или `retained_to` раньше `retained_from` | Ошибки валидации по полям |
| `403` | Токен пользователя консоли или API-ключ не имеет доступа | `{"detail": "You do not have permission to perform this action."}` |
| `503` | Биометрическое хранилище было недоступно; повторите запрос | `{"detail": "The biometric-template operation could not finish because an external store is unavailable. The operation is retryable."}` |


## OpenAPI

````yaml ru/openapi-25.json POST /v3/biometric-templates/delete/
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/delete/:
    post:
      tags:
        - Biometric Templates
      summary: Массовое удаление сохранённых биометрических шаблонов
      description: >-
        Приложение, включившее эту функцию, сохраняет один отдельно управляемый
        биометрический шаблон лица без изображений, привязанный к Пользователю
        при удалении сессии (см. `DELETE /v3/session/{sessionId}/delete/`).
        Шаблоны представляют собой биометрические данные с ограниченным сроком
        действия `expires_at`; они никогда не содержат изображений, данных
        сессии или полей личности и безвозвратно удаляются при удалении
        Пользователя, стирании данных в целях конфиденциальности, истечении
        срока действия или явной очистке. Эти endpoint принимают только
        API-ключи приложения (`x-api-key`); пользовательские токены Business
        Console отклоняются с ошибкой `403`.


        Очищает множество шаблонов за один вызов, по явному списку
        идентификаторов или с флагом `delete_all: true`, при необходимости
        суженным теми же фильтрами, что и endpoint списка. Шаблоны очищаются по
        одному, и для каждого результата указывается `purged` или
        `already_purged`. Если хранилище биометрических данных недоступно, вызов
        возвращает `503` на первом сбойном шаблоне: шаблоны, очищенные ранее в
        запросе, остаются очищенными, сбойный переходит в `purge_failed` (уже
        исключён из сопоставления), а повторение запроса завершает операцию.


        **`delete_all: true` без фильтров очищает каждый биометрический шаблон в
        приложении, и это действие невозможно отменить.** Сначала вызовите
        endpoint подсчёта количества с теми же фильтрами.
      operationId: bulk_purge_biometric_templates
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                template_uuids:
                  type: array
                  items:
                    type: string
                    format: uuid
                  minItems: 1
                  description: >-
                    Шаблоны для безвозвратного удаления. Обязательно, если
                    `delete_all` не равен `true`. Уже удаленные идентификаторы
                    возвращаются как `already_purged`.
                delete_all:
                  type: boolean
                  default: false
                  description: >-
                    Когда `true`, безвозвратно удаляет все шаблоны,
                    соответствующие указанным ниже фильтрам (все шаблоны
                    приложения, если фильтр не задан). Параметр `template_uuids`
                    игнорируется. Действие необратимо.
                vendor_data:
                  type: string
                  description: >-
                    Только с `delete_all`: нечувствительное к регистру
                    сопоставление по подстроке в `vendor_data`
                    пользователя-владельца.
                vendor_user_uuid:
                  type: string
                  format: uuid
                  description: >-
                    Только с `delete_all`: точное совпадение по
                    пользователю-владельцу.
                status:
                  type: string
                  enum:
                    - pending
                    - active
                    - expired
                    - held_out_of_use
                    - purge_pending
                    - purge_failed
                  description: Только с `delete_all`.
                source_type:
                  type: string
                  enum:
                    - session_delete
                    - automatic_retention
                    - backfill
                  description: Только с `delete_all`.
                retained_from:
                  type: string
                  format: date-time
                  description: Только с `delete_all`.
                retained_to:
                  type: string
                  format: date-time
                  description: >-
                    Только с `delete_all`. Не должно быть раньше
                    `retained_from`.
            examples:
              By id:
                value:
                  template_uuids:
                    - 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
                    - 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d
              Every template of one User:
                value:
                  delete_all: true
                  vendor_user_uuid: 2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f
              Every template in the application:
                value:
                  delete_all: true
      responses:
        '200':
          description: Результаты очистки по шаблонам.
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        uuid:
                          type: string
                          format: uuid
                        outcome:
                          type: string
                          enum:
                            - purged
                            - already_purged
              examples:
                Mixed:
                  value:
                    results:
                      - uuid: 9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b
                        outcome: purged
                      - uuid: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d
                        outcome: already_purged
        '400':
          description: Ошибка валидации — ничего не очищено.
          content:
            application/json:
              examples:
                Missing selector:
                  value:
                    template_uuids:
                      - This field is required unless delete_all is true.
                Bad range:
                  value:
                    retained_to:
                      - Must be on or after retained_from.
        '403':
          description: >-
            Токен пользователя Console, либо данный API-ключ не разрешён. Эти
            endpoint принимают только API-ключи приложений.
          content:
            application/json:
              examples:
                Forbidden:
                  value:
                    detail: You do not have permission to perform this action.
        '503':
          description: >-
            Хранилище биометрии было недоступно при сохранении или удалении
            биометрического шаблона. Ничего не удалено; повторите тот же запрос.
            Повторные попытки идемпотентны и сходятся к одному шаблону.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              examples:
                Retryable:
                  value:
                    detail: >-
                      The biometric-template operation could not finish because
                      an external store is unavailable. The operation is
                      retryable.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            https://verification.didit.me/v3/biometric-templates/delete/ \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"delete_all": true, "vendor_user_uuid": "2f7c1a9e-8b4d-4c6a-9e1f-3d5b7a9c1e2f"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.biometric_templates.batch_delete(
                template_uuids=["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"],
            )
            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.batchDelete({
              template_uuids: ["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"],
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.BiometricTemplates.BatchDelete(ctx, didit.BiometricTemplatesBatchDeleteParams{\n\tTemplateUUIDs: didit.Some([]string{\"9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b\", \"1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d\"}),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: >-
            import java.util.List;

            import me.didit.Didit;

            import me.didit.types.BiometricTemplatesBatchDeleteParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result =
            client.biometricTemplates().batchDelete(BiometricTemplatesBatchDeleteParams.builder()
                    .templateUuids(List.of("9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"))
                    .build());
            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->batchDelete([
                'template_uuids' => ['9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b', '1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d'],
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result = didit.biometric_templates.batch_delete(template_uuids:
            ["9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b",
            "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d"])

            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.BatchDeleteAsync(new
            BiometricTemplatesBatchDeleteParams

            {
                TemplateUuids = new string[] { "9d2f4b6e-1c3a-4e8f-b7d5-0a1c2e3f4a5b", "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d" },
            });

            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.