Флоу (сценарии верификации)

Сценарий верификации (флоу) определяет состав, порядок и параметры шагов, которые проходит пользователь в рамках KYC-процедуры. Создание и редактирование флоу осуществляется в административной панели (визуальный редактор флоу, шаблоны, управление версиями).

Использование флоу в Tenant API

При создании ссылки верификации в теле запроса указывается flow_id:

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

Request Body

Link options (flow_id required)

application/json

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

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 Request

curl -X POST 'https://api.onekyc.io/tenant/v1/kyc/verification-links' \  -H 'X-Timestamp: string' \  -H 'Content-Type: application/json' \  -d '{}'

Example ResponseSchema

{
  "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"
  }
}

{  "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"  }}

Идентификаторы доступных флоу можно получить следующими способами:

В административной панели в разделе Флоу.
Через Admin API (при необходимости автоматизации).

Выполнение сценария верификации происходит на стороне OneKYC. После создания ссылки пользователь переходит по ней и последовательно проходит все шаги флоу на странице верификации OneKYC.

Структура флоу

Каждый флоу включает следующие компоненты:

Шаги верификации — набор этапов, которые проходит пользователь. Document liveness и face liveness входят составной частью в шаги документа и селфи соответственно.
Правила переходов — определяют последовательность выполнения шагов.
Параметры — требования к документам, настройки проверок, конфигурация вебхуков.
Брендинг — визуальное оформление: цветовая палитра, логотип, тексты интерфейса.

Подробное описание работы со ссылками верификации приведено в разделе Ссылки верификации.

Флоу (сценарии верификации)

Использование флоу в Tenant APICopy Anchor Link

AuthorizationCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Структура флоуCopy Anchor Link

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