> ## 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: сущность KYB > Обновление изменяемых полей Didit Business (KYB): отображаемое имя, метаданные, теги. Поля, взятые из реестра, изменить нельзя. Оплата за вызов. Промпт для обновления бизнеса Скопировать промпт в буфер обмена \

\`Goal: Partial-update a Didit Business (KYB) entity by vendor_data.

Endpoint: PATCH https://verification.didit.me/v3/businesses/{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; counters and session history are left alone):
\- display_name (string, nullable)
\- legal_name (string, nullable)
\- registration_number (string, nullable)
\- country_code (string, nullable) — ISO 3166-1 alpha-2.
\- region (string, nullable) — ISO 3166-2.
\- status (enum) — "ACTIVE" | "FLAGGED" | "BLOCKED" (VendorBusinessStatusChoices). Setting "BLOCKED" auto-adds vendor_data to the system blocklist.
\- metadata (object, nullable) — REPLACES existing metadata wholesale; merge client-side if you only want to add keys.
\- 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 this update actually changes status. Webhooks do not carry it.

curl:
curl -X PATCH 'https://verification.didit.me/v3/businesses/company-123/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"display_name": "Acme", "metadata": {"tier": "enterprise"}}'

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

Side effects:
\- Every edit is recorded in the company's activity (actor derived from the API key): a status change with reason, and a profile update when display_name, legal_name, registration_number, country_code or metadata change.
\- last_activity_at bumped to now().
\- Re-sending an unchanged body is safe.

Failure modes:
\- 400 — validation. Common: { "status": ["Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED"] }, { "metadata": ["Metadata must be a JSON object."] }
\{ "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.
\- 429 — rate-limited.

Notes:
\- vendor_data in the URL cannot be changed via this endpoint.
\- For status-only flips, prefer the dedicated PATCH /v3/businesses/{vendor_data}/update-status/.
\- Overriding registry-derived fields is allowed but flagged in the audit log.

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

\
Вставьте в ## ОбзорОбновляет изменяемые поля [сущности Business](https://docs.didit.me/ru/entities/businesses/overview.md). Поля, заполняемые из данных реестра (`legal_name`, `registration_number`, `country_code`), становятся доступными только для чтения после первой одобренной сессии Верификации бизнеса (KYB).## Когда использовать- **Переименовать**: задайте более понятный `display_name` для внутренних представлений. - **Обновить метаданные**: переведите бизнес между внутренними уровнями, добавьте внутреннюю заметку или измените теги. - **Переопределить данные реестра** (с осторожностью): переопределение принимается, но отмечается в [журнале аудита](https://docs.didit.me/ru/console/audit-logs.md).## Примечания- `vendor_data` в URL нельзя изменить через этот endpoint. - Отправляет webhook `business.data.updated` с массивом `changed_fields`. - Каждое изменение записывается в раздел **Активность** компании в Business Console. Изменение `status` записывается с необязательным `reason` (до 1000 символов), а изменение `display_name`, `legal_name`, `registration_number`, `country_code` или `metadata` записывается как обновление профиля. Webhook `business.status.updated` не содержит `reason`.## РазрешенияОсновной секрет и [API-ключи](https://docs.didit.me/ru/console/api-keys.md) с полным доступом всегда могут вызывать этот endpoint. Ключу с настраиваемым доступом нужно разрешение на запись для **Компании** (`businesses`). Ключ, ограниченный отдельными сценариями или только одобренными сессиями, не может обращаться к этому endpoint.[Роли и разрешения](https://docs.didit.me/ru/console/roles-permissions.md) в Console определяют, что участник команды может делать в Console. Для запросов с API-ключами они не проверяются.## Связанные материалы- [Операции с бизнесом](https://docs.didit.me/ru/entities/businesses/operations.md) - [Модель данных](https://docs.didit.me/ru/entities/businesses/data-model.md) - [Обновление статуса](https://docs.didit.me/ru/management-api/businesses/update-status.md) ## OpenAPI ````yaml ru/openapi-25.json PATCH /v3/businesses/{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/businesses/{vendor_data}/: patch: tags: - Businesses summary: Обновить компанию description: >- Частичное обновление компании: `display_name`, `legal_name`, `registration_number`, `country_code`, `status`, `metadata`. `metadata` заменяется полностью. Установка `status` в значение `BLOCKED` добавляет `vendor_data` в системный список блокировки; изменение со статуса `BLOCKED` удаляет эту запись. Каждое изменение фиксируется в активности компании: смена статуса с опциональным указанием `reason`, а изменение `display_name`, `legal_name`, `registration_number`, `country_code` или `metadata` как обновление профиля. operationId: update_business parameters: - name: vendor_data in: path required: true schema: type: string description: >- Ваш уникальный идентификатор компании (произвольная строка, НЕ UUID). example: company-123 requestBody: required: true content: application/json: schema: type: object description: >- Тело частичного обновления. Передавайте только те поля, которые хотите изменить. properties: display_name: type: string nullable: true description: >- Понятное отображаемое имя, показываемое в консоли (имеет приоритет над `legal_name` при отображении в интерфейсе). 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`). status: type: string enum: - ACTIVE - FLAGGED - BLOCKED description: >- Статус жизненного цикла компании. Установка значения `BLOCKED` автоматически добавляет `vendor_data` в системный список блокировки; смена со статуса `BLOCKED` удаляет эту запись из списка блокировки. metadata: type: object nullable: true description: >- Произвольный JSON-объект, прикрепляемый к компании. **Полностью заменяет** существующие метаданные при обновлении — объединяйте на стороне клиента, если нужно лишь добавить ключи. reason: type: string nullable: true maxLength: 1000 description: >- Причина изменения статуса. Записывается в записи об изменении статуса в разделе **Activity** компании в Business Console, только когда статус действительно меняется. В webhook не передается. examples: Update name: summary: Обновить отображаемое имя value: display_name: Acme Corp Flag for review: summary: Переключить статус value: status: FLAGGED Add metadata: summary: Заменить JSON метаданных value: metadata: industry: fintech risk_level: low Fix registry data: summary: Скорректировать извлечённые поля value: legal_name: Acme Trading International Ltd registration_number: '12345678' country_code: GB Flag with reason: summary: Пометить компанию и зафиксировать причину value: status: FLAGGED reason: Ownership structure under review responses: '200': description: Компания обновлена. Возвращается полная обновлённая запись компании. content: application/json: schema: $ref: '#/components/schemas/BusinessDetailItem' examples: Updated: value: didit_internal_id: a1b2c3d4-e5f6-4890-abcd-ef1234567890 vendor_data: company-123 display_name: Acme Corp legal_name: Acme Trading Ltd registration_number: '12345678' country_code: GB effective_name: Acme Corp status: FLAGGED 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 risk_level: low updated_at: '2026-03-15T10:30:00Z' '400': description: >- Недопустимое тело запроса: обычно неизвестный `status`, некорректные `metadata` или `reason` длиннее 1000 символов. content: application/json: examples: Bad status: value: status: - >- Invalid status. Valid options are: ACTIVE, FLAGGED, BLOCKED Bad metadata: value: metadata: - Metadata must be a JSON object. 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/' \ -H 'x-api-key: YOUR_API_KEY' \ -H 'Content-Type: application/json' \ -d '{"display_name": "Acme Corp", "status": "FLAGGED"}' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY. client = Didit() result = client.businesses.update( "company-123", display_name="Acme Corp", ) 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.update("company-123", { display_name: "Acme Corp", }); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Businesses.Update(ctx, \"company-123\", didit.BusinessesUpdateParams{\n\tDisplayName: didit.String(\"Acme Corp\"),\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.BusinessesUpdateParams; // Reads DIDIT_API_KEY. Didit client = new Didit(); var result = client.businesses().update("company-123", BusinessesUpdateParams.builder() .displayName("Acme Corp") .build()); System.out.println(result); - lang: php label: PHP source: |- businesses->update('company-123', [ 'display_name' => 'Acme Corp', ]); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY. didit = Didit::Client.new result = didit.businesses.update( "company-123", display_name: "Acme Corp" ) 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.UpdateAsync("company-123", new BusinessesUpdateParams { DisplayName = "Acme Corp", }); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: 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.