{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Gnosis Pay","colors":{"primary":"#766DE5","light":"#9994ED","dark":"#1A1751"},"logo":"https://mintcdn.com/gnosispay/r5LM-98W_O_YQrwq/static/img/logo-light.svg?fit=max\u0026auto=format\u0026n=r5LM-98W_O_YQrwq\u0026q=85\u0026s=8ca5f2faddda775e89f56d1f6672d6b9","favicon":"https://mintcdn.com/gnosispay/r5LM-98W_O_YQrwq/static/img/faviconnew.ico?fit=max\u0026auto=format\u0026n=r5LM-98W_O_YQrwq\u0026q=85\u0026s=75faff6ac763e313dfb5e4399f5affcc","api":{"playground":{"display":"interactive"},"examples":{"languages":["javascript","curl","python","go","java","ruby"]}},"appearance":{"default":"dark","strict":true},"navbar":{"links":[{"href":"https://form.typeform.com/to/naN3irHW?typeform-source=gnosispay.com","label":"Contact Sales team"}],"primary":{"type":"button","label":"Sign in as Partner","href":"https://partner-dashboard.sandbox.gnosispay.com/auth/signin"}},"footer":{"socials":{"x":"https://x.com/gnosispay","website":"https://gnosispay.com/","github":"https://github.com/gnosispay"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"gnosispay","hasAudioNarration":false,"actualSubdomain":"gnosispay","customDomains":["docs.gnosispay.com"],"gitSource":{"type":"github","owner":"gnosispay","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af2fb3ffc241a857f245ce5","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":93},{"language":"default","tag":"Partner API (Platform Integration)","count":48},{"language":"default","tag":"User API (Embedded Integration)","count":45},{"language":"default","tag":"Cards","count":24},{"language":"default","tag":"Embedded Integration","count":19},{"language":"default","tag":"Concepts","count":14},{"language":"default","tag":"KYC","count":14},{"language":"default","tag":"Platform Integration","count":13},{"language":"default","tag":"Accounts","count":9},{"language":"default","tag":"Manage Cards","count":9}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","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}],"googleFontsInlined":false},"customCss":[{"filePath":"static/css/custom.css","content":".hero-title{color:#000000}html.dark .hero-title{color:#ffffff}.hero-subtext{color:#4a4570}html.dark .hero-subtext{color:#c6c2ee}#background-color{background-color:#fbebd4!important}html.dark #background-color{background-color:#0b0836!important}#navbar{background-color:#1a1751!important}navbar-link:hover,nav-anchor:hover{color:#cbfb6c!important;transition:color 0.15s ease}#topbar-cta-button{background-color:#cbfb6c!important;color:#1a1751!important;border:none!important;border-radius:999px!important;transition:filter 0.15s ease,\n transform 0.15s ease}#topbar-cta-button:hover{filter:brightness(1.08);transform:translateY(-1px)}card,.card{background-color:rgba(118, 109, 229, 0.05)!important;border:1px solid rgba(203, 251, 108, 0.45)!important;border-radius:12px!important;box-shadow:none!important;transition:border-color 0.2s ease,\n box-shadow 0.2s ease,\n transform 0.2s ease}card:hover,.card:hover{border-color:#cbfb6c!important;box-shadow:0 0 0 3px rgba(203, 251, 108, 0.15)!important;transform:translateY(-2px)}card-group,columns,.card-group{border:none!important;background:none!important;box-shadow:none!important;gap:24px!important}html.dark card,html.dark .card{background-color:rgba(255, 255, 255, 0.035)!important;color:#fbebd4!important}footer{background-color:transparent!important;border-top:1px solid rgba(203, 251, 108, 0.15)}footer,footer a{color:#4a4570!important}html.dark footer,html.dark footer a{color:#c6c2ee!important}footer a:hover{color:#cbfb6c!important;transition:color 0.15s ease}.prose,.prose p,.prose li{color:#2a2550!important}html.dark .prose,html.dark .prose p,html.dark .prose li{color:#ece9ff!important}"},{"filePath":"static/css/timeline.css","content":".gp-timeline{display:grid;grid-template-columns:repeat(3, 1fr);gap:0;margin-top:32px}.gp-step{position:relative;display:block;padding-right:32px;text-decoration:none!important;border-bottom:none!important}.gp-step:not(:last-child)::before{content:\"\";position:absolute;top:15px;left:44px;right:12px;height:2px;background:linear-gradient(90deg, #CBFB6C, rgba(203, 251, 108, 0.15))}.gp-badge{position:relative;z-index:1;display:flex;align-items:center;justify-content:center;width:32px;height:32px;border-radius:999px;background:#CBFB6C;color:#1A1751;font-weight:800;font-size:15px;box-shadow:0 0 0 6px rgba(203, 251, 108, 0.12)}.gp-step-body{display:flex;flex-direction:column;margin-top:20px}.gp-step-title{font-size:18px;font-weight:700;color:#FFFFFF}.gp-step-text{font-size:15px;line-height:1.55;color:rgba(255, 255, 255, 0.7);margin-top:8px}.gp-step-link{font-size:14px;font-weight:600;color:#CBFB6C;margin-top:14px}.gp-step:hover .gp-step-link{text-decoration:underline;text-underline-offset:3px}.gp-step:focus-visible{outline:2px solid #CBFB6C;outline-offset:6px;border-radius:8px}@media (max-width: 767px){.gp-timeline{grid-template-columns:1fr;gap:32px}.gp-step{padding:0 0 0 52px}.gp-badge{position:absolute;left:0;top:0}.gp-step:not(:last-child)::before{top:44px;left:15px;right:auto;bottom:-20px;width:2px;height:auto;background:linear-gradient(180deg, #CBFB6C, rgba(203, 251, 108, 0.15))}.gp-step-body{margin-top:4px}}"}],"page":{"pagePath":"api-reference/partner-api/kyc/get-a-kyc-profile","slug":"/api-reference/partner-api/kyc/get-a-kyc-profile","pageMetadata":{"title":"Get a KYC profile","description":"Retrieves a KYC profile and its verified details when available.\n\nUse the profile `status` to control onboarding. Create an account only\nafter the profile is `approved` and the required onboarding steps are complete.","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/kyc/profiles/{kyc_profile_id}","href":"/api-reference/partner-api/kyc/get-a-kyc-profile","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, 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(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Retrieves a KYC profile and its verified details when available.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Use the profile \", _jsx(_components.code, {\n children: \"status\"\n }), \" to control onboarding. Create an account only\\nafter the profile is \", _jsx(_components.code, {\n children: \"approved\"\n }), \" and the required onboarding steps are complete.\"]\n })]\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":{"config":{},"pageMetadata":{"title":"Get a KYC profile","description":"Retrieves a KYC profile and its verified details when available.\n\nUse the profile `status` to control onboarding. Create an account only\nafter the profile is `approved` and the required onboarding steps are complete.","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/kyc/profiles/{kyc_profile_id}","href":"/api-reference/partner-api/kyc/get-a-kyc-profile","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"kyc_profiles.get.v1","summary":"Get a KYC profile","description":"Retrieves a KYC profile and its verified details when available.\n\nUse the profile `status` to control onboarding. Create an account only\nafter the profile is `approved` and the required onboarding steps are complete.","parameters":["193ae75b-74bd-4550-8812-14b0195b1e36"],"responses":{"200":"28b7eabb-3fa5-4468-8238-20cccc1bdcb3","default":"51563bb4-0c45-41d0-bd86-83cdec5dc889"},"tags":["KYC"],"x-ogen-operation-group":"KYC","method":"get","type":"path","servers":["1a735a7a-745f-4fc4-b5fc-f3350a5fcf36","eefd330d-9464-492d-8018-3ed89cb2b655"],"security":["5d15b3a7-9568-4b6a-b479-82e8ed2e9e79"],"path":"/v1/kyc/profiles/{kyc_profile_id}","baseUrlOptions":["https://core.prod.gnosispay.com/partner-api","https://core.sandbox.gnosispay.in/core"],"title":"Get a KYC profile","codeSamples":[],"requestExampleLanguages":["javascript","bash","python","go","java","ruby"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"193ae75b-74bd-4550-8812-14b0195b1e36":{"name":"kyc_profile_id","in":"path","required":true,"description":"The unique identifier of the KYC profile.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"The unique identifier of the KYC profile.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"28b7eabb-3fa5-4468-8238-20cccc1bdcb3":{"description":"The request has succeeded.","content":{"application/json":{"schema":{"type":"object","required":["id","email","status","details"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique KYC profile identifier.","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"email":{"type":"string","description":"Email address of the person being onboarded.","isRequired":true,"uniqueKey":"email","typeLabel":"string"},"status":{"type":"string","enum":["pending","approved","blocked","rejected","requires_action","resubmission_requested"],"description":"Current KYC profile status.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"details":{"oneOf":[{"type":"object","description":"Verified profile details; null until they are available.","required":["full_name","phone_number","date_of_birth","nationality","country_of_residence","country_of_birth","document_number","gender","addresses"],"properties":{"full_name":{"type":"string","description":"User's verified full name.","isRequired":true,"uniqueKey":"details.oneOf.0.full_name","typeLabel":"string"},"phone_number":{"type":"string","description":"User's verified phone number.","isRequired":true,"uniqueKey":"details.oneOf.0.phone_number","typeLabel":"string"},"date_of_birth":{"type":"string","format":"date-time","description":"User's date of birth.","isRequired":true,"uniqueKey":"details.oneOf.0.date_of_birth","typeLabel":"string\u003cdate-time>"},"nationality":{"type":"string","description":"User's nationality.","isRequired":true,"uniqueKey":"details.oneOf.0.nationality","typeLabel":"string"},"country_of_residence":{"type":"string","description":"User's country of residence.","isRequired":true,"uniqueKey":"details.oneOf.0.country_of_residence","typeLabel":"string"},"country_of_birth":{"type":"string","description":"User's country of birth.","isRequired":true,"uniqueKey":"details.oneOf.0.country_of_birth","typeLabel":"string"},"document_number":{"type":"string","description":"User's identity-document number.","isRequired":true,"uniqueKey":"details.oneOf.0.document_number","typeLabel":"string"},"gender":{"type":"string","description":"User's gender, as recorded during verification.","isRequired":true,"uniqueKey":"details.oneOf.0.gender","typeLabel":"string"},"addresses":{"type":"array","items":{"type":"object","required":["id","country","postal_code","city","state","address1","address2"],"properties":{"id":{"type":"string","format":"uuid","description":"Unique address identifier.","isRequired":true,"uniqueKey":"details.oneOf.0.addresses.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"country":{"type":"string","description":"ISO 3166 country code.","isRequired":true,"uniqueKey":"details.oneOf.0.addresses.items.[INDEX].country","typeLabel":"string"},"postal_code":{"type":"string","description":"Postal code.","isRequired":true,"uniqueKey":"details.oneOf.0.addresses.items.[INDEX].postal_code","typeLabel":"string"},"city":{"type":"string","description":"City.","isRequired":true,"uniqueKey":"details.oneOf.0.addresses.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","description":"State, province, or region.","isRequired":true,"uniqueKey":"details.oneOf.0.addresses.items.[INDEX].state","typeLabel":"string"},"address1":{"type":"string","description":"Primary address line.","isRequired":true,"uniqueKey":"details.oneOf.0.addresses.items.[INDEX].address1","typeLabel":"string"},"address2":{"oneOf":[{"type":"string","description":"Additional address line, when available.","isRequired":true,"uniqueKey":"details.oneOf.0.addresses.items.[INDEX].address2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Additional address line, when available.","isRequired":true,"uniqueKey":"details.oneOf.0.addresses.items.[INDEX].address2.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details.oneOf.0.addresses.items.[INDEX].address2","typeLabel":"string | null"}},"uniqueKey":"details.oneOf.0.addresses.items.[INDEX]","typeLabel":"object"},"description":"User's verified addresses.","isRequired":true,"uniqueKey":"details.oneOf.0.addresses","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"details.oneOf.0","typeLabel":"object"},{"type":"null","description":"Verified profile details; null until they are available.","isRequired":true,"uniqueKey":"details.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"details","typeLabel":"object | null"},"external_reference":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_-]+$","description":"Client-provided external reference.","uniqueKey":"external_reference","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","email":"\u003cstring>","status":"pending","details":{"full_name":"\u003cstring>","phone_number":"\u003cstring>","date_of_birth":"2023-11-07T05:31:56Z","nationality":"\u003cstring>","country_of_residence":"\u003cstring>","country_of_birth":"\u003cstring>","document_number":"\u003cstring>","gender":"\u003cstring>","addresses":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","country":"\u003cstring>","postal_code":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","address1":"\u003cstring>","address2":"\u003cstring>"}]},"external_reference":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"51563bb4-0c45-41d0-bd86-83cdec5dc889":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","format":"int32","description":"HTTP status code.","isRequired":true,"uniqueKey":"code","typeLabel":"integer\u003cint32>"},"message":{"type":"string","description":"Generic human-readable text for the status code. Do not parse it.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"reason":{"type":"string","description":"Stable machine-readable code identifying the specific cause, present only\nfor errors that expose one (e.g. `CREATE_CARD_LIMIT_EXCEEDED`). Branch on\nthis rather than on `message`.","uniqueKey":"reason","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"message":"\u003cstring>","reason":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5d15b3a7-9568-4b6a-b479-82e8ed2e9e79":{"BearerAuth":{"type":"http","scheme":"Bearer","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"1a735a7a-745f-4fc4-b5fc-f3350a5fcf36":{"url":"https://core.prod.gnosispay.com/partner-api","description":"Production","variables":{}},"eefd330d-9464-492d-8018-3ed89cb2b655":{"url":"https://core.sandbox.gnosispay.in/core","description":"Sandbox","variables":{}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"Bearer","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"https://core.sandbox.gnosispay.in/partner-api/openapi.json"},"subdomain":"gnosispay","siteName":"Gnosis Pay","title":"Get a KYC profile - Gnosis Pay","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T11:08:52.910Z","originalFileLocation":"api-reference/partner-api/kyc/get-a-kyc-profile.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieves a KYC profile and its verified details when available. Use the profile status to control onboarding. Create an account only after the profile is approved and the required onboarding steps are complete.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Gnosis Pay\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/gnosispay/lLG7igH-FG-_49c3/_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/gnosispay/lLG7igH-FG-_49c3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/gnosispay/lLG7igH-FG-_49c3/_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/gnosispay/lLG7igH-FG-_49c3/_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/gnosispay/lLG7igH-FG-_49c3/_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/gnosispay/lLG7igH-FG-_49c3/_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/gnosispay/lLG7igH-FG-_49c3/_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/gnosispay/lLG7igH-FG-_49c3/_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/gnosispay/lLG7igH-FG-_49c3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get a KYC profile - Gnosis Pay\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieves a KYC profile and its verified details when available. Use the profile status to control onboarding. Create an account only after the profile is approved and the required onboarding steps are complete.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Gnosis Pay\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.gnosispay.com/api-reference/partner-api/kyc/get-a-kyc-profile\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://gnosispay.mintlify.site/_mintlify/api/og/v2?division=KYC\u0026amp;title=Get+a+KYC+profile\u0026amp;description=Retrieves+a+KYC+profile+and+its+verified+details+when+available.%0A%0AUse+the+profile+%60status%60+to+control+onboarding.+Create+an+account+only%0Aafter+the+profile+is+%60a\u0026amp;theme=dc6323c48fad4c1b39fe1877\u0026amp;signature=f1ce3f944df1e0d2a04964d87af0e45786d223b3674b526014ab7eb4eb58c0f0\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get a KYC profile - Gnosis Pay\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieves a KYC profile and its verified details when available. Use the profile status to control onboarding. Create an account only after the profile is approved and the required onboarding steps are complete.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://gnosispay.mintlify.site/_mintlify/api/og/v2?division=KYC\u0026amp;title=Get+a+KYC+profile\u0026amp;description=Retrieves+a+KYC+profile+and+its+verified+details+when+available.%0A%0AUse+the+profile+%60status%60+to+control+onboarding.+Create+an+account+only%0Aafter+the+profile+is+%60a\u0026amp;theme=dc6323c48fad4c1b39fe1877\u0026amp;signature=f1ce3f944df1e0d2a04964d87af0e45786d223b3674b526014ab7eb4eb58c0f0\">\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/gnosispay/lLG7igH-FG-_49c3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Gnosis Pay\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#766DE5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.gnosispay.com/api-reference/partner-api/kyc/get-a-kyc-profile\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/partner-api/kyc/get-a-kyc-profile.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.gnosispay.com/#organization\",\"name\":\"Gnosis Pay\",\"url\":\"https://docs.gnosispay.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/gnosispay/r5LM-98W_O_YQrwq/static/img/logo-light.svg?fit=max\u0026auto=format\u0026n=r5LM-98W_O_YQrwq\u0026q=85\u0026s=8ca5f2faddda775e89f56d1f6672d6b9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.gnosispay.com#website\",\"name\":\"Gnosis Pay\",\"url\":\"https://docs.gnosispay.com\",\"publisher\":{\"@id\":\"https://docs.gnosispay.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.gnosispay.com/api-reference/partner-api/kyc/get-a-kyc-profile#webpage\",\"url\":\"https://docs.gnosispay.com/api-reference/partner-api/kyc/get-a-kyc-profile\",\"name\":\"Get a KYC profile\",\"description\":\"Retrieves a KYC profile and its verified details when available. Use the profile status to control onboarding. Create an account only after the profile is approved and the required onboarding steps are complete.\",\"dateModified\":\"2026-11-10T11:08:52.910Z\",\"isPartOf\":{\"@id\":\"https://docs.gnosispay.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.gnosispay.com/api-reference/partner-api/kyc/get-a-kyc-profile#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.gnosispay.com/api-reference/partner-api/kyc/get-a-kyc-profile#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Partner API (Platform Integration)\",\"item\":\"https://docs.gnosispay.com/api-reference/partner-api/accounts/list-accounts\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"KYC\",\"item\":\"https://docs.gnosispay.com/api-reference/partner-api/kyc/list-kyc-profiles\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get a KYC profile\",\"item\":\"https://docs.gnosispay.com/api-reference/partner-api/kyc/get-a-kyc-profile\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.gnosispay.com/api-reference/partner-api/kyc/get-a-kyc-profile#apireference\",\"headline\":\"Get a KYC profile\",\"name\":\"Get a KYC profile\",\"description\":\"Retrieves a KYC profile and its verified details when available. Use the profile status to control onboarding. Create an account only after the profile is approved and the required onboarding steps are complete.\",\"url\":\"https://docs.gnosispay.com/api-reference/partner-api/kyc/get-a-kyc-profile\",\"mainEntityOfPage\":{\"@id\":\"https://docs.gnosispay.com/api-reference/partner-api/kyc/get-a-kyc-profile#webpage\"},\"dateModified\":\"2026-11-10T11:08:52.910Z\",\"publisher\":{\"@id\":\"https://docs.gnosispay.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.gnosispay.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Gnosis Pay\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Gnosis Pay","nav":{"global":null,"tabs":[{"tab":"Concepts","pages":[{"title":"Concepts","href":"/concepts/intro"}]},{"tab":"Platform Integration","pages":[{"title":"Platform Integration","href":"/platform-integration/configuring-environment"}]},{"tab":"Embedded Integration","pages":[{"title":"Embedded Integration","href":"/embedded-integration/configuring-environment"}]},{"tab":"API Reference","groups":[{"group":"Partner API (Platform Integration)","pages":[{"group":"Accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/accounts","href":"/api-reference/partner-api/accounts/list-accounts"},{"title":"Create an account","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/accounts","href":"/api-reference/partner-api/accounts/create-an-account"},{"title":"Get an account","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/accounts/{account_id}","href":"/api-reference/partner-api/accounts/get-an-account"},{"title":"List available deposit tokens","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/accounts/{account_id}/available-tokens","href":"/api-reference/partner-api/accounts/list-available-deposit-tokens"},{"title":"Get account balances","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/accounts/{account_id}/balances","href":"/api-reference/partner-api/accounts/get-account-balances"},{"title":"Get an account spending limit","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/accounts/{account_id}/limit","href":"/api-reference/partner-api/accounts/get-an-account-spending-limit"},{"title":"Set an account spending limit","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json put /v1/accounts/{account_id}/limit","href":"/api-reference/partner-api/accounts/set-an-account-spending-limit"}]},{"group":"Cards","pages":[{"title":"List cardholders","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/cardholders","href":"/api-reference/partner-api/cards/list-cardholders"},{"title":"Create a cardholder","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/cardholders","href":"/api-reference/partner-api/cards/create-a-cardholder"},{"title":"Get a cardholder","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/cardholders/{cardholder_id}","href":"/api-reference/partner-api/cards/get-a-cardholder"},{"title":"Update a cardholder","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json patch /v1/cardholders/{cardholder_id}","href":"/api-reference/partner-api/cards/update-a-cardholder"},{"title":"List cards","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/cards","href":"/api-reference/partner-api/cards/list-cards"},{"title":"Create a virtual card","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/cards/virtual","href":"/api-reference/partner-api/cards/create-a-virtual-card"},{"title":"Get a card","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/cards/{card_id}","href":"/api-reference/partner-api/cards/get-a-card"},{"title":"Create Apple Pay provisioning data","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/cards/{card_id}/apple-pay/provisioning","href":"/api-reference/partner-api/cards/create-apple-pay-provisioning-data"},{"title":"Block a card","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/cards/{card_id}/block","href":"/api-reference/partner-api/cards/block-a-card"},{"title":"Cancel a card","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/cards/{card_id}/cancel","href":"/api-reference/partner-api/cards/cancel-a-card"},{"title":"Get a card spending limit","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/cards/{card_id}/limit","href":"/api-reference/partner-api/cards/get-a-card-spending-limit"},{"title":"Set a card spending limit","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json put /v1/cards/{card_id}/limit","href":"/api-reference/partner-api/cards/set-a-card-spending-limit"},{"title":"Unblock a card","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/cards/{card_id}/unblock","href":"/api-reference/partner-api/cards/unblock-a-card"}]},{"group":"Card transactions","pages":[{"title":"List card transactions","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/card-transactions","href":"/api-reference/partner-api/card-transactions/list-card-transactions"},{"title":"Get a card transaction","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/card-transactions/{card_transaction_id}","href":"/api-reference/partner-api/card-transactions/get-a-card-transaction"}]},{"group":"KYC","pages":[{"title":"List KYC profiles","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/kyc/profiles","href":"/api-reference/partner-api/kyc/list-kyc-profiles"},{"title":"Create a KYC profile","description":"Creates a KYC profile and starts the identity-verification flow.\n\nUse a stable `external_reference` from your system and persist the returned\n`profile_id`. The external reference acts as the idempotency key for profile creation:\nretrying with the same external reference and email returns the existing profile ID\nwithout restarting onboarding. Reusing the external reference with a different email\nreturns a conflict.\n\nNext, collect the current terms, retrieve the profile's verification checks,\nand collect source-of-funds answers when required.","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/kyc/profiles","href":"/api-reference/partner-api/kyc/create-a-kyc-profile"},{"title":"Get a KYC profile","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/kyc/profiles/{kyc_profile_id}","href":"/api-reference/partner-api/kyc/get-a-kyc-profile"},{"title":"List KYC profile checks","description":"Lists the identity-verification checks associated with a KYC profile.\n\nDuring onboarding, select the current `basic` check and retrieve it by ID\nto obtain the user-completion credential required by your client.","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/kyc/profiles/{kyc_profile_id}/checks","href":"/api-reference/partner-api/kyc/list-kyc-profile-checks"},{"title":"Get a KYC check","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/kyc/profiles/{kyc_profile_id}/checks/{check_id}","href":"/api-reference/partner-api/kyc/get-a-kyc-check"},{"title":"Get profile source-of-funds answers","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/kyc/profiles/{kyc_profile_id}/source-of-funds","href":"/api-reference/partner-api/kyc/get-profile-source-of-funds-answers"},{"title":"Submit profile source-of-funds answers","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/kyc/profiles/{kyc_profile_id}/source-of-funds","href":"/api-reference/partner-api/kyc/submit-profile-source-of-funds-answers"},{"title":"Get profile terms status","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/kyc/profiles/{kyc_profile_id}/terms","href":"/api-reference/partner-api/kyc/get-profile-terms-status"},{"title":"Accept terms for a profile","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/kyc/profiles/{kyc_profile_id}/terms","href":"/api-reference/partner-api/kyc/accept-terms-for-a-profile"},{"title":"Get source-of-funds questions","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/kyc/source-of-funds-questions","href":"/api-reference/partner-api/kyc/get-source-of-funds-questions"},{"title":"List current terms of service","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/kyc/terms-of-service","href":"/api-reference/partner-api/kyc/list-current-terms-of-service"}]},{"group":"Deposits","pages":[{"title":"List deposits","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/deposits","href":"/api-reference/partner-api/deposits/list-deposits"},{"title":"Get a deposit","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/deposits/{deposit_id}","href":"/api-reference/partner-api/deposits/get-a-deposit"}]},{"group":"Withdrawals","pages":[{"title":"List withdrawals","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/withdrawals","href":"/api-reference/partner-api/withdrawals/list-withdrawals"},{"title":"Create a withdrawal","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/withdrawals","href":"/api-reference/partner-api/withdrawals/create-a-withdrawal"},{"title":"Get a withdrawal","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/withdrawals/{withdrawal_id}","href":"/api-reference/partner-api/withdrawals/get-a-withdrawal"}]},{"group":"PCI","pages":[{"title":"Get encrypted card details","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/pci/cards/{card_id}/details","href":"/api-reference/partner-api/pci/get-encrypted-card-details"},{"title":"Get an encrypted card PIN","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/pci/cards/{card_id}/pin","href":"/api-reference/partner-api/pci/get-an-encrypted-card-pin"},{"title":"Set an encrypted card PIN","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/pci/cards/{card_id}/pin","href":"/api-reference/partner-api/pci/set-an-encrypted-card-pin"},{"title":"Get PCI encryption keys","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/pci/public-key","href":"/api-reference/partner-api/pci/get-pci-encryption-keys"}]},{"group":"3DS","pages":[{"title":"Get a 3DS challenge","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/3ds/challenges/{challenge_id}","href":"/api-reference/partner-api/3ds/get-a-3ds-challenge"},{"title":"Decide a 3DS challenge","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/3ds/challenges/{challenge_id}/decision","href":"/api-reference/partner-api/3ds/decide-a-3ds-challenge"}]},{"group":"Webhooks","pages":[{"title":"Get the webhook configuration","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json get /v1/webhooks","href":"/api-reference/partner-api/webhooks/get-the-webhook-configuration"},{"title":"Create a webhook configuration","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json post /v1/webhooks","href":"/api-reference/partner-api/webhooks/create-a-webhook-configuration"},{"title":"Delete the webhook configuration","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json delete /v1/webhooks","href":"/api-reference/partner-api/webhooks/delete-the-webhook-configuration"},{"title":"Update the webhook configuration","deprecated":null,"version":null,"openapi":"https://core.sandbox.gnosispay.in/partner-api/openapi.json patch /v1/webhooks","href":"/api-reference/partner-api/webhooks/update-the-webhook-configuration"}]}]},{"group":"User API (Embedded Integration)","pages":[{"group":"Auth","pages":[{"title":"Get Siwe message","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /auth/siwe/{address}","href":"/api-reference/user-api/auth/get-siwe-message"},{"title":"Get Access Token","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /auth/siwe","href":"/api-reference/user-api/auth/get-access-token"},{"title":"Request Email Verification","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /email-verification","href":"/api-reference/user-api/auth/request-email-verification"},{"title":"Refresh Access Token","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /auth/refresh","href":"/api-reference/user-api/auth/refresh-access-token"},{"title":"Logout","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /auth/logout","href":"/api-reference/user-api/auth/logout"}]},{"group":"User","pages":[{"title":"Get Current User","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /user","href":"/api-reference/user-api/user/get-current-user"},{"title":"Register User","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /user","href":"/api-reference/user-api/user/register-user"},{"title":"Get Onboarding Status","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /user/onboarding","href":"/api-reference/user-api/user/get-onboarding-status"}]},{"group":"Terms","pages":[{"title":"List Available Terms","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /terms","href":"/api-reference/user-api/terms/list-available-terms"},{"title":"Get User Terms Status","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /user/terms","href":"/api-reference/user-api/terms/get-user-terms-status"},{"title":"Accept Terms","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /user/terms","href":"/api-reference/user-api/terms/accept-terms"}]},{"group":"Source of Funds","pages":[{"title":"Get SOF Questions","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /source-of-funds","href":"/api-reference/user-api/source-of-funds/get-sof-questions"},{"title":"Submit SOF Answers","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /source-of-funds","href":"/api-reference/user-api/source-of-funds/submit-sof-answers"}]},{"group":"Phone","pages":[{"title":"Get Phone Number","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /phone","href":"/api-reference/user-api/phone/get-phone-number"},{"title":"Set Phone Number","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /phone","href":"/api-reference/user-api/phone/set-phone-number"},{"title":"Update Phone Number","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json patch /phone","href":"/api-reference/user-api/phone/update-phone-number"},{"title":"Request Phone Verification","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /phone/verification","href":"/api-reference/user-api/phone/request-phone-verification"}]},{"group":"User Account","pages":[{"title":"Get Account","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /user/account","href":"/api-reference/user-api/user-account/get-account"},{"title":"Create Account","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /user/account","href":"/api-reference/user-api/user-account/create-account"},{"title":"Get Account Daily Spending Limit","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /user/account/limit","href":"/api-reference/user-api/user-account/get-account-daily-spending-limit"},{"title":"Set Account Daily Spending Limit","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json put /user/account/limit","href":"/api-reference/user-api/user-account/set-account-daily-spending-limit"}]},{"group":"Cards","pages":[{"title":"Create Virtual Card","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /cards/virtual","href":"/api-reference/user-api/cards/create-virtual-card"},{"title":"List Cards","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /cards","href":"/api-reference/user-api/cards/list-cards"},{"title":"Get Card Daily Spending Limit","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /cards/{cardId}/limit","href":"/api-reference/user-api/cards/get-card-daily-spending-limit"},{"title":"Set Card Daily Spending Limit","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json put /cards/{cardId}/limit","href":"/api-reference/user-api/cards/set-card-daily-spending-limit"},{"title":"Create Apple Pay Provisioning Data","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /cards/{cardId}/apple-pay/provisioning","href":"/api-reference/user-api/cards/create-apple-pay-provisioning-data"},{"title":"Block Card","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /cards/{cardId}/block","href":"/api-reference/user-api/cards/block-card"},{"title":"Unblock Card","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /cards/{cardId}/unblock","href":"/api-reference/user-api/cards/unblock-card"},{"title":"Cancel Card","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /cards/{cardId}/cancel","href":"/api-reference/user-api/cards/cancel-card"}]},{"group":"User Movements","pages":[{"title":"Get Account Balances (v2)","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /user/balances/v2","href":"/api-reference/user-api/user-movements/get-account-balances-v2"},{"title":"Get User Deposits","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /user/deposits","href":"/api-reference/user-api/user-movements/get-user-deposits"},{"title":"Get Account Statement","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /user/statement","href":"/api-reference/user-api/user-movements/get-account-statement"},{"title":"Create Withdrawal","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /user/withdrawal","href":"/api-reference/user-api/user-movements/create-withdrawal"},{"title":"Get User Withdrawals","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /user/withdrawals","href":"/api-reference/user-api/user-movements/get-user-withdrawals"}]},{"group":"KYC","pages":[{"title":"Generate KYC Applicant Share Token","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /kyc/import-partner-applicant","href":"/api-reference/user-api/kyc/generate-kyc-applicant-share-token"}]},{"group":"PCI","pages":[{"title":"Get PCI EIP-712 Challenge","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /pci/cards/{cardId}/challenge","href":"/api-reference/user-api/pci/get-pci-eip-712-challenge"},{"title":"Get Card Details","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /pci/cards/{cardId}/details","href":"/api-reference/user-api/pci/get-card-details"},{"title":"Get Card PIN","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /pci/cards/{cardId}/pin","href":"/api-reference/user-api/pci/get-card-pin"},{"title":"Set Card PIN","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /pci/cards/{cardId}/pin","href":"/api-reference/user-api/pci/set-card-pin"},{"title":"Get PCI Public Key","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /pci/public-key","href":"/api-reference/user-api/pci/get-pci-public-key"}]},{"group":"3DS","pages":[{"title":"Get 3dschallenges","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /3ds/challenges","href":"/api-reference/user-api/3ds/get-3dschallenges"},{"title":"Get 3dschallenges 1","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /3ds/challenges/{challengeId}","href":"/api-reference/user-api/3ds/get-3dschallenges-1"},{"title":"Post 3dschallenges decision","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /3ds/challenges/{challengeId}/decision","href":"/api-reference/user-api/3ds/post-3dschallenges-decision"},{"title":"Post 3dschallenges decision challenge","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json post /3ds/challenges/{challengeId}/decision-challenge","href":"/api-reference/user-api/3ds/post-3dschallenges-decision-challenge"}]},{"group":"Health","pages":[{"title":"Health check endpoint","deprecated":null,"version":null,"openapi":"https://core.prod.gnosispay.com/user-api/openapi.json get /health","href":"/api-reference/user-api/health/health-check-endpoint"}]}]}]},{"tab":"Migration","pages":[{"title":"Migration","href":"/migration/migration-overview"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Get a KYC profile - Gnosis Pay","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}