> ## 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 Didit > POST /v3/blocklist/add/: добавляет лицо, документ, телефон или email сессии Didit в список блокировки, и совпадающие новые сессии будут отклонены. Промпт API для добавления в список блокировки Скопировать промпт в буфер обмена \

\`Blocklist the face, document, phone number or email address of one of my Didit verification sessions through the Management API.

Endpoint:
POST https://verification.didit.me/v3/blocklist/add/

Authentication:
Use the x-api-key header with my Didit API key. A scoped API key needs workflows: write.

Goal:
\- After reviewing a fraudulent session, block what it collected so the same person is declined next time.

Request body (application/json):
\{
"session_id": "33333333-4444-5555-6666-777777777777", // required: a verification session of my application
"blocklist_face": true,       // optional, default false
"blocklist_document": true,   // optional, default false
"blocklist_phone": false,     // optional, default false
"blocklist_email": false      // optional, default false
}
At least one blocklist_* flag must be true.

Behavior:
\- Didit uses the session's most recent record of each selected type.
\- Each selected record is flagged as blocklisted and gets an entry, linked to the session, in the matching system blocklist (added_by "api").
\- From then on, new sessions with a matching face, document number, phone number or email address are declined.
\- The session itself and sessions that already finished are not changed.
\- Safe to repeat: an item already listed keeps its single entry, and its blocklisted_at is refreshed.
\- All or nothing: Didit checks every selected item first. If one is missing, nothing is blocklisted.
\- A document needs its issuing state, document type, document number and full name.

Example call:
curl -X POST "https://verification.didit.me/v3/blocklist/add/" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"session_id": "33333333-4444-5555-6666-777777777777", "blocklist_face": true, "blocklist_document": true}'

Example response (200):
\{ "message": "Successfully updated blocklist." }

Failure modes:
\- 400: session_id is missing ({ "session_id": ["This field is required."] }) or not a UUID ({ "session_id": ["Must be a valid UUID."] }); the session is not a verification session of this application ({ "non_field_errors": ["Session not found"] }; business verification sessions are not accepted); no flag is true ({ "non_field_errors": ["Must specify at least one item to blocklist"] }); the session has no record of a selected type ({ "non_field_errors": ["Session does not have a face record"] }); or the document lacks a required field.
\- 401: the API key has expired.
\- 403: missing x-api-key (a wrong, revoked or expired key gets 401) ({ "detail": "You do not have permission to perform this action." }), or a scoped key without workflows: write.
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects:
\- Writes entries to the system face, document, phone and email blocklists and blocks matching new sessions.

To block a value without a session, or an IP address, device fingerprint, user or business, use POST /v3/lists/{list_uuid}/entries/ on the matching system blocklist instead.

For the full integration shape, see /integration/integration-prompt.`

\
Вставьте в Добавляет в список блокировки то, что собрала одна сессия верификации: лицо, документ, удостоверяющий личность, номер телефона или адрес электронной почты. Didit помечает каждую выбранную запись как заблокированную и добавляет её в соответствующий системный список блокировки, связанный с сессией. Новые сессии с совпадающим лицом, номером документа, номером телефона или адресом электронной почты отклоняются с этого момента.> [!NOTE] > > Вызов выполняется целиком или не выполняется вовсе: если в сессии нет записи выбранного типа или в документе отсутствует штат выдачи, тип документа, номер документа или полное имя, возвращается `400`, и ничего не добавляется в список блокировки. Повторный вызов для элемента, который уже находится в списке блокировки, безопасен.Чтобы проверить, что заблокировано, используйте [Список заблокированных элементов](https://docs.didit.me/ru/management-api/blocklist/list.md). Чтобы снять блокировку, используйте [Удалить из списка блокировки](https://docs.didit.me/ru/management-api/blocklist/remove.md). Чтобы заблокировать адрес, отпечаток устройства, пользователя, компанию или значение без сессии, добавьте запись в соответствующий системный список блокировки с помощью [Создать запись](https://docs.didit.me/ru/management-api/lists/create-entry.md). О том, как применяются списки блокировки, см. [Список блокировки пользователей](https://docs.didit.me/ru/entities/users/blocklist.md). ## OpenAPI ````yaml ru/openapi-25.json POST /v3/blocklist/add/ 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/blocklist/add/: post: tags: - Blocklist summary: Добавить элементы сессии в список блокировки description: >- Добавляет лицо, документ, удостоверяющий личность, номер телефона или адрес электронной почты из сессии проверки пользователя приложения в список блокировки. Для каждого выбранного типа Didit берёт самую последнюю запись сессии, помечает её как занесённую в список блокировки и добавляет связанную с сессией запись в соответствующий системный список блокировки (`added_by: "api"`), поэтому новые сессии с совпадающим лицом, номером документа, номером телефона или адресом электронной почты отклоняются. Каждый выбранный элемент сначала проверяется, поэтому, если хотя бы один из них отсутствует, ничего не добавляется в список блокировки; повторный вызов для уже внесённого элемента сохраняет единственную запись и обновляет `blocklisted_at`. Сама сессия и уже завершённые сессии не изменяются. Для ограниченного API-ключа требуется `workflows: write`. operationId: add_to_blocklist requestBody: required: true content: application/json: schema: type: object required: - session_id description: Хотя бы один флаг `blocklist_*` должен иметь значение `true`. properties: session_id: type: string format: uuid description: >- Сессия верификации личности вашего приложения. Удалённые сессии отклоняются. blocklist_face: type: boolean default: false description: Добавить лицо сессии в список блокировки. blocklist_document: type: boolean default: false description: >- Добавить документ сессии, удостоверяющий личность, в список блокировки. Для документа требуются государство выдачи, тип документа, номер документа и полное имя. blocklist_phone: type: boolean default: false description: Добавить номер телефона сессии в список блокировки. blocklist_email: type: boolean default: false description: Добавить адрес электронной почты сессии в список блокировки. examples: Face and document: value: session_id: 33333333-4444-5555-6666-777777777777 blocklist_face: true blocklist_document: true Phone only: value: session_id: 33333333-4444-5555-6666-777777777777 blocklist_phone: true responses: '200': description: Выбранные элементы были добавлены в список блокировки. content: application/json: schema: type: object required: - message properties: message: type: string description: Всегда `Successfully updated blocklist.` examples: Blocklisted: value: message: Successfully updated blocklist. '400': description: >- Некорректное тело запроса, сессия не является сессией верификации этого приложения или не содержит записей выбранного типа. Ничего не было добавлено в список блокировки. content: application/json: examples: Unknown session: value: non_field_errors: - Session not found No item selected: value: non_field_errors: - Must specify at least one item to blocklist No face record: value: non_field_errors: - Session does not have a face record Incomplete document: value: non_field_errors: - >- To blocklist a document, the document must have an issuing state, document type, document number and full name Invalid session id: value: session_id: - Must be a valid UUID. Missing session id: value: session_id: - This field is required. '401': description: >- Срок действия API-ключа с ограниченной областью действия истёк. Другие ошибки аутентификации возвращают `403`. content: application/json: examples: Expired API key: value: detail: This API key has expired. '403': description: >- Заголовок `x-api-key` отсутствует (при неверном, отозванном или истёкшем ключе возвращается `401`), либо API-ключ с ограниченной областью действия не имеет разрешения `workflows: write` или используется с IP-адреса вне своего списка разрешённых. content: application/json: examples: Missing or invalid API key: value: detail: You do not have permission to perform this action. Scoped key without workflows access: value: detail: This API key has no write access to workflows. '429': $ref: '#/components/responses/RateLimitedWrite' security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: |- curl -X POST 'https://verification.didit.me/v3/blocklist/add/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{ "session_id": "33333333-4444-5555-6666-777777777777", "blocklist_face": true, "blocklist_document": true }' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.blocklist.add( session_id="33333333-4444-5555-6666-777777777777", blocklist_face=True, blocklist_document=True, ) 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.blocklist.add({ session_id: "33333333-4444-5555-6666-777777777777", blocklist_face: true, blocklist_document: true, }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Blocklist.Add(ctx, didit.BlocklistAddParams{\n\tSessionID: \"33333333-4444-5555-6666-777777777777\",\n\tBlocklistFace: didit.Bool(true),\n\tBlocklistDocument: didit.Bool(true),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: |- import me.didit.Didit; import me.didit.types.BlocklistAddParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.blocklist().add(BlocklistAddParams.builder() .sessionId("33333333-4444-5555-6666-777777777777") .blocklistFace(true) .blocklistDocument(true) .build()); System.out.println(result); - lang: php label: PHP source: |- blocklist->add([ 'session_id' => '33333333-4444-5555-6666-777777777777', 'blocklist_face' => true, 'blocklist_document' => true, ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.blocklist.add( session_id: "33333333-4444-5555-6666-777777777777", blocklist_face: true, blocklist_document: true ) 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.Blocklist.AddAsync(new BlocklistAddParams { SessionId = "33333333-4444-5555-6666-777777777777", BlocklistFace = true, BlocklistDocument = true, }); Console.WriteLine(JsonSerializer.Serialize(result)); components: responses: RateLimitedWrite: description: >- Превышен общий лимит на запись в 300 запросов в минуту на один API-ключ. Подождите время, указанное в `Retry-After`, перед повторной попыткой. content: application/json: schema: type: object required: - detail properties: detail: type: string example: detail: >- Write request rate limit exceeded. You can make up to 300 requests per minute. 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.