VOvobiz
Sub-Account KYC

Create a hosted KYC session

Creates a Vobiz-hosted KYC session for the sub-account. With flow_type=email (default) Vobiz emails the customer a signed link (from kyc@vobiz.ai, hosted at kyc.vobiz.ai) and customer_email is required. With flow_type=redirect, omit customer_email, pass a redirect_url, and the widget_url is returned directly for an inline redirect.

This is the sub-account–scoped equivalent of the partner-level KYC Sessions endpoint.

post/api/v1/sub-accounts/{sub_auth_id}/kyc-sessions

Request

Path parameters

sub_auth_idstring required
Example:SA_XXXXXX

The sub-account's Auth ID.

Request body

account_auth_idstring required

The sub-account's auth_id (typically equal to the path sub_auth_id).

flow_type'email' | 'redirect' required
customer_emailstring email

Required when flow_type is email.

redirect_urlstring uri

Required when flow_type is redirect. After verification the customer's browser is sent to this URL.

webhook_urlstring uri

HTTPS endpoint VoBiz POSTs the KYC result to. Omit it and no callbacks are sent.

expires_in_daysinteger

Example request

{
  "account_auth_id": "SA_XXXXXX",
  "customer_email": "customer@example.com",
  "redirect_url": "https://your-app.example.com/kyc/done",
  "webhook_url": "https://your-app.example.com/kyc/webhook",
  "expires_in_days": 30
}

Response

KYC session created

Changes

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