Unique identifier for tracking the request across systems.
{"docsConfig":{"theme":"palm","$schema":"https://mintlify.com/docs.json","name":"Sandbox","description":"End-to-end tax automation platform for businesses to verify tax ids, calculate \u0026 pay taxes, generate e-invoices, process tax documents, analyse \u0026 reconcile tax ledgers, prepare and file tax returns through SDKs \u0026 APIs.","colors":{"primary":"#151455","light":"#CFCEFF","dark":"#1B1B20"},"logo":{"light":"https://mintcdn.com/in-co-sandbox/83aihwHbv0_fbS-u/static/logo/light.svg?fit=max\u0026auto=format\u0026n=83aihwHbv0_fbS-u\u0026q=85\u0026s=83271c8bdbc5e5c9585f979d9a278d59","dark":"https://mintcdn.com/in-co-sandbox/83aihwHbv0_fbS-u/static/logo/dark.svg?fit=max\u0026auto=format\u0026n=83aihwHbv0_fbS-u\u0026q=85\u0026s=179fdab40936062e350c9197e38ddf85","href":"https://developer.sandbox.co.in/"},"favicon":{"light":"https://mintcdn.com/in-co-sandbox/83aihwHbv0_fbS-u/static/favicon/light.svg?fit=max\u0026auto=format\u0026n=83aihwHbv0_fbS-u\u0026q=85\u0026s=11228c94a2f4982dc5e2b54c24501858","dark":"https://mintcdn.com/in-co-sandbox/83aihwHbv0_fbS-u/static/favicon/dark.svg?fit=max\u0026auto=format\u0026n=83aihwHbv0_fbS-u\u0026q=85\u0026s=3b7eaa27875373c8d3882169bf79874e"},"api":{"examples":{"prefill":true}},"background":{"decoration":"gradient"},"navbar":{"links":[{"icon":"life-ring","href":"https://help.sandbox.co.in/","label":"Help Centre"},{"icon":"phone","href":"https://sandbox.co.in/contact-sales","label":"Contact Sales"}],"primary":{"type":"button","label":"Sign Up","href":"https://accounts.sandbox.co.in/signup"}},"footer":{"socials":{"github":"https://github.com/in-co-sandbox","linkedin":"https://www.linkedin.com/showcase/sandboxapi","medium":"https://medium.com/blog-by-sandbox","youtube":"https://www.youtube.com/@sandboxapi","x":"https://twitter.com/sandbox_api"}},"styling":{"eyebrows":"breadcrumbs","latex":false},"integrations":{"gtm":{"tagId":"GTM-NWRF32W"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"in-co-sandbox","hasAudioNarration":false,"actualSubdomain":"in-co-sandbox","customDomains":["developer.sandbox.co.in"],"gitSource":{"type":"github","owner":"company-quicko","repo":"in-co-sandbox","deployBranch":"main","contentDirectory":"in-co-sandbox-docs","isPrivate":true,"mountPath":"","label":"","_id":"6adf43f8a6cc13f54cfb5698"},"entitlements":{},"buildId":"6aec2063afba45a8ed32643b","clientVersion":"0.0.4124","searchFilterCounts":[{"language":"default","tag":"API Reference","count":359},{"language":"default","tag":"GST","count":201},{"language":"default","tag":"Compliance","count":201},{"language":"default","tag":"Taxpayer","count":117},{"language":"default","tag":"TDS","count":89},{"language":"default","tag":"Income Tax","count":57},{"language":"default","tag":"KYC","count":54},{"language":"default","tag":"Calculator","count":44},{"language":"default","tag":"Tax P\u0026L","count":41},{"language":"default","tag":"E-Way Bill","count":40}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-tabs{display:flex;align-items:center;justify-content:flex-start;width:100%}.nav-tabs>.nav-tabs-item:not(:has(~.nav-tabs-item)){margin-left:auto!important}img.icon,a img.icon,img[class*=\"icon\"],a img[class*=\"icon\"],img[class*=\"bg-\"],a img[class*=\"bg-\"],.card img.icon,.card a img.icon,.nav-dropdown-item-icon img,.nav-dropdown-item-icon a img{background:transparent!important;background-color:transparent!important;box-shadow:none!important}.dark img.icon,.dark a img.icon,body:has(#landing_page_background_div) #header,body:has(#landing_page_background_div) header#header{display:none!important}.dark img[class*=\"bg-\"],.dark a img[class*=\"bg-\"]{background:transparent!important;background-color:transparent!important;box-shadow:none!important}img.icon,a img.icon{padding:0!important;border-radius:0!important}div:has(>div>div>div>#landing_page_background_div){width:100%;height:100%;background:url('/static/svg/landing/bg-pattern-light.svg');background-size:contain;background-repeat:no-repeat}.dark div:has(>div>div>div>#landing_page_background_div){background:url('/static/svg/landing/bg-pattern.svg');background-size:contain;background-repeat:no-repeat}"}],"page":{"pagePath":"api-reference/kyc/entitylocker/endpoints/initiate_session","slug":"/api-reference/kyc/entitylocker/endpoints/initiate_session","pageMetadata":{"title":"Initiate Session","description":"The Initiate Session API returns a EntityLocker link that the user is redirected to, where they can provide consent for the requested documents.","openapi":"api-reference/kyc/openapi.json POST /kyc/entitylocker/sessions/init","href":"/api-reference/kyc/entitylocker/endpoints/initiate_session"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"The Initiate Session API returns a EntityLocker link that the user is redirected to, where they can provide consent for the requested documents.\"\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{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const{Card}={..._provideComponents(),...props.components};if(!Card)_missingMdxReference(`Card`,true);return _jsx(Card,{title:`Run in Postman`,icon:`https://mintcdn.com/in-co-sandbox/83aihwHbv0_fbS-u/static/svg/Postman.svg?fit=max\u0026auto=format\u0026n=83aihwHbv0_fbS-u\u0026q=85\u0026s=c252d94cbef2e1c096d674adefd8a736`,horizontal:true,arrow:`true`,href:`https://www.postman.com/in-co-sandbox/sandbox-api/request/wc2zc29/initiate-session`,\"data-og-width\":`2030`,width:`2030`,\"data-og-height\":`2031`,height:`2031`,\"data-path\":`static/svg/Postman.svg`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/in-co-sandbox/83aihwHbv0_fbS-u/static/svg/Postman.svg?w=280\u0026fit=max\u0026auto=format\u0026n=83aihwHbv0_fbS-u\u0026q=85\u0026s=a36892fc12e18833a533c6a3ea87b2d2 280w, https://mintcdn.com/in-co-sandbox/83aihwHbv0_fbS-u/static/svg/Postman.svg?w=560\u0026fit=max\u0026auto=format\u0026n=83aihwHbv0_fbS-u\u0026q=85\u0026s=0038f29f58bec20afb88dd9b5282fe77 560w, https://mintcdn.com/in-co-sandbox/83aihwHbv0_fbS-u/static/svg/Postman.svg?w=840\u0026fit=max\u0026auto=format\u0026n=83aihwHbv0_fbS-u\u0026q=85\u0026s=fd715fb176f324194f90811bf191c9cf 840w, https://mintcdn.com/in-co-sandbox/83aihwHbv0_fbS-u/static/svg/Postman.svg?w=1100\u0026fit=max\u0026auto=format\u0026n=83aihwHbv0_fbS-u\u0026q=85\u0026s=bfa1a515ddd9e88f1c5fdfd9916493d6 1100w, https://mintcdn.com/in-co-sandbox/83aihwHbv0_fbS-u/static/svg/Postman.svg?w=1650\u0026fit=max\u0026auto=format\u0026n=83aihwHbv0_fbS-u\u0026q=85\u0026s=21fc2488eb606a8713e97f890cbd9ff2 1650w, https://mintcdn.com/in-co-sandbox/83aihwHbv0_fbS-u/static/svg/Postman.svg?w=2500\u0026fit=max\u0026auto=format\u0026n=83aihwHbv0_fbS-u\u0026q=85\u0026s=4f34643f4386db45f3067b4b03946f6e 2500w`})}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":{"title":"Initiate Session","description":"The Initiate Session API returns a EntityLocker link that the user is redirected to, where they can provide consent for the requested documents.","openapi":"api-reference/kyc/openapi.json POST /kyc/entitylocker/sessions/init","href":"/api-reference/kyc/entitylocker/endpoints/initiate_session"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Initiate session","deprecated":false,"description":"The Initiate Session API returns a EntityLocker link that the user is redirected to, where they can provide consent for the requested documents.","operationId":"initiateSession","tags":["kyc","entitylocker"],"parameters":["74d5d487-6fa3-42da-9f17-635801eaa8f3","7b126e02-092a-4ba9-9c46-5d564fa367f4","3cd36334-1233-4c53-82c6-a2898caf333e","6b30cc9e-4129-4c4a-8860-66d51fcd798b"],"requestBody":"be79b96a-ed6a-4bd3-bfa1-8fa2a0c694d7","responses":{"200":"5cbe3d18-d986-45cf-8f6f-df01ae1e68b9"},"security":[],"method":"post","type":"path","servers":["54fad7f1-cf5b-4566-84e3-d30450a09c90","986dd909-36e1-472b-82b1-14cf92c0c2ba"],"path":"/kyc/entitylocker/sessions/init","baseUrlOptions":["https://test-api.sandbox.co.in","https://api.sandbox.co.in"],"title":"Initiate session","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.@entity":"in.co.sandbox.kyc.entitylocker.session.request","body.flow":"signin","body.redirect_url":"https://sandbox.co.in/","body.consent_expiry":1765887697411}]},"dependencies":{"parameters":{"74d5d487-6fa3-42da-9f17-635801eaa8f3":{"name":"Authorization","in":"header","description":"JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).","required":true,"example":"{{access_token}}","schema":{"type":"string","isRequired":true,"description":"JWT access token. For token-generation steps, refer to the [Quickstart Guide](https://developer.sandbox.co.in/guides/get-started/quickstart).","uniqueKey":"","typeLabel":"string"}},"7b126e02-092a-4ba9-9c46-5d564fa367f4":{"name":"x-api-key","in":"header","description":"API key used to identify and authenticate the client.","required":true,"example":"{{api_key}}","schema":{"type":"string","isRequired":true,"description":"API key used to identify and authenticate the client.","uniqueKey":"","typeLabel":"string"}},"3cd36334-1233-4c53-82c6-a2898caf333e":{"name":"x-api-version","in":"header","description":"Specifies the API version for the request.","required":false,"example":"1.0.0","schema":{"type":"string","isRequired":false,"description":"Specifies the API version for the request.","uniqueKey":"","typeLabel":"string"}},"6b30cc9e-4129-4c4a-8860-66d51fcd798b":{"name":"Content-Type","in":"header","description":"Media type of the request body.","required":false,"example":"application/json","schema":{"type":"string","enum":["application/json"],"isRequired":false,"description":"Media type of the request body.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"@entity":{"type":"string","enum":["in.co.sandbox.kyc.entitylocker.session.request"],"isRequired":true,"uniqueKey":"@entity","typeLabel":"enum\u003cstring>"},"flow":{"type":"string","enum":["signin","signup"],"description":"EntityLocker user journey to initiate for this session. Use `signin` for existing users or `signup` to create a new EntityLocker account.","isRequired":true,"uniqueKey":"flow","typeLabel":"enum\u003cstring>"},"redirect_url":{"type":"string","format":"uri","pattern":"^https://","description":"HTTPS URL where the user will be redirected after completing the EntityLocker consent flow.","isRequired":true,"uniqueKey":"redirect_url","typeLabel":"string\u003curi>"},"consent_expiry":{"type":"integer","minimum":0,"description":"Unix timestamp in milliseconds after which the consent request becomes invalid. Must be at least 1 hour later than the current server time.","uniqueKey":"consent_expiry","typeLabel":"integer"}},"required":["@entity","flow","redirect_url"],"uniqueKey":"","typeLabel":"object"},"examples":{"200 - Session initiated":{"title":"200 - Session initiated","value":{"@entity":"in.co.sandbox.kyc.entitylocker.session.request","flow":"signin","redirect_url":"https://sandbox.co.in/","consent_expiry":1765887697411}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"5cbe3d18-d986-45cf-8f6f-df01ae1e68b9":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"HTTP status code.","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"timestamp":{"type":"integer","description":"Unix timestamp (in milliseconds) indicating when the server generated the response.","isRequired":true,"uniqueKey":"timestamp","typeLabel":"integer"},"data":{"type":"object","description":"Response payload containing the requested data or error details.","properties":{"@entity":{"type":"string","isRequired":true,"uniqueKey":"data.@entity","typeLabel":"string"},"authorization_url":{"type":"string","description":"The URL to which the user should be redirected to complete the authorization flow. This URL initiates the user authentication and consent process.","isRequired":true,"uniqueKey":"data.authorization_url","typeLabel":"string"},"session_id":{"type":"string","description":"A unique identifier for the user session. This ID is used to track and manage the state of the user's consent.","isRequired":true,"uniqueKey":"data.session_id","typeLabel":"string"}},"required":["@entity","authorization_url","session_id"],"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"transaction_id":{"type":"string","description":"Unique identifier for tracking the request across systems.","isRequired":true,"uniqueKey":"transaction_id","typeLabel":"string"}},"required":["code","timestamp","data","transaction_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"200 - Session initiated":{"title":"200 - Session initiated","value":{"code":200,"timestamp":1765534184274,"data":{"@entity":"in.co.sandbox.kyc.entitylocker.session.response","authorization_url":"https://entity.digilocker.gov.in/public/oauth2/1/authorize?response_type=code\u0026client_id=VRF23C1E3B\u0026redirect_uri=https%3A%2F%2Fdev-api.sandbox.co.in%2Fcallbacks%2Fkyc%2Fentitylocker%2Foauth\u0026state=ZDgyMDM0NzItMTFiMC00ZGRhLWFlOWItY2U0YzI0OTRmMWRkfGQzZjg4OTdlLWYxZmYtNDQ0OS05NzA0LTcwNzNmNjkzMDI5NnxodHRwczovL3NhbmRib3guY28uaW4v\u0026code_challenge=yxAtiqiBw2FrXmavMHn7bVnq7nW-sWRNI50JTMuYtAE\u0026code_challenge_method=S256\u0026consent_valid_till=1767205777","session_id":"d3f8897e-f1ff-4449-9704-7073f6930296"},"transaction_id":"02683ff9-2abc-42ab-a050-945f21068bce"}}},"exampleType":"examples"}},"headers":{},"exampleType":"examples"}},"security":{},"servers":{"54fad7f1-cf5b-4566-84e3-d30450a09c90":{"url":"https://test-api.sandbox.co.in","description":"test"},"986dd909-36e1-472b-82b1-14cf92c0c2ba":{"url":"https://api.sandbox.co.in","description":"prod"}}},"originalFileLocation":"api-reference/kyc/openapi.json"},"subdomain":"in-co-sandbox","siteName":"Sandbox","title":"Initiate Session - Sandbox","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T12:14:58.834Z","originalFileLocation":"api-reference/kyc/entitylocker/endpoints/initiate_session.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}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=\"The Initiate Session API returns a EntityLocker link that the user is redirected to, where they can provide consent for the requested documents.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Sandbox\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/in-co-sandbox/1vAiCQMOtoIXdhlB/_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=\"/mintlify-assets/_mintlify/favicons/in-co-sandbox/1vAiCQMOtoIXdhlB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/in-co-sandbox/1vAiCQMOtoIXdhlB/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/in-co-sandbox/1vAiCQMOtoIXdhlB/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/in-co-sandbox/1vAiCQMOtoIXdhlB/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/in-co-sandbox/1vAiCQMOtoIXdhlB/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/in-co-sandbox/1vAiCQMOtoIXdhlB/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/in-co-sandbox/1vAiCQMOtoIXdhlB/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/in-co-sandbox/1vAiCQMOtoIXdhlB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Initiate Session - Sandbox\">\u003cmeta data-mint-head property=\"og:description\" content=\"The Initiate Session API returns a EntityLocker link that the user is redirected to, where they can provide consent for the requested documents.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Sandbox\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.sandbox.co.in/api-reference/kyc/entitylocker/endpoints/initiate_session\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://in-co-sandbox.mintlify.site/_mintlify/api/og/v2?division=APIs\u0026amp;title=Initiate+Session\u0026amp;description=The+Initiate+Session+API+returns+a+EntityLocker+link+that+the+user+is+redirected+to%2C+where+they+can+provide+consent+for+the+requested+documents.\u0026amp;theme=df0fa091765a33c812179186\u0026amp;signature=613cc44f22a7c4ddeeff3038e74e272824db07b519c63d5c78db0969c0775e24\">\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=\"Initiate Session - Sandbox\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The Initiate Session API returns a EntityLocker link that the user is redirected to, where they can provide consent for the requested documents.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://in-co-sandbox.mintlify.site/_mintlify/api/og/v2?division=APIs\u0026amp;title=Initiate+Session\u0026amp;description=The+Initiate+Session+API+returns+a+EntityLocker+link+that+the+user+is+redirected+to%2C+where+they+can+provide+consent+for+the+requested+documents.\u0026amp;theme=df0fa091765a33c812179186\u0026amp;signature=613cc44f22a7c4ddeeff3038e74e272824db07b519c63d5c78db0969c0775e24\">\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=\"/mintlify-assets/_mintlify/favicons/in-co-sandbox/1vAiCQMOtoIXdhlB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Sandbox\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#151455\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.sandbox.co.in/api-reference/kyc/entitylocker/endpoints/initiate_session\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/kyc/entitylocker/endpoints/initiate_session.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.sandbox.co.in/#organization\",\"name\":\"Sandbox\",\"url\":\"https://developer.sandbox.co.in\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/in-co-sandbox/83aihwHbv0_fbS-u/static/logo/light.svg?fit=max\u0026auto=format\u0026n=83aihwHbv0_fbS-u\u0026q=85\u0026s=83271c8bdbc5e5c9585f979d9a278d59\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.sandbox.co.in#website\",\"name\":\"Sandbox\",\"url\":\"https://developer.sandbox.co.in\",\"publisher\":{\"@id\":\"https://developer.sandbox.co.in/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.sandbox.co.in/api-reference/kyc/entitylocker/endpoints/initiate_session#webpage\",\"url\":\"https://developer.sandbox.co.in/api-reference/kyc/entitylocker/endpoints/initiate_session\",\"name\":\"Initiate Session\",\"description\":\"The Initiate Session API returns a EntityLocker link that the user is redirected to, where they can provide consent for the requested documents.\",\"dateModified\":\"2026-10-26T12:14:58.834Z\",\"isPartOf\":{\"@id\":\"https://developer.sandbox.co.in#website\"},\"breadcrumb\":{\"@id\":\"https://developer.sandbox.co.in/api-reference/kyc/entitylocker/endpoints/initiate_session#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.sandbox.co.in/api-reference/kyc/entitylocker/endpoints/initiate_session#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"EntityLocker\",\"item\":\"https://developer.sandbox.co.in/api-reference/kyc/entitylocker/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Initiate Session\",\"item\":\"https://developer.sandbox.co.in/api-reference/kyc/entitylocker/endpoints/initiate_session\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.sandbox.co.in/api-reference/kyc/entitylocker/endpoints/initiate_session#apireference\",\"headline\":\"Initiate Session\",\"name\":\"Initiate Session\",\"description\":\"The Initiate Session API returns a EntityLocker link that the user is redirected to, where they can provide consent for the requested documents.\",\"url\":\"https://developer.sandbox.co.in/api-reference/kyc/entitylocker/endpoints/initiate_session\",\"mainEntityOfPage\":{\"@id\":\"https://developer.sandbox.co.in/api-reference/kyc/entitylocker/endpoints/initiate_session#webpage\"},\"dateModified\":\"2026-10-26T12:14:58.834Z\",\"publisher\":{\"@id\":\"https://developer.sandbox.co.in/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.sandbox.co.in#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Sandbox\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Sandbox\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/kyc/entitylocker/endpoints/initiate_session.md","siteName":"Sandbox","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","icon":"code","menu":[{"item":"Authentication","icon":"rocket-vertical","description":"Authenticate and get access to use Sandbox APIs","pages":[{"title":"Authentication","href":"/api-reference/authenticate"}]},{"item":"KYC","icon":"https://mintlify.s3.us-west-1.amazonaws.com/in-co-sandbox/static/svg/workload-icons/KYC.svg","description":"Confirm Identities with confidence","pages":[{"title":"Overview","href":"/api-reference/kyc/overview"},{"title":"OpenAPI Spec","url":"https://developer.sandbox.co.in/api-reference/kyc/openapi.json","href":"/api-reference/kyc/openapi-specification"},{"group":"Aadhaar","pages":[{"title":"Overview","href":"/api-reference/kyc/aadhaar/overview"},{"title":"Generate OTP","openapi":"api-reference/kyc/openapi.json POST /kyc/aadhaar/okyc/otp","sidebarTitle":"Generate OTP","href":"/api-reference/kyc/aadhaar/endpoints/generate_otp"},{"title":"Verify Aadhaar OTP","openapi":"api-reference/kyc/openapi.json POST /kyc/aadhaar/okyc/otp/verify","sidebarTitle":"Verify OTP","href":"/api-reference/kyc/aadhaar/endpoints/verify_otp"}]},{"group":"Bank","pages":[{"title":"Overview","href":"/api-reference/kyc/bank/overview"},{"title":"IFSC Verification","openapi":"api-reference/kyc/openapi.json GET /bank/{ifsc}","href":"/api-reference/kyc/bank/endpoints/ifsc_verification"},{"title":"Penny Drop","openapi":"api-reference/kyc/openapi.json GET /bank/{ifsc}/accounts/{account_number}/verify","href":"/api-reference/kyc/bank/endpoints/penny_drop"},{"title":"Penny-Less","openapi":"api-reference/kyc/openapi.json GET /bank/{ifsc}/accounts/{account_number}/penniless-verify","href":"/api-reference/kyc/bank/endpoints/penny_less"}]},{"group":"DigiLocker","pages":[{"title":"Overview","href":"/api-reference/kyc/digilocker/overview"},{"group":"APIs","pages":[{"title":"Verify User Account","openapi":"api-reference/kyc/openapi.json POST /kyc/digilocker/user/verify","href":"/api-reference/kyc/digilocker/endpoints/verify_user"},{"title":"Initiate Session","openapi":"api-reference/kyc/openapi.json POST /kyc/digilocker/sessions/init","href":"/api-reference/kyc/digilocker/endpoints/initiate_session"},{"title":"Session Status","openapi":"api-reference/kyc/openapi.json GET /kyc/digilocker/sessions/{session_id}/status","href":"/api-reference/kyc/digilocker/endpoints/session_status"},{"title":"DigiLocker session status webhook","sidebarTitle":"Session status webhook","openapi":"api-reference/kyc/openapi.json webhook DigiLockerSessionStatus","href":"/api-reference/kyc/digilocker/endpoints/webhook"},{"title":"Get User Profile","openapi":"api-reference/kyc/openapi.json GET /kyc/digilocker/sessions/{session_id}/user/profile","href":"/api-reference/kyc/digilocker/endpoints/user_profile"},{"title":"Fetch Document","openapi":"api-reference/kyc/openapi.json GET /kyc/digilocker/sessions/{session_id}/documents/{doc_type}","href":"/api-reference/kyc/digilocker/endpoints/fetch_document"}]},{"group":"SDK","pages":[{"title":"Introduction","href":"/api-reference/kyc/digilocker-sdk/getting-started/introduction"},{"group":"Platforms","pages":[{"title":"Web","href":"/api-reference/kyc/digilocker-sdk/getting-started/platforms/web"},{"title":"Android","href":"/api-reference/kyc/digilocker-sdk/getting-started/platforms/android"},{"title":"iOS","href":"/api-reference/kyc/digilocker-sdk/getting-started/platforms/ios"},{"title":"Flutter","href":"/api-reference/kyc/digilocker-sdk/getting-started/platforms/flutter"}]},{"group":"Endpoints","pages":[{"title":"Create Session","openapi":"api-reference/kyc/openapi.json POST /kyc/digilocker-sdk/sessions/create","href":"/api-reference/kyc/digilocker-sdk/endpoints/create-session"},{"title":"Get Session Status","openapi":"api-reference/kyc/openapi.json GET /kyc/digilocker-sdk/sessions/{session_id}/status","href":"/api-reference/kyc/digilocker-sdk/endpoints/get-session-status"},{"title":"Get User Profile","openapi":"api-reference/kyc/openapi.json GET /kyc/digilocker-sdk/sessions/{session_id}/user/profile","href":"/api-reference/kyc/digilocker-sdk/endpoints/user_profile"},{"title":"Get Document","openapi":"api-reference/kyc/openapi.json GET /kyc/digilocker-sdk/sessions/{session_id}/documents/{doc_type}","href":"/api-reference/kyc/digilocker-sdk/endpoints/get-document"}]}]},{"title":"Sample Responses","icon":"file-code","sidebarTitle":"Sample Responses","href":"/api-reference/kyc/digilocker/sample-responses"}]},{"group":"EntityLocker","pages":[{"title":"Overview","description":"Retrieve verified business documents from EntityLocker via consent-based verification","href":"/api-reference/kyc/entitylocker/overview"},{"group":"APIs","pages":[{"title":"Initiate Session","openapi":"api-reference/kyc/openapi.json POST /kyc/entitylocker/sessions/init","href":"/api-reference/kyc/entitylocker/endpoints/initiate_session"},{"title":"Session Status","description":"Session Status API allows you to check the latest status of session and the list of consented documents if consent is received.","openapi":"api-reference/kyc/openapi.json GET /kyc/entitylocker/sessions/{session_id}/status","href":"/api-reference/kyc/entitylocker/endpoints/session_status"},{"title":"EntityLocker session status webhook","sidebarTitle":"Session status webhook","openapi":"api-reference/kyc/openapi.json webhook EntityLockerSessionStatus","href":"/api-reference/kyc/entitylocker/endpoints/webhook"},{"title":"Fetch Document","openapi":"api-reference/kyc/openapi.json GET /kyc/entitylocker/sessions/{session_id}/documents/{doc_type}","href":"/api-reference/kyc/entitylocker/endpoints/fetch_document"},{"title":"Get Entity Details","openapi":"api-reference/kyc/openapi.json GET /kyc/entitylocker/sessions/{session_id}/entity","href":"/api-reference/kyc/entitylocker/endpoints/get_entity_details"},{"title":"Get User Profile","openapi":"api-reference/kyc/openapi.json GET /kyc/entitylocker/sessions/{session_id}/user/profile","href":"/api-reference/kyc/entitylocker/endpoints/get_user_profile_details"}]},{"group":"SDK","pages":[{"title":"Introduction","href":"/api-reference/kyc/entitylocker-sdk/getting-started/introduction"},{"group":"Platforms","pages":[{"title":"Web","href":"/api-reference/kyc/entitylocker-sdk/getting-started/platforms/web"},{"title":"Android","href":"/api-reference/kyc/entitylocker-sdk/getting-started/platforms/android"},{"title":"iOS","href":"/api-reference/kyc/entitylocker-sdk/getting-started/platforms/ios"},{"title":"Flutter","href":"/api-reference/kyc/entitylocker-sdk/getting-started/platforms/flutter"}]},{"group":"Endpoints","pages":[{"title":"Create Session","openapi":"api-reference/kyc/openapi.json POST /kyc/entitylocker-sdk/sessions/create","href":"/api-reference/kyc/entitylocker-sdk/endpoints/create_session"},{"title":"Get Session Status","openapi":"api-reference/kyc/openapi.json GET /kyc/entitylocker-sdk/sessions/{session_id}/status","href":"/api-reference/kyc/entitylocker-sdk/endpoints/get_session_status"},{"title":"Fetch Document","openapi":"api-reference/kyc/openapi.json GET /kyc/entitylocker-sdk/sessions/{session_id}/documents/{doc_type}","href":"/api-reference/kyc/entitylocker-sdk/endpoints/fetch_document"}]}]},{"title":"Sample Responses","icon":"file-code","href":"/api-reference/kyc/entitylocker/sample-responses"}]},{"group":"MCA","pages":[{"title":"Overview","href":"/api-reference/kyc/mca/overview"},{"title":"Company Master Data","openapi":"api-reference/kyc/openapi.json POST /kyc/mca/company/master-data","href":"/api-reference/kyc/mca/company_master_data"},{"title":"Search Company","openapi":"api-reference/kyc/openapi.json GET /kyc/mca/company/master-data/search","href":"/api-reference/kyc/mca/search_company"},{"title":"Director Master Data","openapi":"api-reference/kyc/openapi.json POST /mca/director/master-data/search","href":"/api-reference/kyc/mca/director_master_data"}]},{"group":"PAN","pages":[{"title":"Overview","href":"/api-reference/kyc/pan/overview"},{"title":"Verify PAN Details","openapi":"api-reference/kyc/openapi.json POST /kyc/pan/verify","href":"/api-reference/kyc/pan/endpoints/verify_pan_details"},{"title":"PAN Aadhaar Link Status","openapi":"api-reference/kyc/openapi.json POST /kyc/pan-aadhaar/status","href":"/api-reference/kyc/pan/endpoints/pan_aadhaar_link_status"}]},{"group":"Annexures","pages":[{"title":"Master Data","href":"/api-reference/kyc/annexures/master_data"}]}]},{"item":"GST","icon":"https://mintlify.s3.us-west-1.amazonaws.com/in-co-sandbox/static/svg/workload-icons/GST.svg","description":"Simple and Secure GST Compliance","pages":[{"title":"GST","href":"/api-reference/gst/overview"}]},{"item":"TDS","icon":"https://mintlify.s3.us-west-1.amazonaws.com/in-co-sandbox/static/svg/workload-icons/TDS.svg","description":"Automate TDS on Salary \u0026 Non-Salary Payments","pages":[{"title":"TDS","href":"/api-reference/tds/overview"}]},{"item":"Income Tax","icon":"https://mintlify.s3.us-west-1.amazonaws.com/in-co-sandbox/static/svg/workload-icons/IT.svg","description":"Direct tax compliance on auto-pilot","pages":[{"title":"Income Tax","href":"/api-reference/it/overview"}]},{"item":"Bank","icon":"https://mintlify.s3.us-west-1.amazonaws.com/in-co-sandbox/static/svg/Bank.svg","description":"Bank APIs","hidden":true,"pages":[{"title":"Bank","href":"/api-reference/bank/overview"}]}]},{"tab":"Recipes","icon":"flask","menu":[{"item":"KYC","description":"Quick recipes for fast, reliable identity checks.","pages":[{"title":"KYC","href":"/recipes/kyc/introduction"}]},{"item":"GST","description":"Easy steps for smooth, error-free GST workflows.","pages":[{"title":"GST","href":"/recipes/gst/introduction"}]},{"item":"TDS","description":"Guides to set up seamless, automated TDS.","pages":[{"title":"TDS","href":"/recipes/tds/introduction"}]},{"item":"Income Tax","description":"Ready flows to automate your Income tax tasks.","pages":[{"title":"Income Tax","href":"/recipes/it/introduction"}]}],"pages":[{"title":"Recipes","href":"/recipes/kyc/introduction"}]},{"tab":"Changelog","icon":"clock","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Resources","icon":"books","menu":[{"item":"Postman Collections","icon":"book-bookmark","href":"https://www.postman.com/in-co-sandbox/sandbox-api"},{"item":"SDKs \u0026 Clients","icon":"cube","href":"https://github.com/in-co-sandbox"},{"item":"MCP Server","icon":"server","description":"","href":"https://developer.sandbox.co.in/mcp"},{"item":"Status","icon":"signal-stream","href":"https://status.api.sandbox.co.in/"},{"item":"Pricing","icon":"indian-rupee-sign","href":"https://sandbox.co.in/pricing?utm_campaign=header-menu\u0026utm_source=in-co-sandbox-developer\u0026utm_medium=direct"},{"item":"Customer Stories","icon":"users","href":"https://sandbox.co.in/customers"}]}]},"basePath":"","title":"Initiate Session - Sandbox","buildId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","deploymentId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CDiBsYGW.js","utils-KF9rPlmF.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C26urKTX.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BdjmJAC1.js","snippetPresets-3IpDBjt3.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-D4x_2vvo.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BIWdc5Pa.js","shallow-LQqfiMNd.js","getApiPlaygroundDisplay-DryzlOZG.js","CodeSnippet-tcJujU4r.js","CodeSnippets-BHp0nVLL.js","Page-1CZdsdAn.js","getPastedJson-DU-1ayUv.js","icon-CZK2hPr4.js","MethodPill-DOaqmTFC.js","DuplicateIcon-B5-nUxxl.js","createIcon-CDP_U77G.js","DynamicMarkdown-GHvayGOn.js","SectionHeading-BYvpkmUD.js","axios-vUo_bRtp.js","Markdown-uxhlayGT.js","clsx-B35qUV0p.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BvrGG8gU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CAf0yVYe.js"]}