> ## 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 списка пользователей: сущности User > Получайте все сущности User приложения Didit с фильтрами по статусу, поиску и дате. Программное управление жизненным циклом пользователей. Промпт для списка пользователей Скопировать промпт в буфер обмена \

\`Goal: Page through Didit User entities for an application and consume them in your backend.

Endpoint: GET https://verification.didit.me/v3/users/
Auth header: x-api-key: 

Query params (all optional):
\- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices, NOT the session enum).
\- search: free-text over vendor_data, display_name, full_name, approved_emails, approved_phones.
\- country: ISO 3166-1 alpha-3 (e.g. "USA", "ESP") — filters by issuing country of approved documents.
\- limit: integer, 1–200, default 50.
\- offset: integer, 0+, default 0. Prefer following the "next" URL from the previous page.

curl:
curl -X GET 'https://verification.didit.me/v3/users/?limit=50&status=ACTIVE' \
-H 'x-api-key: YOUR_API_KEY'

Response 200 (envelope):
\{
"count": ,
"next": ,
"previous": ,
"results": [ UserListItem, ... ]
}

UserListItem key fields: didit_internal_id (UUID), vendor_data (string, may be null), display_name, full_name, effective_name, status, portrait_image_url, session_count, approved_count, declined_count, in_review_count, issuing_states, approved_emails, approved_phones, features (map of feature -> "Approved" | "Declined" | "In Review" | ...), features_list, last_session_at, first_session_at, tags, created_at. See /reference/data-models for the full shape.

Notes:
\- Ordered by last_session_at desc (most recently active first).
\- Deleted users are not returned.
\- vendor_data is a free-form client-supplied string, NOT a UUID. It may be null when the originating session did not provide one.

Pagination loop:
url = 'https://verification.didit.me/v3/users/?limit=200&status=ACTIVE'
while url:
r = requests.get(url, headers={'x-api-key': API_KEY})
r.raise_for_status()
page = r.json()
for user in page['results']:
    ...handle user...
url = page['next']

Failure modes (all return {"detail": "..."} unless noted):
\- 401 — missing or revoked x-api-key.
\- 403 — the API key is revoked or is not valid for this application.
\- 429 — rate-limited. Honour Retry-After header.

For end-to-end Didit integration, paste in the full prompt at /integration/integration-prompt.`

\
Вставьте в ## ОбзорВозвращает постраничный список [сущностей User](https://docs.didit.me/ru/entities/users/overview.md) для аутентифицированного приложения. Используйте его, чтобы синхронизировать пользователей с вашим хранилищем данных, находить пользователей, которым нужно внимание аналитика, или искать по отображаемому имени.## Когда использовать- **Периодическая синхронизация** таблицы пользователей с внешней BI-системой или хранилищем данных. - **Очереди аналитиков**: фильтруйте по `status=FLAGGED` или по устаревшему `last_activity_at`, чтобы формировать очередь на проверку. - **Поиск** пользователей по `display_name`, `full_name` или `vendor_data`.## Фильтры и пагинация| Параметр запроса | Описание | | - | - | | `status` | Фильтр по `ACTIVE`, `FLAGGED` или `BLOCKED`. | | `search` | Поиск по подстроке в `vendor_data`, `display_name`, `full_name`, адресах электронной почты и номерах телефонов. | | `country_code` | Фильтр по `issuing_states` (ISO 3166-1 alpha-3). | | `created_after`, `created_before` | Диапазон дат создания (ISO 8601). | | `last_activity_after`, `last_activity_before` | Диапазон дат активности. | | `page_size` | От 1 до 200. По умолчанию: 50. | | `cursor` | Курсор пагинации, возвращённый в предыдущем ответе. |## Примечания- Каждый элемент ответа содержит `didit_internal_id`. `vendor_data` может быть `null`, если исходная сессия или транзакция не передали это значение. - Этот endpoint использует пагинацию по курсору: сохраняйте курсор `next` между вызовами и прекращайте запросы, когда `next` пуст. - См. [модель данных пользователя](https://docs.didit.me/ru/entities/users/data-model.md), где перечислены все поля записи пользователя.## РазрешенияЛюбой активный API-ключ приложения может вызывать этот endpoint. API-ключи Didit **с областью действия на уровне приложения, а не роли**: [роли и разрешения](https://docs.didit.me/ru/console/roles-permissions.md) в Консоли (`list:users` и остальные) определяют, что *человек* может делать в Консоли, и не применяются к трафику Management API. Чтобы ограничить доступ к этому endpoint, ограничьте круг лиц, которые могут читать API-ключ приложения.## Связанные материалы- [Обзор пользователей](https://docs.didit.me/ru/entities/users/overview.md) - [Получить пользователя](https://docs.didit.me/ru/management-api/users/get.md) - [Операции с пользователями](https://docs.didit.me/ru/entities/users/operations.md) ## OpenAPI ````yaml ru/openapi-25.json GET /v3/users/ 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/users/: get: tags: - Users summary: Получить список пользователей description: >- Получить список [пользователей](/entities/users), которых Didit формирует на основе сессий KYC с одинаковым значением `vendor_data` (произвольная строка, НЕ UUID), а также пользователей, созданных через API. С пагинацией, отсортирован по `last_session_at` по убыванию (desc). Этот endpoint не поддерживает параметры фильтрации или поиска — запрашивайте страницы и фильтруйте на стороне клиента. operationId: list_users parameters: - name: limit in: query schema: type: integer default: 50 minimum: 1 maximum: 1000000 description: >- Размер страницы. По умолчанию 50, если не указан. Жёсткого максимума нет, но рекомендуется оставлять страницы небольшими для уменьшения задержки. - name: offset in: query schema: type: integer maximum: 1000000 minimum: 0 default: 0 description: >- Смещение первой возвращаемой записи, начиная с нуля. Рекомендуется переходить по URL `next` с предыдущей страницы вместо вычисления вручную. responses: '200': description: >- Список пользователей с пагинацией, со статусом верификации, количеством сессий и детализацией по функциям. content: application/json: schema: type: object properties: count: type: integer description: >- Количество подходящих строк: точное до 100, с ограничением в 100 сверх этого для производительности. Не используйте его для определения последней страницы; вместо этого ориентируйтесь на то, что `next` равен `null`. next: type: string nullable: true description: >- Абсолютный URL следующей страницы или `null` на последней странице. previous: type: string nullable: true description: >- Абсолютный URL предыдущей страницы или `null` на первой странице. results: type: array items: $ref: '#/components/schemas/UserListItem' examples: Example: value: count: 2 next: null previous: null results: - didit_internal_id: f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418 vendor_data: user-abc-123 display_name: null full_name: John Michael Doe date_of_birth: '1990-05-15' effective_name: John Michael Doe status: ACTIVE portrait_image_url: https:///... session_count: 3 approved_count: 2 declined_count: 0 in_review_count: 1 issuing_states: - USA approved_emails: - john@example.com approved_phones: - '+14155551234' features: ID_VERIFICATION: Approved LIVENESS: Approved FACE_MATCH: Approved AML: Approved features_list: - feature: ID_VERIFICATION status: Approved - feature: LIVENESS status: Approved - feature: FACE_MATCH status: Approved - feature: AML status: Approved last_session_at: '2025-06-15T10:30:00Z' last_activity_at: '2025-06-15T10:30:00Z' first_session_at: '2025-06-01T08:00:00Z' tags: - uuid: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d name: VIP color: '#2567FF' created_at: '2025-06-01T08:00:00Z' - didit_internal_id: 6ed99d53-e8f5-4cf8-9ac1-4a506cb40f6b vendor_data: null display_name: Jane S. full_name: Jane Elizabeth Smith date_of_birth: '1985-11-22' effective_name: Jane S. status: FLAGGED portrait_image_url: null session_count: 1 approved_count: 0 declined_count: 0 in_review_count: 1 issuing_states: [] approved_emails: [] approved_phones: [] features: ID_VERIFICATION: In Review features_list: - feature: ID_VERIFICATION status: In Review last_session_at: '2025-06-20T14:00:00Z' last_activity_at: '2025-06-20T14:05:00Z' first_session_at: '2025-06-20T14:00:00Z' tags: [] created_at: '2025-06-20T14:00:00Z' '401': description: >- Учетные данные не переданы. Запросы к путям `/v3/users/*` без заголовка `x-api-key` (или токена `Authorization: Bearer`) отклоняются промежуточным ПО аутентификации до попадания в API. content: application/json: examples: Missing credentials: value: detail: >- You must be authenticated with a valid access token to access this endpoint. '403': description: >- Ключ не может запрашивать список пользователей для этого приложения. Отсутствующий ключ возвращает `403`; неверный, отозванный или просроченный ключ возвращает `401`. content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '429': description: >- Лимит запросов превышен; снизьте частоту запросов и повторите попытку через интервал, указанный в `Retry-After`. content: application/json: examples: Rate limited: value: detail: Request was throttled. Expected available in 30 seconds. security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: |- curl -X GET 'https://verification.didit.me/v3/users/?limit=50' \ -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.users.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.users.list()) { console.log(item); } - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\niter := client.Users.ListAutoPaging(ctx, didit.UsersListParams{})\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.users().list()) { System.out.println(item); } - lang: php label: PHP source: |- users->list() as $item) { print_r($item->toArray()); } - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new didit.users.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.Users.ListAsync()) { Console.WriteLine(JsonSerializer.Serialize(item)); } components: schemas: UserListItem: type: object description: Верифицированный пользователь. properties: didit_internal_id: type: string format: uuid description: Стабильный внутренний UUID Didit для этого пользователя. vendor_data: type: string nullable: true description: >- Ваш уникальный идентификатор этого пользователя (передаётся при создании сессий). Может быть равен null, если идентификатор поставщика не был передан. display_name: type: string nullable: true description: Пользовательское отображаемое имя, заданное вами full_name: type: string nullable: true description: Полное имя, извлечённое из верифицированных документов date_of_birth: type: string format: date nullable: true effective_name: type: string nullable: true description: 'Наиболее подходящее имя: display_name, если задано, иначе full_name' status: type: string enum: - ACTIVE - FLAGGED - BLOCKED description: >- Статус жизненного цикла записи пользователя (НЕ статус сессии). `ACTIVE` используется по умолчанию, `FLAGGED` помечает пользователя для ручной проверки, `BLOCKED` запрещает новые сессии для этого `vendor_data`. portrait_image_url: type: string nullable: true description: >- Предварительно подписанный URL портретного фото пользователя (срок действия истекает через несколько часов) session_count: type: integer description: Общее количество сессий верификации для этого пользователя approved_count: type: integer description: Количество одобренных сессий declined_count: type: integer description: Количество отклонённых сессий in_review_count: type: integer description: Количество сессий на проверке issuing_states: type: array items: type: string description: >- Коды стран выдачи по стандарту ISO 3166-1 alpha-3, указанные в одобренных документах, удостоверяющих личность этого пользователя, например `["USA", "ESP"]`. Пустой массив, если таких кодов нет. approved_emails: type: array items: type: string description: >- Подтверждённые адреса электронной почты, собранные из одобренных сессий этого пользователя, например `["john@example.com"]`. approved_phones: type: array items: type: string description: >- Подтверждённые номера телефонов, собранные из одобренных сессий этого пользователя, например `["+14155551234"]`. features: type: object description: >- Агрегированный статус по функциям среди всех сессий этого пользователя. Возможные ключи: `ID_VERIFICATION`, `NFC`, `LIVENESS`, `FACE_MATCH`, `POA`, `QUESTIONNAIRE`, `EMAIL_VERIFICATION`, `PHONE`, `AML`, `IP_ANALYSIS`, `AGE_ESTIMATION`, `DATABASE_VALIDATION`. Возможные значения: `Approved`, `Declined`, `In Review`, `Not Finished`, `Resub Requested`. features_list: type: array items: type: object properties: feature: type: string status: type: string description: >- Те же данные, что и `features`, в виде упорядоченного массива объектов `{feature, status}`. last_session_at: type: string format: date-time nullable: true description: Временная метка последней сессии first_session_at: type: string format: date-time nullable: true description: Временная метка первой сессии last_activity_at: type: string format: date-time nullable: true description: >- Временная метка последней активности по этому пользователю (сессия, транзакция, смена статуса, редактирование данных и т. д.). tags: type: array items: type: object properties: uuid: type: string format: uuid name: type: string color: type: string description: Теги, назначенные этому пользователю created_at: type: string format: date-time 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.