Перейти к основному содержанию
GET
curl

Обзор

Возвращает одну сущность пользователя, идентифицируемую по vendor_data. В ответах содержится didit_internal_id: стабильный внутренний идентификатор Didit.

Когда использовать

  • Проверка текущего состояния верификации пользователя: объект features содержит последний статус каждой функции в одном объекте.
  • Экраны с подробной информацией в вашем интерфейсе: запрашивайте профиль по требованию перед отображением.
  • Скоринг рисков: комбинируйте счётчики сессий и features, чтобы оценивать каждого пользователя на вашей стороне.

Примечания

  • vendor_data в URL чувствителен к регистру.
  • Возвращает 404, если в приложении нет пользователя с таким vendor_data.
  • Совокупные счётчики (session_count, approved_count, declined_count, in_review_count) обновляются в реальном времени по мере завершения сессий.
  • Все поля описаны в модели данных пользователя.

Разрешения

Вызывать этот endpoint может любой активный API-ключ приложения. API-ключи Didit привязаны к приложению, а не к ролям: роли и разрешения в Консоли (read:users и другие) определяют, что человек может делать в Консоли, и для трафика Management API не проверяются. Чтобы контролировать, кто может вызывать этот endpoint, контролируйте, кто может читать API-ключ приложения.

Связанные материалы

Авторизации

x-api-key
string
header
обязательно

API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.

Параметры пути

vendor_data
string
обязательно

Ваш уникальный идентификатор пользователя — произвольная строка (НЕ UUID). Это то же значение, которое вы передавали в vendor_data при создании сессии, в которой этот пользователь был представлен впервые; сопоставляется в точности в переданном виде.

Ответ

Полные сведения о пользователе, включая метаданные, комментарии / журнал действий и агрегированные данные сессии.

Полные сведения о пользователе. Дополняет UserListItem метаданными, комментариями и updated_at.

didit_internal_id
string<uuid>

Стабильный внутренний UUID Didit для этого пользователя.

vendor_data
string | null

Ваш уникальный идентификатор этого пользователя (передаётся при создании сессий). Может быть равен null, если идентификатор поставщика не был передан.

display_name
string | null

Пользовательское отображаемое имя, заданное вами

full_name
string | null

Полное имя, извлечённое из верифицированных документов

date_of_birth
string<date> | null
effective_name
string | null

Наиболее подходящее имя: display_name, если задано, иначе full_name

status
enum<string>

Статус жизненного цикла записи пользователя (НЕ статус сессии). ACTIVE используется по умолчанию, FLAGGED помечает пользователя для ручной проверки, BLOCKED запрещает новые сессии для этого vendor_data.

Доступные опции:
ACTIVE,
FLAGGED,
BLOCKED
portrait_image_url
string | null

Предварительно подписанный URL портретного фото пользователя (срок действия истекает через несколько часов)

session_count
integer

Общее количество сессий верификации для этого пользователя

approved_count
integer

Количество одобренных сессий

declined_count
integer

Количество отклонённых сессий

in_review_count
integer

Количество сессий на проверке

issuing_states
string[]

Коды стран выдачи по стандарту ISO 3166-1 alpha-3, указанные в одобренных документах, удостоверяющих личность этого пользователя, например ["USA", "ESP"]. Пустой массив, если таких кодов нет.

approved_emails
string[]

Подтверждённые адреса электронной почты, собранные из одобренных сессий этого пользователя, например ["john@example.com"].

approved_phones
string[]

Подтверждённые номера телефонов, собранные из одобренных сессий этого пользователя, например ["+14155551234"].

features
object

Агрегированный статус по функциям среди всех сессий этого пользователя. Возможные ключи: 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
object[]

Те же данные, что и features, в виде упорядоченного массива объектов {feature, status}.

last_session_at
string<date-time> | null

Временная метка последней сессии

first_session_at
string<date-time> | null

Временная метка первой сессии

last_activity_at
string<date-time> | null

Временная метка последней активности по этому пользователю (сессия, транзакция, смена статуса, редактирование данных и т. д.).

tags
object[]

Назначения тегов. ПРИМЕЧАНИЕ: в подробных ответах каждая запись представляет собой объект-связку тега ({uuid, tag: {...}, added_by_email, added_by_name, created_at}), в отличие от плоской структуры {uuid, name, color}, используемой в ответах со списком.

created_at
string<date-time>
metadata
object

JSON с пользовательскими метаданными, прикреплённый вами к этому пользователю. По умолчанию: {}.

comments
object[]

Журнал действий и комментарии по этому пользователю (изменения статуса, правки профиля, ручные заметки).

updated_at
string<date-time>
Последнее изменение 7 ноября 2026 г.