---
title: "Create a hosted KYC session"
method: POST
path: "/api/v1/sub-accounts/{sub_auth_id}/kyc-sessions"
tags: ["Sub-Account KYC"]
---

# Create a hosted KYC session

`POST /api/v1/sub-accounts/{sub_auth_id}/kyc-sessions`

## Request

- Base URL: `https://api.vobiz.ai`
- URL: `https://api.vobiz.ai/api/v1/sub-accounts/{sub_auth_id}/kyc-sessions`
- Auth: API key in header `X-Auth-ID` and API key in header `X-Auth-Token`
- TypeScript: <https://skmtc.dev/vobiz/apis/vobiz-api/docs/api/v1/sub-accounts/:sub_auth_id/kyc-sessions/post.ts> (a function with typed inputs; its response is checked against the schema)

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](/partner/api/kyc-sessions) endpoint.

## Path parameters

- `sub_auth_id` string, required

## Request body

- object
  - `account_auth_id` string, required: The sub-account's auth_id (typically equal to the path `sub_auth_id`).
  - `flow_type` 'email' | 'redirect', required
  - `customer_email` string, email: Required when `flow_type` is `email`.
  - `redirect_url` string, uri: Required when `flow_type` is `redirect`. After verification the customer's browser is sent to this URL.
  - `webhook_url` string, uri: HTTPS endpoint VoBiz POSTs the KYC result to. Omit it and no callbacks are sent.
  - `expires_in_days` integer

## Response `201`

KYC session created

## Other responses

- `422`: Validation error (email flow missing `customer_email`, or redirect flow missing `redirect_url`)

---

[API](https://skmtc.dev/vobiz/apis/vobiz-api.md) - [All operations](https://skmtc.dev/vobiz/apis/vobiz-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vobiz/apis/vobiz-api/revisions/863f08cd6737?raw)