Initiate KYC session

Triggers VoBiz to email a KYC link to the customer. KYC is OTP-based (PAN + Aadhaar via DigiLocker for individuals, PAN + GSTIN for companies). No document uploads required.

post/api/v1/partner/kyc-sessions

Request body

account_auth_idstring required

Customer's auth_id (from create-customer-account).

flow_type'email' | 'redirect'

Delivery mode. email (default) emails the customer the KYC link. redirect returns a widget_url in the response for immediate redirect.

customer_emailstring email

Required when flow_type is email. Ignored otherwise.

redirect_urlstring uri

Required when flow_type is redirect. After verification the customer's browser is sent to this URL with query params session_id, status, auth_id.

webhook_urlstring uri

VoBiz POSTs the KYC result here.

expires_in_daysinteger

Days before the KYC link expires.

metadataobject

Free-form key/value object echoed back on GET and webhooks.

Example request

{
  "account_auth_id": "MA_ZKITB8Z2",
  "customer_email": "customer@example.com",
  "redirect_url": "https://yourapp.com/kyc-complete",
  "webhook_url": "https://yourapp.com/kyc-webhook",
  "expires_in_days": 14,
  "metadata": {
    "customer_ref": "TEST_001",
    "plan": "starter"
  }
}

Response

KYC session created

Changes

No recorded changes to this endpoint across all 1 revision of this API.