Перейти к содержимому
Справочник API Получить API-ключи

С чего начать · Глава 3

Тестовый и боевой режимы

Соберите и протестируйте всю интеграцию в тестовом режиме с имитацией результатов, а после верификации бизнеса переключитесь на боевой ключ.

3 мин чтения

Тестовый и боевой режимы: отличия

Тестовый Боевой
Префикс API-ключа sk_test_ sk_live_
Проверки Реальных проверок нет. Результат выбирается суффиксом external_id Реальные проверки документа, проверка присутствия, сверка селфи с документом и AML по желанию
Изображения Принимается любое изображение Нужны настоящий документ и настоящий человек
Данные документа Синтетический образец, из хранилища ничего не читается Данные документа человека
Вебхуки Отправляются так же, как в боевом режиме, с "env": "sandbox" "env": "live"
Месячный лимит Не ограничен, но учитывается в GET /usage → sandbox Лимит вашего тарифа
Когда доступно Сразу после регистрации После верификации бизнеса

Базовый URL у обоих одинаковый: https://kyc.goxost.net/api/v1. Окружение определяет ключ, и каждый ключ видит только своё окружение. Заявители, сессии, вебхук-эндпоинты и проверки в тестовом режиме отделены от боевого; ID из одного окружения в другом возвращает 404 not_found.

В панели эти режимы называются Тестовый и Боевой.

Выбор результата в тестовом режиме

С ключом sk_test_ решение зависит от того, чем заканчивается external_id заявителя. Суффикс читается при создании сессии.

external_id оканчивается на Решение decision_type reject_labels
что угодно другое (например, -green) GREEN null []
-expired RED retry DOC_EXPIRED
-mismatch RED final FACE_MISMATCH
-hold ON_HOLD null PEP_MATCH
-sanctions RED final SANCTIONS_MATCH
-duplicate RED final DUPLICATE
-underage RED final UNDERAGE
-age-unknown ON_HOLD null AGE_UNKNOWN
-recapture ON_HOLD null DOC_SCREEN_RECAPTURE
{ "external_id": "user-8812-hold" }

Примечания:

  • -age-unknown работает только в сценарии «только возраст» (Настройки → Проверки в панели); в остальных сценариях он даёт GREEN. В сценарии «только возраст» каждый результат содержит ещё и проверку age, а -sanctions и -duplicate дают GREEN, потому что AML и поиск дубликатов там не выполняются.
  • -duplicate в тестовом режиме не возвращает ID других заявителей.
  • -recapture имитирует изображение документа, не прошедшее проверку подлинности: добавляет проверку doc_fraud со статусом warn; в остальных тестовых результатах такой проверки нет.

Данные документа в тестовом режиме

В тестовом режиме GET /verifications/{id} возвращает в document.data синтетический образец документа: «ERIKSSON ANNA MARIA», паспорт L898902C3, страна UTO. Даты считаются относительно времени проверки. С -expired документ просрочен (is_expired: true); с -underage возраст — 16 лет. В сценариях «только возраст» document.data равно null, как и в боевом режиме.

Проверьте в тестовом режиме каждую ветку кода: GREEN, RED с retry, RED с final и ON_HOLD с последующей ручной проверкой. Тестовый ON_HOLD можно решить через POST /verifications/{id}/review или в панели и получить verification.reviewed.

Совет

Direct API в тестовом режиме

С ключом sk_test_ Direct API не выполняет реальных проверок: каждая проверка возвращает имитированный pass с баллом 0.99, а проверка документа — тот же синтетический образец. Вызовы не ограничены, но учитываются.

Переход в боевой режим

Тестовый режим доступен сразу после регистрации. Боевой режим — создание ключей sk_live_, боевой API и боевое окружение в панели — открывается после двух шагов в панели:

  1. Профиль бизнеса. Тип бизнеса (company, entrepreneur или individual), юридическое название, регистрационный номер (для физлиц необязателен), страна, сайт, название и описание проекта, сфера применения и цель проверки по умолчанию. Справки и публичная страница проверки показывают из этого профиля, какой бизнес и проект провёл проверку и с какой целью.
  2. Личность владельца. Владелец аккаунта проходит обычную KYC-проверку. GREEN верифицирует аккаунт; ON_HOLD рассматривают сотрудники GOXOST; после RED можно попробовать снова (всего 3 попытки).

Пока оба шага не пройдены, любой запрос с ключом sk_live_ возвращает:

{
  "error": {
    "code": "tenant_not_verified",
    "message": "Live mode opens after your business profile and owner identity are verified.",
    "request_id": "req_01m6yyj5gq0x3c7d2n8v5kp4rt"
  }
}

с HTTP-статусом 403. Если позже вы измените юридическое название, регистрационный номер или тип бизнеса, боевой режим продолжит работать, но профиль будет отмечен для повторной проверки.

Лимиты и бесплатный тариф

Бесплатный тариф включает 100 боевых проверок в месяц. Единица резервируется при создании сессии и возвращается, если сессия истекла неиспользованной, заменена новой сессией или заявитель сброшен либо удалён до отправки. У отдельной AML-проверки и вызовов Direct API свои месячные счётчики с тем же лимитом. Когда лимит боевого режима исчерпан, API возвращает 429 plan_limit_reached.

Проверить счётчики можно через GET /usage:

{
  "period": "2026-11",
  "plan": "free",
  "limit": 100,
  "live": { "verifications": 12, "aml_checks": 0, "direct_checks": 0 },
  "sandbox": { "verifications": 51, "aml_checks": 0, "direct_checks": 7 },
  "core_url": "https://…/v1"
}

core_url — базовый URL для вызовов Direct API.