While the base URL for all API requests on the production environment is:
To be communicated at a later time
Authentication
The APIs on the staging environment are currently open and do not require an
API key for authentication. However, they are subject to change with prior
notice.
You must include your API key as a header in all requests made on the platform.Headers
x-api-key {{API-KEY}}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Embedded Finance","colors":{"primary":"#725AC1","light":"#9B84DA","dark":"#4B3A91"},"logo":{"light":"https://mintcdn.com/embeddedfinance/hJo0WqC0cP20nSJP/logo/e.svg?fit=max\u0026auto=format\u0026n=hJo0WqC0cP20nSJP\u0026q=85\u0026s=693ffe01cd71be8ed27c48c6a07e28b1","dark":"https://mintcdn.com/embeddedfinance/hJo0WqC0cP20nSJP/logo/e.svg?fit=max\u0026auto=format\u0026n=hJo0WqC0cP20nSJP\u0026q=85\u0026s=693ffe01cd71be8ed27c48c6a07e28b1"},"favicon":"/e.svg","api":{"mdx":{"auth":{},"server":"https://api-dev-embedded.embedly.ng"}},"background":{"color":{"light":"#F7F5FF","dark":"#1B1523"}},"navbar":{"links":[]},"footer":{"socials":{}},"navigation":{"global":{"anchors":[]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"embeddedfinance","hasAudioNarration":false,"actualSubdomain":"embeddedfinance","customDomains":["docs-embeddedfinance.embedly.ng"],"gitSource":{"type":"github","owner":"slowwwburn","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9264f93c0d64dfeafc008:success","clientVersion":"0.0.4248","searchFilterCounts":[{"language":"default","tag":"API Documentation","count":39},{"language":"default","tag":"Business","count":13},{"language":"default","tag":"Virtual Wallets","count":13},{"language":"default","tag":"Transfers","count":8},{"language":"default","tag":"Business virtual wallet","count":6},{"language":"default","tag":"Business Customer","count":5},{"language":"default","tag":"Customer","count":3},{"language":"default","tag":"Getting Started","count":1},{"language":"default","tag":"Webhooks","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/authentication","slug":"/api-reference/authentication","pageMetadata":{"title":"Overview","description":"Overview page to integrating Embedded Finance APIs","href":"/api-reference/authentication"},"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: \"Overview page to integrating Embedded Finance APIs\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading,Info}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Info)_missingMdxReference(`Info`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`To enable you access the full Embedded Finance API services, a staging environment has been created for you.`}),`\n`,_jsx(Heading,{level:`2`,id:`base-url`,children:`Base URL`}),`\n`,_jsx(_components.p,{children:`The base URL for all API requests on the staging environment is:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api-dev-embedded.embedly.ng/embedded/api/v1`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(_components.p,{children:`While the base URL for all API requests on the production environment is:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`To be communicated at a later time`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsx(Heading,{level:`2`,id:`authentication`,children:`Authentication`}),`\n`,_jsx(Info,{children:_jsx(_components.p,{children:`The APIs on the staging environment are currently open and do not require an\nAPI key for authentication. However, they are subject to change with prior\nnotice.`})}),`\n`,_jsx(_components.p,{children:`You must include your API key as a header in all requests made on the platform.`}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Headers`})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`x-api-key {{API-KEY}}`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Overview","description":"Overview page to integrating Embedded Finance APIs","href":"/api-reference/authentication"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Base URL","slug":"base-url","depth":2,"children":[]},{"title":"Authentication","slug":"authentication","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"embeddedfinance","siteName":"Embedded Finance","title":"Overview - Embedded Finance","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T07:04:36.589Z","originalFileLocation":"api-reference/authentication.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Overview page to integrating Embedded Finance APIs\">\u003cmeta data-mint-head name=\"application-name\" content=\"Embedded Finance\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/embeddedfinance/ZsqPYwIu2dNYJ1kb/_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/embeddedfinance/ZsqPYwIu2dNYJ1kb/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/embeddedfinance/ZsqPYwIu2dNYJ1kb/_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/embeddedfinance/ZsqPYwIu2dNYJ1kb/_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/embeddedfinance/ZsqPYwIu2dNYJ1kb/_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/embeddedfinance/ZsqPYwIu2dNYJ1kb/_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/embeddedfinance/ZsqPYwIu2dNYJ1kb/_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/embeddedfinance/ZsqPYwIu2dNYJ1kb/_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/embeddedfinance/ZsqPYwIu2dNYJ1kb/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Overview - Embedded Finance\">\u003cmeta data-mint-head property=\"og:description\" content=\"Overview page to integrating Embedded Finance APIs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Embedded Finance\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs-embeddedfinance.embedly.ng/api-reference/authentication\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://embeddedfinance.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Overview\u0026amp;description=Overview+page+to+integrating+Embedded+Finance+APIs\u0026amp;theme=711160d0bcf53e6ed15f16ef\u0026amp;signature=918fbd1c82254f40c6e7c3ce20329a247882af9f9e656e285c54e4acc8a6ba23\">\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=\"Overview - Embedded Finance\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Overview page to integrating Embedded Finance APIs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://embeddedfinance.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Overview\u0026amp;description=Overview+page+to+integrating+Embedded+Finance+APIs\u0026amp;theme=711160d0bcf53e6ed15f16ef\u0026amp;signature=918fbd1c82254f40c6e7c3ce20329a247882af9f9e656e285c54e4acc8a6ba23\">\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/embeddedfinance/ZsqPYwIu2dNYJ1kb/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Embedded Finance\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#725AC1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs-embeddedfinance.embedly.ng/api-reference/authentication\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/authentication.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs-embeddedfinance.embedly.ng/#organization\",\"name\":\"Embedded Finance\",\"url\":\"https://docs-embeddedfinance.embedly.ng\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/embeddedfinance/hJo0WqC0cP20nSJP/logo/e.svg?fit=max\u0026auto=format\u0026n=hJo0WqC0cP20nSJP\u0026q=85\u0026s=693ffe01cd71be8ed27c48c6a07e28b1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs-embeddedfinance.embedly.ng#website\",\"name\":\"Embedded Finance\",\"url\":\"https://docs-embeddedfinance.embedly.ng\",\"publisher\":{\"@id\":\"https://docs-embeddedfinance.embedly.ng/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs-embeddedfinance.embedly.ng/api-reference/authentication#webpage\",\"url\":\"https://docs-embeddedfinance.embedly.ng/api-reference/authentication\",\"name\":\"Overview\",\"description\":\"Overview page to integrating Embedded Finance APIs\",\"dateModified\":\"2026-01-07T07:04:36.589Z\",\"isPartOf\":{\"@id\":\"https://docs-embeddedfinance.embedly.ng#website\"},\"breadcrumb\":{\"@id\":\"https://docs-embeddedfinance.embedly.ng/api-reference/authentication#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs-embeddedfinance.embedly.ng/api-reference/authentication#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Embedded Finance\",\"item\":\"https://docs-embeddedfinance.embedly.ng\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Overview\",\"item\":\"https://docs-embeddedfinance.embedly.ng/api-reference/authentication\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs-embeddedfinance.embedly.ng/api-reference/authentication#article\",\"headline\":\"Overview\",\"name\":\"Overview\",\"description\":\"Overview page to integrating Embedded Finance APIs\",\"url\":\"https://docs-embeddedfinance.embedly.ng/api-reference/authentication\",\"mainEntityOfPage\":{\"@id\":\"https://docs-embeddedfinance.embedly.ng/api-reference/authentication#webpage\"},\"dateModified\":\"2026-01-07T07:04:36.589Z\",\"publisher\":{\"@id\":\"https://docs-embeddedfinance.embedly.ng/#organization\"},\"isPartOf\":{\"@id\":\"https://docs-embeddedfinance.embedly.ng#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Embedded Finance\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Embedded Finance\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/authentication.md","siteName":"Embedded Finance","nav":{"global":{"anchors":[]},"tabs":[{"tab":"API Documentation","pages":[{"group":"Getting Started","pages":[{"title":"Overview","href":"/api-reference/authentication"}]},{"group":"Customer","pages":[{"title":"Overview","description":"The Customer service provides a comprehensive solution for organizations to efficiently manage their individual customers. This service streamlines individual customer onboarding, customer wallet management, and ensures regulatory compliance through Know Your Customer (KYC) procedures.","href":"/api-reference/customer"},{"title":"Create Customer","api":"POST /embedded/api/v1/create-org-customer","href":"/api-reference/playground/customer/create_customer"},{"title":"Upload Customer File","api":"POST /embedded/api/v1/org/upload-customer-file","href":"/api-reference/playground/customer/upload_customer_file"}]},{"group":"Business","pages":[{"title":"Business Overview","href":"/api-reference/business"},{"title":"Create Business","api":"POST /embedded/api/v1/create-business","href":"/api-reference/playground/business/create_business"},{"title":"Upload Business File","api":"POST /embedded/api/v1/upload-business-file","href":"/api-reference/playground/business/upload_business_file"},{"title":"Verify Director Details","api":"POST /embedded/api/v1/verify-director","href":"/api-reference/playground/business/verify_director"},{"title":"Business Transfer","api":"POST /business/transfer","href":"/api-reference/playground/business/business_transfer"},{"title":"Get A Business","api":"GET /embedded/api/v1/business/{businessId}","href":"/api-reference/playground/business/get_business"},{"title":"Get All Businesses","api":"GET /embedded/api/v1/organizations/{orgId}/businesses","href":"/api-reference/playground/business/get_businesses"},{"title":"Get Fund wallet balance","api":"GET /embedded/api/v1/wallets/org/business/fund-wallet-balance","href":"/api-reference/playground/business/get_fund_wallet_balance"},{"group":"Business Customer","pages":[{"title":"Overview","href":"/api-reference/business_customer"},{"title":"Create Business Customer","api":"POST /embedded/api/v1/create-business-customer","href":"/api-reference/playground/business/customers/create_business_customer"},{"title":"Upload Business Customer File","api":"POST /embedded/api/v1/upload-customer-file","href":"/api-reference/playground/business/customers/upload_customer_file"},{"title":"Get A Business Customer","api":"GET /embedded/api/v1/customer/{customerId}","href":"/api-reference/playground/business/customers/get_business_customer"},{"title":"Get All Business Customers","api":"GET /embedded/api/v1/businesses/{businessId}/customers","href":"/api-reference/playground/business/customers/get_business_customers"}]}]},{"group":"Transfers","pages":[{"title":"Overview","href":"/api-reference/transfer"},{"title":"Account Name Enquiry","api":"POST /embedded/api/v1/account/enquiry","href":"/api-reference/playground/transfers/name_enquiry"},{"title":"Bulk Transfer Name Enquiry","api":"POST /embedded/api/v1/enquiry/bulk","href":"/api-reference/playground/transfers/bulk_transfer_name_enquiry"},{"title":"Organization bulk transfer","api":"Post /embedded/api/v1/org/bulk-transfer","href":"/api-reference/playground/transfers/org_bulk_transfer"},{"title":"Business bulk transfer","api":"Post /embedded/api/v1/business/bulk-transfer","href":"/api-reference/playground/transfers/business_bulk_transfer"},{"title":"Transaction History","api":"Get /embedded/api/v1/org/transactions","href":"/api-reference/playground/transfers/transaction_history"},{"title":"Check Transaction Status","api":"Get /embedded/api/v1/transaction/check-status","href":"/api-reference/playground/transfers/check_transactions_status"},{"title":"Check Bulk Transaction Status","api":"Get /embedded/api/v1/transaction/bulk/check-status","href":"/api-reference/playground/transfers/check_bulk_transaction_status"}]},{"group":"Virtual Wallets","pages":[{"title":null,"href":"/api-reference/wallets"},{"title":"Create org virtual wallets","api":"POST /embedded/api/v1/wallets/org/virtual-wallet?orgId={orgId}","href":"/api-reference/playground/wallets/create_virtual_wallets"},{"title":"freeze a virtual wallets","api":"PATCH /embedded/api/v1/wallets/org/virtual-wallet/freeze","href":"/api-reference/playground/wallets/freeze_a_wallet"},{"title":"Get a virtual wallet","api":"GET /embedded/api/v1/wallets/org/wallets/{id}","href":"/api-reference/playground/wallets/get_a_wallet"},{"title":"Get all virtual Wallets for an Organization","api":"GET /embedded/api/v1/wallets/org/wallets","href":"/api-reference/playground/wallets/get_all_wallets"},{"title":"unfreeze a virtual wallet","api":"PATCH /embedded/api/v1/wallets/org/virtual-wallet/unfreeze","href":"/api-reference/playground/wallets/unfreeze_a_wallet"},{"title":"Get Fund wallet balance","api":"GET /embedded/api/v1/wallets/org/fund-wallet-balance","href":"/api-reference/playground/wallets/get_fund_wallet_balance"},{"group":"Business virtual wallet","pages":[{"title":"Overview","href":"/api-reference/business_virtual_wallets"},{"title":"Create org business virtual wallets","api":"POST /embedded/api/v1/wallets/business/virtual-wallet?orgId={orgId}","href":"/api-reference/playground/wallets/Business_virtual_wallet/create_virtual_wallets"},{"title":"freeze a virtual wallets","api":"PATCH /embedded/api/v1/wallets/org/business/virtual-wallet/freeze","href":"/api-reference/playground/wallets/Business_virtual_wallet/freeze_a_wallet"},{"title":"Get a virtual wallet","api":"GET /embedded/api/v1/wallets/org/wallets/{id}","href":"/api-reference/playground/wallets/Business_virtual_wallet/get_a_wallet"},{"title":"Get all virtual Wallets for an Organization's Business","api":"GET /embedded/api/v1/wallets/org/wallets","href":"/api-reference/playground/wallets/Business_virtual_wallet/get_all_wallets"},{"title":"unfreeze a virtual wallet","api":"PATCH /embedded/api/v1/wallets/org/business/virtual-wallet/unfreeze","href":"/api-reference/playground/wallets/Business_virtual_wallet/unfreeze_a_wallet"}]}]},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/api-reference/webhooks"}]}]}]},"basePath":"","title":"Overview - Embedded Finance","deploymentId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","buildId":"dpl_2pTxFtyBudBMYZiCw1MyvoA1wxpd","dynamics":[],"chunks":[]}