> ## 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. # Получение комплаенс-списка: Get List API > GET /v3/lists/{list_uuid}/: получение данных списка Didit (блокировки, разрешений, пользовательского) с количеством записей и метаданными. Промпт API получения списка Скопировать промпт в буфер обмена \

\`Fetch a single Didit list's metadata through the Management API.

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

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

Goal:
\- Retrieve the details of a specific list: name, description, list_type, entry_type, is_system, entry_count, last_entry_added_at.
\- Use this to render a list-detail view or to confirm a list still exists before adding entries.

Path parameter:
\- list_uuid: the list UUID returned by GET /v3/lists/ or POST /v3/lists/.

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

What to read from the response:
\- list_type: "blocklist" | "allowlist" | "custom" (drives what a match does).
\- entry_type: decides how values are validated and which data is matched.
\- is_system: true for the lists Didit provisions (one blocklist per entry type, the "High Risk Countries" list, any system allowlist). These cannot be renamed, edited or deleted.
\- entry_count, last_entry_added_at: computed over the list's current entries.

This endpoint returns the list metadata only. To fetch entries, call GET /v3/lists/{list_uuid}/entries/.

Failure modes:
\- 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": "No List matches the given query." }).
\- 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.`

\
Вставьте в Получите сведения об одном списке, включая количество его записей и время добавления самой новой записи. Список другого приложения или удалённый список возвращает `404`.Чтобы прочитать значения в списке, используйте [Записи списка](https://docs.didit.me/ru/management-api/lists/list-entries.md). ## OpenAPI ````yaml ru/openapi-25.json GET /v3/lists/{list_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/lists/{list_uuid}/: get: tags: - Lists summary: Получить список description: >- Возвращает один список приложения с количеством записей и временем добавления самой новой записи. Список другого приложения или удалённый список возвращает `404`. Этот запрос возвращает только сам список: его значения можно прочитать с помощью [Получение записей списка](https://docs.didit.me/ru/management-api/lists/list-entries). Для API-ключа с ограниченной областью действия требуется разрешение `workflows: read`. operationId: get_list 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 responses: '200': description: Список. content: application/json: schema: $ref: '#/components/schemas/ComplianceList' examples: System face blocklist: value: uuid: 11111111-2222-3333-4444-555555555555 name: Face Blocklist description: >- Blocked biometric faces. When a face matching an entry in this list is detected during liveness verification, the session will be automatically declined. list_type: blocklist entry_type: face is_system: true entry_count: 12 last_entry_added_at: '2026-10-09T16:42:03.118204Z' created_at: '2026-01-14T10:02:11.402917Z' updated_at: '2026-01-14T10:02:11.402917Z' '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: No List matches the given query. '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/' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.lists.retrieve( "11111111-2222-3333-4444-555555555555", ) 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.lists.retrieve("11111111-2222-3333-4444-555555555555"); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Lists.Retrieve(ctx, \"11111111-2222-3333-4444-555555555555\")\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.lists().retrieve("11111111-2222-3333-4444-555555555555"); System.out.println(result); - lang: php label: PHP source: >- lists->retrieve('11111111-2222-3333-4444-555555555555'); print_r($result->toArray()); - lang: ruby label: Ruby source: >- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.lists.retrieve("11111111-2222-3333-4444-555555555555") 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.Lists.RetrieveAsync("11111111-2222-3333-4444-555555555555"); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: ComplianceList: type: object description: >- Список блокировки, список разрешений или кастомный список одного приложения. required: - uuid - name - description - list_type - entry_type - is_system - entry_count - last_entry_added_at - created_at - updated_at properties: uuid: type: string format: uuid description: >- Идентификатор списка. Используйте его как `list_uuid` в endpoint'ах списков и записей, а также как значение условия правила сценария или правила транзакции с `value_type: "list"`. name: type: string maxLength: 255 description: Название списка, уникальное среди списков приложения. description: type: string description: Описание в виде произвольного текста. Пустая строка, если не задано. list_type: type: string enum: - blocklist - allowlist - custom description: >- `blocklist`: совпадение отклоняет сессию или транзакцию (только системные списки, по одному на каждый тип записи). `allowlist`: совпадающие элементы считаются доверенными, например список разрешённых лиц пропускает действие при обнаружении дубликата лица; никогда не переопределяет совпадение со списком блокировки. `custom`: используется в условиях правил сценария и транзакций (`value_type: "list"`). entry_type: type: string enum: - face - document - phone - email - ip_address - device_fingerprint - wallet_address - bank_account - country - user - business - key description: >- Что содержит список: `face`, `document` (номер документа), `phone`, `email`, `ip_address` (IP-адрес или диапазон CIDR), `device_fingerprint`, `wallet_address`, `bank_account`, `country` (ISO 3166-1 alpha-3), `user` или `business` (ваши `vendor_data`), либо `key` (любая строка). Это определяет, как проверяются и сопоставляются значения записей. is_system: type: boolean description: >- `true` для списков, предоставляемых Didit: по одному списку блокировки на каждый тип записи (`face`, `document`, `phone`, `email`, `ip_address`, `device_fingerprint`, `wallet_address`, `bank_account`, `user`, `business`), пользовательский список **High Risk Countries** и системные белые списки. Системные списки нельзя переименовывать, редактировать или удалять; вы можете добавлять и удалять их записи. entry_count: type: integer minimum: 0 description: Количество записей, находящихся в списке в данный момент. last_entry_added_at: type: string format: date-time nullable: true description: >- Время добавления самой новой текущей записи. `null` для пустого списка. created_at: type: string format: date-time description: Время создания списка. updated_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.