> ## 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 обновления статуса пользователя: блокировка и флаги

> Блокируйте, помечайте флагом или активируйте пользователя вендора в Didit. Статус применяется к будущим KYC-сессиям и скринингу транзакций. Оплата за вызов.



Промпт для обновления статуса пользователя
        Скопировать промпт в буфер обмена



      
      

\<pre>

\`Goal: Flip ONLY the lifecycle status of a Didit User entity. Use the full PATCH /v3/users/{vendor_data}/ when you also need to touch other fields.

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

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

Request body:
\- status (enum, REQUIRED) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorUserStatusChoices, NOT the session enum).
\- 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 the status actually changes. Webhooks do not carry it.

Status semantics:
\- ACTIVE  → normal. New sessions allowed for this vendor_data.
\- FLAGGED → still accepted, highlighted in Console for manual review; filterable with ?status=FLAGGED.
\- BLOCKED → terminal. Adds vendor_data to the system blocklist. Subsequent session creations for the same identifier are rejected with a blocklist hit. Flipping back to ACTIVE/FLAGGED removes the blocklist entry automatically.

curl:
curl -X PATCH 'https://verification.didit.me/v3/users/user-abc-123/update-status/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"status": "BLOCKED", "reason": "Chargeback fraud pattern confirmed"}'

Response 200: full updated UserDetailItem (same shape as GET /v3/users/{vendor_data}/). See /reference/data-models.

Side effects:
\- Toggles the system blocklist entry when entering/leaving BLOCKED.
\- Writes one STATUS_CHANGED entry to the user's comments activity log (actor = API key identity), with reason as its comment.
\- Idempotent — re-sending the same status is a no-op (no extra audit row, no extra blocklist toggle).

Failure modes:
\- 400 — validation:
\{ "status": "This field is required." }
\{ "status": "Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED" }
\{ "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 (or deleted). { "detail": "Not found." }
\- 429 — rate-limited.

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

\</pre>



      
      

Вставьте в

## ОбзорПереводит [сущность User](https://docs.didit.me/ru/entities/users/overview.md) между статусами `ACTIVE`, `FLAGGED` и `BLOCKED`. Полный конечный автомат см. в разделе [жизненный цикл сущности](https://docs.didit.me/ru/entities/lifecycle.md).## Когда использовать- **Заблокировать пользователя** после подтверждения мошенничества или нарушения требований комплаенса.
- **Пометить пользователя** для ручной проверки, не блокируя его жёстко.
- **Разблокировать** пользователя после успешного устранения причин.
- **Передавать внешние сигналы**: например, когда ваш собственный движок выявления мошенничества присваивает пользователю оценку выше порога, переведите его в `FLAGGED` через этот endpoint.## Примечания- Допустимые значения: `ACTIVE`, `FLAGGED`, `BLOCKED`. Недопустимые значения возвращают 400.
- Передайте необязательный параметр `reason` (до 1000 символов), чтобы записать причину изменения статуса.
  Didit сохраняет его как комментарий к записи об изменении статуса в активности пользователя: `comments[].comment` у пользователя и **Активность** в Business Console.
  Он записывается только тогда, когда статус действительно меняется.
- Для пользователей со статусом `BLOCKED` все новые сессии и все новые транзакции автоматически отклоняются.
- Отправляет webhook `user.status.updated` с полями `previous_status` и `status`.
  Webhook не содержит `reason`.## Применение статусов| Статус | Влияние на новые сессии | Влияние на новые транзакции |
| - | - | - |
| `ACTIVE` | Обычный процесс | Обычный процесс |
| `FLAGGED` | Разрешено, но направляется в `IN_REVIEW` | Разрешено; может автоматически эскалироваться в зависимости от правил |
| `BLOCKED` | Автоматически отклоняется | Автоматически отклоняется |## РазрешенияОсновной секретный ключ и [API-ключи](https://docs.didit.me/ru/console/api-keys.md) с полным доступом всегда могут вызывать этот endpoint.
Ключу с настраиваемым доступом требуется разрешение на запись в разделе **People** (`users`).
Ключ, ограниченный отдельными сценариями или одобренными сессиями, не может обратиться к этому endpoint.[Роли и разрешения](https://docs.didit.me/ru/console/roles-permissions.md) в Console определяют, что может делать член команды в Console.
Для запросов с API-ключами они не проверяются.## Связанные разделы- [Жизненный цикл сущности](https://docs.didit.me/ru/entities/lifecycle.md)
- [Список блокировки пользователей](https://docs.didit.me/ru/entities/users/blocklist.md)
- [webhook сущностей](https://docs.didit.me/ru/entities/webhooks.md)


## OpenAPI

````yaml ru/openapi-25.json PATCH /v3/users/{vendor_data}/update-status/
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}/update-status/:
    patch:
      tags:
        - Users
      summary: Обновить статус пользователя
      description: >-
        Переключить только `status` жизненного цикла пользователя: `ACTIVE`,
        `FLAGGED` или `BLOCKED` (не статусы сессии). `BLOCKED` добавляет
        `vendor_data` в системный список блокировки; выход из `BLOCKED` удаляет
        эту запись. Каждое изменение фиксируется как действие `STATUS_CHANGED`
        пользователя с необязательным `reason` в качестве `comment`. Отправка
        текущего статуса ничего не меняет и не записывает `reason`. Webhook
        `user.status.updated` не содержит `reason`.
      operationId: update_user_status
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: Ваш уникальный идентификатор пользователя.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/EntityStatusUpdateRequest'
                - type: object
                  properties:
                    reason:
                      type: string
                      nullable: true
                      maxLength: 1000
                      description: >-
                        Причина изменения статуса. Записывается в записи об
                        изменении статуса в активности пользователя
                        (`comments[].comment` и раздел **Activity** в Business
                        Console), только когда статус действительно меняется. В
                        webhook не передается.
            examples:
              Activate:
                summary: Повторно активировать пользователя
                value:
                  status: ACTIVE
              Flag:
                summary: Пометить пользователя для проверки
                value:
                  status: FLAGGED
              Block:
                summary: >-
                  Заблокировать пользователя (добавляет в системный список
                  блокировки)
                value:
                  status: BLOCKED
              Block with reason:
                summary: Заблокировать пользователя и указать причину
                value:
                  status: BLOCKED
                  reason: Chargeback fraud pattern confirmed
      responses:
        '200':
          description: >-
            Статус пользователя обновлён. Возвращается полная запись
            пользователя.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserDetailItem'
              examples:
                Blocked:
                  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: BLOCKED
                    metadata:
                      tier: premium
                      source: website
                    portrait_image_url: https://<media-host>/...
                    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: Chargeback fraud pattern confirmed
                        actor_email: null
                        actor_name: null
                        previous_status: ACTIVE
                        new_status: BLOCKED
                        previous_value: null
                        new_value: null
                        changed_fields: []
                        metadata: null
                        mentioned_emails: []
                        created_at: '2025-06-15T10:30:00Z'
                    created_at: '2025-06-01T08:00:00Z'
                    updated_at: '2025-06-15T10:30:00Z'
        '400':
          description: >-
            Отсутствует или недействителен `status`, либо `reason` превышает
            1000 символов.
          content:
            application/json:
              examples:
                Missing status:
                  value:
                    status:
                      - This field is required.
                Bad status:
                  value:
                    status:
                      - >-
                        Invalid status. Valid options are: ACTIVE, FLAGGED,
                        BLOCKED
                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/update-status/'
            \
              -H 'x-api-key: YOUR_API_KEY' \
              -H 'Content-Type: application/json' \
              -d '{"status": "BLOCKED"}'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.users.update_status(
                "user-123",
                status="ACTIVE",
            )
            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.updateStatus("user-123", {
              status: "ACTIVE",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Users.UpdateStatus(ctx, \"user-123\", didit.UsersUpdateStatusParams{\n\tStatus: \"ACTIVE\",\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.EntityStatusUpdateRequest;

            import me.didit.types.UsersUpdateStatusParams;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result = client.users().updateStatus("user-123",
            UsersUpdateStatusParams.builder()
                    .status(EntityStatusUpdateRequest.Status.of("ACTIVE"))
                    .build());
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->users->updateStatus('user-123', [
                'status' => 'ACTIVE',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.users.update_status(
              "user-123",
              status: "ACTIVE"
            )
            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.UpdateStatusAsync("user-123", new
            UsersUpdateStatusParams

            {
                Status = "ACTIVE",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    EntityStatusUpdateRequest:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Новый статус жизненного цикла. `BLOCKED` также добавляет
            `vendor_data` в системный список блокировки.
    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.