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

Обзор

Обновляет изменяемые поля сущности Business. Поля, заполняемые из данных реестра (legal_name, registration_number, country_code), становятся доступными только для чтения после первой одобренной сессии Верификации бизнеса (KYB).

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

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

Примечания

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

Тело частичного обновления. Передавайте только те поля, которые хотите изменить.

display_name
string | null

Понятное отображаемое имя, показываемое в консоли (имеет приоритет над legal_name при отображении в интерфейсе).

Официальное юридическое наименование из реестра или ручного ввода.

registration_number
string | null

Регистрационный номер или номер инкорпорации компании.

country_code
string | null

Страна инкорпорации (ISO 3166-1 alpha-2, например, GB, US).

status
enum<string>

Статус жизненного цикла компании. Установка значения BLOCKED автоматически добавляет vendor_data в системный список блокировки; смена со статуса BLOCKED удаляет эту запись из списка блокировки.

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

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

reason
string | null

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

Maximum string length: 1000

Ответ

Компания обновлена. Возвращается полная обновлённая запись компании.

Полные сведения о компании. Расширяет BusinessListItem метаданными и updated_at.

didit_internal_id
string<uuid>

Стабильный внутренний UUID Didit для этой компании.

vendor_data
string | null

Ваш уникальный идентификатор этой компании (передаётся при создании сессий). Может быть равен null, если идентификатор поставщика не был передан.

display_name
string | null

Пользовательское отображаемое имя, заданное вами

Официальное юридическое наименование из реестра или ручного ввода

registration_number
string | null

Регистрационный номер или номер инкорпорации компании

country_code
string | null

Страна инкорпорации (ISO 3166-1 alpha-2, например, GB, US).

effective_name
string | null

Наиболее подходящее имя: display_name, если задано, иначе legal_name

status
enum<string>

Статус жизненного цикла записи компании (НЕ статус сессии). ACTIVE используется по умолчанию, FLAGGED помечает её для ручной проверки, BLOCKED запрещает новые сессии для этого vendor_data.

Доступные опции:
ACTIVE,
FLAGGED,
BLOCKED
session_count
integer

Общее количество сессий верификации для этой компании

approved_count
integer

Количество одобренных сессий

declined_count
integer

Количество отклонённых сессий

in_review_count
integer

Количество сессий на проверке

features
object

Агрегированный статус по функциям среди всех KYB-сессий этой компании. В настоящее время единственным ключом является KYB (статус проверки компании по реестру). Возможные значения: 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[]

Теги, назначенные этой компании

created_at
string<date-time>
metadata
object

JSON с пользовательскими метаданными, прикреплённый вами к этой компании. По умолчанию {}.

updated_at
string<date-time>
Последнее изменение 7 ноября 2026 г.