К содержимому
OneKYC
Админ-панель

Ссылки верификации

Обновлено:

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

Создание ссылки

Для создания новой ссылки верификации нажмите «Создать ссылку» и укажите следующие параметры:

  • Флоу — сценарий верификации, по которому будет создана сессия при переходе по ссылке.
  • Срок действия — временной интервал, в течение которого ссылка остаётся активной. По истечении срока ссылка становится недействительной.
  • Внешний ID пользователя (необязательно) — идентификатор пользователя в вашей системе (external_user_id) для привязки сессии к конкретному аппликанту.
  • Локаль (необязательно) — языковые параметры интерфейса верификации.
  • Redirect URL (необязательно) — адрес для перенаправления пользователя после завершения верификации (например, https://myapp.com/dashboard).

После создания система генерирует:

  • URL ссылки — полный адрес с токеном для передачи пользователю.
  • Короткий код — при необходимости используется для альтернативного доступа.

Сформированную ссылку можно направить пользователю любым удобным способом: электронная почта, SMS, личный кабинет вашего приложения.

Redirect URL

Параметр redirect_url определяет адрес, на который пользователь будет перенаправлен после завершения верификации. Поведение экрана завершения (кнопка перехода или автоматический редирект) настраивается в параметрах сценария — см. Флоу — настройки редиректа.

Если redirect_url не указан, экран завершения отображается без элементов перенаправления.

Создание через API

Ссылки верификации доступны для программного создания через Tenant API, что позволяет интегрировать выдачу ссылок в бизнес-процессы вашего приложения (например, из CRM-системы):

POST
/v1/kyc/verification-links

Authorization

ApiKeyAuth
headerAuthorization<token>

HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.

Header Parameters

X-Timestamp*string

Unix timestamp (seconds, max 5 min drift)

Request Body

Link options (flow_id required)

application/json
  1. body
expires_in?integer

seconds

external_reference?string
external_user_id?string
flow_id?string
locale?string
metadata?
prefilled?
redirect_url?string
utm_campaign?string
utm_medium?string
utm_source?string

Response Body

Created or reused link

application/json
  1. response
data?
success?boolean
Example Request
curl -X POST 'https://api.onekyc.io/tenant/v1/kyc/verification-links' \  -H 'X-Timestamp: string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "success": true,  "data": {    "created_at": "string",    "delivery_eligible": true,    "expires_at": "string",    "external_reference": "string",    "external_user_id": "string",    "flow_id": "string",    "id": "string",    "link_url": "string",    "locale": "string",    "qr_code_url": "string",    "redirect_url": "string",    "reuse_reason": "external_reference",    "reused": true,    "session_id": "string",    "session_resumable": true,    "session_status": "string",    "short_url": "string",    "status": "string",    "url": "string",    "verification_link": "string",    "verification_url": "string"  }}

Список ссылок

В реестре ссылок отображаются следующие данные:

ПолеОписание
IDУникальный идентификатор ссылки
ФлоуПривязанный сценарий верификации
СтатусАктивна, использована или отозвана
Срок действияДата и время истечения ссылки
Дата созданияДата и время генерации ссылки

При переходе к детальному просмотру ссылки доступны: полный URL, информация об использовании (дата, устройство — при наличии данных), привязанная сессия.

Отзыв ссылки

Для аннулирования ссылки (ошибка при создании, отмена верификации, изменение условий):

  1. Найдите ссылку в списке.
  2. Нажмите «Отозвать».
  3. Подтвердите действие.

После отзыва переход по ссылке не приводит к созданию сессии — пользователь получит уведомление о недействительности ссылки.

QR-код

Для каждой активной ссылки доступна генерация QR-кода. QR-код применяется в сценариях, когда пользователю необходимо продолжить верификацию на мобильном устройстве: отсканировав код камерой смартфона, пользователь переходит к интерфейсу верификации.

Генерация QR-кода доступна как в админ-панели, так и через Tenant API:

GET
/v1/kyc/verification-links/{id}/qr

Authorization

ApiKeyAuth
headerAuthorization<token>

HMAC-SHA256 Credential=<key_id>, Signature=<hex_signature>. SignedHeaders=x-timestamp is optional. Requires X-Timestamp header.

Path Parameters

id*string

Link UUID

Query Parameters

size?integer

QR size in pixels (1-1024, default 256)

Header Parameters

X-Timestamp*string

Unix timestamp (seconds, max 5 min drift)

Response Body

PNG image

response?unknownimage/png
Example Request
curl -X GET 'https://api.onekyc.io/tenant/v1/kyc/verification-links/string/qr' \  -H 'X-Timestamp: string'
Example Response
null

Дополнительные операции в админ-панели

Помимо стандартных действий (создание, отзыв, QR-код), админ-панель предоставляет следующие возможности:

  • Дублирование ссылки — создание копии существующей ссылки с теми же параметрами (флоу, срок действия, локаль), но новым токеном. Полезно для повторной отправки тем же пользователям с актуальным сроком жизни.
  • Массовые действия — одновременное выполнение действий (например, отзыв) над набором ссылок: отметьте нужные строки в таблице и выберите действие из контекстного меню.
  • Отправка ссылки по email / SMS — прямая отправка ссылки заявителю выбранным каналом из админ-панели (без необходимости копировать URL и формировать сообщение вручную). Канал зависит от настроек тенанта (наличие подключённого SMS-провайдера, корпоративного SMTP).

Вебхуки

Назад

Команда

Далее

На этой странице

Создание ссылкиRedirect URLСоздание через APIСписок ссылокОтзыв ссылкиQR-кодДополнительные операции в админ-панели