URL to start the KYC flow (e.g. Sumsub WebSDK), if applicable.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Meld","colors":{"primary":"#000000","light":"#333333","dark":"#000000"},"logo":{"light":"https://mintcdn.com/meld-e276f676/9EVVQ1Ona28SP_qw/logo/light.svg?fit=max\u0026auto=format\u0026n=9EVVQ1Ona28SP_qw\u0026q=85\u0026s=6a498429bac268f91120055053a14593","dark":"https://mintcdn.com/meld-e276f676/9EVVQ1Ona28SP_qw/logo/dark.svg?fit=max\u0026auto=format\u0026n=9EVVQ1Ona28SP_qw\u0026q=85\u0026s=db79e8d4d4ddeb3ce23be15e159cc5b6"},"favicon":"https://mintcdn.com/meld-e276f676/hUvLlcIJC-ZfeJZm/favicon.svg?fit=max\u0026auto=format\u0026n=hUvLlcIJC-ZfeJZm\u0026q=85\u0026s=1d361599ebecc87def220cc278fbb12f","api":{"examples":{"defaults":"required","prefill":true}},"appearance":{"default":"light"},"navbar":{"links":[{"href":"https://www.meld.io/coverage","label":"Coverage"},{"href":"mailto:support@meld.io","label":"Support"}]},"footer":{"socials":{"x":"https://x.com/meldio"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"meld-e276f676","hasAudioNarration":false,"actualSubdomain":"meld-e276f676","customDomains":["docs.meld.io"],"gitSource":{"type":"github","owner":"meldeng","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad7b3faa5f82acf6a8cac34","collectionId":"ca2d4ce5-06ba-426e-825c-9569d8b8c355","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad7b3faa5f82acf6a8cac34"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae1a199f8179dd80879b5db","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"API Reference","count":194},{"language":"default","tag":"Documentation","count":150},{"language":"default","tag":"Bank Linking","count":149},{"language":"default","tag":"Stablecoins \u0026 Digital Assets","count":52},{"language":"default","tag":"Partner Details","count":37},{"language":"default","tag":"Payments","count":30},{"language":"default","tag":"Transactions","count":27},{"language":"default","tag":"Service Providers","count":27},{"language":"default","tag":"Service Provider","count":27},{"language":"default","tag":"Crypto","count":22}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"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":"per-site-search-delta","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":"editor-private-page-search","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate","slug":"/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate","pageMetadata":{"title":"Initiate customer KYC","description":"Retrieve a url that when launched displays a UI that commences KYC for your user","deprecated":null,"version":null,"sidebarTitle":"Accounts customers kyc initiate","openapi":"/openapi/customer-20231219.json post /accounts/customers/{customerId}/kyc/initiate","href":"/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve a url that when launched displays a UI that commences KYC for your user\"\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":"Initiate customer KYC","description":"Retrieve a url that when launched displays a UI that commences KYC for your user","deprecated":null,"version":null,"sidebarTitle":"Accounts customers kyc initiate","openapi":"/openapi/customer-20231219.json post /accounts/customers/{customerId}/kyc/initiate","href":"/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Customers"],"summary":"Initiate customer KYC","description":"Retrieve a url that when launched displays a UI that commences KYC for your user","operationId":"accounts-customers-kyc-initiate","parameters":["253fca07-60a9-47b1-b24b-9db305dc9498","9a95af3e-2000-4672-af97-144367d78005"],"requestBody":"feab34f6-462e-4a8d-bd23-cc348230ad1f","responses":{"200":"1d1d2958-67bc-4b1e-b3a4-a5434f227a96","400":"92121834-e5a1-478d-be00-d744c4c63a46","401":"85213425-16f2-4585-a4a4-908bcd67e2ba","403":"f951ad6a-c2ec-4d33-8210-763fe577d16e","404":"94ac481e-c300-495c-bad5-2d0098f59676","409":"15dc9c1e-64f1-481d-9c6a-881b709b47fc","422":"ad890274-b181-40b2-bd82-d9c81e9c752c","500":"552d5b83-6dd6-4227-a6dd-d9063e121c91"},"security":["fba37287-5784-435b-8cdf-a23c2c17af8b"],"x-mint":{"href":"/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate"},"method":"post","type":"path","servers":["01ea824d-b7e5-40e1-af19-fa49ea1e01a1","d2a2e3dc-4395-4119-8e1b-34da7118c7ee"],"path":"/accounts/customers/{customerId}/kyc/initiate","baseUrlOptions":["https://api-sb.meld.io","https://api.meld.io"],"title":"Initiate customer KYC","codeSamples":[],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.mode":"HOSTED_URL","body.serviceProvider":"SUMSUB"}]},"dependencies":{"parameters":{"253fca07-60a9-47b1-b24b-9db305dc9498":{"name":"Meld-Version","in":"header","description":"Dated API version to use for this request, e.g. `2026-02-03`.","required":false,"schema":{"type":"string","example":"2023-12-19","isRequired":false,"description":"Dated API version to use for this request, e.g. `2026-02-03`.","uniqueKey":"","typeLabel":"string"}},"9a95af3e-2000-4672-af97-144367d78005":{"name":"customerId","in":"path","description":"Customer id","required":true,"schema":{"type":"string","isRequired":true,"description":"Customer id","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Request to initiate KYC for a customer with a given provider","properties":{"mode":{"type":"string","description":"KYC initiation mode","enum":["HOSTED_URL","TOKEN_IMPORT"],"isRequired":true,"uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"serviceProvider":{"type":"string","description":"KYC provider to use (currently only SUMSUB is supported)","enum":["SUMSUB"],"example":"SUMSUB","minLength":1,"isRequired":true,"uniqueKey":"serviceProvider","typeLabel":"enum\u003cstring>"},"kycShareProviders":{"type":"array","description":"Additional KYC providers to share the result with","items":{"type":"string","enum":["ACROSS","AEROPAY","AKOYA","ALCHEMYPAY","APPLEPAY","AUTHORIZENET","BANXA","BILIRA","BINANCECONNECT","BINANCEPAY","BLOCKCHAINDOTCOM","BOOMFI","BRAINTREE","BRALE","BTCDIRECT","CASHAPP","CHECKOUT","CIRCLE","COINBASEPAY","COINFLOW","DUENETWORK","ELDORADO","FINICITY","FLASHNET","FONBNK","GUARDARIAN","HARBOUR","KOYWE","KRYPTONIM","MERCURYO","MESH","MESO","MOONPAY","MOOV","MX","NMI","NOAH","ONMETA","ONRAMPMONEY","PAYBIS","PAYPAL","PLAID","RAMP","REVOLUT","ROBINHOOD","ROUTERPROTOCOL","SALTEDGE","SALTEDGEPARTNERS","SARDINE","SHIFT4","SHOPIFY","SIMPLEX","SKRILLCRYPTO","SQUARE","STRIPE","SUMSUB","SWAPPED","TANGOCARD","TELLER","TOPPER","TRANSAK","TREMENDOUS","TRANSFI","UNLIMIT","UPHOLD","WYRE","XANPOOL","YELLOWCARD","YODLEE"],"uniqueKey":"kycShareProviders.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueItems":true,"uniqueKey":"kycShareProviders","typeLabel":"enum\u003cstring>[]"},"serviceProviderDetails":{"type":"object","title":"SumsubTokenImportKycDetails","description":"Provider-specific details required for the selected mode. Required when mode is TOKEN_IMPORT, null for HOSTED_URL","required":["applicantId","kycToken"],"properties":{"kycToken":{"type":"string","description":"Access token issued by the KYC provider","minLength":1,"isRequired":true,"uniqueKey":"serviceProviderDetails.kycToken","typeLabel":"string"},"applicantId":{"type":"string","description":"Applicant ID from the KYC provider","minLength":1,"isRequired":true,"uniqueKey":"serviceProviderDetails.applicantId","typeLabel":"string"}},"uniqueKey":"serviceProviderDetails","typeLabel":"SumsubTokenImportKycDetails · object"}},"required":["mode","serviceProvider"],"uniqueKey":"","typeLabel":"object"},"example":{"mode":"HOSTED_URL","serviceProvider":"SUMSUB"},"examples":{"Example":{"title":"Example","value":{"mode":"HOSTED_URL","serviceProvider":"SUMSUB"}}},"exampleType":"examples"}},"required":true,"exampleType":"examples"},"responses":{"1d1d2958-67bc-4b1e-b3a4-a5434f227a96":{"description":"OK","content":{"*/*":{"schema":{"type":"object","description":"Response after initiating KYC: customer/provider/status. Token is obtained via getToken once KYC is complete.","properties":{"customerId":{"type":"string","description":"Customer id (Meld)","uniqueKey":"customerId","typeLabel":"string"},"serviceProvider":{"type":"string","description":"KYC provider","enum":["SUMSUB"],"uniqueKey":"serviceProvider","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Current KYC status","enum":["PENDING","APPROVED","REJECTED","EXPIRED","UNKNOWN"],"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"URL to start the KYC flow (e.g. Sumsub WebSDK), if applicable.","uniqueKey":"url","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customerId":"\u003cstring>","serviceProvider":"SUMSUB","status":"PENDING","url":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"92121834-e5a1-478d-be00-d744c4c63a46":{"description":"Bad Request : check request values and format\n\nRead message — it names which condition applied, from the values listed under `message`.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"`BAD_REQUEST`","uniqueKey":"code","typeLabel":"string"},"errors":{"type":"array","description":"Any of:\n\n- `[Meld-Version] is invalid`\n- `Required parameter [customerId] is missing`","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors","typeLabel":"string[]"},"message":{"type":"string","description":"Bad request","uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Quote this when asking Meld about a specific failure.","uniqueKey":"requestId","typeLabel":"string"},"serviceProviderDetails":{"type":"object","properties":{"code":{"type":"string","description":"The provider's own error code, when it sent one.","uniqueKey":"serviceProviderDetails.code","typeLabel":"string"},"message":{"type":"string","description":"The provider's own message.","uniqueKey":"serviceProviderDetails.message","typeLabel":"string"}},"example":{"code":"5034","message":"Digital currency and blockchain combination is restricted for customer's country"},"description":"The provider's own error detail, when the failure came from a service provider. Usually `code` and `message`; a few providers pass their own body through, so other keys can appear.","additionalProperties":{"oneOf":[{}],"uniqueKey":"serviceProviderDetails.additionalProperties","typeLabel":"any"},"uniqueKey":"serviceProviderDetails","typeLabel":"object"},"timestamp":{"type":"string","format":"date-time","description":"When the failure occurred. ISO 8601, UTC (`YYYY-MM-DDThh:mm:ss.sss+00:00`).","example":"2026-08-14T09:41:22.482+00:00","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":"BAD_REQUEST","message":"Bad request","requestId":"01JB2K7C9XQZ4M8N2P5R6T3V","timestamp":"2026-08-14T09:41:22.482+00:00","errors":["[Meld-Version] is invalid"]},"examples":{"Example":{"title":"Example","value":{"code":"BAD_REQUEST","message":"Bad request","requestId":"01JB2K7C9XQZ4M8N2P5R6T3V","timestamp":"2026-08-14T09:41:22.482+00:00","errors":["[Meld-Version] is invalid"]}}},"exampleType":"examples"}},"exampleType":"examples"},"85213425-16f2-4585-a4a4-908bcd67e2ba":{"description":"Invalid credentials\n\nCheck the API credentials being sent.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"`UNAUTHORIZED`","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Access denied","uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Quote this when asking Meld about a specific failure.","uniqueKey":"requestId","typeLabel":"string"},"serviceProviderDetails":{"type":"object","properties":{"code":{"type":"string","description":"The provider's own error code, when it sent one.","uniqueKey":"serviceProviderDetails.code","typeLabel":"string"},"message":{"type":"string","description":"The provider's own message.","uniqueKey":"serviceProviderDetails.message","typeLabel":"string"}},"example":{"code":"5034","message":"Digital currency and blockchain combination is restricted for customer's country"},"description":"The provider's own error detail, when the failure came from a service provider. Usually `code` and `message`; a few providers pass their own body through, so other keys can appear.","additionalProperties":{"oneOf":[{}],"uniqueKey":"serviceProviderDetails.additionalProperties","typeLabel":"any"},"uniqueKey":"serviceProviderDetails","typeLabel":"object"},"timestamp":{"type":"string","format":"date-time","description":"When the failure occurred. ISO 8601, UTC (`YYYY-MM-DDThh:mm:ss.sss+00:00`).","example":"2026-08-14T09:41:22.482+00:00","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":"UNAUTHORIZED","message":"Access denied","requestId":"01JB2K7C9XQZ4M8N2P5R6T3V","timestamp":"2026-08-14T09:41:22.482+00:00"},"examples":{"Example":{"title":"Example","value":{"code":"UNAUTHORIZED","message":"Access denied","requestId":"01JB2K7C9XQZ4M8N2P5R6T3V","timestamp":"2026-08-14T09:41:22.482+00:00"}}},"exampleType":"examples"}},"exampleType":"examples"},"f951ad6a-c2ec-4d33-8210-763fe577d16e":{"description":"Unauthenticated or authenticated with insufficient access\n\nCheck the account's permissions for this operation.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"`FORBIDDEN`","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Access denied","uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Quote this when asking Meld about a specific failure.","uniqueKey":"requestId","typeLabel":"string"},"serviceProviderDetails":{"type":"object","properties":{"code":{"type":"string","description":"The provider's own error code, when it sent one.","uniqueKey":"serviceProviderDetails.code","typeLabel":"string"},"message":{"type":"string","description":"The provider's own message.","uniqueKey":"serviceProviderDetails.message","typeLabel":"string"}},"example":{"code":"5034","message":"Digital currency and blockchain combination is restricted for customer's country"},"description":"The provider's own error detail, when the failure came from a service provider. Usually `code` and `message`; a few providers pass their own body through, so other keys can appear.","additionalProperties":{"oneOf":[{}],"uniqueKey":"serviceProviderDetails.additionalProperties","typeLabel":"any"},"uniqueKey":"serviceProviderDetails","typeLabel":"object"},"timestamp":{"type":"string","format":"date-time","description":"When the failure occurred. ISO 8601, UTC (`YYYY-MM-DDThh:mm:ss.sss+00:00`).","example":"2026-08-14T09:41:22.482+00:00","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":"FORBIDDEN","message":"Access denied","requestId":"01JB2K7C9XQZ4M8N2P5R6T3V","timestamp":"2026-08-14T09:41:22.482+00:00"},"examples":{"Example":{"title":"Example","value":{"code":"FORBIDDEN","message":"Access denied","requestId":"01JB2K7C9XQZ4M8N2P5R6T3V","timestamp":"2026-08-14T09:41:22.482+00:00"}}},"exampleType":"examples"}},"exampleType":"examples"},"94ac481e-c300-495c-bad5-2d0098f59676":{"description":"Customer not found\n\nVerify the identifier in the request.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"`NOT_FOUND`","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Resource not found","uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Quote this when asking Meld about a specific failure.","uniqueKey":"requestId","typeLabel":"string"},"serviceProviderDetails":{"type":"object","properties":{"code":{"type":"string","description":"The provider's own error code, when it sent one.","uniqueKey":"serviceProviderDetails.code","typeLabel":"string"},"message":{"type":"string","description":"The provider's own message.","uniqueKey":"serviceProviderDetails.message","typeLabel":"string"}},"example":{"code":"5034","message":"Digital currency and blockchain combination is restricted for customer's country"},"description":"The provider's own error detail, when the failure came from a service provider. Usually `code` and `message`; a few providers pass their own body through, so other keys can appear.","additionalProperties":{"oneOf":[{}],"uniqueKey":"serviceProviderDetails.additionalProperties","typeLabel":"any"},"uniqueKey":"serviceProviderDetails","typeLabel":"object"},"timestamp":{"type":"string","format":"date-time","description":"When the failure occurred. ISO 8601, UTC (`YYYY-MM-DDThh:mm:ss.sss+00:00`).","example":"2026-08-14T09:41:22.482+00:00","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":"NOT_FOUND","message":"Resource not found","requestId":"01JB2K7C9XQZ4M8N2P5R6T3V","timestamp":"2026-08-14T09:41:22.482+00:00"},"examples":{"Example":{"title":"Example","value":{"code":"NOT_FOUND","message":"Resource not found","requestId":"01JB2K7C9XQZ4M8N2P5R6T3V","timestamp":"2026-08-14T09:41:22.482+00:00"}}},"exampleType":"examples"}},"exampleType":"examples"},"15dc9c1e-64f1-481d-9c6a-881b709b47fc":{"description":"KYC already initiated for this customer and provider\n\nResolve the conflicting state, then retry.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"`CONFLICT`","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Conflict","uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Quote this when asking Meld about a specific failure.","uniqueKey":"requestId","typeLabel":"string"},"serviceProviderDetails":{"type":"object","properties":{"code":{"type":"string","description":"The provider's own error code, when it sent one.","uniqueKey":"serviceProviderDetails.code","typeLabel":"string"},"message":{"type":"string","description":"The provider's own message.","uniqueKey":"serviceProviderDetails.message","typeLabel":"string"}},"example":{"code":"5034","message":"Digital currency and blockchain combination is restricted for customer's country"},"description":"The provider's own error detail, when the failure came from a service provider. Usually `code` and `message`; a few providers pass their own body through, so other keys can appear.","additionalProperties":{"oneOf":[{}],"uniqueKey":"serviceProviderDetails.additionalProperties","typeLabel":"any"},"uniqueKey":"serviceProviderDetails","typeLabel":"object"},"timestamp":{"type":"string","format":"date-time","description":"When the failure occurred. ISO 8601, UTC (`YYYY-MM-DDThh:mm:ss.sss+00:00`).","example":"2026-08-14T09:41:22.482+00:00","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":"CONFLICT","message":"Conflict","requestId":"01JB2K7C9XQZ4M8N2P5R6T3V","timestamp":"2026-08-14T09:41:22.482+00:00"},"examples":{"Example":{"title":"Example","value":{"code":"CONFLICT","message":"Conflict","requestId":"01JB2K7C9XQZ4M8N2P5R6T3V","timestamp":"2026-08-14T09:41:22.482+00:00"}}},"exampleType":"examples"}},"exampleType":"examples"},"ad890274-b181-40b2-bd82-d9c81e9c752c":{"description":"Customer is not compliant for KYC sharing","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"Stable identifier for the failure.","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"A description of what went wrong.","uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Quote this when asking Meld about a specific failure.","uniqueKey":"requestId","typeLabel":"string"},"serviceProviderDetails":{"type":"object","properties":{"code":{"type":"string","description":"The provider's own error code, when it sent one.","uniqueKey":"serviceProviderDetails.code","typeLabel":"string"},"message":{"type":"string","description":"The provider's own message.","uniqueKey":"serviceProviderDetails.message","typeLabel":"string"}},"example":{"code":"5034","message":"Digital currency and blockchain combination is restricted for customer's country"},"description":"The provider's own error detail, when the failure came from a service provider. Usually `code` and `message`; a few providers pass their own body through, so other keys can appear.","additionalProperties":{"oneOf":[{}],"uniqueKey":"serviceProviderDetails.additionalProperties","typeLabel":"any"},"uniqueKey":"serviceProviderDetails","typeLabel":"object"},"timestamp":{"type":"string","format":"date-time","description":"When the failure occurred. ISO 8601, UTC (`YYYY-MM-DDThh:mm:ss.sss+00:00`).","example":"2026-08-14T09:41:22.482+00:00","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","requestId":"\u003cstring>","serviceProviderDetails":{"code":"5034","message":"Digital currency and blockchain combination is restricted for customer's country"},"timestamp":"2026-08-14T09:41:22.482+00:00"}}},"exampleType":"generated"}},"exampleType":"generated"},"552d5b83-6dd6-4227-a6dd-d9063e121c91":{"description":"Server Error. This applies to all 5xx errors, including but not limited to 500, 501, 502, 503, and 504 errors. You should treat all of these errors the same.\n\nAn internal Meld error. Contact Meld support with the requestId; a retry may not clear it.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","description":"`UNEXPECTED_ERROR`","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Unexpected error","uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"Quote this when asking Meld about a specific failure.","uniqueKey":"requestId","typeLabel":"string"},"serviceProviderDetails":{"type":"object","properties":{"code":{"type":"string","description":"The provider's own error code, when it sent one.","uniqueKey":"serviceProviderDetails.code","typeLabel":"string"},"message":{"type":"string","description":"The provider's own message.","uniqueKey":"serviceProviderDetails.message","typeLabel":"string"}},"example":{"code":"5034","message":"Digital currency and blockchain combination is restricted for customer's country"},"description":"The provider's own error detail, when the failure came from a service provider. Usually `code` and `message`; a few providers pass their own body through, so other keys can appear.","additionalProperties":{"oneOf":[{}],"uniqueKey":"serviceProviderDetails.additionalProperties","typeLabel":"any"},"uniqueKey":"serviceProviderDetails","typeLabel":"object"},"timestamp":{"type":"string","format":"date-time","description":"When the failure occurred. ISO 8601, UTC (`YYYY-MM-DDThh:mm:ss.sss+00:00`).","example":"2026-08-14T09:41:22.482+00:00","uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":"UNEXPECTED_ERROR","message":"Unexpected error","requestId":"01JB2K7C9XQZ4M8N2P5R6T3V","timestamp":"2026-08-14T09:41:22.482+00:00"},"examples":{"Example":{"title":"Example","value":{"code":"UNEXPECTED_ERROR","message":"Unexpected error","requestId":"01JB2K7C9XQZ4M8N2P5R6T3V","timestamp":"2026-08-14T09:41:22.482+00:00"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"fba37287-5784-435b-8cdf-a23c2c17af8b":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","x-default":"BASIC \u003cMeld API Key>","scopes":[]}}},"servers":{"01ea824d-b7e5-40e1-af19-fa49ea1e01a1":{"url":"https://api-sb.meld.io","description":"Meld API sandbox"},"d2a2e3dc-4395-4119-8e1b-34da7118c7ee":{"url":"https://api.meld.io","description":"Meld API production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","x-default":"BASIC \u003cMeld API Key>","scopes":[]},"schema":{"title":"Authorization","type":"string","isRequired":true,"default":"BASIC \u003cMeld API Key>","typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi/customer-20231219.json"},"subdomain":"meld-e276f676","siteName":"Meld","title":"Initiate customer KYC - Meld","navMaps":{"firstHrefInVersion":{"2026-02-03":{"href":"/api-reference/customer/customers/accounts-customers-search","matchLevel":2},"2025-03-04":{"href":"/api-reference/customer/2025-03-04/customers/accounts-customers-kyc-initiate","matchLevel":1},"2023-12-19":{"href":"/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-09-01T17:01:38.802Z","originalFileLocation":"api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve a url that when launched displays a UI that commences KYC for your user\">\u003cmeta data-mint-head name=\"application-name\" content=\"Meld\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/meld-e276f676/VTnI9uBWWNTnirMq/_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/meld-e276f676/VTnI9uBWWNTnirMq/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/meld-e276f676/VTnI9uBWWNTnirMq/_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/meld-e276f676/VTnI9uBWWNTnirMq/_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/meld-e276f676/VTnI9uBWWNTnirMq/_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/meld-e276f676/VTnI9uBWWNTnirMq/_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/meld-e276f676/VTnI9uBWWNTnirMq/_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/meld-e276f676/VTnI9uBWWNTnirMq/_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/meld-e276f676/VTnI9uBWWNTnirMq/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Initiate customer KYC - Meld\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a url that when launched displays a UI that commences KYC for your user\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Meld\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.meld.io/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://meld-e276f676.mintlify.app/_mintlify/api/og/v2?division=Customers\u0026amp;title=Initiate+customer+KYC\u0026amp;description=Retrieve+a+url+that+when+launched+displays+a+UI+that+commences+KYC+for+your+user\u0026amp;theme=28c66332baab02857e320658\u0026amp;signature=7a2ed89545440d02ad2bbfc36cb8de5a4b76af84351e37ebb10976347abac1d7\">\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 customer KYC - Meld\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a url that when launched displays a UI that commences KYC for your user\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://meld-e276f676.mintlify.app/_mintlify/api/og/v2?division=Customers\u0026amp;title=Initiate+customer+KYC\u0026amp;description=Retrieve+a+url+that+when+launched+displays+a+UI+that+commences+KYC+for+your+user\u0026amp;theme=28c66332baab02857e320658\u0026amp;signature=7a2ed89545440d02ad2bbfc36cb8de5a4b76af84351e37ebb10976347abac1d7\">\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/meld-e276f676/VTnI9uBWWNTnirMq/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Meld\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#000000\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.meld.io/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.meld.io/#organization\",\"name\":\"Meld\",\"url\":\"https://docs.meld.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/meld-e276f676/9EVVQ1Ona28SP_qw/logo/light.svg?fit=max\u0026auto=format\u0026n=9EVVQ1Ona28SP_qw\u0026q=85\u0026s=6a498429bac268f91120055053a14593\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.meld.io#website\",\"name\":\"Meld\",\"url\":\"https://docs.meld.io\",\"publisher\":{\"@id\":\"https://docs.meld.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.meld.io/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate#webpage\",\"url\":\"https://docs.meld.io/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate\",\"name\":\"Initiate customer KYC\",\"description\":\"Retrieve a url that when launched displays a UI that commences KYC for your user\",\"dateModified\":\"2026-09-01T17:01:38.802Z\",\"isPartOf\":{\"@id\":\"https://docs.meld.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.meld.io/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.meld.io/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Customer\",\"item\":\"https://docs.meld.io/api-reference/customer/2023-12-19/customers/accounts-customers-search\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customers\",\"item\":\"https://docs.meld.io/api-reference/customer/2023-12-19/customers/accounts-customers-search\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Initiate customer KYC\",\"item\":\"https://docs.meld.io/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.meld.io/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate#apireference\",\"headline\":\"Initiate customer KYC\",\"name\":\"Initiate customer KYC\",\"description\":\"Retrieve a url that when launched displays a UI that commences KYC for your user\",\"url\":\"https://docs.meld.io/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate\",\"mainEntityOfPage\":{\"@id\":\"https://docs.meld.io/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate#webpage\"},\"dateModified\":\"2026-09-01T17:01:38.802Z\",\"publisher\":{\"@id\":\"https://docs.meld.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.meld.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Meld\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Meld","nav":{"global":null,"versions":[{"version":"2026-02-03","default":true,"tag":"Latest","pages":[{"title":"2026-02-03","href":"/api-reference/customer/customers/accounts-customers-search"}]},{"version":"2025-03-04","pages":[{"title":"2025-03-04","href":"/api-reference/customer/2025-03-04/customers/accounts-customers-kyc-initiate"}]},{"version":"2023-12-19","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/welcome/overview"}]},{"tab":"API Reference","groups":[{"group":"Crypto","pages":[{"group":"Retail Ramp","pages":[{"title":"Create a crypto widget","deprecated":null,"version":null,"sidebarTitle":"Crypto session widget create","openapi":"/openapi/crypto-20231219.json post /crypto/session/widget","href":"/api-reference/crypto/2023-12-19/retail-ramp/crypto-session-widget-create"},{"title":"Get transaction by id","deprecated":null,"version":null,"sidebarTitle":"Payments transactions get","openapi":"/openapi/crypto-20231219.json get /payments/transactions/{id}","href":"/api-reference/crypto/2023-12-19/retail-ramp/payments-transactions-get"},{"title":"Search transactions","deprecated":null,"version":null,"sidebarTitle":"Payments transactions search","openapi":"/openapi/crypto-20231219.json get /payments/transactions","href":"/api-reference/crypto/2023-12-19/retail-ramp/payments-transactions-search"},{"title":"Fetch a transaction from the provider (for offramp use)","deprecated":null,"version":null,"sidebarTitle":"Payments transactions sessions get","openapi":"/openapi/crypto-20231219.json get /payments/transactions/sessions/{sessionId}","href":"/api-reference/crypto/2023-12-19/retail-ramp/payments-transactions-sessions-get"}]},{"group":"Headless","pages":[{"title":"Create a headless offramp order","deprecated":null,"version":null,"sidebarTitle":"Crypto order headless offramp create","openapi":"/openapi/crypto-20231219.json post /crypto/order/headless/offramp","href":"/api-reference/crypto/2023-12-19/headless/crypto-order-headless-offramp-create"},{"title":"Create or retrieve standing virtual-account onramp deposit instructions","deprecated":null,"version":null,"sidebarTitle":"Payments virtual account deposit instructions create","openapi":"/openapi/crypto-20231219.json post /payments/virtual-account/deposit-instructions","href":"/api-reference/crypto/2023-12-19/headless/payments-virtual-account-deposit-instructions-create"}]}]},{"group":"Bank Linking","pages":[{"group":"Connect","pages":[{"title":"Create a connection","deprecated":null,"version":null,"sidebarTitle":"Bank linking connect create","openapi":"/openapi/banklinking-20231219.json post /bank-linking/connect/start","href":"/api-reference/bank-linking/2023-12-19/connect/bank-linking-connect-create"},{"title":"Repair a connection","deprecated":null,"version":null,"sidebarTitle":"Bank linking connect repair","openapi":"/openapi/banklinking-20231219.json post /bank-linking/connect/repair","href":"/api-reference/bank-linking/2023-12-19/connect/bank-linking-connect-repair"}]},{"group":"Connections","pages":[{"title":"Get an institution connection","deprecated":null,"version":null,"sidebarTitle":"Bank linking connections get","openapi":"/openapi/banklinking-20231219.json get /bank-linking/connections/{connectionId}","href":"/api-reference/bank-linking/2023-12-19/connections/bank-linking-connections-get"},{"title":"Delete an institution connection","deprecated":null,"version":null,"sidebarTitle":"Bank linking connections delete","openapi":"/openapi/banklinking-20231219.json delete /bank-linking/connections/{connectionId}","href":"/api-reference/bank-linking/2023-12-19/connections/bank-linking-connections-delete"},{"title":"Search institution connections","deprecated":null,"version":null,"sidebarTitle":"Bank linking connections search","openapi":"/openapi/banklinking-20231219.json get /bank-linking/connections","href":"/api-reference/bank-linking/2023-12-19/connections/bank-linking-connections-search"},{"title":"Update a connection","deprecated":null,"version":null,"sidebarTitle":"Bank linking connection update","openapi":"/openapi/banklinking-20231219.json post /bank-linking/connections/{connectionId}/update","href":"/api-reference/bank-linking/2023-12-19/connections/bank-linking-connection-update"},{"title":"Refresh accounts belonging to a connection","deprecated":null,"version":null,"sidebarTitle":"Bank linking connections refresh","openapi":"/openapi/banklinking-20231219.json post /bank-linking/connections/{connectionId}/refresh","href":"/api-reference/bank-linking/2023-12-19/connections/bank-linking-connections-refresh"},{"title":"Import existing connections with a service provider","deprecated":null,"version":null,"sidebarTitle":"Bank linking connections import","openapi":"/openapi/banklinking-20231219.json post /bank-linking/connections/import","href":"/api-reference/bank-linking/2023-12-19/connections/bank-linking-connections-import"}]},{"group":"Accounts","pages":[{"title":"Get a financial account","deprecated":null,"version":null,"sidebarTitle":"Bank linking accounts get","openapi":"/openapi/banklinking-20231219.json get /bank-linking/accounts/{financialAccountId}","href":"/api-reference/bank-linking/2023-12-19/accounts/bank-linking-accounts-get"},{"title":"Search financial accounts","deprecated":null,"version":null,"sidebarTitle":"Bank linking accounts search","openapi":"/openapi/banklinking-20231219.json get /bank-linking/accounts","href":"/api-reference/bank-linking/2023-12-19/accounts/bank-linking-accounts-search"},{"title":"Create processor token","deprecated":null,"version":null,"sidebarTitle":"Bank linking accounts create processor token","openapi":"/openapi/banklinking-20231219.json post /bank-linking/accounts/{financialAccountId}/processors/create-token","href":"/api-reference/bank-linking/2023-12-19/accounts/bank-linking-accounts-create-processor-token"}]},{"group":"Transactions","pages":[{"title":"Get a financial account transaction","deprecated":null,"version":null,"sidebarTitle":"Bank linking transactions get","openapi":"/openapi/banklinking-20231219.json get /bank-linking/transactions/{transactionId}","href":"/api-reference/bank-linking/2023-12-19/transactions/bank-linking-transactions-get"},{"title":"Search financial account transactions","deprecated":null,"version":null,"sidebarTitle":"Bank linking transactions search","openapi":"/openapi/banklinking-20231219.json get /bank-linking/transactions","href":"/api-reference/bank-linking/2023-12-19/transactions/bank-linking-transactions-search"}]},{"group":"Investments","pages":[{"title":"Get a financial account investment holding","deprecated":null,"version":null,"sidebarTitle":"Bank linking investment holdings get","openapi":"/openapi/banklinking-20231219.json get /bank-linking/investments/holdings/{investmentHoldingId}","href":"/api-reference/bank-linking/2023-12-19/investments/bank-linking-investment-holdings-get"},{"title":"Search financial account investment holdings","deprecated":null,"version":null,"sidebarTitle":"Bank linking investment holdings search","openapi":"/openapi/banklinking-20231219.json get /bank-linking/investments/holdings","href":"/api-reference/bank-linking/2023-12-19/investments/bank-linking-investment-holdings-search"},{"title":"Get a financial account investment transaction","deprecated":null,"version":null,"sidebarTitle":"Bank linking investment transactions get","openapi":"/openapi/banklinking-20231219.json get /bank-linking/investments/transactions/{investmentTransactionId}","href":"/api-reference/bank-linking/2023-12-19/investments/bank-linking-investment-transactions-get"},{"title":"Search financial account investment transactions","deprecated":null,"version":null,"sidebarTitle":"Bank linking investment transactions search","openapi":"/openapi/banklinking-20231219.json get /bank-linking/investments/transactions","href":"/api-reference/bank-linking/2023-12-19/investments/bank-linking-investment-transactions-search"}]},{"group":"Institutions","pages":[{"title":"Get institution","deprecated":null,"version":null,"sidebarTitle":"Bank linking institutions get","openapi":"/openapi/banklinking-20231219.json get /institutions/{institutionId}","href":"/api-reference/bank-linking/2023-12-19/institutions/bank-linking-institutions-get"},{"title":"Search institutions","deprecated":null,"version":null,"sidebarTitle":"Bank linking institutions search","openapi":"/openapi/banklinking-20231219.json get /institutions","href":"/api-reference/bank-linking/2023-12-19/institutions/bank-linking-institutions-search"}]}]},{"group":"Payments","pages":[{"group":"Transactions","pages":[{"title":"Create a Meld payment token","deprecated":null,"version":null,"sidebarTitle":"Payment token post","openapi":"/openapi/payments-20231219.json post /payments/tokens","href":"/api-reference/payments/2023-12-19/transactions/payment-token-post"},{"title":"Search transactions","deprecated":null,"version":null,"sidebarTitle":"Payments transactions search","openapi":"/openapi/payments-20231219.json get /payments/transactions","href":"/api-reference/payments/2023-12-19/transactions/payments-transactions-search"},{"title":"Create a payment transaction","deprecated":null,"version":null,"sidebarTitle":"Payments transactions create","openapi":"/openapi/payments-20231219.json post /payments/transactions","href":"/api-reference/payments/2023-12-19/transactions/payments-transactions-create"},{"title":"Capture a payment transaction","deprecated":null,"version":null,"sidebarTitle":"Payments transactions capture","openapi":"/openapi/payments-20231219.json post /payments/transactions/{id}/capture","href":"/api-reference/payments/2023-12-19/transactions/payments-transactions-capture"},{"title":"Get transaction by id","deprecated":null,"version":null,"sidebarTitle":"Payments transactions get","openapi":"/openapi/payments-20231219.json get /payments/transactions/{id}","href":"/api-reference/payments/2023-12-19/transactions/payments-transactions-get"},{"title":"Refund a payment transaction","deprecated":null,"version":null,"sidebarTitle":"Payments transactions refund","openapi":"/openapi/payments-20231219.json post /payments/transactions/{id}/refund","href":"/api-reference/payments/2023-12-19/transactions/payments-transactions-refund"},{"title":"Create a payout transaction","deprecated":null,"version":null,"sidebarTitle":"Payouts transactions create","openapi":"/openapi/payments-20231219.json post /payments/transactions/payout","href":"/api-reference/payments/2023-12-19/transactions/payouts-transactions-create"}]},{"group":"External Transactions","pages":[{"title":"Import an external payment transaction","deprecated":null,"version":null,"sidebarTitle":"Payments external transactions import","openapi":"/openapi/payments-20231219.json post /payments/external/import","href":"/api-reference/payments/2023-12-19/external-transactions/payments-external-transactions-import"},{"title":"Refund an external payment transaction","deprecated":null,"version":null,"sidebarTitle":"Payments external transactions refund","openapi":"/openapi/payments-20231219.json post /payments/external/refund","href":"/api-reference/payments/2023-12-19/external-transactions/payments-external-transactions-refund"}]},{"group":"Risk","pages":[{"title":"Create a risk analysis","deprecated":null,"version":null,"sidebarTitle":"Payments transactions risk analysis","openapi":"/openapi/payments-20231219.json post /payments/risk-analysis","href":"/api-reference/payments/2023-12-19/risk/payments-transactions-risk-analysis"}]}]},{"group":"Customer","pages":[{"group":"Customers","pages":[{"title":"Search customers","deprecated":null,"version":null,"sidebarTitle":"Accounts customers search","openapi":"/openapi/customer-20231219.json get /accounts/customers","href":"/api-reference/customer/2023-12-19/customers/accounts-customers-search"},{"title":"Create a new customer or retrieve a customer by its external id","deprecated":null,"version":null,"sidebarTitle":"Accounts customers create","openapi":"/openapi/customer-20231219.json post /accounts/customers","href":"/api-reference/customer/2023-12-19/customers/accounts-customers-create"},{"title":"Delete a customer","deprecated":null,"version":null,"sidebarTitle":"Accounts customers delete","openapi":"/openapi/customer-20231219.json delete /accounts/customers/{customerId}","href":"/api-reference/customer/2023-12-19/customers/accounts-customers-delete"},{"title":"Update a customer","deprecated":null,"version":null,"sidebarTitle":"Accounts customers update","openapi":"/openapi/customer-20231219.json patch /accounts/customers/{customerId}","href":"/api-reference/customer/2023-12-19/customers/accounts-customers-update"},{"title":"Add an address to a customer","description":null,"deprecated":null,"version":null,"sidebarTitle":"Accounts customers addresses create","openapi":"/openapi/customer-20231219.json post /accounts/customers/{customerId}/addresses","href":"/api-reference/customer/2023-12-19/customers/accounts-customers-addresses-create"},{"title":"Initiate customer KYC","deprecated":null,"version":null,"sidebarTitle":"Accounts customers kyc initiate","openapi":"/openapi/customer-20231219.json post /accounts/customers/{customerId}/kyc/initiate","href":"/api-reference/customer/2023-12-19/customers/accounts-customers-kyc-initiate"}]}]},{"group":"Service Providers","pages":[{"group":"Service Provider","pages":[{"title":"Search service providers","description":"\u003cWarning>\n\n**⚠️ Deprecated — this endpoint is slated for removal.** Migrate to the [Network Partner API](/api-reference/network-partners) as soon as you can; see the [migration guide](/docs/stablecoins/white-label-api-integration/migration-service-provider-to-network-partner). Do not build new integrations against this endpoint.\n\n\u003c/Warning>\n\nReturns a list of service providers which meet the search criteria.","deprecated":true,"version":null,"sidebarTitle":"Service providers search","openapi":"/openapi/serviceproviders-20231219.json get /service-providers","href":"/api-reference/service-providers/2023-12-19/service-provider/service-providers-search"},{"title":"Search countries","deprecated":true,"version":null,"sidebarTitle":"Service providers properties country search","openapi":"/openapi/serviceproviders-20231219.json get /service-providers/properties/countries","href":"/api-reference/service-providers/2023-12-19/service-provider/service-providers-properties-country-search"},{"title":"Search crypto currencies","deprecated":true,"version":null,"sidebarTitle":"Service providers properties crypto currency search","openapi":"/openapi/serviceproviders-20231219.json get /service-providers/properties/crypto-currencies","href":"/api-reference/service-providers/2023-12-19/service-provider/service-providers-properties-crypto-currency-search"},{"title":"Search defaults by country","deprecated":true,"version":null,"sidebarTitle":"Service providers properties defaults by country search","openapi":"/openapi/serviceproviders-20231219.json get /service-providers/properties/defaults/by-country","href":"/api-reference/service-providers/2023-12-19/service-provider/service-providers-properties-defaults-by-country-search"},{"title":"Search fiat currencies","deprecated":true,"version":null,"sidebarTitle":"Service providers properties fiat currency search","openapi":"/openapi/serviceproviders-20231219.json get /service-providers/properties/fiat-currencies","href":"/api-reference/service-providers/2023-12-19/service-provider/service-providers-properties-fiat-currency-search"},{"title":"Search payment methods","deprecated":true,"version":null,"sidebarTitle":"Service providers properties payment method search","openapi":"/openapi/serviceproviders-20231219.json get /service-providers/properties/payment-methods","href":"/api-reference/service-providers/2023-12-19/service-provider/service-providers-properties-payment-method-search"},{"title":"Get crypto sell limits for crypto currencies","deprecated":true,"version":null,"sidebarTitle":"Service providers limits crypto currency sells get","openapi":"/openapi/serviceproviders-20231219.json get /service-providers/limits/crypto-currency-sells","href":"/api-reference/service-providers/2023-12-19/service-provider/service-providers-limits-crypto-currency-sells-get"},{"title":"Get crypto purchase limits for fiat currencies","deprecated":true,"version":null,"sidebarTitle":"Service providers limits fiat currency purchase get","openapi":"/openapi/serviceproviders-20231219.json get /service-providers/limits/fiat-currency-purchases","href":"/api-reference/service-providers/2023-12-19/service-provider/service-providers-limits-fiat-currency-purchase-get"},{"title":"Get KYC levels for fiat currencies","deprecated":true,"version":null,"sidebarTitle":"Service providers limits kyc fiat level get","openapi":"/openapi/serviceproviders-20231219.json get /service-providers/limits/kyc-fiat-levels","href":"/api-reference/service-providers/2023-12-19/service-provider/service-providers-limits-kyc-fiat-level-get"}]}]},{"group":"Webhooks","pages":[{"group":"Profile","pages":[{"title":"Search webhook profiles","deprecated":null,"version":null,"sidebarTitle":"Webhooks profiles search","openapi":"/openapi/webhooks-20231219.json get /notifications/webhooks","href":"/api-reference/webhooks/2023-12-19/profile/webhooks-profiles-search"},{"title":"Create a new webhook profile","deprecated":null,"version":null,"sidebarTitle":"Webhooks profiles create","openapi":"/openapi/webhooks-20231219.json post /notifications/webhooks","href":"/api-reference/webhooks/2023-12-19/profile/webhooks-profiles-create"},{"title":"Get all webhook event types that can be sent","deprecated":null,"version":null,"sidebarTitle":"Webhooks events get","openapi":"/openapi/webhooks-20231219.json get /notifications/webhooks/event-types","href":"/api-reference/webhooks/2023-12-19/profile/webhooks-events-get"},{"title":"Get an existing webhook profile","deprecated":null,"version":null,"sidebarTitle":"Webhooks profiles get","openapi":"/openapi/webhooks-20231219.json get /notifications/webhooks/{webhookProfileId}","href":"/api-reference/webhooks/2023-12-19/profile/webhooks-profiles-get"},{"title":"Update an existing webhook profile","deprecated":null,"version":null,"sidebarTitle":"Webhooks profiles update","openapi":"/openapi/webhooks-20231219.json patch /notifications/webhooks/{webhookProfileId}","href":"/api-reference/webhooks/2023-12-19/profile/webhooks-profiles-update"},{"title":"Test an existing webhook profile","deprecated":null,"version":null,"sidebarTitle":"Webhooks profiles test","openapi":"/openapi/webhooks-20231219.json post /notifications/webhooks/{webhookProfileId}/test","href":"/api-reference/webhooks/2023-12-19/profile/webhooks-profiles-test"}]}]},{"group":"Beta","pages":[{"group":"Activity Log","pages":[{"title":"Search activity log","deprecated":null,"version":null,"sidebarTitle":"Activity log search","openapi":"/openapi/beta-20231219.json get /activity-log","href":"/api-reference/beta/2023-12-19/activity-log/activity-log-search"},{"title":"Gets details for activities","deprecated":null,"version":null,"sidebarTitle":"Activity log details get","openapi":"/openapi/beta-20231219.json get /activity-log/details","href":"/api-reference/beta/2023-12-19/activity-log/activity-log-details-get"}]}]}]}]}]},"title":"Initiate customer KYC - Meld","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}