{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cashfree Developer Documentation","colors":{"primary":"#6930ca","light":"#cfb8f5","dark":"#130851"},"logo":{"light":"https://mintcdn.com/cashfreepayments-d00050e9/6mQw7is1us8FhXrb/static/logo/light.svg?fit=max\u0026auto=format\u0026n=6mQw7is1us8FhXrb\u0026q=85\u0026s=8a2837083063d8a01e0be6b454a1baf1","dark":"https://mintcdn.com/cashfreepayments-d00050e9/6mQw7is1us8FhXrb/static/logo/dark.svg?fit=max\u0026auto=format\u0026n=6mQw7is1us8FhXrb\u0026q=85\u0026s=5c7de40784c6f6f9eebdad085ec5a7ef"},"favicon":"https://mintcdn.com/cashfreepayments-d00050e9/NpjCgm3mwC7v6gp-/static/favicon.png?fit=max\u0026auto=format\u0026n=NpjCgm3mwC7v6gp-\u0026q=85\u0026s=ba85dcd024bd70845e38c3f3957514c6","appearance":{"default":"light","strict":false},"background":{"color":{"light":"#fbfbfb","dark":"#000000"}},"navbar":{"links":[{"href":"https://www.cashfree.com/support/","label":"Contact Us"}],"primary":{"type":"button","label":"Get Started","href":"https://merchant.cashfree.com/merchants/signup?source-action=docs%20page\u0026action=Sign%20Up\u0026button-id=StartNow_Navbar"}},"footer":{"socials":{"github":"https://github.com/cashfree","youtube":"https://www.youtube.com/channel/UCxO0W7xVngh7TfkChPa_nwg","website":"https://www.cashfree.com/blog/category/engineering","discord":"https://discord.com/invite/w97HT9RKCF"}},"search":{"prompt":"Search or ask..."},"seo":{"metatags":{"og:title":"Cashfree Developer Documentation","og:description":"Welcome to the Cashfree developer documentation. You will find help about Cashfree products and APIs that will help you start using our products quickly.","og:site_name":"Cashfree Developer Documentation","twitter:site":"@gocashfree","google-site-verification":"T69Ao_T0Ps8pkRbluKzW179qvd_aCsWISCApeSsIhRU"},"indexing":"all"},"fonts":{"heading":{"family":"Inter","weight":600},"body":{"family":"Inter","weight":400}},"styling":{"codeblocks":"dark","latex":true},"integrations":{"ga4":{"measurementId":"G-56SCQ867FW"},"gtm":{"tagId":"GTM-5SRVH4P"}},"contextual":{"options":["chatgpt","claude","copy","view",{"title":"Open in Discord","description":"Join our Discord community","icon":"discord","href":"https://discord.com/invite/w97HT9RKCF"}],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cashfreepayments-d00050e9","hasAudioNarration":false,"actualSubdomain":"cashfreepayments-d00050e9","customDomains":["www.cashfree.com"],"gitSource":{"type":"github","owner":"cashfree","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae0738a0040e29b52141157","collectionId":"bf60a5e0-bbe7-4ccf-9f81-e7233a83105b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae0738a0040e29b52141157"},"feedback":{"thumbs":true,"agentFeedback":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"CONTEXTUAL_FEEDBACK":{"status":"DISABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae0738a0040e29b52141157","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"Payments APIs","count":520},{"language":"default","tag":"Other Versions","count":349},{"language":"default","tag":"Payments","count":304},{"language":"default","tag":"v2026-01-01","count":159},{"language":"default","tag":"Subscription","count":151},{"language":"default","tag":"v2025-01-01","count":150},{"language":"default","tag":"v2023-08-01","count":142},{"language":"default","tag":"Payment Gateway","count":136},{"language":"default","tag":"Secure ID","count":106},{"language":"default","tag":"Payouts","count":105}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":false,"email":"documentation@cashfree.com","showHelpButton":true}},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"starterQuestions":[{"_id":"6916d346c181a220cfa37e8d","deploymentId":"66d5827f2de686bc28e7722b","questionText":"How do I accept payments online?","status":"active","generatedBy":"manual","createdAt":"2025-11-14T06:59:18.295Z","updatedAt":"2025-11-14T06:59:18.295Z","__v":0},{"_id":"6916d306c181a220cfa370e8","deploymentId":"66d5827f2de686bc28e7722b","questionText":"What is Cashfree Hosted Checkout?","status":"active","generatedBy":"manual","createdAt":"2025-11-14T06:58:14.574Z","updatedAt":"2025-11-14T06:58:14.574Z","__v":0},{"_id":"6916d2dbc181a220cfa368a4","deploymentId":"66d5827f2de686bc28e7722b","questionText":"How do I create a payment link?","status":"active","generatedBy":"manual","createdAt":"2025-11-14T06:57:31.657Z","updatedAt":"2025-11-14T06:57:31.657Z","__v":0}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","href":"/docs/_mintlify/custom/cashfreepayments-d00050e9/e1e3b3ccb8bef592/style.css"},{"filePath":"grid.css","content":".container,.container-fluid{margin-right:auto;margin-left:auto}.container{padding-top:3rem;padding-bottom:3rem}.container-fluid{padding:3rem 2rem}.col-xs,.row{box-sizing:border-box}.row{display:-webkit-box;display:-ms-flexbox;display:flex;-webkit-box-flex:0;-ms-flex:0 1 auto;flex:0 1 auto;-webkit-box-orient:horizontal;-webkit-box-direction:normal;-ms-flex-direction:row;flex-direction:row;-ms-flex-wrap:wrap;flex-wrap:wrap;margin-right:-.5rem;margin-left:-.5rem}.col.reverse,.row.reverse{-webkit-box-orient:horizontal;-webkit-box-direction:reverse;-ms-flex-direction:row-reverse;flex-direction:row-reverse}.col.reverse{-webkit-box-orient:vertical;-ms-flex-direction:column-reverse;flex-direction:column-reverse}.col-xs{-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-xs-1,.col-xs-10,.col-xs-11,.col-xs-12,.col-xs-2,.col-xs-3,.col-xs-4,.col-xs-5,.col-xs-6,.col-xs-7,.col-xs-8,.col-xs-9,.col-xs-offset-0,.col-xs-offset-1,.col-xs-offset-10,.col-xs-offset-11,.col-xs-offset-12,.col-xs-offset-2,.col-xs-offset-3,.col-xs-offset-4,.col-xs-offset-5,.col-xs-offset-6,.col-xs-offset-7,.col-xs-offset-8,.col-xs-offset-9{box-sizing:border-box;-webkit-box-flex:0;-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-xs{-webkit-box-flex:1;-ms-flex-positive:1;flex-grow:1;-ms-flex-preferred-size:0;flex-basis:0;max-width:100%}.col-xs-1{-ms-flex-preferred-size:8.33333333%;flex-basis:8.33333333%;max-width:8.33333333%}.col-xs-2{-ms-flex-preferred-size:16.66666667%;flex-basis:16.66666667%;max-width:16.66666667%}.col-xs-3{-ms-flex-preferred-size:25%;flex-basis:25%;max-width:25%}.col-xs-4{-ms-flex-preferred-size:33.33333333%;flex-basis:33.33333333%;max-width:33.33333333%}.col-xs-5{-ms-flex-preferred-size:41.66666667%;flex-basis:41.66666667%;max-width:41.66666667%}.col-xs-6{-ms-flex-preferred-size:50%;flex-basis:50%;max-width:50%}.col-xs-7{-ms-flex-preferred-size:58.33333333%;flex-basis:58.33333333%;max-width:58.33333333%}.col-xs-8{-ms-flex-preferred-size:66.66666667%;flex-basis:66.66666667%;max-width:66.66666667%}.col-xs-9{-ms-flex-preferred-size:75%;flex-basis:75%;max-width:75%}.col-xs-10{-ms-flex-preferred-size:83.33333333%;flex-basis:83.33333333%;max-width:83.33333333%}.col-xs-11{-ms-flex-preferred-size:91.66666667%;flex-basis:91.66666667%;max-width:91.66666667%}.col-xs-12{-ms-flex-preferred-size:100%;flex-basis:100%;max-width:100%}.col-xs-offset-0{margin-left:0}.col-xs-offset-1{margin-left:8.33333333%}.col-xs-offset-2{margin-left:16.66666667%}.col-xs-offset-3{margin-left:25%}.col-xs-offset-4{margin-left:33.33333333%}.col-xs-offset-5{margin-left:41.66666667%}.col-xs-offset-6{margin-left:50%}.col-xs-offset-7{margin-left:58.33333333%}.col-xs-offset-8{margin-left:66.66666667%}.col-xs-offset-9{margin-left:75%}.col-xs-offset-10{margin-left:83.33333333%}.col-xs-offset-11{margin-left:91.66666667%}.start-xs{-webkit-box-pack:start;-ms-flex-pack:start;justify-content:flex-start;text-align:start}.center-xs{-webkit-box-pack:center;-ms-flex-pack:center;justify-content:center;text-align:center}.end-xs{-webkit-box-pack:end;-ms-flex-pack:end;justify-content:flex-end;text-align:end}.top-xs{-webkit-box-align:start;-ms-flex-align:start;align-items:flex-start}.middle-xs{-webkit-box-align:center;-ms-flex-align:center;align-items:center}.bottom-xs{-webkit-box-align:end;-ms-flex-align:end;align-items:flex-end}.around-xs{-ms-flex-pack:distribute;justify-content:space-around}.between-xs{-webkit-box-pack:justify;-ms-flex-pack:justify;justify-content:space-between}.first-xs{-webkit-box-ordinal-group:0;-ms-flex-order:-1;order:-1}.last-xs{-webkit-box-ordinal-group:2;-ms-flex-order:1;order:1}@media only screen and (min-width:48em){.container{width:49rem}.col-sm{box-sizing:border-box;-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-sm-1,.col-sm-10,.col-sm-11,.col-sm-12,.col-sm-2,.col-sm-3,.col-sm-4,.col-sm-5,.col-sm-6,.col-sm-7,.col-sm-8,.col-sm-9,.col-sm-offset-0,.col-sm-offset-1,.col-sm-offset-10,.col-sm-offset-11,.col-sm-offset-12,.col-sm-offset-2,.col-sm-offset-3,.col-sm-offset-4,.col-sm-offset-5,.col-sm-offset-6,.col-sm-offset-7,.col-sm-offset-8,.col-sm-offset-9{box-sizing:border-box;-webkit-box-flex:0;-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-sm{-webkit-box-flex:1;-ms-flex-positive:1;flex-grow:1;-ms-flex-preferred-size:0;flex-basis:0;max-width:100%}.col-sm-1{-ms-flex-preferred-size:8.33333333%;flex-basis:8.33333333%;max-width:8.33333333%}.col-sm-2{-ms-flex-preferred-size:16.66666667%;flex-basis:16.66666667%;max-width:16.66666667%}.col-sm-3{-ms-flex-preferred-size:25%;flex-basis:25%;max-width:25%}.col-sm-4{-ms-flex-preferred-size:33.33333333%;flex-basis:33.33333333%;max-width:33.33333333%}.col-sm-5{-ms-flex-preferred-size:41.66666667%;flex-basis:41.66666667%;max-width:41.66666667%}.col-sm-6{-ms-flex-preferred-size:50%;flex-basis:50%;max-width:50%}.col-sm-7{-ms-flex-preferred-size:58.33333333%;flex-basis:58.33333333%;max-width:58.33333333%}.col-sm-8{-ms-flex-preferred-size:66.66666667%;flex-basis:66.66666667%;max-width:66.66666667%}.col-sm-9{-ms-flex-preferred-size:75%;flex-basis:75%;max-width:75%}.col-sm-10{-ms-flex-preferred-size:83.33333333%;flex-basis:83.33333333%;max-width:83.33333333%}.col-sm-11{-ms-flex-preferred-size:91.66666667%;flex-basis:91.66666667%;max-width:91.66666667%}.col-sm-12{-ms-flex-preferred-size:100%;flex-basis:100%;max-width:100%}.col-sm-offset-0{margin-left:0}.col-sm-offset-1{margin-left:8.33333333%}.col-sm-offset-2{margin-left:16.66666667%}.col-sm-offset-3{margin-left:25%}.col-sm-offset-4{margin-left:33.33333333%}.col-sm-offset-5{margin-left:41.66666667%}.col-sm-offset-6{margin-left:50%}.col-sm-offset-7{margin-left:58.33333333%}.col-sm-offset-8{margin-left:66.66666667%}.col-sm-offset-9{margin-left:75%}.col-sm-offset-10{margin-left:83.33333333%}.col-sm-offset-11{margin-left:91.66666667%}.start-sm{-webkit-box-pack:start;-ms-flex-pack:start;justify-content:flex-start;text-align:start}.center-sm{-webkit-box-pack:center;-ms-flex-pack:center;justify-content:center;text-align:center}.end-sm{-webkit-box-pack:end;-ms-flex-pack:end;justify-content:flex-end;text-align:end}.top-sm{-webkit-box-align:start;-ms-flex-align:start;align-items:flex-start}.middle-sm{-webkit-box-align:center;-ms-flex-align:center;align-items:center}.bottom-sm{-webkit-box-align:end;-ms-flex-align:end;align-items:flex-end}.around-sm{-ms-flex-pack:distribute;justify-content:space-around}.between-sm{-webkit-box-pack:justify;-ms-flex-pack:justify;justify-content:space-between}.first-sm{-webkit-box-ordinal-group:0;-ms-flex-order:-1;order:-1}.last-sm{-webkit-box-ordinal-group:2;-ms-flex-order:1;order:1}}@media only screen and (min-width:64em){.container{width:65rem}.col-md{box-sizing:border-box;-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-md-1,.col-md-10,.col-md-11,.col-md-12,.col-md-2,.col-md-3,.col-md-4,.col-md-5,.col-md-6,.col-md-7,.col-md-8,.col-md-9,.col-md-offset-0,.col-md-offset-1,.col-md-offset-10,.col-md-offset-11,.col-md-offset-12,.col-md-offset-2,.col-md-offset-3,.col-md-offset-4,.col-md-offset-5,.col-md-offset-6,.col-md-offset-7,.col-md-offset-8,.col-md-offset-9{box-sizing:border-box;-webkit-box-flex:0;-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-md{-webkit-box-flex:1;-ms-flex-positive:1;flex-grow:1;-ms-flex-preferred-size:0;flex-basis:0;max-width:100%}.col-md-1{-ms-flex-preferred-size:8.33333333%;flex-basis:8.33333333%;max-width:8.33333333%}.col-md-2{-ms-flex-preferred-size:16.66666667%;flex-basis:16.66666667%;max-width:16.66666667%}.col-md-3{-ms-flex-preferred-size:25%;flex-basis:25%;max-width:25%}.col-md-4{-ms-flex-preferred-size:33.33333333%;flex-basis:33.33333333%;max-width:33.33333333%}.col-md-5{-ms-flex-preferred-size:41.66666667%;flex-basis:41.66666667%;max-width:41.66666667%}.col-md-6{-ms-flex-preferred-size:50%;flex-basis:50%;max-width:50%}.col-md-7{-ms-flex-preferred-size:58.33333333%;flex-basis:58.33333333%;max-width:58.33333333%}.col-md-8{-ms-flex-preferred-size:66.66666667%;flex-basis:66.66666667%;max-width:66.66666667%}.col-md-9{-ms-flex-preferred-size:75%;flex-basis:75%;max-width:75%}.col-md-10{-ms-flex-preferred-size:83.33333333%;flex-basis:83.33333333%;max-width:83.33333333%}.col-md-11{-ms-flex-preferred-size:91.66666667%;flex-basis:91.66666667%;max-width:91.66666667%}.col-md-12{-ms-flex-preferred-size:100%;flex-basis:100%;max-width:100%}.col-md-offset-0{margin-left:0}.col-md-offset-1{margin-left:8.33333333%}.col-md-offset-2{margin-left:16.66666667%}.col-md-offset-3{margin-left:25%}.col-md-offset-4{margin-left:33.33333333%}.col-md-offset-5{margin-left:41.66666667%}.col-md-offset-6{margin-left:50%}.col-md-offset-7{margin-left:58.33333333%}.col-md-offset-8{margin-left:66.66666667%}.col-md-offset-9{margin-left:75%}.col-md-offset-10{margin-left:83.33333333%}.col-md-offset-11{margin-left:91.66666667%}.start-md{-webkit-box-pack:start;-ms-flex-pack:start;justify-content:flex-start;text-align:start}.center-md{-webkit-box-pack:center;-ms-flex-pack:center;justify-content:center;text-align:center}.end-md{-webkit-box-pack:end;-ms-flex-pack:end;justify-content:flex-end;text-align:end}.top-md{-webkit-box-align:start;-ms-flex-align:start;align-items:flex-start}.middle-md{-webkit-box-align:center;-ms-flex-align:center;align-items:center}.bottom-md{-webkit-box-align:end;-ms-flex-align:end;align-items:flex-end}.around-md{-ms-flex-pack:distribute;justify-content:space-around}.between-md{-webkit-box-pack:justify;-ms-flex-pack:justify;justify-content:space-between}.first-md{-webkit-box-ordinal-group:0;-ms-flex-order:-1;order:-1}.last-md{-webkit-box-ordinal-group:2;-ms-flex-order:1;order:1}}@media only screen and (min-width:75em){.container{width:76rem}.col-lg{box-sizing:border-box;-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-lg-1,.col-lg-10,.col-lg-11,.col-lg-12,.col-lg-2,.col-lg-3,.col-lg-4,.col-lg-5,.col-lg-6,.col-lg-7,.col-lg-8,.col-lg-9,.col-lg-offset-0,.col-lg-offset-1,.col-lg-offset-10,.col-lg-offset-11,.col-lg-offset-12,.col-lg-offset-2,.col-lg-offset-3,.col-lg-offset-4,.col-lg-offset-5,.col-lg-offset-6,.col-lg-offset-7,.col-lg-offset-8,.col-lg-offset-9{box-sizing:border-box;-webkit-box-flex:0;-ms-flex:0 0 auto;flex:0 0 auto;padding-right:.5rem;padding-left:.5rem}.col-lg{-webkit-box-flex:1;-ms-flex-positive:1;flex-grow:1;-ms-flex-preferred-size:0;flex-basis:0;max-width:100%}.col-lg-1{-ms-flex-preferred-size:8.33333333%;flex-basis:8.33333333%;max-width:8.33333333%}.col-lg-2{-ms-flex-preferred-size:16.66666667%;flex-basis:16.66666667%;max-width:16.66666667%}.col-lg-3{-ms-flex-preferred-size:25%;flex-basis:25%;max-width:25%}.col-lg-4{-ms-flex-preferred-size:33.33333333%;flex-basis:33.33333333%;max-width:33.33333333%}.col-lg-5{-ms-flex-preferred-size:41.66666667%;flex-basis:41.66666667%;max-width:41.66666667%}.col-lg-6{-ms-flex-preferred-size:50%;flex-basis:50%;max-width:50%}.col-lg-7{-ms-flex-preferred-size:58.33333333%;flex-basis:58.33333333%;max-width:58.33333333%}.col-lg-8{-ms-flex-preferred-size:66.66666667%;flex-basis:66.66666667%;max-width:66.66666667%}.col-lg-9{-ms-flex-preferred-size:75%;flex-basis:75%;max-width:75%}.col-lg-10{-ms-flex-preferred-size:83.33333333%;flex-basis:83.33333333%;max-width:83.33333333%}.col-lg-11{-ms-flex-preferred-size:91.66666667%;flex-basis:91.66666667%;max-width:91.66666667%}.col-lg-12{-ms-flex-preferred-size:100%;flex-basis:100%;max-width:100%}.col-lg-offset-0{margin-left:0}.col-lg-offset-1{margin-left:8.33333333%}.col-lg-offset-2{margin-left:16.66666667%}.col-lg-offset-3{margin-left:25%}.col-lg-offset-4{margin-left:33.33333333%}.col-lg-offset-5{margin-left:41.66666667%}.col-lg-offset-6{margin-left:50%}.col-lg-offset-7{margin-left:58.33333333%}.col-lg-offset-8{margin-left:66.66666667%}.col-lg-offset-9{margin-left:75%}.col-lg-offset-10{margin-left:83.33333333%}.col-lg-offset-11{margin-left:91.66666667%}.start-lg{-webkit-box-pack:start;-ms-flex-pack:start;justify-content:flex-start;text-align:start}.center-lg{-webkit-box-pack:center;-ms-flex-pack:center;justify-content:center;text-align:center}.end-lg{-webkit-box-pack:end;-ms-flex-pack:end;justify-content:flex-end;text-align:end}.top-lg{-webkit-box-align:start;-ms-flex-align:start;align-items:flex-start}.middle-lg{-webkit-box-align:center;-ms-flex-align:center;align-items:center}.bottom-lg{-webkit-box-align:end;-ms-flex-align:end;align-items:flex-end}.around-lg{-ms-flex-pack:distribute;justify-content:space-around}.between-lg{-webkit-box-pack:justify;-ms-flex-pack:justify;justify-content:space-between}.first-lg{-webkit-box-ordinal-group:0;-ms-flex-order:-1;order:-1}.last-lg{-webkit-box-ordinal-group:2;-ms-flex-order:1;order:1}}"},{"filePath":"typography.css","content":".landing-page h1{font-size:2.4rem}.landing-page h2{font-size:2rem}.landing-page h3{font-size:1.6rem}.landing-page h4{font-size:1.2rem}.landing-page h5{font-size:1rem}.landing-page h6{font-size:.8rem}.bold{font-weight:700}.semibold{font-weight:600}.medium{font-weight:500}.regular{font-weight:400}.light{font-weight:300}"}],"page":{"pagePath":"api-reference/vrs/v2/kyc-links/get-form-status","slug":"/api-reference/vrs/v2/kyc-links/get-form-status","pageMetadata":{"openapi":"get /form","og:title":"KYC Form Status | Cashfree","og:description":"Query the Cashfree KYC link status endpoint to retrieve module-level verification results, the journey's current state, and any captured customer attributes.","keywords":["KYC links","form links","identity verification","API reference","REST API"],"title":"Get KYC Link Status","description":"Use this API to get the status of the KYC link by passing `verification_id` or `reference_id` to get the KYC Link status.","href":"/api-reference/vrs/v2/kyc-links/get-form-status","hidden":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Use this API to get the status of the KYC link by passing \", _jsx(_components.code, {\n children: \"verification_id\"\n }), \" or \", _jsx(_components.code, {\n children: \"reference_id\"\n }), \" to get the KYC Link status.\"]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"openapi":"get /form","og:title":"KYC Form Status | Cashfree","og:description":"Query the Cashfree KYC link status endpoint to retrieve module-level verification results, the journey's current state, and any captured customer attributes.","keywords":["KYC links","form links","identity verification","API reference","REST API"],"title":"Get KYC Link Status","description":"Use this API to get the status of the KYC link by passing `verification_id` or `reference_id` to get the KYC Link status.","href":"/api-reference/vrs/v2/kyc-links/get-form-status","hidden":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/cashfreepayments-d00050e9/0a1efd0b138512b4/util/downloadImages.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/7b49b0aba32ccd66/util/checkLinks.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/6520965c686ab08e/util/updateFrontmatter.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/e6313895ea4c2bf0/export-docs/export.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/6459e4b38b43a234/export-docs/sync-kb.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/82d5b75dd1e333d2/snippets/postman-buttons/postman-links.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/e8f71dc9fab8d95d/scripts/ga4-video-tracking.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/e3b0c44298fc1c14/scripts/generate-postman-buttons.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/bc4eac15553663a2/scripts/openapi-rm-desc.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/5748000362acad1e/scripts/quote-openapi.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/0a7365ce97b5cca7/scripts/script.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/d99a96c0c4b010fe/scripts/updateHelpAccordionsWithPostHog.js","/docs/_mintlify/custom/cashfreepayments-d00050e9/bd8561d01634fd2e/scripts/updateIframeSrc.js"],"openApiReferenceData":{"operation":{"tags":["Get KYC Link Status"],"operationId":"VrsGetKYCLinkStatus","security":["ad88be4c-0468-4d29-afc9-eb2f8b6b2d45"],"summary":"Get KYC Link Status","description":"Use this API to get the status of the KYC link by passing `verification_id` or `reference_id` to get the KYC Link status.","parameters":["1a4ad364-9e78-4b9b-abb0-51a7c16670c0","91caf832-6d9a-4e7d-9233-8e6fb4e307c9","3b035ffd-6f4c-43f8-9e79-f4ad927d6da7"],"responses":{"200":"e07808dc-4f43-40ee-9551-0c230650ad98","400":"0ae31728-8d41-41b0-b10a-5192689a0c37","401":"ae22aeda-b8db-496f-8db8-00d73d4b6678","403":"bb82261d-b28c-4b1c-bb4a-36053ea41499","404":"b4fadbf1-dfd2-42f6-9f45-5082cfec62bc","429":"8932f880-c18b-4e68-bb3a-e60b98f20e70","500":"84ab1e80-d270-41bc-94c0-9440b94a170c"},"method":"get","type":"path","servers":["e8722298-3b0c-45ea-bd61-34ad60b3de53","9e0e60d8-0a97-45a8-bb99-5d45e7de8b0b"],"path":"/form","baseUrlOptions":["https://sandbox.cashfree.com/verification","https://api.cashfree.com/verification"],"title":"Get KYC Link Status","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"1a4ad364-9e78-4b9b-abb0-51a7c16670c0":{"description":"Send the signature if two-factor authentication is selected as Public Key. [More details](https://www.cashfree.com/docs/api-reference/vrs/getting-started#2fa-api-signature-generation).","name":"x-cf-signature","in":"header","required":false,"schema":{"type":"string","isRequired":false,"description":"Send the signature if two-factor authentication is selected as Public Key. [More details](https://www.cashfree.com/docs/api-reference/vrs/getting-started#2fa-api-signature-generation).","uniqueKey":"","typeLabel":"string"},"example":""},"91caf832-6d9a-4e7d-9233-8e6fb4e307c9":{"name":"verificationID","description":"It is the unique ID you created to identify the KYC link.","in":"query","required":false,"schema":{"type":"string","example":"ABC00123","default":"ABC00123","isRequired":false,"description":"It is the unique ID you created to identify the KYC link.","uniqueKey":"","typeLabel":"string"}},"3b035ffd-6f4c-43f8-9e79-f4ad927d6da7":{"name":"referenceID","description":"It is the unique ID you receive in the response of Generate KYC Link API.","in":"query","required":false,"schema":{"type":"string","example":"235461","default":"235461","isRequired":false,"description":"It is the unique ID you receive in the response of Generate KYC Link API.","uniqueKey":"","typeLabel":"string"}}},"responses":{"e07808dc-4f43-40ee-9551-0c230650ad98":{"description":"Response Body of VRS GetFormStatus API.","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"It displays the name of the individual.","example":"John Doe","uniqueKey":"name","typeLabel":"string"},"phone":{"type":"string","description":"It displays the phone number of the individual.","example":9999999999,"uniqueKey":"phone","typeLabel":"string"},"email":{"type":"string","description":"It displays the email address of the individual.","example":"test@cashfree.com","uniqueKey":"email","typeLabel":"string"},"verification_id":{"type":"string","description":"It displays the unique ID you created to identify the form.","example":"testverificationid","uniqueKey":"verification_id","typeLabel":"string"},"reference_id":{"type":"integer","description":"It displays the unique ID created by Cashfree for reference purposes.","example":235461,"uniqueKey":"reference_id","typeLabel":"integer"},"link_expiry":{"type":"string","description":"It displays the expiry date of the link.","example":"2025-12-02","uniqueKey":"link_expiry","typeLabel":"string"},"form_link":{"type":"string","description":"It displays the URL of the form.","example":"https://forms.cashfree.com/","uniqueKey":"form_link","typeLabel":"string"},"form_status":{"type":"string","description":"It displays the status of the form.","example":"PENDING","uniqueKey":"form_status","typeLabel":"string"},"verification_details":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"reference_id":{"type":"integer","description":"It displays the unique ID created by Cashfree for reference purposes.","example":234,"uniqueKey":"verification_details.items.[INDEX].oneOf.0.reference_id","typeLabel":"integer"},"type":{"type":"string","description":"It displays the verification type.","example":"OFFLINE_AADHAAR_VERIFICATION","uniqueKey":"verification_details.items.[INDEX].oneOf.0.type","typeLabel":"string"},"status":{"type":"string","description":"It displays the verification status.","example":"SUCCESS","uniqueKey":"verification_details.items.[INDEX].oneOf.0.status","typeLabel":"string"}},"uniqueKey":"verification_details.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","properties":{"reference_id":{"type":"integer","example":0,"uniqueKey":"verification_details.items.[INDEX].oneOf.1.reference_id","typeLabel":"integer"},"type":{"type":"string","example":"PANDETAILS_VERIFICATION","uniqueKey":"verification_details.items.[INDEX].oneOf.1.type","typeLabel":"string"},"status":{"type":"string","example":"PENDING","uniqueKey":"verification_details.items.[INDEX].oneOf.1.status","typeLabel":"string"}},"uniqueKey":"verification_details.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","properties":{"reference_id":{"type":"integer","example":236,"uniqueKey":"verification_details.items.[INDEX].oneOf.2.reference_id","typeLabel":"integer"},"type":{"type":"string","example":"BANKDETAILS_VALIDATION","uniqueKey":"verification_details.items.[INDEX].oneOf.2.type","typeLabel":"string"},"status":{"type":"string","example":"FAILED","uniqueKey":"verification_details.items.[INDEX].oneOf.2.status","typeLabel":"string"}},"uniqueKey":"verification_details.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","properties":{"reference_id":{"type":"integer","example":237,"uniqueKey":"verification_details.items.[INDEX].oneOf.3.reference_id","typeLabel":"integer"},"type":{"type":"string","example":"UPIDETAILS_VALIDATION","uniqueKey":"verification_details.items.[INDEX].oneOf.3.type","typeLabel":"string"},"status":{"type":"string","example":"FAILED","uniqueKey":"verification_details.items.[INDEX].oneOf.3.status","typeLabel":"string"}},"uniqueKey":"verification_details.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"verification_details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"verification_details","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"John Doe","phone":9999999999,"email":"test@cashfree.com","verification_id":"testverificationid","reference_id":235461,"link_expiry":"2025-12-02","form_link":"https://forms.cashfree.com/","form_status":"PENDING","verification_details":[{"reference_id":234,"type":"OFFLINE_AADHAAR_VERIFICATION","status":"SUCCESS"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"0ae31728-8d41-41b0-b10a-5192689a0c37":{"description":"Get Form Status responses for 400.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"x-client-id_missing","uniqueKey":"code","typeLabel":"string"},"error":{"type":"object","example":{"ref_id":102},"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","example":"x-client-id is missing in the request.","description":"It displays the outcome of the error.","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","description":"It displays the type of error.","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Reference ID or Verification ID Missing":{"title":"Reference ID or Verification ID Missing","value":{"type":"validation_error","code":"invalid_request","message":"Provide verificationID or referenceID"}},"Client ID in Missing":{"title":"Client ID in Missing","value":{"type":"validation_error","code":"x-client-id_missing","message":"x-client-id is missing in the request."}},"Client Secret in Missing":{"title":"Client Secret in Missing","value":{"type":"validation_error","code":"x-client-secret_missing","message":"x-client-secret is missing in the request."}}},"exampleType":"examples"}},"exampleType":"examples"},"ae22aeda-b8db-496f-8db8-00d73d4b6678":{"description":"Invalid client ID and client secret combination.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"x-client-id_missing","uniqueKey":"code","typeLabel":"string"},"error":{"type":"object","example":{"ref_id":102},"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","example":"x-client-id is missing in the request.","description":"It displays the outcome of the error.","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","description":"It displays the type of error.","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Invalid client ID and client secret combination":{"title":"Invalid client ID and client secret combination","value":{"type":"authentication_error","code":"authentication_failed","message":"Invalid clientId and clientSecret combination"}}},"exampleType":"examples"}},"exampleType":"examples"},"bb82261d-b28c-4b1c-bb4a-36053ea41499":{"description":"Authentication error (IP not whitelisted).","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"x-client-id_missing","uniqueKey":"code","typeLabel":"string"},"error":{"type":"object","example":{"ref_id":102},"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","example":"x-client-id is missing in the request.","description":"It displays the outcome of the error.","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","description":"It displays the type of error.","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"IP not whitelisted":{"title":"IP not whitelisted","value":{"type":"authentication_error","code":"ip_validation_failed","message":"IP not whitelisted your current ip is 106.51.91.104.For IP whitelisting assistance, visit our guide at https://www.cashfree.com/docs/secure-id/get-started/integration/ip-whitelisting-verification"}},"x-cf-signature header missing":{"title":"x-cf-signature header missing","value":{"type":"validation_error","code":"authentication_failed","message":"x-cf-signature missing in the request header"}}},"exampleType":"examples"}},"exampleType":"examples"},"b4fadbf1-dfd2-42f6-9f45-5082cfec62bc":{"description":"Not found error.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"x-client-id_missing","uniqueKey":"code","typeLabel":"string"},"error":{"type":"object","example":{"ref_id":102},"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","example":"x-client-id is missing in the request.","description":"It displays the outcome of the error.","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","description":"It displays the type of error.","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"not_found_error","code":"Resource not found","message":"No data found"},"examples":{"Example":{"title":"Example","value":{"type":"not_found_error","code":"Resource not found","message":"No data found"}}},"exampleType":"examples"}},"exampleType":"examples"},"8932f880-c18b-4e68-bb3a-e60b98f20e70":{"description":"Rate limit exceed error.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"x-client-id_missing","uniqueKey":"code","typeLabel":"string"},"error":{"type":"object","example":{"ref_id":102},"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","example":"x-client-id is missing in the request.","description":"It displays the outcome of the error.","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","description":"It displays the type of error.","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Rate limit error per operation":{"title":"Rate limit error per operation","value":{"type":"rate_limit_error","code":"too_many_requests_per_operation","message":"Too many requests for this operation, rate limit reached"}},"Rate limit error per IP":{"title":"Rate limit error per IP","value":{"type":"rate_limit_error","code":"too_many_requests_per_ip","message":"Too many requests from the IP, rate limit reached"}}},"exampleType":"examples"}},"exampleType":"examples"},"84ab1e80-d270-41bc-94c0-9440b94a170c":{"description":"Internal error.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","example":"x-client-id_missing","uniqueKey":"code","typeLabel":"string"},"error":{"type":"object","example":{"ref_id":102},"uniqueKey":"error","typeLabel":"object"},"message":{"type":"string","example":"x-client-id is missing in the request.","description":"It displays the outcome of the error.","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","example":"validation_error","description":"It displays the type of error.","uniqueKey":"type","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Internal Server Error":{"title":"Internal Server Error","value":{"type":"internal_error","code":"request_failed","message":"Unable to process your request. Try again after some time"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"ad88be4c-0468-4d29-afc9-eb2f8b6b2d45":{"XClientID":{"type":"apiKey","in":"header","name":"x-client-id","description":"Your unique client identifier issued by Cashfree. You can find this in your [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).","scopes":[]},"XClientSecret":{"type":"apiKey","in":"header","name":"x-client-secret","description":"The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).","scopes":[]}}},"servers":{"e8722298-3b0c-45ea-bd61-34ad60b3de53":{"description":"Sandbox Server","url":"https://sandbox.cashfree.com/verification"},"9e0e60d8-0a97-45a8-bb99-5d45e7de8b0b":{"description":"Production Server","url":"https://api.cashfree.com/verification"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-client-id","description":"Your unique client identifier issued by Cashfree. You can find this in your [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).","scopes":[]},"schema":{"title":"x-client-id","type":"string","description":"Your unique client identifier issued by Cashfree. You can find this in your [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"XClientID","name":"x-client-id"},{"scheme":{"type":"apiKey","in":"header","name":"x-client-secret","description":"The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).","scopes":[]},"schema":{"title":"x-client-secret","type":"string","description":"The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/developers/api-keys).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"XClientSecret","name":"x-client-secret"}],"title":"XClientID \u0026 XClientSecret"}]},"originalFileLocation":"openapi/vrs/vrsv2.yaml"},"subdomain":"cashfreepayments-d00050e9","siteName":"Cashfree Developer Documentation","title":"KYC Form Status | Cashfree","relatedPagesConfig":{"enabled":true,"limit":5,"mode":"manual"},"contextualStarterQuestions":[{"_id":"6a79b1813629fc88876e01f0","deploymentId":"66d5827f2de686bc28e7722b","questionText":"Can I use reference_id to check?","status":"active","generatedBy":"contextual","path":"api-reference/vrs/v2/kyc-links/get-form-status","createdAt":"2026-08-10T11:09:53.186Z","updatedAt":"2026-08-10T11:09:53.186Z","__v":0},{"_id":"6a79b1813629fc88876e01ef","deploymentId":"66d5827f2de686bc28e7722b","questionText":"What parameters are needed for status?","status":"active","generatedBy":"contextual","path":"api-reference/vrs/v2/kyc-links/get-form-status","createdAt":"2026-08-10T11:09:53.186Z","updatedAt":"2026-08-10T11:09:53.186Z","__v":0},{"_id":"6a79b1813629fc88876e01ee","deploymentId":"66d5827f2de686bc28e7722b","questionText":"How do I check KYC link status?","status":"active","generatedBy":"contextual","path":"api-reference/vrs/v2/kyc-links/get-form-status","createdAt":"2026-08-10T11:09:53.186Z","updatedAt":"2026-08-10T11:09:53.186Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-09T10:17:23.924Z","originalFileLocation":"api-reference/vrs/v2/kyc-links/get-form-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=\"light\"}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=\"Use this API to get the status of the KYC link by passing verification_id or reference_id to get the KYC Link status.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cashfree Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"KYC Form Status | Cashfree\">\u003cmeta data-mint-head property=\"og:description\" content=\"Query the Cashfree KYC link status endpoint to retrieve module-level verification results, the journey\u0026#x27;s current state, and any captured customer attributes.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cashfree Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/get-form-status\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cashfreepayments-d00050e9.mintlify.app/_mintlify/api/og/v2?division=KYC+Links\u0026amp;title=Get+KYC+Link+Status\u0026amp;description=Use+this+API+to+get+the+status+of+the+KYC+link+by+passing+%60verification_id%60+or+%60reference_id%60+to+get+the+KYC+Link+status.\u0026amp;theme=2adde9c6a50d91a75e16dbfe\u0026amp;signature=77069c2141a11c86baf9dafd0aeb758a7265470106648a35b4c49a05e815d2a2\">\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=\"KYC Form Status | Cashfree\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Query the Cashfree KYC link status endpoint to retrieve module-level verification results, the journey\u0026#x27;s current state, and any captured customer attributes.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cashfreepayments-d00050e9.mintlify.app/_mintlify/api/og/v2?division=KYC+Links\u0026amp;title=Get+KYC+Link+Status\u0026amp;description=Use+this+API+to+get+the+status+of+the+KYC+link+by+passing+%60verification_id%60+or+%60reference_id%60+to+get+the+KYC+Link+status.\u0026amp;theme=2adde9c6a50d91a75e16dbfe\u0026amp;signature=77069c2141a11c86baf9dafd0aeb758a7265470106648a35b4c49a05e815d2a2\">\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/cashfreepayments-d00050e9/MP8bOqKxh3TohVa1/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cashfree Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6930ca\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"T69Ao_T0Ps8pkRbluKzW179qvd_aCsWISCApeSsIhRU\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/get-form-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/api-reference/vrs/v2/kyc-links/get-form-status.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.cashfree.com/#organization\",\"name\":\"Cashfree Developer Documentation\",\"url\":\"https://www.cashfree.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cashfreepayments-d00050e9/6mQw7is1us8FhXrb/static/logo/light.svg?fit=max\u0026auto=format\u0026n=6mQw7is1us8FhXrb\u0026q=85\u0026s=8a2837083063d8a01e0be6b454a1baf1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.cashfree.com/docs#website\",\"name\":\"Cashfree Developer Documentation\",\"url\":\"https://www.cashfree.com/docs\",\"publisher\":{\"@id\":\"https://www.cashfree.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/get-form-status#webpage\",\"url\":\"https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/get-form-status\",\"name\":\"Get KYC Link Status\",\"description\":\"Use this API to get the status of the KYC link by passing verification_id or reference_id to get the KYC Link status.\",\"dateModified\":\"2026-02-09T10:17:23.924Z\",\"isPartOf\":{\"@id\":\"https://www.cashfree.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/get-form-status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/get-form-status#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"V2\",\"item\":\"https://www.cashfree.com/docs/api-reference/vrs/v2/bav-v2/bank-account-verification-sync-v2\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"KYC Links\",\"item\":\"https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/generate-form-link\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get KYC Link Status\",\"item\":\"https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/get-form-status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/get-form-status#apireference\",\"headline\":\"Get KYC Link Status\",\"name\":\"Get KYC Link Status\",\"description\":\"Use this API to get the status of the KYC link by passing verification_id or reference_id to get the KYC Link status.\",\"url\":\"https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/get-form-status\",\"mainEntityOfPage\":{\"@id\":\"https://www.cashfree.com/docs/api-reference/vrs/v2/kyc-links/get-form-status#webpage\"},\"dateModified\":\"2026-02-09T10:17:23.924Z\",\"keywords\":\"KYC links, form links, identity verification, API reference, REST API\",\"publisher\":{\"@id\":\"https://www.cashfree.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.cashfree.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cashfree Developer Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cashfree Developer Documentation","nav":{"global":null,"tabs":[{"tab":"Payments","pages":[{"title":"Payments","href":"/payments/introduction"}]},{"tab":"Payouts","pages":[{"title":"Payouts","href":"/payouts/payouts/introduction"}]},{"tab":"Secure ID","pages":[{"title":"Secure ID","href":"/secure-id/introduction"}]},{"tab":"Partners and Platforms","pages":[{"title":"Partners and Platforms","href":"/partners/introduction"}]},{"tab":"Payments APIs","hidden":true,"pages":[{"title":"Payments APIs","href":"/api-reference/payments/overview"}]},{"tab":"Payouts APIs","hidden":true,"pages":[{"title":"Payouts APIs","href":"/api-reference/payouts/overview"}]},{"tab":"Secure ID APIs","hidden":true,"groups":[{"group":"Secure ID APIs","pages":[{"title":"Overview","sidebarTitle":"Overview","description":"Use Cashfree Secure ID REST APIs to verify identities, documents, and bank accounts in real time with webhooks, SDKs, and bulk processing support.","href":"/api-reference/vrs/overview"},{"title":"Getting Started","sidebarTitle":"Getting Started","description":"Set up your Cashfree Secure ID integration by generating API keys, whitelisting IPs, configuring 2FA signatures, and reviewing test endpoints before going live.","href":"/api-reference/vrs/getting-started"},{"title":"Server Side SDKs","sidebarTitle":"Server Side SDKs","description":"Install and configure Cashfree Secure ID server SDKs for Node.js, Java, Python, and PHP to call KYC and verification APIs without writing low-level REST code.","href":"/api-reference/vrs/v2/sdk/verification-suite-server-sdks"},{"title":"API Rate Limits","sidebarTitle":"Rate Limits","description":"Review transactions-per-minute rate limits for Cashfree Secure ID verification APIs and follow best practices to keep production traffic within quotas.","icon":null,"iconType":"solid","href":"/api-reference/vrs/v2/verification-rate-limits"},{"group":"Webhooks","pages":[{"title":"Secure ID Webhooks","sidebarTitle":"Overview","description":"Index of Secure ID webhooks (Video KYC, BAV, reverse penny drop, DigiLocker, KYC links, e-sign) and a link to signature verification.","icon":"webhook","href":"/api-reference/vrs/webhooks-overview"},{"title":"Webhook Signature Verification","sidebarTitle":"Signature Verification","description":"Validate the x-webhook-signature header on Cashfree Secure ID webhooks to confirm payload authenticity and protect your backend from spoofed events.","icon":"webhook","iconType":"solid","href":"/api-reference/vrs/webhook-signature-verification"}]},{"title":"Data to Test Integration","sidebarTitle":"Data to Test Integration","description":"Use these sample documents, bank accounts, and parameters to validate every Cashfree Secure ID API across both success and failure verification scenarios.","icon":null,"iconType":"solid","href":"/api-reference/vrs/data-to-test-integration"}]},{"group":"V2","pages":[{"group":"Bank Account Verification","pages":[{"group":"BAV V2","pages":[{"group":"Sync","pages":[{"openapi":"post /bank-account/sync","title":"Bank Account Verification Sync V2","description":"Use this API to perform real-time validation of bank account numbers and IFSC codes. This synchronous verification provides instant results for immediate account verification needs.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#bank-numbers) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/bav-v2/bank-account-verification-sync-v2"}]},{"group":"Async","pages":[{"openapi":"post /bank-account/async","title":"Bank Account Verification Async V2","description":"Use this API to verify bank account information. This asynchronous verification returns results via webhook or status polling. \n\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#bank-numbers) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/bav-v2/bank-account-verification-async-v2"},{"openapi":"get /bank-account","title":"Get BAV Status V2","description":"Use this API to check the status of your bank verification requests by passing reference ID or user ID to see if the validation is complete and get the results.","href":"/api-reference/vrs/v2/bav-v2/get-bav-status-v2"}]},{"group":"Bulk","pages":[{"openapi":"post /bank-account/bulk","title":"Bulk Bank Account Verification V2","description":"Use this API to verify bank account information in bulk.\n\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#bank-numbers) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/bav-v2/bulk-bank-account-verification-v2"},{"openapi":"get /bank-account/bulk","title":"Get Bulk BAV Status V2","description":"Use this API to get the details of the bulk bank account verification request by passing either the bulk reference ID or bulk validation ID. If you want to get the status of a single entry, pass the particular reference ID in the request. ","href":"/api-reference/vrs/v2/bav-v2/get-bulk-bav-status-v2"}]},{"title":"BAV Response Description","sidebarTitle":"BAV Response Description","description":"Decode every Cashfree Bank Account Verification API response field, including account_status codes, name match scores, and bank identifier metadata.","icon":null,"iconType":"solid","href":"/api-reference/vrs/v2/bav-v2/bav-response-description"},{"title":"Webhooks","sidebarTitle":"Webhooks","description":"Subscribe to Cashfree async Bank Account Verification webhooks to receive penny drop and BAV result events when verification completes for users.","icon":"webhook","href":"/api-reference/vrs/v2/bav-v2/webhooks-bank-account-verification"}]},{"group":"Reverse Penny Drop","pages":[{"openapi":"post /reverse-penny-drop","title":"Create Reverse Penny Drop Request","description":"Use this API to create a reverse penny drop request. Reverse penny drop is a verification method for validating bank account information. \n\nYour customers or users makes a payment of one rupee through a UPI based transaction and get the one rupee back within 48 hours once the verification is complete.\n\n\u003cNote>The generated RPD link is valid for 10 minutes. You must complete the reverse penny drop process within this time.\u003c/Note>","href":"/api-reference/vrs/v2/reverse-penny-drop/create-reverse-penny-drop-request"},{"openapi":"get /remitter/status","title":"Get Reverse Penny Drop Request Details","description":"Use this API to get the details of the created reverse penny drop request by passing reference ID or user ID to check if the validation is complete and get the results.","href":"/api-reference/vrs/v2/reverse-penny-drop/get-reverse-penny-drop-request-details"},{"title":"Webhooks","sidebarTitle":"Webhooks","description":"Set up Cashfree Reverse Penny Drop webhooks to receive notifications when customer-initiated UPI or netbanking bank verifications complete.","icon":"webhook","href":"/api-reference/vrs/v2/reverse-penny-drop/webhooks-reverse-penny"}]},{"group":"UPI Penny Drop","pages":[{"openapi":"post /upi/penny-drop","title":"UPI Penny Drop Request","description":"Use this API to to validate bank account details by sending a one rupee UPI transaction to the provided VPA and retrieving the associated bank account information.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#upi-penny-drop) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/upi-penny-drop/create-upi-penny-drop-request"}]},{"group":"IFSC","pages":[{"openapi":"post /ifsc","title":"IFSC Verification V2","description":"Use this API to verify whether the IFSC information passed in the request is valid.\n\nView the [test data](/docs/api-reference/vrs/data-to-test-integration#bank-numbers) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/ifsc/ifsc-verification-v2"}]}]},{"group":"Video KYC","pages":[{"title":"Video KYC Integration","sidebarTitle":"Video KYC Integration","description":"Choose between SDK and API integrations for Cashfree Video KYC to meet RBI-compliant remote onboarding requirements with live agent-assisted verification.","href":"/api-reference/vrs/v2/video-kyc/vkyc-integration"},{"openapi":"post /user","title":"Create User for Secure ID","description":"Use this API to create a Secure ID user profile, which is required to initiate Video KYC verification.","href":"/api-reference/vrs/v2/video-kyc/add-user"},{"openapi":"post /vkyc","title":"Initiate Video KYC Request","description":"Use this API to generate a Video KYC verification link for a user and send it through the configured notification channels (SMS, email, or WhatsApp). The message content can be configured using user and agent templates.","href":"/api-reference/vrs/v2/video-kyc/initiate-vkyc"},{"openapi":"get /vkyc","title":"Get status of Video KYC","description":"Use this API to check the status of a Video KYC request by passing `reference_id` or the `verification_id`. The API returns the current status of the Video KYC request along with user details.","href":"/api-reference/vrs/v2/video-kyc/get-vkyc-status"},{"openapi":"post /oauth/token","title":"Create Auth Token to Initialise the SDK","description":"Use this API to generate an authentication token required to initialise the Cashfree SDK by passing your `app_id`, and product name (such as Video KYC) in the request body. ","href":"/api-reference/vrs/v2/video-kyc/oauth-token"},{"title":"Status Codes and Templates","sidebarTitle":"Status Codes and Templates","description":"Reference every Cashfree VKYC status, sub-status combination, user template, and agent template you need to interpret responses and configure your flow.","href":"/api-reference/vrs/v2/video-kyc/vkyc-descriptions"},{"title":"Webhooks","sidebarTitle":"Webhooks","description":"Configure Cashfree Video KYC webhooks to receive real-time event updates so you can track session progress, completion, and outcomes without polling APIs.","icon":"webhook","href":"/api-reference/vrs/v2/video-kyc/webhook"},{"group":"IP","pages":[{"openapi":"post /ip","title":"Verify IP","description":"Use this API to fetch the details of the IP passed in the request.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#ip-address) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/ip/verify-ip"}]}]},{"group":"DigiLocker/Aadhaar","pages":[{"group":"DigiLocker","pages":[{"title":"DigiLocker Integration","sidebarTitle":"DigiLocker Integration","description":"Integrate Cashfree DigiLocker APIs to fetch consent-based government documents such as Aadhaar, PAN, and driving licence for compliant customer onboarding.","href":"/api-reference/vrs/v2/digilocker/digilocker-integration"},{"title":"React Native Integration","sidebarTitle":"React Native Integration","description":"Integrate the Cashfree DigiLocker React Native SDK to fetch government-issued Aadhaar, PAN, and Driving Licence documents with consent flows.","href":"/api-reference/vrs/v2/digilocker/digilocker-sdk"},{"openapi":"post /digilocker/verify-account","title":"Verify Account","description":"Use this API to verify whether a mobile number or Aadhaar number is already registered with DigiLocker. \n\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#digilocker-verify-account) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/digilocker/verify-digilocker-account"},{"openapi":"post /digilocker","title":"Create URL","description":"Use this API to create a DigiLocker URL to retrieve and verify Aadhaar, PAN, and driving-license information of your customer.","href":"/api-reference/vrs/v2/digilocker/create-digilocker-url"},{"openapi":"get /digilocker","title":"Get Verification Status","description":"Use this API to fetch the current status of a DigiLocker verification request by passing either the `verification_id` used during DigiLocker URL creation or the `reference_id` returned in the Cashfree response.","href":"/api-reference/vrs/v2/digilocker/get-digilocker-verification-status"},{"openapi":"get /digilocker/document/{document_type}","title":"Get Document","description":"Use this API to get your customer's document details from from DigiLocker after successful grant of consent.","href":"/api-reference/vrs/v2/digilocker/get-document-from-digilocker"},{"title":"DigiLocker Webhooks","sidebarTitle":"DigiLocker Webhooks","description":"Receive Cashfree DigiLocker webhooks for consent grants, document fetches, and verification completion so your backend can update KYC records automatically.","icon":"webhook","href":"/api-reference/vrs/v2/digilocker/webhooks-digilocker"}]},{"group":"Aadhaar","pages":[{"openapi":"post /aadhaar-masking","title":"Aadhaar Masking","description":"Use this API to protect customer privacy by masking sensitive Aadhaar information. It masks the first 8 digits and disables QR codes, making Aadhaar cards safe to store in your database while maintaining compliance with data protection regulations. \n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#aadhaar-masking) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/aadhaar/aadhaar-masking"}]}]},{"group":"PAN","pages":[{"group":"PAN Sync","pages":[{"openapi":"post /pan","title":"Verify","description":"Use this API to check the existence of a PAN. If the PAN is valid, the response returns the registered name and the PAN type (Individual or Business).\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#pan) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/pan/verify-pan-sync"},{"openapi":"get /pan/{reference_id}","title":"Get Status","description":"Use this API to get the verification status of the Verify PAN Sync API by passing the reference ID.","href":"/api-reference/vrs/v2/pan/get-status-of-verify-pan-sync"}]},{"group":"PAN Bulk","pages":[{"openapi":"post /pan/bulk","title":"Verify","description":"Use this API to verify the customer PAN information individually or in bulk by passing either the reference ID or bulk verification ID.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#pan) and use the information to trigger the validations. The test data are usable only in the test environment sandbox. ","href":"/api-reference/vrs/v2/pan/verify-pan-in-bulk"},{"openapi":"get /pan/bulk","title":"Get Status","description":"Use this API to get the status of the Verify PAN in Bulk API request. You need to enter either the reference ID or bulk verification ID.","href":"/api-reference/vrs/v2/pan/get-status-for-verify-pan-in-bulk"}]},{"openapi":"post /pan-lite","title":"PAN Lite","description":"Use this API to validate PAN information of individuals. The API helps verify the unique identifier, name of the individual, date of birth, and other information that helps you in customer onboarding, KYC verification, and other fraud prevention security measures.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#pan) and use the information to trigger the validations.The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/pan/pan-lite"},{"openapi":"post /pan/advance","title":"PAN 360","description":"Use this API to verify the PAN information of a customer. You can retrieve more information such as first name, last name, masked aadhaar number,masked email, masked mobile number and other contact information and more. Please note that, mobile number, email, and address fields have an approximate fill rate of 45%, based on recent changes in the underlying data sources.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#pan) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/pan/pan-360"},{"title":"PAN Status Codes","sidebarTitle":"PAN Status Codes","description":"Use this reference to interpret pan status code and pan status description values returned by Cashfree PAN verification APIs.","icon":null,"href":"/api-reference/vrs/v2/pan/pan-status-descriptions"}]},{"group":"1-Click Onboarding","pages":[{"group":"1-Click Onboarding(SDK)","pages":[{"title":"Integration Overview","sidebarTitle":"Integration Overview","description":"Integrate the Cashfree 1-Click Onboarding SDK in Android, iOS, or web apps to launch verification flows, manage sessions, and handle success or error callbacks.","href":"/api-reference/vrs/v2/1-click-onboarding/1-click-onboarding-sdk"},{"openapi":"post /user/data-availability","title":"Data Availability","description":"Use this API to check the availability of user data by passing the required details and retrieve data availability status. ","href":"/api-reference/vrs/v2/1-click-onboarding/data-availability"},{"openapi":"post /oauth2/session","title":"Initiate OAuth","description":"Use this API to initiate the OAuth process by passing the necessary credentials to obtain the session details, which will be used to initiate the SDK. ","href":"/api-reference/vrs/v2/1-click-onboarding/initiate-oauth"},{"openapi":"post /oauth2/generate-token","title":"OAuth Access Token Generation","description":"Use this API to generate an access token after the user completes the OAuth authentication process. This token is required to access user details once the user provides consent.\n\u003cNote> The X Client ID and X Client Secret mentioned in this API are obtained from the [Merchant Dashboard](https://merchant.cashfree.com/verificationsuite/1-click-onboarding) when creating the app under 1-Click section.\u003c/Note>","href":"/api-reference/vrs/v2/1-click-onboarding/oauth-access-token-generation"},{"openapi":"get /oauth2/user-details","title":"Fetch User Details From Access Token","description":"Use this API to retrieve user details by passing a valid access token fetched from the [OAuth Access Token Generation API](https://www.cashfree.com/docs/api-reference/vrs/v2/1-click-onboarding/oauth-access-token-generation#oauth-access-token-generation). \n\nThis endpoint fetches the information associated with the authenticated user.","href":"/api-reference/vrs/v2/1-click-onboarding/fetch-user-details-from-access-token"}]},{"group":"Mobile 360","pages":[{"openapi":"post /mobile360/otp/send","title":"Mobile 360 Send OTP Request","description":"The Mobile Send OTP API generates and sends a One-Time Password (OTP) to a user's mobile number via specified notification modes like SMS or WhatsApp.It captures consent details, ensuring secure and compliant user verification. View the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#mobile-360) and use the information to trigger the validations. You can use the test data only in test environments such as sandbox.","href":"/api-reference/vrs/v2/mobile-360-otp-flow/mobile-360-send-otp-request"},{"openapi":"post /mobile360/otp/verify","title":"Mobile 360 Verify OTP","description":"Use this API to extract multiple identity types from mobile number.","href":"/api-reference/vrs/v2/mobile-360-otp-flow/mobile-360-verify-otp"}]},{"group":"Advanced Employment","pages":[{"openapi":"post /advance-employment","title":"Get Employment Details","description":"Use this API to to retrieve an individual's recent employment details. \n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#employment-information) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/advanced-employment/get-employment-details"}]}]},{"group":"Address Verification","pages":[{"group":"Reverse Geocoding","pages":[{"openapi":"post /reverse-geocoding","title":"Reverse Geocoding","description":"Use this API to convert geographic coordinates (latitude and longitude) into readable location information for verification purposes.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#reverse-geocoding-coordinates) and use the information to trigger the validations.The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/reverse-geocoding/reverse-geocoding"}]},{"group":"Geocoding","pages":[{"openapi":"post /geocoding","title":"Geocoding","description":"Use this API to convert a physical address into geographic coordinates (latitude and longitude). This helps verify location accuracy, enable map integrations, calculate distances, and support location-based services.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#geocoding) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/geocoding/geocoding"}]}]},{"group":"Biometric KYC","pages":[{"group":"Face Match","pages":[{"openapi":"post /face-match","title":"Face Match","description":"Use this API to match the facial features of your customer in one image with another. You can compare an image with another image or with an image in an ID.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#face-match) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/face-match/face-match"}]},{"group":"Name Match","pages":[{"openapi":"post /name-match","title":"Verify Name Match","description":"Use this API to compare two names and evaluate how closely they match. This API is helpful in KYC, onboarding, fraud prevention, and reconciliation workflows. It supports variations such as initials, phonetic similarities, and minor spelling differences.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#name-match) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/name-match/name-match"}]},{"group":"Face Liveness","pages":[{"openapi":"post /face-liveness","title":"Face Liveness Check","description":"Use this API to check whether a submitted image contains a real human face. The API analyses facial characteristics and liveness signals to prevent spoofing attempts and validate genuine user presence and returns comprehensive facial analysis.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#face-liveness) and use the information to trigger the validations.","href":"/api-reference/vrs/v2/face-liveness/face-liveness"}]}]},{"group":"Smart OCR","pages":[{"openapi":"post /bharat-ocr","title":"Smart OCR","description":"Use this API to upload images or PDFs of documents and extract structured fields. It also includes image quality checks, fraud detection and optional verification against government databases.","href":"/api-reference/vrs/v2/smart-ocr/smart-ocr"},{"group":"Success Responses","pages":[{"title":"Aadhaar","sidebarTitle":"Aadhaar","description":"Inspect the Cashfree Smart OCR success response for the Aadhaar document so you can map extracted fields like name, DOB, address, and Aadhaar number.","href":"/api-reference/vrs/v2/smart-ocr/success-responses/aadhaar"},{"title":"PAN","sidebarTitle":"PAN","description":"Review the Cashfree Smart OCR success response for a PAN card to understand parsed values for PAN number, name, father's name, and date of birth.","href":"/api-reference/vrs/v2/smart-ocr/success-responses/pan"},{"title":"Driving Licence","sidebarTitle":"Driving Licence","description":"Review the sample success response returned by the Cashfree Smart OCR API for an Indian Driving Licence so you can map every field in your application.","href":"/api-reference/vrs/v2/smart-ocr/success-responses/DL"},{"title":"Voter ID","sidebarTitle":"Voter ID","description":"Inspect the Cashfree Smart OCR success response for a Voter ID card to map extracted fields such as EPIC number, voter name, parent name, and address.","href":"/api-reference/vrs/v2/smart-ocr/success-responses/voterId"},{"title":"Passport","sidebarTitle":"Passport","description":"Examine the Cashfree Smart OCR success response for a passport document to map fields such as passport number, holder details, dates, and place of issue.","href":"/api-reference/vrs/v2/smart-ocr/success-responses/passport"},{"title":"Vehicle RC","sidebarTitle":"Vehicle RC","description":"Review the Cashfree Smart OCR success response for a Vehicle Registration Certificate to extract vehicle owner, chassis, engine, and registration details.","href":"/api-reference/vrs/v2/smart-ocr/success-responses/vehicle-rc"},{"title":"Cancelled Cheque","sidebarTitle":"Cancelled Cheque","description":"Examine the Cashfree Smart OCR success response for a cancelled cheque image to map extracted account number, IFSC, bank name, and account holder fields.","href":"/api-reference/vrs/v2/smart-ocr/success-responses/cancelled-cheque"},{"title":"INVOICE","sidebarTitle":"Invoice","description":"Read the Cashfree Smart OCR success response for an invoice document and learn how to extract vendor, buyer, GSTIN, line item, and amount details.","href":"/api-reference/vrs/v2/smart-ocr/success-responses/invoice"}]}]},{"group":"Officially Valid Documents(OVDs)","pages":[{"group":"Vehicle RC","pages":[{"openapi":"get /vehicle-rc","title":"Get Vehicle RC Status","description":"Use this API to get the details and status of the vehicle [Verify Vehicle RC API](https://www.cashfree.com/docs/api-reference/vrs/v2/vehicle-rc/get-vehicle-rc-details-1) request by passing the reference ID or verification ID.","href":"/api-reference/vrs/v2/vehicle-rc/get-vehicle-rc-details"},{"openapi":"post /vehicle-rc","title":"Verify Vehicle RC Details","description":"Use this API to verify whether the vehicle information passed in the request is valid.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#registration-certificate-vehicle) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/vehicle-rc/get-vehicle-rc-details-1"}]},{"group":"Voter ID","pages":[{"openapi":"post /voter-id","title":"Verify Voter ID","description":"Use this API to verify whether the voter ID is valid by passing the EPIC number.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#voter-id) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/voter-id/verify-voter-id"}]},{"group":"Driving License","pages":[{"openapi":"post /driving-license","title":"Verify Driving Licence Details","description":"Use this API to verify whether a driving licence is valid. If the licence is valid, the associated details are sent in the response.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#driving-licence) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/driving-license/verify-driving-licence-details"}]},{"group":"Passport","pages":[{"openapi":"post /passport","title":"Verify Passport","description":"This API verifies passport information to confirm customer identity. Provide the passport file number in the request to fetch relevant details.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#passport) and use the information to trigger the validations. The test data are usable only in the test environment sandbox.\n\n\u003cNote> Passport verification is supported only for Indian passports.\u003c/Note>","href":"/api-reference/vrs/v2/passport/verify-passport"}]}]},{"group":"E-sign","pages":[{"openapi":"post /esignature/document","title":"Upload Document For E-Sign","description":"Use this API to upload the document before creating the request for E-Sign. The document ID received in the response of this API is required to create the request for E-Sign.","href":"/api-reference/vrs/v2/e-sign/upload-document-for-e-sign"},{"openapi":"post /esignature","title":"Create E-Sign Request","description":"Use this API to create signature request by passing the signer(s) details and document ID that is received as a response in [Upload Document API](https://www.cashfree.com/docs/api-reference/vrs/v2/e-sign/upload-document-for-e-sign#upload-document-for-e-sign).","href":"/api-reference/vrs/v2/e-sign/create-e-sign-request"},{"openapi":"get /esignature","title":"Get E-Sign Status","description":"Use this API to get the status of the initiated e-sign verification by passing the verification ID or reference ID that is received as a response in [Create E-Sign request API](https://www.cashfree.com/docs/api-reference/vrs/v2/e-sign/create-e-sign-request).","href":"/api-reference/vrs/v2/e-sign/get-e-sign-status"},{"title":"Webhooks","sidebarTitle":"Webhooks","description":"Configure Cashfree e-Sign webhooks to receive notifications when documents are signed, declined, expired, or completed during Aadhaar-based electronic signing.","icon":"webhook","href":"/api-reference/vrs/v2/e-sign/webhooks-esign"}]},{"group":"KYC Links","pages":[{"openapi":"post /form","title":"Generate KYC Link","description":"Use this API to generate a verification form to verify the KYC information of your users digitally.","href":"/api-reference/vrs/v2/kyc-links/generate-form-link"},{"openapi":"get /form","title":"Get KYC Link Status","href":"/api-reference/vrs/v2/kyc-links/get-form-status"},{"openapi":"post /form/static-link","title":"Generate Static KYC Link","description":"Use this API to generate a static KYC link to verify the KYC information of the users digitally. Using the generated single static link, multiple users can be verified which share same verification journey.","href":"/api-reference/vrs/v2/kyc-links/generate-static-link"},{"openapi":"delete /form/static-link","title":"Deactivate Static KYC Link","description":"Use this API to deactivate a static KYC Link.","href":"/api-reference/vrs/v2/kyc-links/deactivate-static-link"},{"title":"Get Status","sidebarTitle":"Get Status","description":"Look up status endpoints for every Cashfree Secure ID verification, from bank account checks to Aadhaar, PAN, e-Sign, and DigiLocker workflows.","href":"/api-reference/vrs/v2/kyc-links/get-status"},{"title":"Webhooks","sidebarTitle":"Webhooks","description":"Subscribe to Cashfree KYC Link webhooks to track when customers open, complete, or fail verification journeys initiated through shareable KYC links.","icon":"webhook","href":"/api-reference/vrs/v2/kyc-links/webhooks"}]},{"group":"Know Your Business(KYBs)","pages":[{"group":"GSTIN","pages":[{"openapi":"post /gstin","title":"Verify GSTIN","description":"Use this API to verify whether the GSTIN information is valid. If the GSTIN is valid, the associated details are sent in the response.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#gstin) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/gstin/verify-gstin"}]},{"group":"PAN to GSTIN","pages":[{"openapi":"post /pan-gstin","title":"Fetch GSTIN with PAN","description":"Use this API to fetch the list of GSTIN associated with the PAN information.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#fetch-gstin-with-pan) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/pan-to-gstin/fetch-gstin-with-pan"}]},{"group":"CIN","pages":[{"openapi":"post /cin","title":"Verify CIN","description":"Use this API to retrieve information from Corporate Identification Number (CIN). \n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#cin) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/cin/verify-cin"}]},{"group":"Udyam","pages":[{"openapi":"post /udyam","title":"Verify Udyam","description":"Use this API to verify an Udyam registration using the Udyam reference number. For a valid registration, the response returns enterprise details such as NIC classification and enterprise unit information. \n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#udyam) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/udyam/verify-udyam"}]},{"group":"PAN to Udyam","pages":[{"openapi":"post /pan-udyam","title":"Fetch Udyam with PAN","description":"Use this API to fetch the Udyam registration number linked to a PAN. For a valid PAN with an associated Udyam registration, the response returns the registration number.\n\nView the [test data](https://www.cashfree.com/docs/api-reference/vrs/data-to-test-integration#pan-to-udyam) and use the information to trigger the validations. The test data can be used only in the sandbox environment.","href":"/api-reference/vrs/v2/pan-to-udyam/fetch-udyam-with-pan"}]}]}]},{"group":"V1 (Depricated API's)","pages":[{"group":"Bank Account Verification","pages":[{"openapi":"get /payout/v1.2/validation/bankDetails","title":"Bank Verification Sync V1.2","description":"Use this API to validate the given bank account number and IFSC. This is a sync verification request.","href":"/api-reference/vrs/v1/bank-account-verification/bank-verification-sync-v12"},{"openapi":"get /payout/v1/asyncValidation/bankDetails","title":"Bank Verification Async","description":"Use this API to validate the given bank account number and IFSC. This is an async verification request.","href":"/api-reference/vrs/v1/bank-account-verification/bank-verification-async"},{"openapi":"get /payout/v1/getValidationStatus/bank","title":"Get Verification Status","description":"Use this API to get the statuses of the bank validation request by providing the bvRefId or userId.","href":"/api-reference/vrs/v1/bank-account-verification/get-verification-status"},{"openapi":"get /payout/v1/ifsc/{ifsc}","title":"IFSC Verification","description":"Use this API to verify if a given IFSC exists. The bank name, the branch that it belongs to, the transfer modes supported, and the respective MICR code will be shown in the response.","href":"/api-reference/vrs/v1/bank-account-verification/ifsc-verification"},{"openapi":"post /payout/v1/bulkValidation/bankDetails","title":"Bulk Bank Verification","description":"Use this API to request bank validations in bulk. It is an asynchronous process.","href":"/api-reference/vrs/v1/bank-account-verification/bulk-bank-verification"},{"openapi":"get /payout/v1/getBulkValidationStatus","title":"Get Bulk Verification Status","description":"Use this API to get the status of bulk bank validation request by providing the bulkValidationId.","href":"/api-reference/vrs/v1/bank-account-verification/get-bulk-verification-status"}]}]}]},{"tab":"Additional APIs","hidden":true,"pages":[{"title":"Additional APIs","href":"/api-reference/prepaid-payment-instruments/overview"}]},{"tab":"Partners APIs","hidden":true,"pages":[{"title":"Partners APIs","href":"/api-reference/platforms/overview"}]},{"tab":"Additional APIs","hidden":true,"pages":[{"title":"Additional APIs","href":"/api-reference/other-apis/bbps/overview"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/overview"}]},{"tab":"AI Stack","pages":[{"title":"AI Stack","href":"/tools-ai/overview"}]},{"tab":"Help Center","pages":[{"title":"Help Center","href":"/help/overview"}]}]},"title":"KYC Form Status | Cashfree","buildId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","deploymentId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bg4Z7D_G.js","utils-Biz734EK.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6F9YHs6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BoJjY_VP.js","snippetPresets-CnZ-mOFh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DC_SB2pp.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BYKtOiIP.js","shallow-COAac_UD.js","getApiPlaygroundDisplay-BV4Viqi2.js","CodeSnippet-DDgW-JXl.js","CodeSnippets-CP1LpNhG.js","Page-BeiUfucV.js","getPastedJson-Cvgvbfmv.js","icon-D-H368xH.js","MethodPill-CXSxH1VW.js","DuplicateIcon-JcbBzF1x.js","createIcon-BDt_aHZM.js","DynamicMarkdown-DO1Fz7ar.js","SectionHeading-mwKBArs3.js","axios-vUo_bRtp.js","Markdown-C3KUTGJN.js","clsx-C6CAjViH.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C3vb5JQZ.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C8Hisf3g.js"]}