Установка
Требования: WordPress 6.0+, PHP 7.4+. WooCommerce — по желанию.
- Скачайте goxost-kyc-wordpress.zip.
- В WordPress откройте Плагины → Добавить новый плагин → Загрузить плагин, выберите zip-архив, нажмите Установить, затем Активировать.
- Откройте Настройки → GOXOST KYC.
Интерфейс плагина переведён на русский и узбекский и показывается на языке сайта. Ниже приведены русские названия, в скобках — английские.
Подключите аккаунт
Понадобятся API-ключ и адрес вебхука из панели GOXOST KYC (регистрация или вход).
- Создайте в панели API-ключ (см. Аутентификация). Начните с ключа
sk_test_…. - В настройках плагина вставьте его в поле Секретный ключ API (API secret key). Страница настроек показывает режим: Песочница для
sk_test_…, Боевой режим дляsk_live_…. - Скопируйте URL вебхука, указанный на странице настроек:
https://your-site.example/wp-json/goxost-kyc/v1/webhook
- В панели откройте Вебхуки → Добавить адрес, вставьте URL и выберите события. Рекомендуемые:
verification.completed,verification.on_hold,verification.reviewed,session.started,verification.submitted,applicant.reset,applicant.deleted,applicant.reverification_due(или просто Все события — остальные плагин игнорирует). Опцию Добавлять данные документа в событие «Результат готов» оставьте выключенной. - Скопируйте секрет
whsec_…(он показывается один раз) в поле Секрет подписи вебхука (Webhook signing secret). - Сохраните и нажмите Проверить подключение (Test connection). Должно появиться «Подключено» с вашим тарифом и периодом.
API-ключ и вебхук должны относиться к одному окружению: тестовый адрес — с ключом sk_test_…, боевой адрес — с ключом sk_live_…. События из другого окружения игнорируются.
Настройки
| Настройка | Описание |
|---|---|
| Секретный ключ API (API secret key) | sk_test_… или sk_live_…. Хранится в WordPress и никогда не передаётся в браузер |
| Базовый URL (Base URL) | https://kyc.goxost.net — меняйте, только если об этом попросит поддержка |
| Секрет подписи вебхука (Webhook signing secret) | Секрет whsec_… вашего адреса вебхука |
| Ключ сценария (flow) (Flow key) | Необязательно. Если пусто, используется сценарий вашего аккаунта по умолчанию. Сценарий закрепляется при первом создании заявителя для пользователя |
| Язык (Language) | Автоматически (язык сайта), узбекский, русский или английский |
| Страница проверки (Verification page) | Страница с шорткодом или блоком. Используется в ссылках, например в уведомлении при оформлении заказа |
| WooCommerce | Требовать проверку перед оформлением заказа (Require verification before checkout) |
| Удаление (Uninstall) | Удалять данные при удалении плагина — удаляет статус проверки и ID, сохранённые у пользователей |
Добавьте страницу проверки
Создайте страницу и добавьте блок Проверка GOXOST KYC (goxost-kyc/verification) или шорткод:
[goxost_kyc]
Необязательные атрибуты переопределяют настройки плагина для этой страницы:
[goxost_kyc flow="basic-kyc" locale="ru"]
| Атрибут | Значения |
|---|---|
flow |
Ключ сценария из панели |
locale |
uz, ru, en |
Что видит посетитель:
- Не вошёл в систему — сообщение и кнопка Войти. Проверка привязана к аккаунту WordPress.
- Не проверен, проверка идёт или отклонена — текущий статус и кнопка Пройти проверку личности (или Попробовать снова). Проверка открывается на той же странице.
- После проверки — «Спасибо! Проверяем результат…», затем статус обновляется с сервера.
- На ручной проверке или проверен — только статус.
Каждый пользователь WordPress получает одного заявителя с external_id wp_<ID пользователя>, например wp_42. По этому идентификатору его можно найти в панели.
Оформление заказа WooCommerce
Если включено Требовать проверку перед оформлением заказа, покупатель без статуса GREEN видит на странице оформления уведомление со ссылкой на страницу проверки и не может оформить заказ. Работает и с классическим оформлением, и с блоком оформления заказа. Гостей сначала просят войти.
Где хранится статус
Плагин хранит в метаданных пользователя только идентификаторы, решение и время — никогда имена, данные документа или изображения.
| Ключ метаданных | Значение |
|---|---|
goxost_kyc_status |
GREEN, RED, ON_HOLD или pending; пусто, если пользователь не начинал |
goxost_kyc_applicant_id |
apl_… |
goxost_kyc_verification_id |
ver_… последнего решения |
goxost_kyc_decided_at |
Время решения, ISO 8601 UTC |
Статус меняется только через подписанный вебхук или чтение из API: applicant.reset и окончание срока действия GREEN сбрасывают решение, applicant.deleted удаляет всё.
В разделе Пользователи колонка KYC показывает статус каждого пользователя. В профиле пользователя есть раздел Проверка личности (GOXOST KYC); администраторы видят также идентификаторы и кнопку Обновить из API.
Хуки для разработчиков
Проверка статуса в шаблонах или своём коде:
if ( goxost_kyc_is_verified() ) { // current user
// show verified content
}
if ( goxost_kyc_is_verified( $user_id ) ) { // any user
// ...
}
goxost_kyc_is_verified( $user_id = null ) читает сохранённый статус и никогда не обращается к API, поэтому его можно вызывать где угодно.
Реакция на решение:
add_action( 'goxost_kyc_decision', function ( $user_id, $decision, $payload ) {
// $decision: GREEN, RED or ON_HOLD
// $payload: the webhook event (id, type, created_at, env, data) without document data
if ( 'GREEN' === $decision ) {
( new WP_User( $user_id ) )->add_role( 'verified_customer' );
}
}, 10, 3 );
Изменение данных, отправляемых при создании заявителя:
add_filter( 'goxost_kyc_applicant_data', function ( $payload, $user_id ) {
$payload['purpose'] = 'Age check for alcohol orders';
$payload['metadata'] = [ 'plan' => 'gold' ];
return $payload;
}, 10, 2 );
Не добавляйте персональные данные в metadata — API отклоняет email и телефон, а metadata не должна содержать персональных данных. Не меняйте external_id: по нему вебхуки сопоставляются с пользователями.