Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Hosted KYC sessions (Pattern B) let you trigger the customer’s identity verification without building any verification UI yourself. You create a session via the API; Vobiz sends the customer an email with a signed link (or returns a widget URL directly) and handles the entire verification flow on kyc.vobiz.ai. Two flow types are supported:
Flow typeHow it worksBest for
emailVobiz emails the customer a signed link from kyc@vobiz.aiAsync onboarding - customer completes at their convenience
redirectAPI returns a widget URL for you to redirect the customer to immediatelySynchronous onboarding embedded in your portal

​
Create a KYC session

POST /api/v1/sub-accounts/{sub_auth_id}/kyc-sessions
Authorization: Bearer {parent_jwt}
Content-Type: application/json

​
Request body

FieldTypeRequiredDescription
account_auth_idstringYesThe sub-account to run KYC for (same as {sub_auth_id} in the path)
flow_typestringYesemail or redirect
customer_emailstringConditionalRequired for flow_type: email - the address Vobiz will send the KYC link to
redirect_urlstringConditionalRequired for flow_type: redirect - your return URL after the customer completes verification
expires_in_daysintegerNoSession expiry in days (default: 30)

​
Email flow example

{
  "account_auth_id": "SA_xxxxxxxx",
  "flow_type": "email",
  "customer_email": "customer@example.com",
  "expires_in_days": 30
}
Response (201) 
{
  "session_id": "KYC_xxxxxxxxxxxxxxxx",
  "flow_type": "email",
  "status": "sent",
  "expires_at": "2025-06-24T10:30:00Z"
}
Vobiz sends the email from kyc@vobiz.ai. The customer clicks the link and completes verification on kyc.vobiz.ai. No further action is required from your side until the KYC status changes.

​
Redirect flow example

{
  "account_auth_id": "SA_xxxxxxxx",
  "flow_type": "redirect",
  "redirect_url": "https://partner.example.com/onboarding/kyc-complete",
  "expires_in_days": 7
}
Response (201) 
{
  "session_id": "KYC_xxxxxxxxxxxxxxxx",
  "flow_type": "redirect",
  "widget_url": "https://kyc.vobiz.ai/session/KYC_xxxxxxxxxxxxxxxx",
  "expires_at": "2025-06-01T10:30:00Z"
}
Redirect your customer to widget_url. After they complete verification, Vobiz redirects them to your redirect_url.

​
Customer experience

The customer sees the Vobiz-hosted KYC widget at kyc.vobiz.ai. They choose the verification method (PAN, GST, Aadhaar, etc.) and submit their documents. Vobiz processes the checks in real time and updates the sub-account’s kyc_calls_blocked status automatically.

​
Checking the result

After a session completes, check the sub-account’s KYC status: 
GET /api/v1/sub-accounts/{sub_auth_id}/kyc/status
Authorization: Bearer {parent_jwt}
When all required verifications pass, kyc_calls_blocked becomes false and the sub-account can make calls.

KYC Overview

kyc_mode setup and kyc_calls_blocked behaviour

Verification Methods

Direct API verification - PAN, GST, CIN, Aadhaar, DigiLocker

Test Mode

Test KYC sessions without real verification checks