Retrieve the aggregated KYC state for a customer_use sub-account - which verifications have passed, whether calls are still blocked, and the business type.
Returns the aggregated KYC state for a customer_use sub-account: the per-document verification states, whether calls are still blocked (kyc_calls_blocked), and the business_type.
Authenticate with your parent main account’sX-Auth-ID and X-Auth-Token - the same credentials used everywhere else in the API. The caller must own the sub-account (or be an admin).
Response fields
Field
Type
Description
sub_account_id
string
The sub-account’s auth_id (SA_…).
kyc_mode
string
personal_use or customer_use.
business_type
string
The legal constitution that drives required documents.
overall_status
string
Aggregate state: not_started, pending, verified, or failed.
kyc_calls_blocked
boolean
true while the sub-account still needs KYC before it can place calls.
verifications
object
Per-document state keyed by type (pan, gst, cin, aadhaar), each not_started / pending / verified / failed.
{"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":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","href":"/docs/_mintlify/custom/vobizai/c4c76a1b5bc930af/custom.css"}]}
{"page":{"pagePath":"sub-accounts/kyc/kyc-status","slug":"/sub-accounts/kyc/kyc-status","pageMetadata":{"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.","keywords":["sub-account KYC status","kyc_calls_blocked","aggregated KYC state","KYC verifications status","customer_use KYC check","Vobiz KYC status API","PAN GST Aadhaar status","sub-account verification state"],"href":"/sub-accounts/kyc/kyc-status"},"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: \"Retrieve the aggregated KYC state for a customer_use sub-account - which verifications have passed, whether calls are still blocked, and the business type.\"\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={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{CodeBlock,Heading,Info,Table,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Returns the aggregated KYC state for a `,_jsx(_components.code,{children:`customer_use`}),` sub-account: the per-document verification states, whether calls are still blocked (`,_jsx(_components.code,{children:`kyc_calls_blocked`}),`), and the `,_jsx(_components.code,{children:`business_type`}),`.`]}),`\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. The caller must own the sub-account (or be an admin).`]})}),`\n`,_jsx(Heading,{level:`2`,id:`response-fields`,children:`Response 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:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`sub_account_id`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`The sub-account’s `,_jsx(_components.code,{children:`auth_id`}),` (`,_jsx(_components.code,{children:`SA_…`}),`).`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`kyc_mode`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`personal_use`}),` or `,_jsx(_components.code,{children:`customer_use`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`business_type`})}),_jsx(_components.td,{children:`string`}),_jsx(_components.td,{children:`The legal constitution that drives required documents.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`overall_status`})}),_jsx(_components.td,{children:`string`}),_jsxs(_components.td,{children:[`Aggregate state: `,_jsx(_components.code,{children:`not_started`}),`, `,_jsx(_components.code,{children:`pending`}),`, `,_jsx(_components.code,{children:`verified`}),`, or `,_jsx(_components.code,{children:`failed`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`kyc_calls_blocked`})}),_jsx(_components.td,{children:`boolean`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`true`}),` while the sub-account still needs KYC before it can place calls.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`verifications`})}),_jsx(_components.td,{children:`object`}),_jsxs(_components.td,{children:[`Per-document state keyed by type (`,_jsx(_components.code,{children:`pan`}),`, `,_jsx(_components.code,{children:`gst`}),`, `,_jsx(_components.code,{children:`cin`}),`, `,_jsx(_components.code,{children:`aadhaar`}),`), each `,_jsx(_components.code,{children:`not_started`}),` / `,_jsx(_components.code,{children:`pending`}),` / `,_jsx(_components.code,{children:`verified`}),` / `,_jsx(_components.code,{children:`failed`}),`.`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`response-example`,children:`Response example`}),`\n`,_jsx(CodeBlock,{filename:`200 OK`,numberOfLines:`13`,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:`13`,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:` \"sub_account_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:` \"kyc_mode\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"customer_use\"`}),_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:` \"business_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"private_limited\"`}),_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:` \"overall_status\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pending\"`}),_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:` \"kyc_calls_blocked\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_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:` \"verifications\"`}),_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:` \"pan\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"verified\"`}),_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:` \"gst\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"pending\"`}),_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:` \"aadhaar\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"not_started\"`}),_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:` \"cin\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"not_started\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:`The caller is not the parent of this sub-account.`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:`Sub-account not found.`})]})]})]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Poll this endpoint after each verification (or on each webhook) and gate the customer’s “go live” on `,_jsx(_components.code,{children:`kyc_calls_blocked === false`}),`.`]})})]})}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":"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.","keywords":["sub-account KYC status","kyc_calls_blocked","aggregated KYC state","KYC verifications status","customer_use KYC check","Vobiz KYC status API","PAN GST Aadhaar status","sub-account verification state"],"href":"/sub-accounts/kyc/kyc-status"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Response fields","slug":"response-fields","depth":2,"children":[]},{"title":"Response example","slug":"response-example","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":"get-subaccount-kyc-status","summary":"Get sub-account 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.","tags":["Sub-Account KYC"],"parameters":["b49ddb11-a3bb-45ad-b4b1-159669e66f57"],"responses":{"200":"3e07254f-e5e7-4da7-a02a-7f9dbc1e88b3","403":"cc9723bb-fc37-4655-a758-1689801b8b63","404":"bd5965e1-929c-4738-aff8-f72623b6f8d5"},"method":"get","type":"path","servers":["63df1293-34a2-4314-96e6-4cfcad0f4404"],"security":["c50d337f-92a2-4e86-b2c1-8be733ff0e0b"],"path":"/api/v1/sub-accounts/{sub_auth_id}/kyc/status","baseUrlOptions":["https://api.vobiz.ai"],"title":"Get sub-account KYC status","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"b49ddb11-a3bb-45ad-b4b1-159669e66f57":{"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"}}},"responses":{"3e07254f-e5e7-4da7-a02a-7f9dbc1e88b3":{"description":"Aggregated KYC state","content":{"application/json":{"schema":{"type":"object","description":"Aggregated KYC state for a sub-account.","properties":{"sub_account_id":{"type":"string","uniqueKey":"sub_account_id","typeLabel":"string"},"kyc_mode":{"type":"string","enum":["personal_use","customer_use"],"uniqueKey":"kyc_mode","typeLabel":"enum\u003cstring>"},"business_type":{"type":"string","uniqueKey":"business_type","typeLabel":"string"},"overall_status":{"type":"string","enum":["not_started","pending","verified","failed"],"uniqueKey":"overall_status","typeLabel":"enum\u003cstring>"},"kyc_calls_blocked":{"type":"boolean","description":"True while the sub-account still needs KYC before it can place calls.","uniqueKey":"kyc_calls_blocked","typeLabel":"boolean"},"verifications":{"type":"object","description":"Per-document state keyed by verification type.","additionalProperties":{"type":"string","enum":["not_started","pending","verified","failed"],"uniqueKey":"verifications.additionalProperties","typeLabel":"enum\u003cstring>"},"uniqueKey":"verifications","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"sub_account_id":"SA_XXXXXX","kyc_mode":"customer_use","business_type":"private_limited","overall_status":"pending","kyc_calls_blocked":true,"verifications":{"pan":"verified","gst":"pending","aadhaar":"not_started","cin":"not_started"}},"examples":{"Example":{"title":"Example","value":{"sub_account_id":"SA_XXXXXX","kyc_mode":"customer_use","business_type":"private_limited","overall_status":"pending","kyc_calls_blocked":true,"verifications":{"pan":"verified","gst":"pending","aadhaar":"not_started","cin":"not_started"}}}},"exampleType":"examples"}},"exampleType":"examples"},"cc9723bb-fc37-4655-a758-1689801b8b63":{"description":"Caller is not the parent of this sub-account","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"},"bd5965e1-929c-4738-aff8-f72623b6f8d5":{"description":"Sub-account not found","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":"Get KYC Status - Vobiz","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T20:13:57.298Z","originalFileLocation":"sub-accounts/kyc/kyc-status.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=\"Retrieve the aggregated KYC state for a customer_use sub-account - which verifications have passed, whether calls are still blocked, and the business type.\">\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=\"Get KYC Status - Vobiz\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve the aggregated KYC state for a customer_use sub-account - which verifications have passed, whether calls are still blocked, and the business type.\">\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-status\">\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=Get+KYC+Status\u0026amp;description=Retrieve+the+aggregated+KYC+state+for+a+customer_use+sub-account+-+which+verifications+have+passed%2C+whether+calls+are+still+blocked%2C+and+the+business+type.\u0026amp;theme=d9cfb5a257c4db351c1c1eeb\u0026amp;signature=8d9e2829f7033fcd9030d78a0449af1441842481936d956193e912445cf04036\">\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=\"Get KYC Status - Vobiz\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve the aggregated KYC state for a customer_use sub-account - which verifications have passed, whether calls are still blocked, and the business type.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://vobizai.mintlify.site/docs/_mintlify/api/og/v2?division=KYC\u0026amp;title=Get+KYC+Status\u0026amp;description=Retrieve+the+aggregated+KYC+state+for+a+customer_use+sub-account+-+which+verifications+have+passed%2C+whether+calls+are+still+blocked%2C+and+the+business+type.\u0026amp;theme=d9cfb5a257c4db351c1c1eeb\u0026amp;signature=8d9e2829f7033fcd9030d78a0449af1441842481936d956193e912445cf04036\">\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-status\">\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-status.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-status#webpage\",\"url\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-status\",\"name\":\"Get 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.\",\"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-status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-status#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\":\"Get KYC Status\",\"item\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-status#apireference\",\"headline\":\"Get KYC Status\",\"name\":\"Get 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.\",\"url\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-status\",\"mainEntityOfPage\":{\"@id\":\"https://www.vobiz.ai/docs/sub-accounts/kyc/kyc-status#webpage\"},\"dateModified\":\"2026-11-18T20:13:57.298Z\",\"keywords\":\"sub-account KYC status, kyc_calls_blocked, aggregated KYC state, KYC verifications status, customer_use KYC check, Vobiz KYC status API, PAN GST Aadhaar status, sub-account verification state\",\"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-status.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","description":"Verify customer_use sub-accounts with a Vobiz-hosted KYC session, then poll the aggregated KYC status until calls are unblocked. Includes a test mode.","href":"/sub-accounts/kyc/overview"},{"openapi":"GET /api/v1/sub-accounts/{sub_auth_id}/kyc/status","title":"Get KYC Status","sidebarTitle":"KYC Status","href":"/sub-accounts/kyc/kyc-status"},{"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.","href":"/sub-accounts/kyc/kyc-session"},{"title":"KYC Email Flow with Webhook","sidebarTitle":"Email Flow \u0026 Webhook","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":"Get KYC Status - 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"]}