Справочник API
Операции API verkyc
Справочник собран из контракта OpenAPI той же версии, что работает на сервере. Для каждой операции указаны метод, путь, области доступа ключа, параметры, тело запроса и ответы.
Версия контракта1.1.0OpenAPI 3.1.1
Как устроены запросы
Запросы подписываются ключом API в заголовке Authorization: Bearer. Ключ имеет среду (тестовая или рабочая) и области доступа.
Операции создания и изменения требуют заголовка Idempotency-Key длиной от 16 до 128 символов.
Ошибки возвращаются в формате application/problem+json с машинным кодом и признаком повтора.
Начало проверки
Контексты обработки
Цель, основание и регион обработки, в которых создаются заявители и дела.
Операции: 1Заявители
Физические лица и компании, которых вы проверяете.
Операции: 4Дела
Проверка заявителя: создание, отправка, сессии, ссылки, проверки, граф владения, отчеты и решения.
Операции: 32Ссылки на проверку
Управление ссылками на страницу проверки.
Операции: 1Сессии
Сессии заявителя в виджете и приложении.
Операции: 1
Результаты и отчеты
Проверки
Отдельные проверки дела с исходами, причинами и доказательствами.
Операции: 3Решения
Решения политики по делу и оценка риска.
Операции: 2Доказательства
Материалы проверки: метаданные, просмотр с маскированием, скачивание.
Операции: 3Отчеты
Подписанные отчеты, их конверт и файлы.
Операции: 3Проверка отчетов
Открытые ключи подписи и проверка подлинности отчета по ссылке без ключа API.
Операции: 2
Разбор и одобрения
Ручной разбор
Очередь разбора, экспертиза документов и решения сотрудников.
Операции: 10Апелляции
Апелляции заявителей и решения по ним.
Операции: 4Одобрения
Одобрение изменений вторым сотрудником.
Операции: 3Оповещения
Оповещения мониторинга и их разбор.
Операции: 2Исключения риска
Ограниченные исключения из правил с владельцем и сроком.
Операции: 4
Покажем на ваших сценариях
Расскажите, кого и где нужно проверять. Подготовим демонстрацию, тестовый доступ к API и расчет стоимости.