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

\`Goal: Fetch a single Didit User entity by your own vendor_data.

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

Path param:
\- vendor_data (string, REQUIRED) — your unique identifier. Free-form string, NOT a UUID. Matching is case-insensitive after Didit normalisation. URL-encode it.

curl:
curl -X GET 'https://verification.didit.me/v3/users/user-abc-123/' \
-H 'x-api-key: YOUR_API_KEY'

Response 200 (UserDetailItem) — extends the list shape with metadata, comments (activity log), and updated_at. Key fields:
\- didit_internal_id (UUID — Didit's stable internal identifier)
\- vendor_data (string)
\- display_name, full_name, date_of_birth, effective_name, portrait_image_url
\- status: "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices)
\- session_count, approved_count, declined_count, in_review_count (aggregate counters)
\- features (map of feature -> latest status)
\- approved_emails, approved_phones, issuing_states
\- metadata (arbitrary JSON you attached)
\- comments (chronological activity log: status changes, manual notes, system events)
\- created_at, updated_at
See /reference/data-models for the full schema.

Notes:
\- Aggregate counters update in real time as sessions reach terminal status.
\- For bulk lookups, prefer paging GET /v3/users/ and indexing locally on vendor_data instead of fanning out one call per identifier.

Failure modes (envelope {"detail": "..."}):
\- 401 — missing or invalid x-api-key.
\- 403 — the API key is revoked or is not valid for this application.
\- 404 — no user with that vendor_data in this application.
\- 429 — rate-limited.

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

\
Вставьте в ## ОбзорВозвращает одну [сущность пользователя](https://docs.didit.me/ru/entities/users/overview.md), идентифицируемую по `vendor_data`. В ответах содержится `didit_internal_id`: стабильный внутренний идентификатор Didit.## Когда использовать- **Проверка** текущего состояния верификации пользователя: объект `features` содержит последний статус каждой функции в одном объекте. - **Экраны с подробной информацией** в вашем интерфейсе: запрашивайте профиль по требованию перед отображением. - **Скоринг рисков**: комбинируйте счётчики сессий и `features`, чтобы оценивать каждого пользователя на вашей стороне.## Примечания- `vendor_data` в URL чувствителен к регистру. - Возвращает `404`, если в приложении нет пользователя с таким `vendor_data`. - Совокупные счётчики (`session_count`, `approved_count`, `declined_count`, `in_review_count`) обновляются в реальном времени по мере завершения сессий. - Все поля описаны в [модели данных пользователя](https://docs.didit.me/ru/entities/users/data-model.md).## РазрешенияВызывать этот endpoint может любой активный API-ключ приложения. API-ключи Didit привязаны к приложению, а не к ролям: [роли и разрешения](https://docs.didit.me/ru/console/roles-permissions.md) в Консоли (`read:users` и другие) определяют, что *человек* может делать в Консоли, и для трафика Management API не проверяются. Чтобы контролировать, кто может вызывать этот endpoint, контролируйте, кто может читать API-ключ приложения.## Связанные материалы- [Обзор пользователей](https://docs.didit.me/ru/entities/users/overview.md) - [Модель данных](https://docs.didit.me/ru/entities/users/data-model.md) - [Список пользователей](https://docs.didit.me/ru/management-api/users/list.md) ## OpenAPI ````yaml ru/openapi-25.json GET /v3/users/{vendor_data}/ 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/{vendor_data}/: get: tags: - Users summary: Получить пользователя description: >- Получить одного [пользователя](/entities/users) по `vendor_data` (точное совпадение). Добавляет `metadata`, `comments` и `updated_at` к списочному представлению, а также переключает `tags` в подробный формат связи с тегами. operationId: get_user parameters: - name: vendor_data in: path required: true schema: type: string description: >- Ваш уникальный идентификатор пользователя — произвольная строка (НЕ UUID). Это то же значение, которое вы передавали в `vendor_data` при создании сессии, в которой этот пользователь был представлен впервые; сопоставляется в точности в переданном виде. example: user-abc-123 responses: '200': description: >- Полные сведения о пользователе, включая метаданные, комментарии / журнал действий и агрегированные данные сессии. content: application/json: schema: $ref: '#/components/schemas/UserDetailItem' examples: Active user: value: 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 metadata: tier: premium source: website 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 tag: uuid: e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b name: VIP color: '#2567FF' description: null source: custom created_at: '2025-05-01T09:00:00Z' updated_at: '2025-05-01T09:00:00Z' added_by_email: analyst@acme.com added_by_name: Jane Analyst created_at: '2025-06-02T11:00:00Z' comments: - uuid: c1111111-2222-4333-8444-555555555555 comment_type: STATUS_CHANGED comment: null actor_email: analyst@acme.com actor_name: Jane Analyst previous_status: FLAGGED new_status: ACTIVE previous_value: null new_value: null changed_fields: [] metadata: null mentioned_emails: [] created_at: '2025-06-01T10:30:00Z' created_at: '2025-06-01T08:00:00Z' updated_at: '2025-06-15T10:30: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: >- Недействительный или отозванный API-ключ, либо ключ не может читать пользователей этого приложения. При отсутствии ключа возвращается `403`; при неверном, отозванном или истёкшем ключе возвращается `401`. content: application/json: examples: Forbidden: value: detail: You do not have permission to perform this action. '404': description: >- Пользователь с указанным `vendor_data` не существует для этого приложения. content: application/json: examples: Not found: value: detail: Not found. '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/user-abc-123/' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.users.retrieve( "user-abc-123", ) 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.users.retrieve("user-abc-123"); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Retrieve(ctx, \"user-abc-123\")\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.users().retrieve("user-abc-123"); System.out.println(result); - lang: php label: PHP source: |- users->retrieve('user-abc-123'); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.users.retrieve("user-abc-123") 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.Users.RetrieveAsync("user-abc-123"); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: UserDetailItem: type: object description: >- Полные сведения о пользователе. Дополняет UserListItem метаданными, комментариями и updated_at. allOf: - $ref: '#/components/schemas/UserListItem' - type: object properties: metadata: type: object description: >- JSON с пользовательскими метаданными, прикреплённый вами к этому пользователю. По умолчанию: `{}`. tags: type: array description: >- Назначения тегов. ПРИМЕЧАНИЕ: в подробных ответах каждая запись представляет собой объект-связку тега (`{uuid, tag: {...}, added_by_email, added_by_name, created_at}`), в отличие от плоской структуры `{uuid, name, color}`, используемой в ответах со списком. items: type: object properties: uuid: type: string format: uuid description: UUID назначения тега (не самого тега). tag: type: object properties: uuid: type: string format: uuid name: type: string color: type: string description: type: string nullable: true source: type: string enum: - didit - custom created_at: type: string format: date-time updated_at: type: string format: date-time added_by_email: type: string nullable: true added_by_name: type: string nullable: true created_at: type: string format: date-time comments: type: array items: type: object properties: uuid: type: string format: uuid comment_type: type: string enum: - COMMENT - STATUS_CHANGED - METADATA_UPDATED - TAG_ADDED - TAG_REMOVED - PROFILE_UPDATED comment: type: string nullable: true actor_email: type: string nullable: true actor_name: type: string nullable: true previous_status: type: string nullable: true enum: - ACTIVE - FLAGGED - BLOCKED - null new_status: type: string nullable: true enum: - ACTIVE - FLAGGED - BLOCKED - null previous_value: type: object nullable: true description: Предыдущие значения полей для записей PROFILE_UPDATED. new_value: type: object nullable: true description: Новые значения полей для записей PROFILE_UPDATED. changed_fields: type: array items: type: string description: Названия полей, изменённых записью PROFILE_UPDATED. metadata: type: object nullable: true mentioned_emails: type: array items: type: string created_at: type: string format: date-time description: >- Журнал действий и комментарии по этому пользователю (изменения статуса, правки профиля, ручные заметки). updated_at: type: string format: date-time 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.