/v3/businesses/. Эта страница даёт концептуальный обзор. Полные схемы запросов и ответов см. в справочнике API.
Получить список компаний
GET /v3/businesses/
Постраничный список компаний вашего приложения с фильтрами по статусу, поиску, стране и диапазону дат.
Получить компанию
GET /v3/businesses/{vendor_data}/
Получите одну компанию по vendor_data.
Создать компанию
POST /v3/businesses/create/
Заранее создайте компанию до запуска любой сессии верификации бизнеса (KYB):
vendor_data уже существует, вернётся ошибка конфликта. Чтобы обновить существующую компанию, используйте PATCH.
Обновить компанию
PATCH /v3/businesses/{vendor_data}/
Обновите изменяемые поля профиля. Поля, полученные из реестра (legal_name, registration_number, country_code), доступны только для чтения после верификации, но их можно переопределить. Переопределения отмечаются в журнале аудита.
Изменяемые поля: display_name, metadata, tags.
Только для чтения после верификации: все поля, полученные из реестра, агрегированные счётчики и карта features.
business.data.updated.
Изменить статус
PATCH /v3/businesses/{vendor_data}/update-status/
Переведите компанию между статусами ACTIVE, FLAGGED и BLOCKED.
Генерирует событие
business.status.updated.
Удалить компании (пакетно)
POST /v3/businesses/delete/
Удаляет одну или несколько компаний. Записи о компаниях удаляются безвозвратно. Сессии верификации этим endpoint не затрагиваются: они сохраняются, но связь с компанией у них удаляется. Удалите их с помощью удаления сессии. Транзакции этим endpoint также не затрагиваются: удалите их в Console.
Модель разрешений
Все endpoint/v3/businesses/* ограничены ресурсом разрешений businesses:
См. роли и разрешения.
Webhook, которые срабатывают при этих операциях
Дальнейшие шаги
Модель данных
Полный справочник полей.
API списка
Схема GET /v3/businesses/.
API создания
Схема POST /v3/businesses/create/.