Проверка мерчанта и KYC
Как получить анкету мерчанта, провести KYC-проверку и вернуть решение.
Результат
Этот раздел нужен партнёрам, которые проверяют данные компании перед подключением платёжных или других регулируемых услуг.
Yario собирает согласованный набор данных и документов, фиксирует согласие на передачу и формирует анкету. Ваша система получает готовый снимок анкеты, проводит проверку и возвращает решение.
Раздел доступен только тогда, когда для подключения включён merchant_onboarding.
Как проходит проверка
- Yario собирает обязательные сведения и согласие мерчанта.
- В подключении появляется анкета со статусом
Submitted. - Ваша система получает уведомление
merchant_onboarding.application.createdили самостоятельно запрашивает список анкет. - Вы получаете актуальную анкету и переводите её в
UnderReview. - После проверки возвращаете один из результатов: запросить сведения, одобрить или отклонить.
- Если мерчант исправил данные, Yario обновляет снимок и отправляет уведомление
merchant_onboarding.application.updated.
Получите анкету
GET /v1/installations/{installationId}/merchant-onboarding/applications— список анкет от новых к старым;GET /v1/installations/{installationId}/merchant-onboarding/applications/{applicationId}— одна актуальная анкета.
Поле snapshot содержит согласованный профиль в формате JSON. Обычно в него входят сведения о компании, адресах, представителях, бенефициарах, банковских реквизитах, документах и согласии на передачу.
Точный состав данных определяется договором. Не делайте интеграцию зависимой от отсутствия новых необязательных полей — неизвестные поля нужно сохранять или пропускать без ошибки.
Верните результат проверки
Используйте PATCH, разрешение merchant_onboarding:write и новый ключ идемпотентности.
Запрос дополнительных данных
{
"status": "InformationRequired",
"review": {
"reasonCode": "director_id_unreadable",
"message": "Нужна читаемая цветная копия удостоверения личности директора.",
"requirements": [
{
"field": "representatives[0].identityDocument",
"message": "Загрузите документ повторно"
}
]
}
}
Положительное решение
{
"status": "Approved",
"review": {
"partnerMerchantId": "merchant-9921",
"decidedAt": "2026-07-16T08:30:00Z"
}
}
Поле review позволяет передать согласованные сведения о решении. Не помещайте в него пароли, API-ключи или данные, которых нет в утверждённом профиле обмена.
Допустимые состояния
| Текущее состояние | Что можно установить дальше |
|---|---|
Submitted | UnderReview, InformationRequired, Approved, Rejected |
UnderReview | InformationRequired, Approved, Rejected |
InformationRequired | UnderReview, InformationRequired, Approved, Rejected |
Approved | Решение окончательное |
Rejected | Решение окончательное |
Вернуть анкету в Submitted нельзя. Попытка изменить окончательное решение вернёт 409.
Защита персональных данных
- скачивайте документы только во время обработки;
- проверяйте HTTPS, размер, тип файла и контрольную сумму;
- предоставляйте доступ только сотрудникам и сервисам, которым он действительно нужен;
- не записывайте анкету, документы и ключи в обычные логи;
- соблюдайте согласованные сроки хранения и удаления.
Yario фиксирует передачу анкеты. Юридическая роль сторон, набор данных и сроки хранения определяются договором.
Как понять, что всё работает
В тестовой среде получите синтетическую анкету, переведите её в допустимое следующее состояние, верните структурированный результат и повторите тот же запрос с тем же ключом идемпотентности. Повтор не должен создать второе решение.
Навигация: начало работы · обзор API · уведомления от Yario · ошибки и повторы · тестирование