> ## 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 (KYB). Статус применяется к будущим KYB-сессиям и скринингу транзакций. Оплата за вызов.



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



      
      

\<pre>

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

Endpoint: PATCH https://verification.didit.me/v3/businesses/{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" (VendorBusinessStatusChoices, NOT the session enum).
\- reason (string, optional, max 1000): why the status changed. Recorded on the status-change entry in the company's Activity in the Business Console, only when the status actually changes. Webhooks do not carry it.

Status semantics:
\- ACTIVE  → normal. New KYB 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 KYB session creations for the same identifier are rejected. Flipping back to ACTIVE/FLAGGED removes the blocklist entry automatically.

curl:
curl -X PATCH 'https://verification.didit.me/v3/businesses/company-123/update-status/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"status": "BLOCKED", "reason": "Registry shows the company dissolved"}'

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

Side effects:
\- Toggles the system blocklist entry when entering/leaving BLOCKED.
\- Writes one status-change entry to the company's activity (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.
\- 403: a scoped API key without businesses write. { "detail": "This API key has no write access to companies." }
\- 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>



      
      

Вставьте в

## ОбзорПереводит [сущность «компания»](https://docs.didit.me/ru/entities/businesses/overview.md) между статусами `ACTIVE`, `FLAGGED` и `BLOCKED`. Полную схему состояний см. в разделе [жизненный цикл сущности](https://docs.didit.me/ru/entities/lifecycle.md).## Когда использовать- **Заблокировать** компанию, попавшую под санкции, или компанию с подтверждённым мошенничеством.
- **Пометить** компанию, которая ожидает ручной проверки.
- **Разблокировать** компанию после устранения нарушений.
- **Передавать внешние сигналы** из ваших собственных систем комплаенса.## Примечания- Допустимые значения: `ACTIVE`, `FLAGGED`, `BLOCKED`.
- Можно передать необязательный параметр `reason` (до 1000 символов), чтобы зафиксировать причину изменения статуса.
  Didit сохраняет его в записи об изменении статуса в разделе **Активность** карточки компании в Business Console.
  Причина записывается только тогда, когда статус действительно меняется.
- Для компаний со статусом `BLOCKED` все новые сессии Верификации бизнеса (KYB) автоматически отклоняются, и все новые транзакции тоже автоматически отклоняются, в том числе когда компания выступает контрагентом.
- Отправляет событие `business.status.updated` с полями `previous_status` и `status`.
  Webhook не передаёт `reason`.## Применение статусов| Статус | Новые сессии Верификации бизнеса (KYB) | Транзакции с участием этой компании |
| - | - | - |
| `ACTIVE` | Обычный поток | Обычный поток |
| `FLAGGED` | Направляется в `IN_REVIEW` | Могут автоматически эскалироваться по правилам |
| `BLOCKED` | Автоматически отклоняется | Автоматически отклоняется |## РазрешенияОсновной секрет и [API-ключи](https://docs.didit.me/ru/console/api-keys.md) с полным доступом всегда могут вызывать этот endpoint.
Для API-ключа с настраиваемым доступом нужно разрешение на запись для **Компании** (`businesses`).
API-ключ, ограниченный некоторыми сценариями или одобренными сессиями, не может обратиться к этому 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/businesses/blocklist.md)
- [Webhook для сущностей](https://docs.didit.me/ru/entities/webhooks.md)


## OpenAPI

````yaml ru/openapi-25.json PATCH /v3/businesses/{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/businesses/{vendor_data}/update-status/:
    patch:
      tags:
        - Businesses
      summary: Обновить статус компании
      description: >-
        Переключает только жизненный цикл `status` компании: `ACTIVE`, `FLAGGED`
        или `BLOCKED` (не статусы сессии). `BLOCKED` добавляет `vendor_data` в
        системный список блокировки; выход из `BLOCKED` удаляет эту запись.
        Каждое изменение фиксируется в журнале активности компании с
        необязательным `reason`. Отправка текущего статуса ничего не меняет и не
        записывает `reason`. Webhook `business.status.updated` не содержит
        `reason`.
      operationId: update_business_status
      parameters:
        - name: vendor_data
          in: path
          required: true
          schema:
            type: string
          description: >-
            Ваш уникальный идентификатор компании (произвольная строка, НЕ
            UUID).
          example: company-123
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/EntityStatusUpdateRequest'
                - type: object
                  properties:
                    reason:
                      type: string
                      nullable: true
                      maxLength: 1000
                      description: >-
                        Причина изменения статуса. Записывается в записи об
                        изменении статуса в разделе **Activity** компании в
                        Business Console, только когда статус действительно
                        меняется. В webhook не передается.
            examples:
              Flag:
                summary: Пометить компанию для проверки
                value:
                  status: FLAGGED
              Block:
                summary: >-
                  Заблокировать компанию (добавляет в системный список
                  блокировки)
                value:
                  status: BLOCKED
              Reactivate:
                summary: Повторно активировать компанию
                value:
                  status: ACTIVE
              Block with reason:
                summary: Заблокировать компанию и указать причину
                value:
                  status: BLOCKED
                  reason: Registry shows the company dissolved
      responses:
        '200':
          description: Статус компании обновлён. Возвращается полная запись компании.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessDetailItem'
              examples:
                Blocked:
                  value:
                    didit_internal_id: a1b2c3d4-e5f6-4890-abcd-ef1234567890
                    vendor_data: company-123
                    display_name: null
                    legal_name: Acme Trading Ltd
                    registration_number: '12345678'
                    country_code: GB
                    effective_name: Acme Trading Ltd
                    status: BLOCKED
                    session_count: 2
                    approved_count: 1
                    declined_count: 0
                    in_review_count: 1
                    features:
                      KYB: Approved
                    features_list:
                      - feature: KYB
                        status: Approved
                    last_session_at: '2026-03-15T10:30:00Z'
                    last_activity_at: '2026-03-15T10:30:00Z'
                    first_session_at: '2026-01-10T08:00:00Z'
                    tags:
                      - uuid: 9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d
                        name: VIP
                        color: '#2567FF'
                    created_at: '2026-01-10T08:00:00Z'
                    metadata:
                      industry: fintech
                    updated_at: '2026-03-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.
        '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 PATCH
            'https://verification.didit.me/v3/businesses/company-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.businesses.update_status(
                "company-123",
                status="FLAGGED",
            )
            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.businesses.updateStatus("company-123", {
              status: "FLAGGED",
            });
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.UpdateStatus(ctx, \"company-123\", didit.BusinessesUpdateStatusParams{\n\tStatus: \"FLAGGED\",\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.BusinessesUpdateStatusParams;

            import me.didit.types.EntityStatusUpdateRequest;


            // Reads DIDIT_API_KEY.

            Didit client = new Didit();


            var result = client.businesses().updateStatus("company-123",
            BusinessesUpdateStatusParams.builder()
                    .status(EntityStatusUpdateRequest.Status.of("FLAGGED"))
                    .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->businesses->updateStatus('company-123', [
                'status' => 'FLAGGED',
            ]);
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.businesses.update_status(
              "company-123",
              status: "FLAGGED"
            )
            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.Businesses.UpdateStatusAsync("company-123", new
            BusinessesUpdateStatusParams

            {
                Status = "FLAGGED",
            });

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    EntityStatusUpdateRequest:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Новый статус жизненного цикла. `BLOCKED` также добавляет
            `vendor_data` в системный список блокировки.
    BusinessDetailItem:
      type: object
      description: >-
        Полные сведения о компании. Расширяет BusinessListItem метаданными и
        updated_at.
      allOf:
        - $ref: '#/components/schemas/BusinessListItem'
        - type: object
          properties:
            metadata:
              type: object
              description: >-
                JSON с пользовательскими метаданными, прикреплённый вами к этой
                компании. По умолчанию `{}`.
            updated_at:
              type: string
              format: date-time
    BusinessListItem:
      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: Пользовательское отображаемое имя, заданное вами
        legal_name:
          type: string
          nullable: true
          description: Официальное юридическое наименование из реестра или ручного ввода
        registration_number:
          type: string
          nullable: true
          description: Регистрационный номер или номер инкорпорации компании
        country_code:
          type: string
          nullable: true
          description: Страна инкорпорации (ISO 3166-1 alpha-2, например, `GB`, `US`).
        effective_name:
          type: string
          nullable: true
          description: 'Наиболее подходящее имя: display_name, если задано, иначе legal_name'
        status:
          type: string
          enum:
            - ACTIVE
            - FLAGGED
            - BLOCKED
          description: >-
            Статус жизненного цикла записи компании (НЕ статус сессии). `ACTIVE`
            используется по умолчанию, `FLAGGED` помечает её для ручной
            проверки, `BLOCKED` запрещает новые сессии для этого `vendor_data`.
        session_count:
          type: integer
          description: Общее количество сессий верификации для этой компании
        approved_count:
          type: integer
          description: Количество одобренных сессий
        declined_count:
          type: integer
          description: Количество отклонённых сессий
        in_review_count:
          type: integer
          description: Количество сессий на проверке
        features:
          type: object
          description: >-
            Агрегированный статус по функциям среди всех KYB-сессий этой
            компании. В настоящее время единственным ключом является `KYB`
            (статус проверки компании по реестру). Возможные значения:
            `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.