> ## 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/lists/{list_uuid}/entries/: постраничные записи списков Didit (блокировки, разрешений, пользовательских) с поиском. Оплата за вызов.



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



      
      

\<pre>

\`Retrieve paginated entries from a Didit list through the Management API.

Endpoint:
GET https://verification.didit.me/v3/lists/{list_uuid}/entries/

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

Goal:
\- Browse, search, or export the entries inside a specific list (blocklist, allowlist, or custom).

Path parameter:
\- list_uuid: the list UUID from GET /v3/lists/.

Query parameters (all optional):
\- search: case-insensitive text that value or display_label must contain.
\- reference_session_id: only the entries taken from this person verification session (for example, to see which of its faces are already in the face blocklist). Must be a session UUID.
\- limit: page size (default 50, at most 1000000).
\- offset: pagination offset (default 0).

Behavior:
\- Current entries only, newest first.
\- Image URLs in metadata (reference_image_url, front_image_url) are short-lived signed URLs, issued again on every call. A scoped key without media: read gets null in their place.

Example call:
curl -X GET "https://verification.didit.me/v3/lists/{list_uuid}/entries/?search=example.com" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- count / next / previous: standard pagination envelope.
\- results[].uuid: entry id; use it as entry_uuid in DELETE /v3/lists/{list_uuid}/entries/{entry_uuid}/.
\- results[].value: the listed value (phone number in E.164, email, document number, IP or CIDR range, wallet address, country code, vendor_data, or a face UUID on face lists). Matching is case-insensitive.
\- results[].display_label, comment: labels and notes.
\- results[].added_by: "api" (an API key), a console user's email or "console", "system" (entries Didit provisions), or "rule" (a transaction rule action).
\- results[].reference_session_id / reference_session_number / reference_session_type: set when the entry was taken from a verification session; reference_session_type is "kyc" or "kyb".
\- results[].reference_object_uuid + metadata.reference_type: the record the entry stands for. metadata.reference_type, when you set it, says whether reference_object_uuid is a "transaction", a "vendor_user" or a "vendor_business".
\- results[].metadata: may include document context (full_name, issuing_state, document_type, document_number), face image URLs, and, for faces from a document-capture selfie, face_image_source and reference_node_id.

Failure modes:
\- 400: reference_session_id is not a valid UUID, 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.
\- 404: no list with this UUID in this application, or it was deleted ({ "detail": "List not found." }).
\- 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>



      
      

Вставьте в

Получите записи одного списка, от новых к старым, с необязательным поиском. `search` находит совпадение с частью значения или метки записи без учета регистра. `reference_session_id` ограничивает результаты записями, полученными из одной сессии верификации. В списке лиц `metadata.face_image_source` показывает, какое из лиц сессии соответствует каждой записи (`liveness`, если поле отсутствует).Записи лиц и документов содержат в `metadata` URL изображений, которые истекают вскоре после вызова. Чтобы получить новые URL, запросите записи повторно и не сохраняйте старые. API-ключ без разрешения **media: read** получает `null` вместо этих URL.


## OpenAPI

````yaml ru/openapi-25.json GET /v3/lists/{list_uuid}/entries/
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/lists/{list_uuid}/entries/:
    get:
      tags:
        - Lists
      summary: Получить список записей списка
      description: >-
        Возвращает текущие записи одного списка, начиная с самых новых. Параметр
        `search` выполняет нечувствительный к регистру поиск по части `value`
        или `display_label` записи, а `reference_session_id` ограничивает
        результаты записями, полученными из одной сессии верификации
        пользователя. URL-адреса изображений в `metadata` представляют собой
        временные подписанные URL-адреса, генерируемые заново при каждом вызове;
        API-ключ с ограниченной областью действия без `media: read` получает
        вместо них `null`. Для API-ключа с ограниченной областью действия
        требуется разрешение `workflows: read`.
      operationId: list_list_entries
      parameters:
        - name: list_uuid
          in: path
          required: true
          description: UUID списка, возвращённый методами List lists или Create a list.
          schema:
            type: string
            format: uuid
          example: 11111111-2222-3333-4444-555555555555
        - name: search
          in: query
          required: false
          description: >-
            Текст без учёта регистра, который должно содержать поле `value` или
            `display_label` записи.
          schema:
            type: string
        - name: reference_session_id
          in: query
          required: false
          description: >-
            Только записи, полученные из этой сессии верификации личности,
            например, чтобы увидеть, какие из её лиц уже внесены в списки.
          schema:
            type: string
            format: uuid
        - 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/ComplianceListEntry'
              examples:
                Entries:
                  value:
                    count: 2
                    next: null
                    previous: null
                    results:
                      - uuid: bbbbbbbb-cccc-dddd-eeee-ffffffffffff
                        value: X1234567
                        display_label: Jane Doe - X1234567
                        comment: ''
                        added_by: api
                        reference_session_id: 33333333-4444-5555-6666-777777777777
                        reference_session_number: 1042
                        reference_session_type: kyc
                        reference_object_uuid: 66666666-7777-8888-9999-000000000000
                        metadata:
                          full_name: Jane Doe
                          issuing_state: ESP
                          document_type: ID
                          region: ''
                          document_number: X1234567
                        created_at: '2026-10-12T10:06:12.774915Z'
                      - uuid: eeeeeeee-ffff-0000-1111-222222222222
                        value: y7654321
                        display_label: ''
                        comment: Reported by a partner
                        added_by: api
                        reference_session_id: null
                        reference_session_number: null
                        reference_session_type: null
                        reference_object_uuid: null
                        metadata: null
                        created_at: '2026-10-03T07:48:30.552810Z'
        '400':
          description: Недопустимый параметр запроса.
          content:
            application/json:
              examples:
                Invalid session id:
                  value:
                    reference_session_id:
                      - Must be a valid UUID.
                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.
        '404':
          description: >-
            Списка с таким UUID не существует в приложении этого API-ключа, или
            он был удален.
          content:
            application/json:
              examples:
                Not found:
                  value:
                    detail: List not found.
        '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/lists/11111111-2222-3333-4444-555555555555/entries/?search=example.com'
            \
              -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.lists.entries.list(
                "11111111-2222-3333-4444-555555555555",
            ):
                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.lists.entries.list("11111111-2222-3333-4444-555555555555")) {
              console.log(item);
            }
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Lists.Entries.ListAutoPaging(ctx, \"11111111-2222-3333-4444-555555555555\", didit.ListsEntriesListParams{})\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.lists().entries().list("11111111-2222-3333-4444-555555555555"))
            {
                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->lists->entries->list('11111111-2222-3333-4444-555555555555')
            as $item) {
                print_r($item->toArray());
            }
        - lang: ruby
          label: Ruby
          source: >-
            require "didit"


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            didit.lists.entries.list("11111111-2222-3333-4444-555555555555").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.Lists.Entries.ListAsync("11111111-2222-3333-4444-555555555555"))

            {
                Console.WriteLine(JsonSerializer.Serialize(item));
            }
components:
  schemas:
    ComplianceListEntry:
      type: object
      description: Одно значение в списке.
      required:
        - uuid
        - value
        - display_label
        - comment
        - added_by
        - reference_session_id
        - reference_session_number
        - reference_session_type
        - reference_object_uuid
        - metadata
        - created_at
      properties:
        uuid:
          type: string
          format: uuid
          description: >-
            Идентификатор записи. Используйте его в качестве `entry_uuid` в
            запросе «Удалить запись списка».
        value:
          type: string
          description: >-
            Значение из списка: номер телефона в формате E.164, адрес
            электронной почты, номер документа, IP-адрес или диапазон CIDR,
            цифровой отпечаток устройства, адрес кошелька, банковский счёт,
            трёхбуквенный код страны по стандарту ISO 3166-1 alpha-3,
            `vendor_data`, любая строка в списке типа `key` или UUID
            сохранённого лица в списке лиц. Отправляемые вами значения
            сохраняются в нижнем регистре, за исключением номеров телефонов и
            кодов стран. Сопоставление нечувствительно к регистру.
        display_label:
          type: string
          nullable: true
          maxLength: 512
          description: >-
            Понятная метка. Didit заполняет её для записей, взятых из сессии
            (например, имя владельца и номер документа), если вы ничего не
            передали.
        comment:
          type: string
          description: >-
            Примечание в виде произвольного текста. Пустая строка, если не
            задано.
        added_by:
          type: string
          nullable: true
          description: >-
            Кто добавил запись: `api` (API-ключ), адрес электронной почты
            пользователя консоли или `console`, `system` или `migration`
            (записи, созданные Didit), либо `rule` (действие правила транзакций
            или мониторинга).
        reference_session_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            Сессия верификации, из которой была взята запись. `null`, если
            запись была добавлена по значению.
        reference_session_number:
          type: integer
          nullable: true
          description: >-
            Номер этой сессии в рамках приложения, как он отображается в
            консоли.
        reference_session_type:
          type: string
          nullable: true
          enum:
            - kyc
            - kyb
            - null
          description: >-
            `kyc` для сессии проверки физического лица, `kyb` для сессии
            верификации бизнеса, `null`, если сессия отсутствует.
        reference_object_uuid:
          type: string
          format: uuid
          nullable: true
          description: >-
            Запись, которой соответствует элемент: запись лица, документа,
            телефона или адреса электронной почты, считанная из сессии, лицо,
            созданное с помощью «Загрузить лицо в список», или переданный вами
            UUID (например, UUID транзакции или `didit_internal_id`
            пользователя).
        metadata:
          type: object
          nullable: true
          additionalProperties: true
          description: >-
            Дополнительный контекст. Содержит ключи, установленные Didit
            (перечисленные здесь), объединенные с любыми `metadata`, переданными
            вами при создании записи, и возвращается в сохраненном виде. `null`,
            если контекст отсутствует.
          properties:
            reference_image_url:
              type: string
              description: >-
                Записи лиц: короткоживущий подписанный URL, генерируемый заново
                при каждом вызове; `null` для API-ключа с ограниченными правами
                без `media: read`. Отсутствует, если к записи не привязано
                изображение.
            front_image_url:
              type: string
              description: >-
                Записи документов, содержащие изображение лицевой стороны
                документа: временный подписанный URL, генерируемый заново при
                каждом вызове; `null` для API-ключа с ограниченной областью
                действия без `media: read`.
            full_name:
              type: string
              description: 'Записи документов, полученные из сессии: полное имя владельца.'
            issuing_state:
              type: string
              description: >-
                Записи документов, полученные из сессии: страна выдачи по
                стандарту ISO 3166-1 alpha-3.
            document_type:
              type: string
              description: >-
                Записи документов, полученные из сессии: код типа документа,
                например `P`, `ID` или `DL`.
            region:
              type: string
              description: >-
                Записи документов, полученные из сессии: штат или провинция
                выдачи для документа регионального выпуска, пусто, если
                неприменимо. Не задаётся действием добавления элементов сессии в
                список блокировки.
            document_number:
              type: string
              description: 'Записи документов, полученные из сессии: номер документа.'
            face_image_source:
              type: string
              enum:
                - front_image_camera_front
                - back_image_camera_front
              description: >-
                Записи лиц, полученные из селфи с захвата документа: какое
                именно селфи. Отсутствует для лиц из проверки живости.
            reference_node_id:
              type: string
              nullable: true
              description: >-
                Записи лиц, полученные из селфи с захвата документа: узел
                верификации личности, из которого поступило селфи.
            fingerprint_tier:
              type: string
              nullable: true
              enum:
                - persistent_id
                - composite_hash
                - legacy_fp
                - unknown
                - null
              description: >-
                Записи цифрового отпечатка устройства, полученные из сессии:
                способ формирования отпечатка. `persistent_id` идентифицирует
                одно устройство; `composite_hash` и `legacy_fp` могут быть
                общими для устройств одной модели.
            sandbox:
              type: boolean
              description: >-
                `true` для записи лица, загруженной в приложении песочницы;
                такая запись ни с чем не совпадает.
            reference_type:
              type: string
              enum:
                - transaction
                - vendor_user
                - vendor_business
              description: >-
                Задаётся вами: объект, на который указывает
                `reference_object_uuid`, чтобы консоль ссылалась на него.
            reference_id:
              type: string
              description: 'Задаётся вами: идентификатор исходной записи.'
        created_at:
          type: string
          format: date-time
          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.