Skip to Content
KnowaKYC
Tenant API (KYC)

Flows (verification scenarios)

A verification scenario (flow) defines the set, order, and parameters of the steps that a user goes through during KYC. Flows are created and edited in the admin panel (visual flow editor, templates, version management).

Using flows in the Tenant API

When you create a verification link, include flow_id in the request body:

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://example.com/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"  }}

You can obtain available flow identifiers in two ways:

  • In the admin panel, Flows section.
  • Through the Admin API (if you need automation).

Flow execution happens on the KnowaKYC side. Once the link is created, the user opens it and goes through every flow step on the KnowaKYC verification page.

Flow structure

Every flow includes the following components:

  • Verification steps — the set of stages a user completes. Document liveness and face liveness are bundled inside the document and selfie steps respectively.
  • Transition rules — define the order in which steps run.
  • Parameters — document requirements, check settings, webhook configuration.
  • Branding — visual styling: colour palette, logo, UI copy.

For detailed verification-link handling, see Verification links.

On this page