Creates a Vobiz-hosted KYC session for the sub-account. Instead of driving each verification step yourself, you hand the customer off to the Vobiz-hosted KYC widget.
Authenticate with your parent main account’sX-Auth-ID and X-Auth-Token - the same credentials used everywhere else in the API.
Flow types
flow_type
Behavior
Required field
email(default)
Vobiz emails the customer a signed link (from kyc@vobiz.ai, hosted at kyc.vobiz.ai). The session sits in email_sent until they open it.
customer_email
redirect
The response returns a widget_url directly - redirect the customer’s browser to it. No email is sent.
redirect_url
Body fields
Field
Type
Required
Description
account_auth_id
string
Yes
The sub-account’s auth_id (SA_…), normally equal to the {sub_auth_id} in the path.
flow_type
string
Yes
email (default) or redirect.
customer_email
string
Conditional
Required when flow_type is email. Where the signed link is sent.
redirect_url
string (URI)
Conditional
Required when flow_type is redirect. The customer is returned here after verification.
webhook_url
string (URI)
No
HTTPS endpoint Vobiz POSTs the KYC result to. Omit it and no callbacks are sent.
expires_in_days
integer
No
Days before the link expires. Defaults to 7.
This is the sub-account–scoped equivalent of the partner-level KYC Sessions endpoint. For session lifecycle, webhook events, and the verified_data shape, see that page - the hosted widget and status model are the same. The partner endpoint additionally accepts reminder_schedule and metadata; see the email and redirect flow walkthroughs for how those carry through to webhook payloads.
{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"Vobiz","colors":{"primary":"#E83C00","light":"#E86A00","dark":"#c93400"},"logo":{"light":"https://mintcdn.com/vobizai/cPP2drhQ7lKsmogc/logo/light.svg?fit=max\u0026auto=format\u0026n=cPP2drhQ7lKsmogc\u0026q=85\u0026s=8e1f6273f626f638f46d6df526d4775c","dark":"https://mintcdn.com/vobizai/cPP2drhQ7lKsmogc/logo/dark.svg?fit=max\u0026auto=format\u0026n=cPP2drhQ7lKsmogc\u0026q=85\u0026s=57b37e5694f01e6933c9ec02a871250a","href":"https://www.vobiz.ai/docs/introduction"},"favicon":"https://mintcdn.com/vobizai/BDRzOqCvIsC8CJvN/favicon.svg?fit=max\u0026auto=format\u0026n=BDRzOqCvIsC8CJvN\u0026q=85\u0026s=b38182f12bc6b0e3a5df2a8ae1474f83","api":{"openapi":["openapi.yaml","openapi-sms.yaml","openapi-whatsapp.yaml"],"playground":{"display":"interactive"},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":true},"mdx":{"auth":{"method":"key","name":"X-Auth-Token"},"server":"https://api.vobiz.ai"}},"appearance":{"default":"dark"},"background":{"decoration":"gradient"},"navbar":{"links":[{"href":"mailto:support@vobiz.ai","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://console.vobiz.ai"}},"footer":{"socials":{"x":"https://x.com/Vobiz_Ai","github":"https://github.com/vobiz-ai","linkedin":"https://linkedin.com/company/vobizai"}},"seo":{"metatags":{"canonical":"https://www.vobiz.ai/docs","og:site_name":"Vobiz Docs","og:type":"website","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@Vobiz_Ai","twitter:creator":"@Vobiz_Ai","theme-color":"#E83C00","color-scheme":"dark light","author":"Vobiz","publisher":"Vobiz","copyright":"Copyright 2025 Vobiz","reply-to":"support@vobiz.ai","robots":"index, follow","format-detection":"telephone=no","referrer":"origin-when-cross-origin","rating":"general","language":"en","category":"Technology","coverage":"Worldwide","distribution":"global","target":"all"},"indexing":"all"},"integrations":{"ga4":{"measurementId":"G-YD6M3FF3P4"}},"contextual":{"options":["copy","view","assistant","chatgpt","claude","perplexity","mcp","add-mcp","cursor","vscode"],"display":"header"},"thumbnails":{"appearance":"dark"},"markdown":{"schema":true},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"API Status","icon":"signal","href":"https://status.vobiz.ai"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"vobizai","hasAudioNarration":false,"actualSubdomain":"vobizai","customDomains":["www.vobiz.ai"],"gitSource":{"type":"github","owner":"vobiz-ai","repo":"mintlify-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6ae8948acb9fa025302af88e"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6b00db3c4dbe5d10f9185131","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":386},{"language":"default","tag":"Voice \u0026 XML","count":119},{"language":"default","tag":"Documentation","count":99},{"language":"default","tag":"SMS \u0026 RCS","count":92},{"language":"default","tag":"Blogs","count":82},{"language":"default","tag":"Articles","count":80},{"language":"default","tag":"Integrations","count":79},{"language":"default","tag":"Examples \u0026 Tutorials","count":59},{"language":"default","tag":"Regular APIs","count":40},{"language":"default","tag":"SIP Trunking","count":32}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@vobiz.ai","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","href":"/docs/_mintlify/custom/vobizai/c4c76a1b5bc930af/custom.css"}]}
{"page":{"pagePath":"sub-accounts/kyc/kyc-session","slug":"/sub-accounts/kyc/kyc-session","pageMetadata":{"openapi":"POST /api/v1/sub-accounts/{sub_auth_id}/kyc-sessions","title":"Initialize KYC","sidebarTitle":"Initialize KYC","description":"Hand off sub-account KYC to a Vobiz-hosted widget - email the customer a signed link or redirect them inline, for sub-account-scoped verification.","keywords":["hosted KYC session","KYC email link","flow_type email","flow_type redirect","kyc.vobiz.ai widget","signed KYC link","sub-account kyc-sessions","Vobiz hosted KYC","email-link KYC session"],"href":"/sub-accounts/kyc/kyc-session"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Hand off sub-account KYC to a Vobiz-hosted widget - email the customer a signed link or redirect them inline, for sub-account-scoped verification.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,em:`em`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,CodeGroup,Heading,Info,Note,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!CodeGroup)_missingMdxReference(`CodeGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Creates a Vobiz-hosted KYC session for the sub-account. Instead of driving each verification step yourself, you hand the customer off to the Vobiz-hosted KYC widget.`}),`\n`,_jsx(Info,{children:_jsxs(_components.p,{children:[`Authenticate with your `,_jsx(_components.strong,{children:`parent main account’s`}),` `,_jsx(_components.code,{children:`X-Auth-ID`}),` and `,_jsx(_components.code,{children:`X-Auth-Token`}),` - the same credentials used everywhere else in the API.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`flow-types`,children:`Flow types`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:_jsx(_components.code,{children:`flow_type`})}),_jsx(_components.th,{children:`Behavior`}),_jsx(_components.th,{children:`Required field`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.code,{children:`email`}),` `,_jsx(_components.em,{children:`(default)`})]}),_jsxs(_components.td,{children:[`Vobiz emails the customer a signed link (from `,_jsx(_components.code,{children:`kyc@vobiz.ai`}),`, hosted at `,_jsx(_components.code,{children:`kyc.vobiz.ai`}),`). The session sits in `,_jsx(_components.code,{children:`email_sent`}),` until they open it.`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`customer_email`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`redirect`})}),_jsxs(_components.td,{children:[`The response returns a `,_jsx(_components.code,{children:`widget_url`}),` directly - redirect the customer’s browser to it. No email is sent.`]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`redirect_url`})})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`body-fields`,children:`Body fields`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Type`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`account_auth_id`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Yes`}),_jsxs(_components.td,{children:[`The sub-account’s `,_jsx(_components.code,{children:`auth_id`}),` (`,_jsx(_components.code,{children:`SA_…`}),`), normally equal to the `,_jsx(_components.code,{children:`{sub_auth_id}`}),` in the path.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`flow_type`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Yes`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`email`}),` (default) or `,_jsx(_components.code,{children:`redirect`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`customer_email`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`Conditional`}),_jsxs(_components.td,{children:[`Required when `,_jsx(_components.code,{children:`flow_type`}),` is `,_jsx(_components.code,{children:`email`}),`. Where the signed link is sent.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`redirect_url`})}),_jsx(_components.td,{children:`string (URI)`}),_jsx(_components.td,{children:`Conditional`}),_jsxs(_components.td,{children:[`Required when `,_jsx(_components.code,{children:`flow_type`}),` is `,_jsx(_components.code,{children:`redirect`}),`. The customer is returned here after verification.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`webhook_url`})}),_jsx(_components.td,{children:`string (URI)`}),_jsx(_components.td,{children:`No`}),_jsx(_components.td,{children:`HTTPS endpoint Vobiz POSTs the KYC result to. Omit it and no callbacks are sent.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`expires_in_days`})}),_jsx(_components.td,{children:`integer`}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Days before the link expires. Defaults to `,_jsx(_components.code,{children:`7`}),`.`]})]})]})]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`This is the sub-account–scoped equivalent of the partner-level `,_jsx(_components.a,{href:`/partner/api/kyc-sessions`,children:`KYC Sessions`}),` endpoint. For session lifecycle, webhook events, and the `,_jsx(_components.code,{children:`verified_data`}),` shape, see that page - the hosted widget and status model are the same. The partner endpoint additionally accepts `,_jsx(_components.code,{children:`reminder_schedule`}),` and `,_jsx(_components.code,{children:`metadata`}),`; see the `,_jsx(_components.a,{href:`/sub-accounts/kyc/email-flow-webhook`,children:`email`}),` and `,_jsx(_components.a,{href:`/sub-accounts/kyc/redirect-flow-webhook`,children:`redirect`}),` flow walkthroughs for how those carry through to webhook payloads.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`responses`,children:`Responses`}),`\n`,_jsxs(CodeGroup,{children:[_jsx(CodeBlock,{filename:`Email flow (201)`,numberOfLines:`9`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`9`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"session_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"a5f8da3c-b47f-40c3-a3e6-d2c9a0f27065\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"account_auth_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SA_XXXXXX\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"customer_email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"customer@example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"email_sent\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"expires_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-06-24T19:37:01.316686Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"widget_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"KYC email dispatched successfully\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsx(CodeBlock,{filename:`Redirect flow (201)`,numberOfLines:`9`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`9`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"session_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"1a0f7da5-2abb-47bf-a6c3-eb5cff7feda5\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"account_auth_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"SA_XXXXXX\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"customer_email\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`null`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"link_ready\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"expires_at\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2026-06-24T19:37:01.841263Z\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"widget_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://kyc.vobiz.ai/verify?token=kst_cb1b3fda...\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"message\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Redirect your customer to widget_url to begin.\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),`\n`,_jsxs(_components.p,{children:[`A `,_jsx(_components.code,{children:`422`}),` is returned when the email flow is missing `,_jsx(_components.code,{children:`customer_email`}),`, or the redirect flow is missing `,_jsx(_components.code,{children:`redirect_url`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`theme-and-embed-the-kyc-widget`,children:`Theme and embed the KYC widget`}),`\n`,_jsxs(_components.p,{children:[`Add a `,_jsx(_components.code,{children:`theme`}),` query parameter to `,_jsx(_components.code,{children:`widget_url`}),` to match your app.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:_jsx(_components.code,{children:`theme`})}),_jsx(_components.th,{children:`Result`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`light`})}),_jsxs(_components.td,{children:[`Light theme. This is also what any URL without a `,_jsx(_components.code,{children:`theme`}),` value uses.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`dark`})}),_jsx(_components.td,{children:`Dark theme.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`auto`})}),_jsx(_components.td,{children:`Follows the customer’s device setting, and switches live if they change it. Best if your app has both themes.`})]})]})]}),`\n`,_jsx(_components.p,{children:`Use the values in lowercase. The theme stays on as the customer moves through the widget.`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://kyc.vobiz.ai/verify?token=kst_cb1b3fda...\u0026theme=dark`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`To show the widget inside your app, load the same URL in an iframe:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`7`,language:`html`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`html`,children:_jsxs(_components.code,{language:`html`,numberOfLines:`7`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`\u003c`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`iframe`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` src`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://kyc.vobiz.ai/verify?token=kst_cb1b3fda...\u0026theme=dark\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` width`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"100%\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` height`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"760\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` style`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"border:0\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` allow`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"camera https://www.kyc.vobiz.ai; clipboard-write https://www.kyc.vobiz.ai\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`>`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`\u003c/`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`iframe`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`>`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`Keep the `,_jsx(_components.code,{children:`allow`}),` value as shown. It gives the widget camera and clipboard access on the host that serves it.`]}),`\n`,_jsx(_components.p,{children:`Links in KYC emails open in the light theme.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"POST /api/v1/sub-accounts/{sub_auth_id}/kyc-sessions","title":"Initialize KYC","sidebarTitle":"Initialize KYC","description":"Hand off sub-account KYC to a Vobiz-hosted widget - email the customer a signed link or redirect them inline, for sub-account-scoped verification.","keywords":["hosted KYC session","KYC email link","flow_type email","flow_type redirect","kyc.vobiz.ai widget","signed KYC link","sub-account kyc-sessions","Vobiz hosted KYC","email-link KYC session"],"href":"/sub-accounts/kyc/kyc-session"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Flow types","slug":"flow-types","depth":2,"children":[]},{"title":"Body fields","slug":"body-fields","depth":2,"children":[]},{"title":"Responses","slug":"responses","depth":2,"children":[]},{"title":"Theme and embed the KYC widget","slug":"theme-and-embed-the-kyc-widget","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/vobizai/478834ae2c200a0e/blog-schema.js","/docs/_mintlify/custom/vobizai/13b0cd7ec6e39877/anchor-link-text.js"],"openApiReferenceData":{"operation":{"operationId":"create-subaccount-kyc-session","summary":"Create a hosted KYC session","description":"Hand off sub-account KYC to a Vobiz-hosted widget - email the customer a signed link or redirect them inline, for sub-account-scoped verification.","tags":["Sub-Account KYC"],"parameters":["e290f670-ba2c-4dae-aa24-275197d1ae9c"],"requestBody":"297075a3-6dcc-4dd7-bbc9-14c7c1876cd2","responses":{"201":"53db83fa-76d4-413d-999f-d66f5f476bff","422":"e62cff5c-84d9-403f-9f97-9f9286b21e24"},"method":"post","type":"path","servers":["63df1293-34a2-4314-96e6-4cfcad0f4404"],"security":["c50d337f-92a2-4e86-b2c1-8be733ff0e0b"],"path":"/api/v1/sub-accounts/{sub_auth_id}/kyc-sessions","baseUrlOptions":["https://api.vobiz.ai"],"title":"Create a hosted KYC session","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.account_auth_id":"SA_XXXXXX","body.flow_type":"email","body.customer_email":"customer@example.com","body.webhook_url":"https://your-app.example.com/kyc/webhook","body.expires_in_days":30},{"body.account_auth_id":"SA_XXXXXX","body.flow_type":"redirect","body.redirect_url":"https://your-app.example.com/kyc/done","body.webhook_url":"https://your-app.example.com/kyc/webhook","body.expires_in_days":30}]},"dependencies":{"parameters":{"e290f670-ba2c-4dae-aa24-275197d1ae9c":{"name":"sub_auth_id","in":"path","required":true,"description":"The sub-account's Auth ID.","schema":{"type":"string","example":"SA_XXXXXX","isRequired":true,"description":"The sub-account's Auth ID.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["account_auth_id","flow_type"],"properties":{"account_auth_id":{"type":"string","description":"The sub-account's auth_id (typically equal to the path `sub_auth_id`).","example":"SA_XXXXXX","isRequired":true,"uniqueKey":"account_auth_id","typeLabel":"string"},"flow_type":{"type":"string","enum":["email","redirect"],"default":"email","isRequired":true,"uniqueKey":"flow_type","typeLabel":"enum\u003cstring>"},"customer_email":{"type":"string","format":"email","description":"Required when `flow_type` is `email`.","example":"customer@example.com","uniqueKey":"customer_email","typeLabel":"string\u003cemail>"},"redirect_url":{"type":"string","format":"uri","description":"Required when `flow_type` is `redirect`. After verification the customer's\nbrowser is sent to this URL.\n","example":"https://your-app.example.com/kyc/done","uniqueKey":"redirect_url","typeLabel":"string\u003curi>"},"webhook_url":{"type":"string","format":"uri","description":"HTTPS endpoint Vobiz POSTs the KYC result to. Omit it and no callbacks are sent.","example":"https://your-app.example.com/kyc/webhook","uniqueKey":"webhook_url","typeLabel":"string\u003curi>"},"expires_in_days":{"type":"integer","default":7,"example":30,"uniqueKey":"expires_in_days","typeLabel":"integer"}},"uniqueKey":"","typeLabel":"object"},"examples":{"email-flow":{"title":"email-flow","summary":"Email flow (Vobiz emails the link)","value":{"account_auth_id":"SA_XXXXXX","flow_type":"email","customer_email":"customer@example.com","webhook_url":"https://your-app.example.com/kyc/webhook","expires_in_days":30}},"redirect-flow":{"title":"redirect-flow","summary":"Redirect flow (you redirect to widget_url)","value":{"account_auth_id":"SA_XXXXXX","flow_type":"redirect","redirect_url":"https://your-app.example.com/kyc/done","webhook_url":"https://your-app.example.com/kyc/webhook","expires_in_days":30}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"53db83fa-76d4-413d-999f-d66f5f476bff":{"description":"KYC session created","content":{"application/json":{"examples":{"email-flow":{"title":"email-flow","summary":"Email-flow response","value":{"session_id":"a5f8da3c-b47f-40c3-a3e6-d2c9a0f27065","account_auth_id":"SA_XXXXXX","customer_email":"customer@example.com","status":"email_sent","expires_at":"2026-06-24T19:37:01.316686Z","widget_url":null,"message":"KYC email dispatched successfully"}},"redirect-flow":{"title":"redirect-flow","summary":"Redirect-flow response","value":{"session_id":"1a0f7da5-2abb-47bf-a6c3-eb5cff7feda5","account_auth_id":"SA_XXXXXX","customer_email":null,"status":"link_ready","expires_at":"2026-06-24T19:37:01.841263Z","widget_url":"https://kyc.vobiz.ai/verify?token=kst_cb1b3fda...","message":"Redirect your customer to widget_url to begin."}}},"exampleType":"examples"}},"exampleType":"examples"},"e62cff5c-84d9-403f-9f97-9f9286b21e24":{"description":"Validation error (email flow missing `customer_email`, or redirect flow missing `redirect_url`)","content":{"application/json":{"schema":{"type":"object","properties":{"api_id":{"type":"string","uniqueKey":"api_id","typeLabel":"string"},"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"api_id":"\u003cstring>","error":"\u003cstring>","message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c50d337f-92a2-4e86-b2c1-8be733ff0e0b":{"AuthID":{"type":"apiKey","in":"header","name":"X-Auth-ID","description":"Your Vobiz account Auth ID","scopes":[],"schemeName":"AuthID"},"AuthToken":{"type":"apiKey","in":"header","name":"X-Auth-Token","description":"Your Vobiz account Auth Token","scopes":[],"schemeName":"AuthToken"}}},"servers":{"63df1293-34a2-4314-96e6-4cfcad0f4404":{"url":"https://api.vobiz.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Auth-ID","description":"Your Vobiz account Auth ID","scopes":[],"schemeName":"AuthID"},"schema":{"title":"X-Auth-ID","type":"string","description":"Your Vobiz account Auth ID","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AuthID","name":"X-Auth-ID"},{"scheme":{"type":"apiKey","in":"header","name":"X-Auth-Token","description":"Your Vobiz account Auth Token","scopes":[],"schemeName":"AuthToken"},"schema":{"title":"X-Auth-Token","type":"string","description":"Your Vobiz account Auth Token","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AuthToken","name":"X-Auth-Token"}],"title":"AuthID \u0026 AuthToken"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"vobizai","siteName":"Vobiz","title":"Initialize KYC - Vobiz","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T20:13:57.298Z","originalFileLocation":"sub-accounts/kyc/kyc-session.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Hand off sub-account KYC to a Vobiz-hosted widget - email the customer a signed link or redirect them inline, for sub-account-scoped verification.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Vobiz\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Initialize KYC - Vobiz\">\u003cmeta data-mint-head property=\"og:description\" content=\"Hand off sub-account KYC to a Vobiz-hosted widget - email the customer a signed link or redirect them inline, for sub-account-scoped verification.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Vobiz Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://vobizai.mintlify.site/docs/_mintlify/api/og/v2?division=KYC\u0026amp;title=Initialize+KYC\u0026amp;description=Hand+off+sub-account+KYC+to+a+Vobiz-hosted+widget+-+email+the+customer+a+signed+link+or+redirect+them+inline%2C+for+sub-account-scoped+verification.\u0026amp;theme=d9cfb5a257c4db351c1c1eeb\u0026amp;signature=42331054acec301048242519b4ba25e8a9f8d0d81ac11d035a03a536fad922a0\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Initialize KYC - Vobiz\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Hand off sub-account KYC to a Vobiz-hosted widget - email the customer a signed link or redirect them inline, for sub-account-scoped verification.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vobizai.mintlify.site/docs/_mintlify/api/og/v2?division=KYC\u0026amp;title=Initialize+KYC\u0026amp;description=Hand+off+sub-account+KYC+to+a+Vobiz-hosted+widget+-+email+the+customer+a+signed+link+or+redirect+them+inline%2C+for+sub-account-scoped+verification.\u0026amp;theme=d9cfb5a257c4db351c1c1eeb\u0026amp;signature=42331054acec301048242519b4ba25e8a9f8d0d81ac11d035a03a536fad922a0\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/docs/mintlify-assets/_mintlify/favicons/vobizai/oc0LWA8xGPKGY1Z5/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Vobiz\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#E83C00\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@Vobiz_Ai\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#E83C00\">\u003cmeta data-mint-head name=\"color-scheme\" content=\"dark light\">\u003cmeta data-mint-head name=\"author\" content=\"Vobiz\">\u003cmeta data-mint-head name=\"publisher\" content=\"Vobiz\">\u003cmeta data-mint-head name=\"copyright\" content=\"Copyright 2025 Vobiz\">\u003cmeta data-mint-head name=\"reply-to\" content=\"support@vobiz.ai\">\u003cmeta data-mint-head name=\"format-detection\" content=\"telephone=no\">\u003cmeta data-mint-head name=\"referrer\" content=\"origin-when-cross-origin\">\u003cmeta data-mint-head name=\"rating\" content=\"general\">\u003cmeta data-mint-head name=\"language\" content=\"en\">\u003cmeta data-mint-head name=\"category\" content=\"Technology\">\u003cmeta data-mint-head name=\"coverage\" content=\"Worldwide\">\u003cmeta data-mint-head name=\"distribution\" content=\"global\">\u003cmeta data-mint-head name=\"target\" content=\"all\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/sub-accounts/kyc/kyc-session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.vobiz.ai/#organization\",\"name\":\"Vobiz\",\"url\":\"https://www.vobiz.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/vobizai/cPP2drhQ7lKsmogc/logo/light.svg?fit=max\u0026auto=format\u0026n=cPP2drhQ7lKsmogc\u0026q=85\u0026s=8e1f6273f626f638f46d6df526d4775c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.vobiz.ai/docs#website\",\"name\":\"Vobiz\",\"url\":\"https://www.vobiz.ai/docs\",\"publisher\":{\"@id\":\"https://www.vobiz.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-session#webpage\",\"url\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-session\",\"name\":\"Initialize KYC\",\"description\":\"Hand off sub-account KYC to a Vobiz-hosted widget - email the customer a signed link or redirect them inline, for sub-account-scoped verification.\",\"dateModified\":\"2026-11-18T20:13:57.298Z\",\"isPartOf\":{\"@id\":\"https://www.vobiz.ai/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Sub-Accounts\",\"item\":\"https://www.vobiz.ai/docs/sub-accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"KYC\",\"item\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Initialize KYC\",\"item\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-session#apireference\",\"headline\":\"Initialize KYC\",\"name\":\"Initialize KYC\",\"description\":\"Hand off sub-account KYC to a Vobiz-hosted widget - email the customer a signed link or redirect them inline, for sub-account-scoped verification.\",\"url\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-session\",\"mainEntityOfPage\":{\"@id\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-session#webpage\"},\"dateModified\":\"2026-11-18T20:13:57.298Z\",\"keywords\":\"hosted KYC session, KYC email link, flow_type email, flow_type redirect, kyc.vobiz.ai widget, signed KYC link, sub-account kyc-sessions, Vobiz hosted KYC, email-link KYC session\",\"publisher\":{\"@id\":\"https://www.vobiz.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://www.vobiz.ai/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Vobiz\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Vobiz\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/docs/sub-accounts/kyc/kyc-session.md","siteName":"Vobiz","nav":{"global":{"anchors":[{"anchor":"API Status","icon":"signal","href":"https://status.vobiz.ai"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","anchors":[{"anchor":"Regular APIs","icon":"database","groups":[{"group":"Account","boost":3,"icon":"circle-user","root":{"title":"Vobiz Account API: Balance \u0026 Concurrency","sidebarTitle":"Account","href":"/account"},"pages":[{"title":"The Account Object","href":"/account/account-object"},{"openapi":"GET /api/v1/auth/me","title":"Retrieve Account Details","href":"/account/retrieve-account"},{"openapi":"GET /api/v1/Account/{auth_id}/balance/{currency}","title":"Balance","href":"/account/balance"},{"openapi":"GET /api/v1/Account/{auth_id}/transactions","title":"Transactions","href":"/account/transactions"},{"openapi":"GET /api/v1/Account/{auth_id}/concurrency","title":"Get Account Concurrency — Live Call Capacity","sidebarTitle":"Concurrency","href":"/account/concurrency"},{"openapi":"GET /api/v1/accounts/{auth_id}/channel-pricing-preview","title":"Preview CPS and concurrency pricing","sidebarTitle":"Preview capacity pricing","href":"/account/channel-pricing-preview"},{"openapi":"POST /api/v1/accounts/{auth_id}/channel-subscriptions","title":"Purchase CPS or concurrency capacity","sidebarTitle":"Purchase capacity","href":"/account/channel-subscriptions"},{"title":"NDNC Webhook","sidebarTitle":"NDNC Webhook","href":"/account/ndnc-webhook"}]},{"group":"Sub-Accounts","icon":"sitemap","root":{"title":"Vobiz Sub-Accounts API: Multi-Tenant Accounts","sidebarTitle":"Sub-Accounts","href":"/sub-accounts"},"pages":[{"title":"Sub-Account Onboarding Flow","sidebarTitle":"Onboarding Flow","href":"/sub-accounts/onboarding-flow"},{"title":"The Subaccount Object","sidebarTitle":"Subaccount Object","href":"/sub-accounts/subaccount-object"},{"openapi":"POST /api/v1/accounts/{auth_id}/sub-accounts/","title":"Create a Subaccount","sidebarTitle":"Create Subaccount","href":"/sub-accounts/create-subaccount"},{"openapi":"GET /api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}","title":"Retrieve a Subaccount","sidebarTitle":"Retrieve Subaccount","href":"/sub-accounts/retrieve-subaccount"},{"openapi":"PUT /api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}","title":"Update a Subaccount","sidebarTitle":"Update Subaccount","href":"/sub-accounts/update-subaccount"},{"openapi":"DELETE /api/v1/accounts/{auth_id}/sub-accounts/{sub_auth_id}","title":"Delete a Subaccount","sidebarTitle":"Delete Subaccount","href":"/sub-accounts/delete-subaccount"},{"openapi":"GET /api/v1/accounts/{auth_id}/sub-accounts/","title":"List All Subaccounts","sidebarTitle":"List Subaccounts","href":"/sub-accounts/list-all-subaccounts"},{"openapi":"POST /api/v1/account/{auth_id}/numbers/{e164}/assign-subaccount","title":"Assign DID to Sub-Account","sidebarTitle":"Assign to Sub-Account","href":"/account-phone-number/assign-subaccount"},{"openapi":"DELETE /api/v1/account/{auth_id}/numbers/{e164}/assign-subaccount","title":"Unassign DID (15-Day Cool-Off)","sidebarTitle":"Unassign from Sub-Account","href":"/account-phone-number/unassign-subaccount"},{"group":"KYC","icon":"id-card","pages":[{"title":"Sub-Account KYC","sidebarTitle":"Overview","href":"/sub-accounts/kyc/overview"},{"openapi":"GET /api/v1/sub-accounts/{sub_auth_id}/kyc/status","title":"Get KYC Status","sidebarTitle":"KYC Status","description":"Retrieve the aggregated KYC state for a customer_use sub-account - which verifications have passed, whether calls are still blocked, and the business type.","href":"/sub-accounts/kyc/kyc-status"},{"openapi":"POST /api/v1/sub-accounts/{sub_auth_id}/kyc-sessions","title":"Initialize KYC","sidebarTitle":"Initialize KYC","href":"/sub-accounts/kyc/kyc-session"},{"title":"KYC Email Flow with Webhook","sidebarTitle":"Email Flow \u0026 Webhook","description":"Start a hosted sub-account KYC via email link and register a webhook for status updates - the session, the events Vobiz POSTs, and HMAC verification.","href":"/sub-accounts/kyc/email-flow-webhook"},{"title":"KYC Redirect Flow with Webhook","sidebarTitle":"Redirect Flow \u0026 Webhook","href":"/sub-accounts/kyc/redirect-flow-webhook"},{"title":"KYC Test Mode","sidebarTitle":"Test Mode","href":"/sub-accounts/kyc/test-mode"}]}]},{"group":"Phone Numbers","icon":"phone","root":{"title":"Vobiz Phone Numbers API: Buy \u0026 Manage DIDs","sidebarTitle":"Phone Numbers","href":"/account-phone-number"},"pages":[{"title":"The PhoneNumber Object","sidebarTitle":"PhoneNumber Object","href":"/account-phone-number/account-phone-number-object"},{"openapi":"GET /api/v1/Account/{auth_id}/numbers","title":"List Account Phone Numbers","href":"/account-phone-number/list-account-phone-numbers"},{"title":"List Inventory Numbers","sidebarTitle":"List Inventory","openapi":"GET /api/v1/Account/{auth_id}/inventory/numbers","href":"/account-phone-number/list-inventory-numbers"},{"title":"Purchase from Inventory","sidebarTitle":"Purchase Number","openapi":"POST /api/v1/Account/{auth_id}/numbers/purchase-from-inventory","href":"/account-phone-number/purchase-from-inventory"},{"openapi":"DELETE /api/v1/Account/{auth_id}/numbers/{e164}","title":"Release a Phone Number","href":"/account-phone-number/unrent-number"},{"openapi":"POST /api/v1/account/{account_id}/numbers/{e164}/cancel-release","title":"Cancel a Number Release","sidebarTitle":"Cancel Release","href":"/account-phone-number/cancel-release"},{"openapi":"GET /api/v1/account/{auth_id}/numbers/{e164}/health","title":"Get Number Health Dashboard","sidebarTitle":"Number Health","href":"/account-phone-number/get-number-health"}]},{"group":"Recordings","icon":"circle-dot","root":{"title":"Vobiz Recordings API: Call \u0026 Conference Recordings","sidebarTitle":"Recording","href":"/recording"},"pages":[{"title":"The Recording Object","href":"/recording/recording-object"},{"openapi":"GET /api/v1/Account/{auth_id}/Recording/{recording_id}/","title":"Retrieve a Recording","href":"/recording/retrieve-recording"},{"openapi":"GET /api/v1/Account/{auth_id}/Recording/","title":"List All Recordings","href":"/recording/list-all-recordings"},{"title":"Download a Recording","href":"/recording/download-recording"},{"openapi":"POST /api/v1/Account/{auth_id}/export/recording/","title":"Export Historical Recordings","sidebarTitle":"Export Recordings","href":"/recording/export-historical-recordings"}]},{"group":"Call Detail Records","icon":"list-ul","root":{"title":"Vobiz Call Detail Records (CDR) API","sidebarTitle":"Call Detail Records","href":"/cdr"},"pages":[{"title":"List CDRs","openapi":"GET /api/v1/Account/{auth_id}/cdr","href":"/cdr/list-cdrs"},{"title":"Get Single CDR","openapi":"GET /api/v1/Account/{auth_id}/cdr/{call_id}","href":"/cdr/get-cdr"},{"title":"Search CDRs","openapi":"GET /api/v1/Account/{auth_id}/cdr/search","href":"/cdr/search-cdrs"},{"title":"Recent CDRs","openapi":"GET /api/v1/Account/{auth_id}/cdr/recent","href":"/cdr/recent-cdrs"},{"title":"Export CDRs as CSV","openapi":"GET /api/v1/Account/{auth_id}/cdr/export","href":"/cdr/export-cdrs"}]}]},{"anchor":"SIP Trunking","icon":"network-wired","pages":[{"title":"SIP Trunking","href":"/trunks"}]},{"anchor":"Voice \u0026 XML","icon":"microphone","pages":[{"title":"Voice \u0026 XML","href":"/applications"}]},{"anchor":"SMS \u0026 RCS","icon":"comment-sms","pages":[{"title":"SMS \u0026 RCS","href":"/sms/overview"}]},{"anchor":"WhatsApp","icon":"comment-dots","pages":[{"title":"WhatsApp","href":"/whatsapp/getting-started/introduction"}]},{"anchor":"Partner API","icon":"handshake","pages":[{"title":"Partner API","href":"/partner"}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations"}]},{"tab":"Examples \u0026 Tutorials","pages":[{"title":"Examples \u0026 Tutorials","href":"/guides/ai-voice-agent"}]},{"tab":"Blogs","pages":[{"title":"Blogs","href":"/blogs"}]}]},"basePath":"","title":"Initialize KYC - Vobiz","deploymentId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","buildId":"dpl_53YqbBPsHdrqSGqXiWPGU7csRVod","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-Ku9dSkH0.js","snippetPresets-Cjez4eet.js","utils-BqNa-fnS.js","style-to-object-BY3JEAdk.js","utils-DiE92JCe.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-Bi0DpqVf.js","conditional-requirements-CFM0id0Q.js","cloneDeep-C6xnxscF.js","_Uint8Array-B7g0OYAt.js","isObject-FP1Yky1u.js","Page--B9YZ09u.js","CodeSnippet-CTZvgJfu.js","DynamicMarkdown-CsgNpZb1.js","SectionHeading-C3K437Dy.js","icon-DlxjjqnB.js","ApiExamples-Bf8Ecb5t.js","usePlaygroundInputsStore-BA942cq6.js","shallow-D0sePNkF.js","isEqual-CnnQO8sL.js","CodeSnippets-BTANoy1T.js","getApiPlaygroundDisplay-BK2o1XYu.js","MethodPill-Cr7Ib9nN.js","getPastedJson-DXo3wtHt.js","Check2Icon-ChEI-f_B.js","axios-CsQoIw0U.js","Markdown-CH4mv0N8.js","AssistantPageLink-BHjmqccN.js","dist-DYCPzQwJ.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}