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

\`Goal: Partial-update a Didit User entity by vendor_data.

Endpoint: PATCH https://verification.didit.me/v3/users/{vendor_data}/
Auth header: x-api-key: 
Content-Type: application/json

Path param:
\- vendor_data (string, REQUIRED) — free-form string, NOT a UUID. URL-encode.

Request body (PARTIAL — only included fields are touched; auto-derived counters and session history are left alone):
\- full_name (string, max 512, nullable)
\- display_name (string, nullable)
\- date_of_birth (string YYYY-MM-DD, nullable)
\- status (enum) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices). Setting "BLOCKED" auto-adds vendor_data to the system blocklist; flipping away removes it.
\- metadata (object, nullable) — REPLACES existing metadata wholesale; merge client-side if you only want to add keys.
\- approved_emails (object)
\- approved_phones (object)
\- issuing_states (object)
\- reason (string, optional, max 1000): why the status changed. Recorded as the comment of the STATUS_CHANGED entry in the user's activity (comments[].comment), only when this update actually changes status. Webhooks do not carry it.

curl:
curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"display_name": "Jane S.", "status": "FLAGGED", "reason": "Address does not match the billing country"}'

Response 200: full updated UserDetailItem (same shape as GET). See /reference/data-models.

Side effects:
\- Writes to the user's comments activity log (actor derived from the API key): a STATUS_CHANGED entry with reason when status changes, and a PROFILE_UPDATED entry when display_name, full_name, date_of_birth or metadata change.
\- last_activity_at bumped to now().
\- Concurrent updates: last-write-wins per field.
\- Re-sending an unchanged body is safe (no extra audit row).

Failure modes:
\- 400 — validation. Examples:
\{ "status": ["Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED"] }
\{ "metadata": ["Metadata must be a JSON object."] }
date_of_birth must be YYYY-MM-DD.
\{ "reason": ["Ensure this field has no more than 1000 characters."] }
\- 401 — missing/invalid x-api-key. { "detail": "Authentication credentials were not provided." }
\- 403 — the API key is revoked or is not valid for this application. { "detail": "You do not have permission to perform this action." }
\- 403: a scoped API key without users write. { "detail": "This API key has no write access to people." }
\- 404 — vendor_data not found. { "detail": "Not found." }
\- 429 — rate-limited.

Notes:
\- vendor_data in the URL itself cannot be changed via this endpoint — create new + delete old to rekey.
\- For status-only flips, prefer the dedicated PATCH /v3/users/{vendor_data}/update-status/.
\- Overriding fields populated by a verified session is allowed but flagged in the audit log.

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

\
Вставьте в ## ОбзорОбновляет изменяемые поля [сущности пользователя](https://docs.didit.me/ru/entities/users/overview.md). Поля, перенесённые из проверенных сессий Проверки пользователей (KYC) (`full_name`, `date_of_birth`, `portrait_image`, совокупные счётчики, `features`), доступны только для чтения.## Когда использовать- **Обновить собственные метаданные**: перевести пользователя на другой уровень, изменить теги, добавить внутреннюю заметку. - **Переименовать**: задать более понятный `display_name` для внутренних представлений в консоли. - **Переопределить проверенные данные** (с осторожностью): ручное переопределение разрешено, но записывается в журнал аудита.## Примечания- `vendor_data` в URL нельзя изменить через этот endpoint. Если нужно сменить ключ, создайте нового пользователя и удалите старого. - Отправляет webhook `user.data.updated` с массивом `changed_fields`, чтобы потребители могли эффективно синхронизировать данные. - Изменение `status` через этот endpoint работает так же, как [Обновление статуса пользователя](https://docs.didit.me/ru/management-api/users/update-status.md). Оно фиксируется в активности пользователя, а необязательное поле `reason` (до 1000 символов) становится его комментарием. При значении `BLOCKED` `vendor_data` добавляется в системный список блокировки. Webhook `user.status.updated` не передаёт `reason`. - Если вы отправите PATCH-запрос для поля, которым сейчас управляет проверенная сессия, переопределение будет принято, но отмечено в [журнале аудита](https://docs.didit.me/ru/console/audit-logs.md).## РазрешенияОсновной секрет и [API-ключи](https://docs.didit.me/ru/console/api-keys.md) с полным доступом всегда могут вызывать этот endpoint. Для API-ключа с индивидуально настроенным доступом нужно право на запись в разделе **Люди** (`users`). Ключ, ограниченный отдельными сценариями или одобренными сессиями, не может вызывать этот endpoint.[Роли и разрешения](https://docs.didit.me/ru/console/roles-permissions.md) в консоли определяют, что участник команды может делать в консоли. Для запросов с API-ключами они не проверяются.## Связанное- [Операции с пользователями](https://docs.didit.me/ru/entities/users/operations.md) - [Модель данных](https://docs.didit.me/ru/entities/users/data-model.md) - [Обновление статуса](https://docs.didit.me/ru/management-api/users/update-status.md) ## OpenAPI ````yaml ru/openapi-25.json PATCH /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}/: patch: tags: - Users summary: Обновить пользователя description: >- Частичное обновление пользователя: `display_name`, `full_name`, `date_of_birth`, `status`, `metadata`, `approved_emails`/`approved_phones`/`issuing_states`. `metadata` заменяется полностью. Изменение `status` здесь работает аналогично [Обновить статус пользователя](#patch-/v3/users/-vendor_data-/update-status/): записывается действие `STATUS_CHANGED` с опциональным `reason`, а значение `BLOCKED` добавляет `vendor_data` в системный список блокировки (изменение статуса с `BLOCKED` удаляет эту запись). Изменения в `display_name`, `full_name`, `date_of_birth` или `metadata` фиксируются как действие `PROFILE_UPDATED`. operationId: update_user parameters: - name: vendor_data in: path required: true schema: type: string description: >- Ваш уникальный идентификатор пользователя (произвольная строка, НЕ UUID). example: user-abc-123 requestBody: content: application/json: schema: type: object properties: full_name: type: string nullable: true maxLength: 512 description: Полное имя пользователя display_name: type: string nullable: true description: Пользовательское отображаемое имя для этого пользователя date_of_birth: type: string format: date nullable: true description: Дата рождения в формате ГГГГ-ММ-ДД status: type: string enum: - ACTIVE - FLAGGED - BLOCKED description: >- Статус жизненного цикла пользователя. Изменение фиксируется как действие `STATUS_CHANGED`, а `BLOCKED` добавляет `vendor_data` в системный список блокировки (смена статуса с `BLOCKED` удаляет эту запись). metadata: type: object nullable: true description: >- Произвольный JSON-объект, прикрепляемый к пользователю. **Полностью заменяет** существующие метаданные при обновлении — объединяйте на стороне клиента, если нужно лишь добавить ключи. approved_emails: type: array items: type: string description: >- Подтверждённые адреса электронной почты для этого пользователя, например `["john@example.com"]`. Полностью заменяет сохранённый список. approved_phones: type: array items: type: string description: >- Подтверждённые номера телефонов для этого пользователя. Полностью заменяет сохранённый список. issuing_states: type: array items: type: string description: >- Страны выдачи (ISO 3166-1 alpha-3), например `["USA"]`. Полностью заменяет сохранённый список. reason: type: string nullable: true maxLength: 1000 description: >- Причина изменения статуса. Записывается в записи об изменении статуса в активности пользователя (`comments[].comment` и раздел **Activity** в Business Console), только когда статус действительно меняется. В webhook не передается. examples: Rename: summary: Задать отображаемое имя value: display_name: Jane S. Override status: summary: Пометить пользователя для проверки value: status: FLAGGED Add metadata: summary: Заменить JSON метаданных value: metadata: tier: premium risk_level: low Fix extracted DOB: summary: Скорректировать извлечённые поля профиля value: full_name: Jane Elizabeth Smith date_of_birth: '1985-11-22' Flag with reason: summary: Пометить пользователя и зафиксировать причину value: status: FLAGGED reason: Address does not match the billing country responses: '200': description: >- Пользователь обновлён. Возвращается полная обновлённая запись пользователя (такой же структуры, как в Get User). content: application/json: schema: $ref: '#/components/schemas/UserDetailItem' examples: Updated: value: didit_internal_id: f4e5e1f2-94a9-4f86-8c16-2b7d9b4db418 vendor_data: user-abc-123 display_name: Jane S. full_name: Jane Elizabeth Smith date_of_birth: '1985-11-22' effective_name: Jane S. status: FLAGGED metadata: tier: premium 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: [] created_at: '2025-06-01T08:00:00Z' updated_at: '2025-06-15T10:30:00Z' '400': description: >- Недопустимое тело запроса — обычно неизвестный `status` или `date_of_birth` не в формате `YYYY-MM-DD`. content: application/json: examples: Bad status: value: status: - '"INVALID" is not a valid choice.' Bad date_of_birth: value: date_of_birth: - >- Date has wrong format. Use one of these formats instead: YYYY-MM-DD. Reason too long: value: reason: - Ensure this field has no more than 1000 characters. '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. '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 PATCH 'https://verification.didit.me/v3/users/user-abc-123/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"display_name": "Jane S.", "status": "FLAGGED"}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.users.update( "user-abc-123", display_name="Jane S.", ) 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.update("user-abc-123", { display_name: "Jane S.", }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.Update(ctx, \"user-abc-123\", didit.UsersUpdateParams{\n\tDisplayName: didit.String(\"Jane S.\"),\n})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: >- import me.didit.Didit; import me.didit.types.UsersUpdateParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.users().update("user-abc-123", UsersUpdateParams.builder() .displayName("Jane S.") .build()); System.out.println(result); - lang: php label: PHP source: |- users->update('user-abc-123', [ 'display_name' => 'Jane S.', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.users.update( "user-abc-123", display_name: "Jane S." ) 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.UpdateAsync("user-abc-123", new UsersUpdateParams { DisplayName = "Jane S.", }); 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.