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

Обзор

Обновляет изменяемые поля сущности пользователя. Поля, перенесённые из проверенных сессий Проверки пользователей (KYC) (full_name, date_of_birth, portrait_image, совокупные счётчики, features), доступны только для чтения.

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

  • Обновить собственные метаданные: перевести пользователя на другой уровень, изменить теги, добавить внутреннюю заметку.
  • Переименовать: задать более понятный display_name для внутренних представлений в консоли.
  • Переопределить проверенные данные (с осторожностью): ручное переопределение разрешено, но записывается в журнал аудита.

Примечания

  • vendor_data в URL нельзя изменить через этот endpoint. Если нужно сменить ключ, создайте нового пользователя и удалите старого.
  • Отправляет webhook user.data.updated с массивом changed_fields, чтобы потребители могли эффективно синхронизировать данные.
  • Изменение status через этот endpoint работает так же, как Обновление статуса пользователя. Оно фиксируется в активности пользователя, а необязательное поле reason (до 1000 символов) становится его комментарием. При значении BLOCKED vendor_data добавляется в системный список блокировки. Webhook user.status.updated не передаёт reason.
  • Если вы отправите PATCH-запрос для поля, которым сейчас управляет проверенная сессия, переопределение будет принято, но отмечено в журнале аудита.

Разрешения

Основной секрет и API-ключи с полным доступом всегда могут вызывать этот endpoint. Для API-ключа с индивидуально настроенным доступом нужно право на запись в разделе Люди (users). Ключ, ограниченный отдельными сценариями или одобренными сессиями, не может вызывать этот 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).

Тело

application/json
full_name
string | null

Полное имя пользователя

Maximum string length: 512
display_name
string | null

Пользовательское отображаемое имя для этого пользователя

date_of_birth
string<date> | null

Дата рождения в формате ГГГГ-ММ-ДД

status
enum<string>

Статус жизненного цикла пользователя. Изменение фиксируется как действие STATUS_CHANGED, а BLOCKED добавляет vendor_data в системный список блокировки (смена статуса с BLOCKED удаляет эту запись).

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

Произвольный JSON-объект, прикрепляемый к пользователю. Полностью заменяет существующие метаданные при обновлении — объединяйте на стороне клиента, если нужно лишь добавить ключи.

approved_emails
string[]

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

approved_phones
string[]

Подтверждённые номера телефонов для этого пользователя. Полностью заменяет сохранённый список.

issuing_states
string[]

Страны выдачи (ISO 3166-1 alpha-3), например ["USA"]. Полностью заменяет сохранённый список.

reason
string | null

Причина изменения статуса. Записывается в записи об изменении статуса в активности пользователя (comments[].comment и раздел Activity в Business Console), только когда статус действительно меняется. В webhook не передается.

Maximum string length: 1000

Ответ

Пользователь обновлён. Возвращается полная обновлённая запись пользователя (такой же структуры, как в Get User).

Полные сведения о пользователе. Дополняет 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 г.