> ## 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/blocklist/: получение списка заблокированных лиц, документов, телефонов и email из сессий Didit, от новых к старым, в одной ленте.



Промпт API для получения элементов списка блокировки
        Скопировать промпт в буфер обмена



      
      

\<pre>

\`List the blocklisted faces, documents, phone numbers and email addresses of my Didit verification sessions through the Management API.

Endpoint:
GET https://verification.didit.me/v3/blocklist/

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

Goal:
\- Get one paginated feed of every session record that is currently blocklisted, to build a "Blocked" screen or audit what my team has blocked.

Behavior:
\- Items are sorted by blocklisted_at, newest first. Items of deleted sessions are not included.
\- Each item has a type ("face", "document", "phone" or "email") and the session it belongs to (session_id, session_number). Fields that do not apply to the type are null.
\- The feed covers records blocklisted from a session: with POST /v3/blocklist/add/, from the console, or with a list entry created from reference_session_id. It does not include values added to a list by hand, uploaded faces, faces taken from a document-capture selfie, or IP address, device fingerprint, wallet, bank account, user and business entries. Read those with GET /v3/lists/{list_uuid}/entries/ on the matching system blocklist.
\- face_image and front_image are short-lived signed URLs, issued again on every call; a scoped key without media: read gets null instead.

Query parameters (all optional):
\- item_type: "face" | "document" | "phone" | "email". When omitted, every type is returned.
\- limit: page size (default 50, at most 1000000).
\- offset: pagination offset (default 0).

Example call:
curl -X GET "https://verification.didit.me/v3/blocklist/?item_type=document" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- count / next / previous: standard pagination envelope.
\- results[].type, session_id, session_number, blocklisted_at.
\- face items: face_image.
\- document items: document_type (for example "P" passport, "ID" national ID, "DL" driver's license), document_number, front_image.
\- phone items: phone_number (E.164), country_code (ISO 3166-1 alpha-2).
\- email items: email.

Failure modes:
\- 400: an unknown item_type, or limit/offset above 1000000.
\- 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: read.
\- 429: rate limited (see /integration/rate-limiting); back off and retry.

Side effects: none. This is a pure read.

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

\</pre>



      
      

Вставьте в

Выведите лица, документы, удостоверяющие личность, номера телефонов и адреса электронной почты из ваших сессий верификации, которые сейчас находятся в списке блокировки, начиная с самых новых. Каждый элемент ссылается на сессию, из которой он появился, чтобы вы могли открыть её в консоли или получить её решение.В этой ленте отображается то, что было добавлено в список блокировки **из сессии**: с помощью [Добавить в список блокировки](https://docs.didit.me/ru/management-api/blocklist/add.md) в консоли или с помощью [записи списка](https://docs.didit.me/ru/management-api/lists/create-entry.md), созданной из `reference_session_id`. Значения, введённые в список вручную, [загруженные лица](https://docs.didit.me/ru/management-api/lists/upload-face.md), лица, взятые из селфи при захвате документа, и остальные типы записей (IP-адрес, отпечаток устройства, кошелёк, банковский счёт, пользователь, компания) хранятся только в системных списках блокировки: получайте их с помощью [Список записей](https://docs.didit.me/ru/management-api/lists/list-entries.md).См. [Блокировка пользователей](https://docs.didit.me/ru/console/blocklist-users.md): там описано, как работает блокировка в консоли.


## OpenAPI

````yaml ru/openapi-25.json GET /v3/blocklist/
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/:
    get:
      tags:
        - Blocklist
      summary: Получить список элементов списка блокировки
      description: >-
        Возвращает одну постранично разбитую ленту с лицами, документами,
        удостоверяющими личность, номерами телефонов и адресами электронной
        почты сессий верификации приложения, которые в данный момент находятся в
        списке блокировки, начиная с самых новых по `blocklisted_at`; фильтрация
        с помощью `item_type`. Элементы удалённых сессий не включаются. Лента
        охватывает записи, добавленные в список блокировки из сессии (с помощью
        [Добавить элементы сессии в список
        блокировки](https://docs.didit.me/ru/management-api/blocklist/add), из
        консоли или через элемент списка, созданный из сессии); значения,
        добавленные в список вручную, загруженные лица, лица из селфи при
        захвате документа и другие типы записей получаются с помощью [Списка
        записей
        списка](https://docs.didit.me/ru/management-api/lists/list-entries).
        `face_image` и `front_image` представляют собой временные подписанные
        URL-адреса, и API-ключ с ограниченной областью действия без `media:
        read` получает `null`. Для API-ключа с ограниченной областью действия
        требуется разрешение `workflows: read`.
      operationId: list_blocklist_items
      parameters:
        - name: item_type
          in: query
          required: false
          description: >-
            Только элементы этого типа. Если параметр опущен, возвращаются все
            типы.
          schema:
            type: string
            enum:
              - face
              - document
              - phone
              - email
        - name: limit
          in: query
          required: false
          description: >-
            Размер страницы. По умолчанию 50. Значение больше 1000000 возвращает
            `400`; для нулевого, отрицательного или нечислового значения
            используется 50.
          schema:
            type: integer
            default: 50
            minimum: 1
            maximum: 1000000
        - name: offset
          in: query
          required: false
          description: >-
            Индекс первого возвращаемого элемента, начиная с нуля. Рекомендуется
            переходить по ссылке `next`. Значение больше 1000000 возвращает
            `400`; отрицательное или нечисловое значение сбрасывается на 0.
          schema:
            type: integer
            maximum: 1000000
            minimum: 0
            default: 0
      responses:
        '200':
          description: Страница элементов списка блокировки, начиная с самых новых.
          content:
            application/json:
              schema:
                type: object
                required:
                  - count
                  - next
                  - previous
                  - results
                properties:
                  count:
                    type: integer
                    minimum: 0
                    description: >-
                      Общее количество элементов списка блокировки,
                      соответствующих фильтрам.
                  next:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      Абсолютный URL следующей страницы или `null` на последней
                      странице.
                  previous:
                    type: string
                    format: uri
                    nullable: true
                    description: >-
                      Абсолютный URL предыдущей страницы или `null` на первой
                      странице.
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/BlocklistedItem'
              examples:
                Mixed feed:
                  value:
                    count: 2
                    next: null
                    previous: null
                    results:
                      - type: document
                        session_id: 33333333-4444-5555-6666-777777777777
                        session_number: 1042
                        blocklisted_at: '2026-10-12T10:06:12.701553Z'
                        face_image: null
                        document_type: ID
                        document_number: X1234567
                        front_image: >-
                          https://media.example.com/documents/front.jpg?expires=1760263938&signature=8b2e47
                        phone_number: null
                        country_code: null
                        email: null
                      - type: phone
                        session_id: 77777777-8888-9999-0000-111111111111
                        session_number: 1017
                        blocklisted_at: '2026-10-08T15:31:09.400127Z'
                        face_image: null
                        document_type: null
                        document_number: null
                        front_image: null
                        phone_number: '+14155552671'
                        country_code: US
                        email: null
        '400':
          description: Недопустимый параметр запроса.
          content:
            application/json:
              examples:
                Unknown item type:
                  value:
                    item_type:
                      - '"wallet" is not a valid choice.'
                Limit too large:
                  value:
                    - limit must not exceed 1000000.
        '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: read` или
            используется с 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 read access to workflows.
        '429':
          description: >-
            Превышен общий лимит на чтение в 600 запросов в минуту на один
            API-ключ. Подождите время, указанное в `Retry-After`, перед
            повторной попыткой.
          content:
            application/json:
              examples:
                Rate limited:
                  value:
                    detail: >-
                      GET request rate limit exceeded. You can make up to 600
                      requests per minute.
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X GET
            'https://verification.didit.me/v3/blocklist/?item_type=document' \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            for item in client.blocklist.list():
                print(item)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            for await (const item of didit.blocklist.list()) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Blocklist.ListAutoPaging(ctx, didit.BlocklistListParams{})\nfor iter.Next() {\n\tfmt.Printf(\"%+v\\n\", iter.Current())\n}\nif err := iter.Err(); err != nil {\n\tlog.Fatal(err)\n}"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            for (var item : client.blocklist().list()) {
                System.out.println(item);
            }
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            foreach ($didit->blocklist->list() as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            didit.blocklist.list.auto_paging_each do |item|
              puts item.to_h
            end
        - lang: csharp
          label: .NET
          source: |-
            using System;
            using System.Text.Json;
            using Didit;

            // Reads DIDIT_API_KEY.
            using var client = new DiditClient();

            await foreach (var item in await client.Blocklist.ListAsync())
            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    BlocklistedItem:
      type: object
      description: >-
        Одно лицо, документ, удостоверяющий личность, номер телефона или адрес
        электронной почты из списка блокировки, обнаруженные в сессии
        верификации. Поля, неприменимые к `type` элемента, содержат `null`.
      required:
        - type
        - session_id
        - session_number
        - blocklisted_at
        - face_image
        - document_type
        - document_number
        - front_image
        - phone_number
        - country_code
        - email
      properties:
        type:
          type: string
          enum:
            - face
            - document
            - phone
            - email
          description: Что было добавлено в список блокировки.
        session_id:
          type: string
          format: uuid
          description: Сессия верификации, к которой относится элемент.
        session_number:
          type: integer
          nullable: true
          description: >-
            Номер этой сессии в рамках приложения, как он отображается в
            консоли.
        blocklisted_at:
          type: string
          format: date-time
          description: Время последнего добавления элемента в список блокировки.
        face_image:
          type: string
          nullable: true
          description: >-
            Элементы лиц: короткоживущий подписанный URL, генерируемый заново
            при каждом вызове; `null` для API-ключа с ограниченными правами без
            `media: read`. Также `null`, если эталонное изображение не
            сохранено.
        document_type:
          type: string
          nullable: true
          description: >-
            Элементы документа: код типа документа, например `P` (паспорт), `ID`
            (национальное удостоверение личности), `DL` (водительские права) или
            `RP` (вид на жительство).
        document_number:
          type: string
          nullable: true
          description: >-
            Элементы документа: номер документа или личный номер, если у
            документа нет номера.
        front_image:
          type: string
          nullable: true
          description: >-
            Элементы документа: изображение лицевой стороны документа, временный
            подписанный URL, генерируемый заново при каждом вызове; `null` для
            API-ключа с ограниченной областью действия без `media: read`.
        phone_number:
          type: string
          nullable: true
          description: 'Элементы телефонного номера: номер телефона в формате E.164.'
        country_code:
          type: string
          nullable: true
          description: >-
            Элементы телефонного номера: страна номера по стандарту ISO 3166-1
            alpha-2.
        email:
          type: string
          nullable: true
          description: 'Элементы электронной почты: адрес электронной почты.'
  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.