Начало работы с GOXOST KYC
Регистрация, тестовый ключ, открытие боевого режима и выбор способа интеграции.
На этой странице
GOXOST KYC — сервис онлайн-подтверждения личности ваших клиентов. Вы направляете клиента на проверку, он фотографирует документ и делает селфи, а ваш сервер получает решение: GREEN (одобрено), RED (отклонено) или ON_HOLD (нужна ручная проверка).
1. Регистрация
- Создайте аккаунт на https://kyc.goxost.net/register и войдите в панель.
- Сразу после регистрации доступна Тестовая среда. Настоящие проверки в ней не проводятся — результат выбираете вы сами, поэтому можно спокойно отладить всю интеграцию.
2. Тестовый ключ
- В панели откройте раздел API-ключи и нажмите Создать ключ.
- Выберите Тестовую среду. Ключ начинается с
sk_test_. - Сразу скопируйте ключ — он показывается только один раз. Храните его в секретных настройках сервера.
Секретный ключ — только для вашего сервера. Никогда не размещайте его в браузере, мобильном приложении или публичном репозитории.
3. Открытие боевого режима
Боевая среда (ключи sk_live_ и настоящие проверки) открывается в панели после двух шагов:
- Профиль компании — тип бизнеса, юридическое название, регистрационный номер (для физлиц необязателен), страна, сайт, название и описание проекта, сфера применения и цель проверки по умолчанию. Эти данные указываются в справках о проверке.
- Личность владельца — владелец аккаунта проходит обычную проверку. При GREEN аккаунт подтверждается; ON_HOLD рассматривают сотрудники GOXOST; после RED можно попробовать снова (всего 3 попытки).
Пока оба шага не пройдены, любой запрос с ключом sk_live_ возвращает ошибку 403 tenant_not_verified.
4. Способ интеграции
Все способы используют один и тот же API и вебхуки:
| Способ | Для чего |
|---|---|
| Ссылка (hosted-страница) | Самый быстрый старт: ссылка в письме, SMS, чате или QR-коде |
Веб-SDK (kyc.js) |
Чтобы клиент оставался на вашем сайте |
| Flutter SDK | Приложения для Android и iOS |
| Плагин WordPress | Сайты на WordPress |
| Direct API | Собственный интерфейс съёмки или проверка изображений, которые уже есть у вас |
Как это работает
- Ваш сервер создаёт заявителя (
POST /applicants). - Создаёт для него сессию и получает одноразовую ссылку (
url) иtoken. - Клиент проходит проверку.
- GOXOST KYC отправляет вебхук на ваш сервер.
- Ваш сервер читает решение через
GET /verifications/{id}.
Окончательное решение всегда принимайте на сервере — по вебхуку или через API. Результат в браузере или приложении нужен только для удобства пользователя.
Документация
Полное руководство, примеры кода и справочник API: https://kyc.goxost.net/docs. Начните с главы «Быстрый старт» — первая проверка в тестовой среде за пять шагов.