sumsub.php¶

В этой статье

Методы API

sumsub/check

sumsub/get_token

sumsub/send_request

Интеграция с сервисом Sumsub KYC для управления верификацией пользователей и отправки приглашений на прохождение проверки.

Методы API¶

Метод	Действие	Описание
`check`	проверка статуса	Выполняет проверку статуса верификации через Sumsub API (тестовый режим).
`get_token`	получение токена	Запрашивает временный access token для работы с Sumsub SDK.
`send_request`	отправка приглашения на KYC	Отправляет пользователю ссылку на прохождение верификации Sumsub.

sumsub/check¶

Выполняет проверку статуса верификации через Sumsub API (тестовый режим).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: check
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/sumsub.php" -X POST \
--data "action=check" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "check",
"data": {
"status": "testCompleted"
}
}

Примеры ошибок

{
"code": -2,
"message": "$module: invalid token"
}

sumsub/get_token¶

Запрашивает временный access token для работы с Sumsub SDK.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_token`
email	✅	string	Электронная почта пользователя для получения токена Sumsub.
token	✅	string	Токен авторизации

Пример запроса

curl -s "https://invapi.hostkey.ru/sumsub.php" -X POST \
--data "action=get_token" \
--data "email=user@example.com" \
--data "token=HOSTKEY_TOKEN"

Пример успешного ответа

{
"result": "OK",
"action": "get_token",
"data": {
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
}

Примеры ошибок

{
"code": -2,
"message": "$module: invalid token"
}

sumsub/send_request¶

Отправляет пользователю ссылку на прохождение верификации Sumsub.

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `send_request`
token	✅	string	Токен авторизации
url	✅	string	Параметр url
user_id	❌	integer	Уникальный идентификатор пользователя для проверки соответствия данных.
email	❌	string	Адрес электронной почты пользователя для отправки приглашения на верификацию.

Пример запроса

curl -s "https://invapi.hostkey.ru/sumsub.php" -X POST \
--data "action=send_request" \
--data "token=VALUE" \
--data "url=VALUE" \
--data "user_id=123" \
--data "email=user@example.com"

Пример успешного ответа

{
"result": "OK",
"message": "KYC invite was sent to user@example.com."
}

Примеры ошибок

{
"code": -1,
"message": "$module: invalid email"
}