{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Onboard Business Documentation","colors":{"primary":"#5E1FEC","light":"#C6FF00","dark":"#530080"},"logo":{"light":"https://mintcdn.com/onboard-business-api/HDH9a6Pjug4DJUP-/logo/new-logo.svg?fit=max\u0026auto=format\u0026n=HDH9a6Pjug4DJUP-\u0026q=85\u0026s=d1c85d5b9605abcc9058bc7186e16415","dark":"https://mintcdn.com/onboard-business-api/HDH9a6Pjug4DJUP-/logo/new-logo.svg?fit=max\u0026auto=format\u0026n=HDH9a6Pjug4DJUP-\u0026q=85\u0026s=d1c85d5b9605abcc9058bc7186e16415"},"favicon":"https://mintcdn.com/onboard-business-api/XHh0yXLsmlnfh---/favicon.svg?fit=max\u0026auto=format\u0026n=XHh0yXLsmlnfh---\u0026q=85\u0026s=e73884ea99f298b23bc799ea6aac802c","api":{"openapi":"api-reference/openapi.yml"},"footer":{"socials":{"x":"https://x.com/OnboardGlobal","github":"https://github.com/OnboardGlobal"}},"seo":{"metatags":{"og:site_name":"Onboard Business","og:title":"Build cross-border payments with the Onboard API","og:description":"One API for stablecoin wallets, local-currency payouts, and account issuance. Documentation for fintechs and payment platforms moving money globally.","og:image":"/images/og-default.png","og:type":"website","twitter:card":"summary_large_image","twitter:site":"@OnboardGlobal","twitter:image":"/images/og-default.png"},"indexing":"all"},"contextual":{"options":["copy"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"onboard-business-api","hasAudioNarration":false,"actualSubdomain":"onboard-business-api","customDomains":["docs.onboard.xyz"],"gitSource":{"type":"github","owner":"nestcoinco","repo":"onboard-business-api-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae4b12e21d44d6b52dd3d17","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":53},{"language":"default","tag":"Guides","count":36},{"language":"default","tag":"Product Features","count":24},{"language":"default","tag":"Virtual Account","count":12},{"language":"default","tag":"Cash Payouts","count":10},{"language":"default","tag":"Cash Deposits","count":9},{"language":"default","tag":"Offramp Accounts","count":9},{"language":"default","tag":"Transaction Activities","count":7},{"language":"default","tag":"Use Cases","count":6},{"language":"default","tag":"Stablecoin Transactions","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoints/info/get-api-info","slug":"/api-reference/endpoints/info/get-api-info","pageMetadata":{"title":"Get API Info","openapi":"GET /exchange/api/info","description":null,"href":"/api-reference/endpoints/info/get-api-info"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components};return _jsx(_components.p,{children:`Returns general information about the API, including current status and version.`})}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 API Info","openapi":"GET /exchange/api/info","description":null,"href":"/api-reference/endpoints/info/get-api-info"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["exchange-external-api"],"summary":"Get CEX Profile","operationId":"queryMyBusinessInfo","responses":{"200":"419aafc6-a8c2-408e-b4d3-0457adf099f0","400":"97926c95-e775-46bc-b12b-b1ef296af6ea","401":"cc85a842-9e31-45e6-b855-0eedf0386e98","500":"3af41861-4ce5-46c1-b3d6-fb4b391d8cd2"},"security":["35292e4f-67c7-41d6-bdc4-75c76b42d727"],"x-visibility":"external","method":"get","type":"path","servers":["f9ce9404-c09f-4cea-8fce-90e53805086c","dfd174e2-6344-4d18-8dc6-fdc59893e057"],"path":"/exchange/api/info","baseUrlOptions":["https://business-api.onboard.xyz","https://external.dev.onboardpay.co"],"title":"Get CEX Profile","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"419aafc6-a8c2-408e-b4d3-0457adf099f0":{"description":"Success","content":{"application/json":{"schema":{"required":["businessCategory","businessEmail","businessFormationDate","businessId","businessIndustry","businessLocation","businessName","businessRegCountry","businessRegNo","createdAt","legalEntityType","monthlyTransactionVolume","operatesInRestrictedRegions","taxCountry","taxIdentificationNumber","transactsOnBehalfOfThirdParties","updatedAt"],"type":"object","properties":{"businessId":{"type":"string","format":"uuid","example":"3a5aaea8-504a-4404-ad3d-b82574fba5e5","description":"General format for UUID","isRequired":true,"uniqueKey":"businessId","typeLabel":"string\u003cuuid>"},"businessName":{"type":"string","description":"Registered name of business entity","example":"Onabord exchange","isRequired":true,"uniqueKey":"businessName","typeLabel":"string"},"businessEmail":{"type":"string","format":"email","description":"Business profile email address","isRequired":true,"uniqueKey":"businessEmail","typeLabel":"string\u003cemail>"},"businessLocation":{"type":"string","description":"business full location address","isRequired":true,"uniqueKey":"businessLocation","typeLabel":"string"},"businessRegNo":{"type":"string","description":"Business registration number (if any)","isRequired":true,"uniqueKey":"businessRegNo","typeLabel":"string"},"businessRegCountry":{"type":"string","description":"Business country of registration (if any)","isRequired":true,"uniqueKey":"businessRegCountry","typeLabel":"string"},"businessFormationDate":{"type":"string","description":"Date the business entity was formed","format":"date","isRequired":true,"uniqueKey":"businessFormationDate","typeLabel":"string\u003cdate>"},"businessIndustry":{"type":"string","description":"Sector the business primarily operates in","enum":["TECHNOLOGY_SOFTWARE","FINANCIAL_SERVICES","ECOMMERCE","MARKETING_ADVERTISING","CONSULTING_PROFESSIONAL_SERVICES","EDUCATION","HEALTHCARE","MANUFACTURING","LOGISTICS_SUPPLY_CHAIN","REAL_ESTATE","CRYPTO_WEB3","GAMING","MEDIA_ENTERTAINMENT","OTHER"],"x-source-svc":"exchange","isRequired":true,"uniqueKey":"businessIndustry","typeLabel":"enum\u003cstring>"},"taxCountry":{"type":"string","description":"Tax residency country, Valid alpha2 country code","minLength":2,"maxLength":2,"isRequired":true,"uniqueKey":"taxCountry","typeLabel":"string"},"taxIdentificationNumber":{"type":"string","description":"Business tax identification number (TIN)","isRequired":true,"uniqueKey":"taxIdentificationNumber","typeLabel":"string"},"legalEntityType":{"type":"string","description":"Legal structure of the business entity (KYB \"Business type (Entity)\")","enum":["LIMITED_LIABILITY_COMPANY","PUBLIC_COMPANY","SOLE_PROPRIETORSHIP","PARTNERSHIP","CORPORATION","TRUST","PRIVATE_FOUNDATION","CHARITY","NON_PROFIT_ORGANIZATION","PUBLIC_AGENCY"],"x-source-svc":"exchange","isRequired":true,"uniqueKey":"legalEntityType","typeLabel":"enum\u003cstring>"},"businessCategory":{"type":"string","description":"KYB onboarding tier that determines the required document set","enum":["GENERAL_BUSINESS","OTC_FX_LIQUIDITY_PROVIDER","LICENSED_FINANCIAL_SERVICES"],"x-source-svc":"exchange","isRequired":true,"uniqueKey":"businessCategory","typeLabel":"enum\u003cstring>"},"monthlyTransactionVolume":{"type":"string","description":"Current monthly transaction volume bucket in USD","isRequired":true,"uniqueKey":"monthlyTransactionVolume","typeLabel":"string"},"transactsOnBehalfOfThirdParties":{"type":"boolean","description":"Whether the business transacts on behalf of other parties","isRequired":true,"uniqueKey":"transactsOnBehalfOfThirdParties","typeLabel":"boolean"},"operatesInRestrictedRegions":{"type":"boolean","description":"Whether the business operates in or serves customers from restricted regions","isRequired":true,"uniqueKey":"operatesInRestrictedRegions","typeLabel":"boolean"},"createdAt":{"type":"string","format":"date-time","description":"Timestamp field.","x-faker":"date.recent","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","description":"Timestamp field.","x-faker":"date.recent","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"productName":{"type":"string","description":"Product name","uniqueKey":"productName","typeLabel":"string"},"productWebsiteUrl":{"type":"string","description":"HTTP link to the product / business website","format":"url","uniqueKey":"productWebsiteUrl","typeLabel":"string\u003curl>"},"productDescription":{"type":"string","description":"Description of product","uniqueKey":"productDescription","typeLabel":"string"},"businessPhoneNumber":{"pattern":"\\+[1-9][0-9]{0,3}[0-9]{7,14}","type":"string","description":"Phone number field.","uniqueKey":"businessPhoneNumber","typeLabel":"string"},"businessLogoUrl":{"type":"string","description":"HTTP link to business image logo","format":"url","uniqueKey":"businessLogoUrl","typeLabel":"string\u003curl>"},"businessType":{"type":"string","uniqueKey":"businessType","typeLabel":"string"},"enabledProducts":{"type":"array","items":{"type":"string","uniqueKey":"enabledProducts.items.[INDEX]","typeLabel":"string"},"uniqueKey":"enabledProducts","typeLabel":"string[]"},"operatingAddress":{"type":"string","description":"Operating address, when different from the registered address","uniqueKey":"operatingAddress","typeLabel":"string"},"restrictedRegions":{"type":"string","description":"Free-text list of restricted regions, when applicable","uniqueKey":"restrictedRegions","typeLabel":"string"},"ultimateBeneficialOwners":{"type":"array","items":{"type":"object","description":"An individual owning 25% or more of the business","required":["fullName","email","ownershipPercentage"],"properties":{"fullName":{"type":"string","isRequired":true,"uniqueKey":"ultimateBeneficialOwners.items.[INDEX].fullName","typeLabel":"string"},"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"ultimateBeneficialOwners.items.[INDEX].email","typeLabel":"string\u003cemail>"},"ownershipPercentage":{"type":"number","isRequired":true,"uniqueKey":"ultimateBeneficialOwners.items.[INDEX].ownershipPercentage","typeLabel":"number"}},"x-source-svc":"exchange","uniqueKey":"ultimateBeneficialOwners.items.[INDEX]","typeLabel":"object"},"uniqueKey":"ultimateBeneficialOwners","typeLabel":"object[]"},"directors":{"type":"array","items":{"type":"object","description":"A current director of the business","required":["fullName","email"],"properties":{"fullName":{"type":"string","isRequired":true,"uniqueKey":"directors.items.[INDEX].fullName","typeLabel":"string"},"email":{"type":"string","format":"email","isRequired":true,"uniqueKey":"directors.items.[INDEX].email","typeLabel":"string\u003cemail>"}},"x-source-svc":"exchange","uniqueKey":"directors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"directors","typeLabel":"object[]"},"authorisedSignatories":{"type":"array","description":"BVNs of authorised signatories (Nigerian-registered entities)","items":{"type":"string","uniqueKey":"authorisedSignatories.items.[INDEX]","typeLabel":"string"},"uniqueKey":"authorisedSignatories","typeLabel":"string[]"},"documents":{"type":"array","items":{"type":"object","description":"An uploaded KYB document","required":["label","uploadId"],"properties":{"label":{"type":"string","description":"Human-readable document name, e.g. Certificate of Incorporation","isRequired":true,"uniqueKey":"documents.items.[INDEX].label","typeLabel":"string"},"uploadId":{"type":"string","description":"Identifier of the stored upload","isRequired":true,"uniqueKey":"documents.items.[INDEX].uploadId","typeLabel":"string"},"url":{"type":"string","description":"Direct URL to the stored file","format":"url","uniqueKey":"documents.items.[INDEX].url","typeLabel":"string\u003curl>"}},"x-source-svc":"exchange","uniqueKey":"documents.items.[INDEX]","typeLabel":"object"},"uniqueKey":"documents","typeLabel":"object[]"},"declarationAcceptedAt":{"type":"string","format":"date-time","description":"Timestamp field.","x-faker":"date.recent","uniqueKey":"declarationAcceptedAt","typeLabel":"string\u003cdate-time>"}},"description":"CEX user profile object","x-source-svc":"exchange","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"businessId":"3a5aaea8-504a-4404-ad3d-b82574fba5e5","businessName":"Onabord exchange","businessEmail":"jsmith@example.com","businessLocation":"\u003cstring>","businessRegNo":"\u003cstring>","businessRegCountry":"\u003cstring>","businessFormationDate":"2023-12-25","businessIndustry":"TECHNOLOGY_SOFTWARE","taxCountry":"\u003cstring>","taxIdentificationNumber":"\u003cstring>","legalEntityType":"LIMITED_LIABILITY_COMPANY","businessCategory":"GENERAL_BUSINESS","monthlyTransactionVolume":"\u003cstring>","transactsOnBehalfOfThirdParties":true,"operatesInRestrictedRegions":true,"createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","productName":"\u003cstring>","productWebsiteUrl":"\u003cstring>","productDescription":"\u003cstring>","businessPhoneNumber":"\u003cstring>","businessLogoUrl":"\u003cstring>","businessType":"\u003cstring>","enabledProducts":["\u003cstring>"],"operatingAddress":"\u003cstring>","restrictedRegions":"\u003cstring>","ultimateBeneficialOwners":[{"fullName":"\u003cstring>","email":"jsmith@example.com","ownershipPercentage":123}],"directors":[{"fullName":"\u003cstring>","email":"jsmith@example.com"}],"authorisedSignatories":["\u003cstring>"],"documents":[{"label":"\u003cstring>","uploadId":"\u003cstring>","url":"\u003cstring>"}],"declarationAcceptedAt":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"97926c95-e775-46bc-b12b-b1ef296af6ea":{"description":"Bad request","content":{"application/json":{"schema":{"description":"Default error object for services. This gives consistent error object that all services may use.","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code","example":"UNKNOWN_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Descriptive error message","example":"Request could not be completed due to an error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","description":"Additional data for this error message.","additionalProperties":true,"properties":{},"uniqueKey":"data","typeLabel":"object"}},"x-common-model":"ErrorMessageDto","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"UNKNOWN_ERROR","message":"Request could not be completed due to an error","data":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"cc85a842-9e31-45e6-b855-0eedf0386e98":{"description":"Unauthorized request","content":{"application/json":{"schema":{"description":"Default error object for services. This gives consistent error object that all services may use.","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code","example":"UNKNOWN_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Descriptive error message","example":"Request could not be completed due to an error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","description":"Additional data for this error message.","additionalProperties":true,"properties":{},"uniqueKey":"data","typeLabel":"object"}},"x-common-model":"ErrorMessageDto","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"UNKNOWN_ERROR","message":"Request could not be completed due to an error","data":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"3af41861-4ce5-46c1-b3d6-fb4b391d8cd2":{"description":"Server error","content":{"application/json":{"schema":{"description":"Default error object for services. This gives consistent error object that all services may use.","type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Error code","example":"UNKNOWN_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Descriptive error message","example":"Request could not be completed due to an error","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","description":"Additional data for this error message.","additionalProperties":true,"properties":{},"uniqueKey":"data","typeLabel":"object"}},"x-common-model":"ErrorMessageDto","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"UNKNOWN_ERROR","message":"Request could not be completed due to an error","data":{}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"35292e4f-67c7-41d6-bdc4-75c76b42d727":{"HMACAuth":{"type":"apiKey","name":"x-api-key","in":"header","description":"Requires authentication via API key and HMAC signature.\n * `x-api-key`: Your API key generated from your Onboard Business dashboard.\n * `x-timestamp`: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 seconds\n * `x-signature`: SHA256 HMAC HEX signature calculated over `t={x-timestamp}\u0026{requestBody}` using your API Secret.","scopes":[],"schemeName":"HMACAuth"}}},"servers":{"f9ce9404-c09f-4cea-8fce-90e53805086c":{"url":"https://business-api.onboard.xyz","description":"Production gateway."},"dfd174e2-6344-4d18-8dc6-fdc59893e057":{"url":"https://external.dev.onboardpay.co","description":"Sandbox gateway — use for integration and testing."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","name":"x-api-key","in":"header","description":"Requires authentication via API key and HMAC signature.\n * `x-api-key`: Your API key generated from your Onboard Business dashboard.\n * `x-timestamp`: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 seconds\n * `x-signature`: SHA256 HMAC HEX signature calculated over `t={x-timestamp}\u0026{requestBody}` using your API Secret.","scopes":[],"schemeName":"HMACAuth"},"schema":{"title":"x-api-key","type":"string","description":"Requires authentication via API key and HMAC signature.\n * `x-api-key`: Your API key generated from your Onboard Business dashboard.\n * `x-timestamp`: Unix epoch timestamp (seconds) used in signature, allowed skew is 30 seconds\n * `x-signature`: SHA256 HMAC HEX signature calculated over `t={x-timestamp}\u0026{requestBody}` using your API Secret.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"HMACAuth","name":"x-api-key"}],"title":"HMACAuth"}]},"originalFileLocation":"api-reference/openapi.yml"},"subdomain":"onboard-business-api","siteName":"Onboard Business Documentation","title":"Build cross-border payments with the Onboard API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T15:01:08.483Z","originalFileLocation":"api-reference/endpoints/info/get-api-info.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=\"application-name\" content=\"Onboard Business Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/onboard-business-api/Fp5J2j_fqFPeMrmS/_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/onboard-business-api/Fp5J2j_fqFPeMrmS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/onboard-business-api/Fp5J2j_fqFPeMrmS/_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/onboard-business-api/Fp5J2j_fqFPeMrmS/_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/onboard-business-api/Fp5J2j_fqFPeMrmS/_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/onboard-business-api/Fp5J2j_fqFPeMrmS/_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/onboard-business-api/Fp5J2j_fqFPeMrmS/_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/onboard-business-api/Fp5J2j_fqFPeMrmS/_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/onboard-business-api/Fp5J2j_fqFPeMrmS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Build cross-border payments with the Onboard API\">\u003cmeta data-mint-head property=\"og:description\" content=\"One API for stablecoin wallets, local-currency payouts, and account issuance. Documentation for fintechs and payment platforms moving money globally.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Onboard Business\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.onboard.xyz/api-reference/endpoints/info/get-api-info\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://onboard-business-api.mintlify.site/images/og-default.png\">\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=\"Build cross-border payments with the Onboard API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"One API for stablecoin wallets, local-currency payouts, and account issuance. Documentation for fintechs and payment platforms moving money globally.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://onboard-business-api.mintlify.site/images/og-default.png\">\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/onboard-business-api/Fp5J2j_fqFPeMrmS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Onboard Business Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5E1FEC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.onboard.xyz/api-reference/endpoints/info/get-api-info\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/info/get-api-info.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.onboard.xyz/#organization\",\"name\":\"Onboard Business Documentation\",\"url\":\"https://docs.onboard.xyz\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/onboard-business-api/HDH9a6Pjug4DJUP-/logo/new-logo.svg?fit=max\u0026auto=format\u0026n=HDH9a6Pjug4DJUP-\u0026q=85\u0026s=d1c85d5b9605abcc9058bc7186e16415\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.onboard.xyz#website\",\"name\":\"Onboard Business Documentation\",\"url\":\"https://docs.onboard.xyz\",\"publisher\":{\"@id\":\"https://docs.onboard.xyz/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/info/get-api-info#webpage\",\"url\":\"https://docs.onboard.xyz/api-reference/endpoints/info/get-api-info\",\"name\":\"Get API Info\",\"dateModified\":\"2026-10-30T15:01:08.483Z\",\"isPartOf\":{\"@id\":\"https://docs.onboard.xyz#website\"},\"breadcrumb\":{\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/info/get-api-info#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/info/get-api-info#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Onboard Business Documentation\",\"item\":\"https://docs.onboard.xyz\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get API Info\",\"item\":\"https://docs.onboard.xyz/api-reference/endpoints/info/get-api-info\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/info/get-api-info#apireference\",\"headline\":\"Get API Info\",\"name\":\"Get API Info\",\"url\":\"https://docs.onboard.xyz/api-reference/endpoints/info/get-api-info\",\"mainEntityOfPage\":{\"@id\":\"https://docs.onboard.xyz/api-reference/endpoints/info/get-api-info#webpage\"},\"image\":\"https://docs.onboard.xyz/images/og-default.png\",\"dateModified\":\"2026-10-30T15:01:08.483Z\",\"publisher\":{\"@id\":\"https://docs.onboard.xyz/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.onboard.xyz#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Onboard Business Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Onboard Business Documentation","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/getting-started/overview"}]},{"tab":"API Reference","groups":[{"group":"Authentication","pages":[{"title":"Base URLs","href":"/api-reference/base-urls"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Webhook Verification","description":null,"href":"/api-reference/webhook-verification"}]},{"group":"Info","pages":[{"title":"Get API Info","openapi":"GET /exchange/api/info","href":"/api-reference/endpoints/info/get-api-info"},{"title":"Get Currency Assets","openapi":"GET /ledger/currency/assets","description":"This operation allows the client to get the Nestcoin supported\nAssets\n","href":"/api-reference/endpoints/info/get-currency-assets"},{"title":"Get Network Tokens","openapi":"GET /ledger/assets/{assetCode}/network-tokens","href":"/api-reference/endpoints/info/get-network-tokens"}]},{"group":"Virtual Account","pages":[{"title":"List Accounts","openapi":"GET /ledger/accounts","href":"/api-reference/endpoints/virtual-account/get-accounts"},{"title":"Get Account by ID","openapi":"GET /ledger/accounts/{accountId}","href":"/api-reference/endpoints/virtual-account/get-account-by-id"},{"title":"List Sub-accounts","openapi":"GET /ledger/subaccounts","href":"/api-reference/endpoints/virtual-account/get-subaccounts"},{"title":"Create Sub-account","openapi":"POST /ledger/subaccounts","href":"/api-reference/endpoints/virtual-account/create-subaccount"},{"title":"Get Sub-account by Reference","openapi":"GET /ledger/subaccounts/{subAccountIdRef}","href":"/api-reference/endpoints/virtual-account/get-subaccount-by-ref"},{"title":"Update Sub-account","openapi":"PUT /ledger/subaccounts/{subAccountIdRef}","href":"/api-reference/endpoints/virtual-account/update-subaccount"},{"title":"Delete Sub-account","openapi":"DELETE /ledger/subaccounts/{subAccountIdRef}","href":"/api-reference/endpoints/virtual-account/delete-subaccount"}]},{"group":"Virtual Account Number","pages":[{"title":"Get Account Number Details","openapi":"GET /ledger/accounts/{accountId}/account-details","href":"/api-reference/endpoints/virtual-account-number/get-account-details"},{"title":"Generate Account Number","openapi":"POST /ledger/accounts/{accountId}/account-details","href":"/api-reference/endpoints/virtual-account-number/create-account-details"},{"title":"Get Sub-account Number Details","openapi":"GET /ledger/subaccounts/{subAccountIdRef}/account-details","href":"/api-reference/endpoints/virtual-account-number/get-subaccount-details"},{"title":"Generate Sub-account Number","openapi":"POST /ledger/subaccounts/{subAccountIdRef}/account-details","href":"/api-reference/endpoints/virtual-account-number/create-subaccount-details"}]},{"group":"Stablecoin Deposits \u0026 Withdrawal","pages":[{"title":"Get Offramp Account Funding Address","openapi":"GET /ledger/offramp-accounts/{id}/funding-address","href":"/api-reference/endpoints/offramp-accounts/get-funding-address"},{"title":"Get Sub-account Funding Address","openapi":"GET /ledger/subaccounts/{subAccountIdRef}/funding-address","href":"/api-reference/endpoints/stablecoin/get-subaccount-funding-address"},{"title":"Generate Sub-account Funding Address","openapi":"POST /ledger/subaccounts/{subAccountIdRef}/funding-address","href":"/api-reference/endpoints/stablecoin/create-subaccount-funding-address"},{"title":"Initiate Crypto Transfer","openapi":"POST /ledger/crypto-transfer","href":"/api-reference/endpoints/stablecoin/create-crypto-transfer"},{"title":"Get Crypto Transfer","openapi":"GET /ledger/crypto-transfer/{transferReference}","href":"/api-reference/endpoints/stablecoin/get-crypto-transfer"}]},{"group":"Crypto Beneficiaries","pages":[{"title":"List Crypto Beneficiaries","openapi":"GET /ledger/crypto-beneficiaries","href":"/api-reference/endpoints/crypto-beneficiaries/list"},{"title":"Create Crypto Beneficiary","openapi":"POST /ledger/crypto-beneficiaries","href":"/api-reference/endpoints/crypto-beneficiaries/create"},{"title":"Get Crypto Beneficiary","openapi":"GET /ledger/crypto-beneficiaries/{beneficiaryId}","href":"/api-reference/endpoints/crypto-beneficiaries/get-by-id"},{"title":"Delete Crypto Beneficiary","openapi":"DELETE /ledger/crypto-beneficiaries/{beneficiaryId}","href":"/api-reference/endpoints/crypto-beneficiaries/delete"}]},{"group":"Fiat Beneficiaries","pages":[{"title":"List Fiat Beneficiaries","openapi":"GET /ledger/fiat-beneficiaries","href":"/api-reference/endpoints/fiat-beneficiaries/list"},{"title":"Create Fiat Beneficiary","openapi":"POST /ledger/fiat-beneficiaries","href":"/api-reference/endpoints/fiat-beneficiaries/create"},{"title":"Get Fiat Beneficiary","openapi":"GET /ledger/fiat-beneficiaries/{beneficiaryId}","href":"/api-reference/endpoints/fiat-beneficiaries/get-by-id"},{"title":"Delete Fiat Beneficiary","openapi":"DELETE /ledger/fiat-beneficiaries/{beneficiaryId}","href":"/api-reference/endpoints/fiat-beneficiaries/delete"}]},{"group":"Cash Deposits","pages":[{"title":"Get Cash Deposit Currencies","openapi":"GET /ledger/cash-deposits/currencies","href":"/api-reference/endpoints/cash-deposits/get-currencies"},{"title":"Get Cash Deposit Rates","openapi":"GET /ledger/cash-deposits/rates","href":"/api-reference/endpoints/cash-deposits/get-rates"},{"title":"Create Cash Deposit Quote","openapi":"POST /ledger/cash-deposits/quotes","href":"/api-reference/endpoints/cash-deposits/create-quote"},{"title":"Create Cash Deposit","openapi":"POST /ledger/cash-deposits","href":"/api-reference/endpoints/cash-deposits/create-deposit"},{"title":"Get Cash Deposit","openapi":"GET /ledger/cash-deposits/{reference}","href":"/api-reference/endpoints/cash-deposits/get-by-reference"},{"title":"List Cash Deposits","openapi":"GET /ledger/cash-deposits","href":"/api-reference/endpoints/cash-deposits/list"}]},{"group":"Cash Payouts","pages":[{"title":"Get Cash Payout Currencies","openapi":"GET /ledger/cash-payments/currencies","href":"/api-reference/endpoints/cash-payouts/get-currencies"},{"title":"Get Cash Payout Rates","openapi":"GET /ledger/cash-payments/rates","href":"/api-reference/endpoints/cash-payouts/get-rates"},{"title":"Create Cash Payout Quote","openapi":"POST /ledger/cash-payments/quotes","href":"/api-reference/endpoints/cash-payouts/create-quote"},{"title":"List Cash Payouts","openapi":"GET /ledger/cash-payments","href":"/api-reference/endpoints/cash-payouts/list"},{"title":"Create Cash Payout","openapi":"POST /ledger/cash-payments","href":"/api-reference/endpoints/cash-payouts/create-payout"},{"title":"Get Cash Payout","openapi":"GET /ledger/cash-payments/{reference}","href":"/api-reference/endpoints/cash-payouts/get-by-reference"}]},{"group":"Offramp Accounts","pages":[{"title":"List Offramp Accounts","openapi":"GET /ledger/offramp-accounts","href":"/api-reference/endpoints/offramp-accounts/list"},{"title":"Create Offramp Account","openapi":"POST /ledger/offramp-accounts","href":"/api-reference/endpoints/offramp-accounts/create"},{"title":"Get Offramp Account","openapi":"GET /ledger/offramp-accounts/{offrampAccountId}","href":"/api-reference/endpoints/offramp-accounts/get-by-id"},{"title":"Delete Offramp Account","openapi":"DELETE /ledger/offramp-accounts/{offrampAccountId}","href":"/api-reference/endpoints/offramp-accounts/delete"},{"title":"Get Offramp Account Funding Address","openapi":"GET /ledger/offramp-accounts/{id}/funding-address","href":"/api-reference/endpoints/offramp-accounts/get-funding-address"},{"title":"Get Offramp Account Transactions","openapi":"GET /ledger/offramp-accounts/{id}/transactions","href":"/api-reference/endpoints/offramp-accounts/get-transactions"}]},{"group":"Transaction Activities","pages":[{"title":"List Account Activities","openapi":"GET /ledger/accounts/{accountId}/activities","href":"/api-reference/endpoints/transaction-activities/account-activities"},{"title":"Get Account Activity","openapi":"GET /ledger/accounts/{accountId}/activities/{activityId}","href":"/api-reference/endpoints/transaction-activities/account-activity-by-id"},{"title":"List Sub-account Activities","openapi":"GET /ledger/subaccounts/{subAccountIdRef}/activities","href":"/api-reference/endpoints/transaction-activities/subaccount-activities"},{"title":"Get Sub-account Activity","openapi":"GET /ledger/subaccounts/{subAccountIdRef}/activities/{activityId}","href":"/api-reference/endpoints/transaction-activities/subaccount-activity-by-id"},{"title":"List All Transaction Activities","openapi":"GET /ledger/transaction-activities","href":"/api-reference/endpoints/transaction-activities/list-all"}]},{"group":"WebHook Events","pages":[{"title":"WebHook Events","href":"/api-reference/webhook-events"}]}]}]},"basePath":"","title":"Build cross-border payments with the Onboard API","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"]}