{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Venly Finance","colors":{"primary":"#e07826","light":"#f0a060","dark":"#c56820"},"logo":{"light":"https://mintcdn.com/venly/NZGy1d4c4LA-0jM9/logo/light_venly_logo.png?fit=max\u0026auto=format\u0026n=NZGy1d4c4LA-0jM9\u0026q=85\u0026s=d808fd8f702829ca93bf607f200800bb","dark":"https://mintcdn.com/venly/NZGy1d4c4LA-0jM9/logo/dark_venly_logo.png?fit=max\u0026auto=format\u0026n=NZGy1d4c4LA-0jM9\u0026q=85\u0026s=3bafc93202007edf53e789ed58bc7002","href":"https://venlyfinance.com"},"favicon":"https://mintcdn.com/venly/MUxny2c1OXcZxLbW/logo/favicon_logo.png?fit=max\u0026auto=format\u0026n=MUxny2c1OXcZxLbW\u0026q=85\u0026s=892dd58ed49fe804011fcf42f60f82d4","api":{"playground":{"display":"interactive"}},"navbar":{"primary":{"type":"button","label":"Venly","href":"https://venlyfinance.com"}},"footer":{"socials":{"x":"https://x.com/Venly_io","linkedin":"https://be.linkedin.com/company/venly-io"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://venlyfinance.com/blog"},{"anchor":"Support","icon":"envelope","href":"https://venlyfinance.com/contact"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"venly","hasAudioNarration":false,"actualSubdomain":"venly","customDomains":["docs.venlyfinance.com"],"gitSource":{"type":"github","owner":"venly","repo":"mintlify-api-docs-main","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad0bd1e4dcba6f2ddf906eb","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Finance API","count":98},{"language":"default","tag":"Fundflow API","count":45},{"language":"default","tag":"Parties","count":13},{"language":"default","tag":"Core Concepts","count":13},{"language":"default","tag":"Ramp Requests","count":12},{"language":"default","tag":"Overview","count":10},{"language":"default","tag":"Webhooks","count":9},{"language":"default","tag":"Onboarding \u0026 Verification","count":9},{"language":"default","tag":"Accounts","count":6},{"language":"default","tag":"Getting Started","count":6}]},"assistantConfig":{},"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":"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/Fundflow-API/company/get-company-details","slug":"/api-reference/Fundflow-API/company/get-company-details","pageMetadata":{"title":"Get company details","description":"Retrieve your company's details and KYB status.","openapi":"api-reference/Fundflow-API.yaml GET /v1/company","href":"/api-reference/Fundflow-API/company/get-company-details"},"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 your company’s details and KYB status.\"\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={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Returns details about the authenticated user’s company, including `,_jsx(_components.code,{children:`kybStatus`}),` and the invoices URL.`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Concept guide:`}),` `,_jsx(_components.a,{href:`/guides/payments/getting-started`,children:`Getting started with Fundflow`})]}),`\n`,_jsxs(Note,{children:[`Your company must have `,_jsx(_components.code,{children:`kybStatus: VERIFIED`}),` before you can create ramp requests.`]})]})}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":"Get company details","description":"Retrieve your company's details and KYB status.","openapi":"api-reference/Fundflow-API.yaml GET /v1/company","href":"/api-reference/Fundflow-API/company/get-company-details"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Company"],"summary":"Get company details","description":"Retrieve your company's details and KYB status.","operationId":"getCompanyDetails","security":["3cdf5403-cdef-4f94-99c4-eaf4112d25c3"],"responses":{"200":"02d8d881-7a1d-49ea-8397-a81488114220","400":"3eec6a15-35a7-4e21-b010-cf27a095485a","401":"9a264bc4-5599-40e7-81d6-c8ba95842bd5","403":"b377b64b-01e5-4378-b22c-011cf74a1d45","404":"fba06eb2-8af7-442b-b9cd-7666a219a4ee","405":"328ae6ec-a20d-4446-97f0-bfebd7f1682f","415":"f018ff4e-4339-4b77-89cc-86e31387529d","500":"578beac2-2457-4ad3-babc-9dad4027d8fd"},"method":"get","type":"path","servers":["d463203b-a1df-4784-bef1-613efa41e537","1644619c-428a-4b27-84dd-626ab5e21547"],"path":"/v1/company","baseUrlOptions":["https://api-fundflow.venly.io","https://api-fundflow-staging.venly.io"],"title":"Get company details","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"responses":{"02d8d881-7a1d-49ea-8397-a81488114220":{"description":"Successfully retrieved company details","content":{"*/*":{"schema":{"type":"object","properties":{"success":{"type":"boolean","default":true,"uniqueKey":"success","typeLabel":"boolean"},"result":{"type":"object","description":"Company details","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"result.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"Legal company name","uniqueKey":"result.name","typeLabel":"string"},"kybStatus":{"type":"string","description":"Know Your Business verification status.\n","enum":["PENDING","VERIFIED","DENIED"],"uniqueKey":"result.kybStatus","typeLabel":"enum\u003cstring>"},"invoicesUrl":{"type":"string","description":"URL to access company invoices","uniqueKey":"result.invoicesUrl","typeLabel":"string"},"sequenceCustomerId":{"type":"string","description":"Customer ID in billing system","uniqueKey":"result.sequenceCustomerId","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"result.createdAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"result","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"result":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","kybStatus":"PENDING","invoicesUrl":"\u003cstring>","sequenceCustomerId":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"3eec6a15-35a7-4e21-b010-cf27a095485a":{"description":"When the request contains invalid input","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","default":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"validation-error","message":"A descriptive error message"}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"validation-error","message":"A descriptive error message"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"9a264bc4-5599-40e7-81d6-c8ba95842bd5":{"description":"When the user is not authorized to access the resource","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","default":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"UNAUTHORIZED","message":"Access is denied."}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"UNAUTHORIZED","message":"Access is denied."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"b377b64b-01e5-4378-b22c-011cf74a1d45":{"description":"When a user doesn't have proper security authority","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","default":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"FORBIDDEN","message":"User doesn't have proper authority to access this resource"}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"FORBIDDEN","message":"User doesn't have proper authority to access this resource"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"fba06eb2-8af7-442b-b9cd-7666a219a4ee":{"description":"When a resource is not found","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","default":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"NOT_FOUND"}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"NOT_FOUND"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"328ae6ec-a20d-4446-97f0-bfebd7f1682f":{"description":"When the HttpMethod is not supported","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","default":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"METHOD_NOT_SUPPORTED","message":"HttpMethod is not supported. Supported methods are [..]"}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"METHOD_NOT_SUPPORTED","message":"HttpMethod is not supported. Supported methods are [..]"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"f018ff4e-4339-4b77-89cc-86e31387529d":{"description":"Usually when the input is not a valid json","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","default":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"INVALID_MEDIA_TYPE"}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"INVALID_MEDIA_TYPE"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"578beac2-2457-4ad3-babc-9dad4027d8fd":{"description":"When there's an unexpected error","content":{"application/json":{"schema":{"type":"object","description":"Error response wrapper","properties":{"success":{"type":"boolean","default":false,"uniqueKey":"success","typeLabel":"boolean"},"errors":{"type":"array","items":{"type":"object","description":"Individual error details","properties":{"code":{"type":"string","description":"Machine-readable error code","uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"},"result":{"oneOf":[{"type":"object","uniqueKey":"result.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"result.oneOf.1","typeLabel":"null"}],"uniqueKey":"result","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"errors":[{"code":"INTERNAL_SERVER_ERROR","message":"A description of the error (optional)"}]},"examples":{"Example":{"title":"Example","value":{"success":false,"errors":[{"code":"INTERNAL_SERVER_ERROR","message":"A description of the error (optional)"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"3cdf5403-cdef-4f94-99c4-eaf4112d25c3":{"OAuth2":{"type":"oauth2","description":"OAuth2 authentication via Venly Identity Platform","flows":{"implicit":{"authorizationUrl":"https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/auth","scopes":{"openid":"OpenID Connect scope","view:ramp-request":"View ramp requests","create:ramp-request":"Create ramp requests","edit:ramp-request":"Edit ramp request amounts","approve:ramp-request":"Approve ramp requests","reject:ramp-request":"Reject ramp requests","cancel:ramp-request":"Cancel ramp requests","sign-off:ramp-request":"Sign off on ramp requests (add transaction hash)","export:ramp-requests":"Export ramp requests","view:company-wallet":"View company wallets","manage:company-wallet":"Create and manage company wallets","view:company-bank-account":"View company bank accounts","manage:company-bank-account":"Create and manage company bank accounts","manage:company-users":"Manage company users"}}},"scopes":[]}}},"servers":{"d463203b-a1df-4784-bef1-613efa41e537":{"url":"https://api-fundflow.venly.io","description":"Production"},"1644619c-428a-4b27-84dd-626ab5e21547":{"url":"https://api-fundflow-staging.venly.io","description":"Staging"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"OAuth2 authentication via Venly Identity Platform","flows":{"implicit":{"authorizationUrl":"https://login-staging.venly.io/auth/realms/VenlyFinance/protocol/openid-connect/auth","scopes":{"openid":"OpenID Connect scope","view:ramp-request":"View ramp requests","create:ramp-request":"Create ramp requests","edit:ramp-request":"Edit ramp request amounts","approve:ramp-request":"Approve ramp requests","reject:ramp-request":"Reject ramp requests","cancel:ramp-request":"Cancel ramp requests","sign-off:ramp-request":"Sign off on ramp requests (add transaction hash)","export:ramp-requests":"Export ramp requests","view:company-wallet":"View company wallets","manage:company-wallet":"Create and manage company wallets","view:company-bank-account":"View company bank accounts","manage:company-bank-account":"Create and manage company bank accounts","manage:company-users":"Manage company users"}}},"scopes":[]},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth2 authentication via Venly Identity Platform","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"OAuth2","name":"Authorization"}],"title":"OAuth2"}]},"originalFileLocation":"api-reference/Fundflow-API.yaml"},"subdomain":"venly","siteName":"Venly Finance","title":"Get company details - Venly Finance","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-15T11:33:09.847Z","originalFileLocation":"api-reference/Fundflow-API/company/get-company-details.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=\"Retrieve your company\u0026#x27;s details and KYB status.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Venly 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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_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/venly/NJHVXnPMqQUaB4Tk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get company details - Venly Finance\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve your company\u0026#x27;s details and KYB status.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Venly Finance\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.venlyfinance.com/api-reference/Fundflow-API/company/get-company-details\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://venly.mintlify.site/_mintlify/api/og/v2?division=Company\u0026amp;title=Get+company+details\u0026amp;description=Retrieve+your+company%27s+details+and+KYB+status.\u0026amp;theme=66844d886c63c9d7741f1e37\u0026amp;signature=0f61ed3e2f79ea127f245ff05947a2a020000ea4d0567f38c93bb4aeb6be5872\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get company details - Venly Finance\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve your company\u0026#x27;s details and KYB status.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://venly.mintlify.site/_mintlify/api/og/v2?division=Company\u0026amp;title=Get+company+details\u0026amp;description=Retrieve+your+company%27s+details+and+KYB+status.\u0026amp;theme=66844d886c63c9d7741f1e37\u0026amp;signature=0f61ed3e2f79ea127f245ff05947a2a020000ea4d0567f38c93bb4aeb6be5872\">\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/venly/NJHVXnPMqQUaB4Tk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Venly Finance\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#e07826\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.venlyfinance.com/api-reference/Fundflow-API/company/get-company-details\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/Fundflow-API/company/get-company-details.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.venlyfinance.com/#organization\",\"name\":\"Venly Finance\",\"url\":\"https://docs.venlyfinance.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/venly/NZGy1d4c4LA-0jM9/logo/light_venly_logo.png?fit=max\u0026auto=format\u0026n=NZGy1d4c4LA-0jM9\u0026q=85\u0026s=d808fd8f702829ca93bf607f200800bb\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.venlyfinance.com#website\",\"name\":\"Venly Finance\",\"url\":\"https://docs.venlyfinance.com\",\"publisher\":{\"@id\":\"https://docs.venlyfinance.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.venlyfinance.com/api-reference/Fundflow-API/company/get-company-details#webpage\",\"url\":\"https://docs.venlyfinance.com/api-reference/Fundflow-API/company/get-company-details\",\"name\":\"Get company details\",\"description\":\"Retrieve your company's details and KYB status.\",\"dateModified\":\"2026-06-15T11:33:09.847Z\",\"isPartOf\":{\"@id\":\"https://docs.venlyfinance.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.venlyfinance.com/api-reference/Fundflow-API/company/get-company-details#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.venlyfinance.com/api-reference/Fundflow-API/company/get-company-details#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Venly Finance\",\"item\":\"https://docs.venlyfinance.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get company details\",\"item\":\"https://docs.venlyfinance.com/api-reference/Fundflow-API/company/get-company-details\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.venlyfinance.com/api-reference/Fundflow-API/company/get-company-details#apireference\",\"headline\":\"Get company details\",\"name\":\"Get company details\",\"description\":\"Retrieve your company's details and KYB status.\",\"url\":\"https://docs.venlyfinance.com/api-reference/Fundflow-API/company/get-company-details\",\"mainEntityOfPage\":{\"@id\":\"https://docs.venlyfinance.com/api-reference/Fundflow-API/company/get-company-details#webpage\"},\"dateModified\":\"2026-06-15T11:33:09.847Z\",\"publisher\":{\"@id\":\"https://docs.venlyfinance.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.venlyfinance.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Venly Finance\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Venly Finance","nav":{"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://venlyfinance.com/blog"},{"anchor":"Support","icon":"envelope","href":"https://venlyfinance.com/contact"}]},"tabs":[{"tab":"Getting Started","pages":[{"title":"Getting Started","href":""}]},{"tab":"Fundflow API","groups":[{"group":"Overview","pages":[{"title":"Getting Started with Fundflow","icon":"rocket","href":"/guides/payments/getting-started"},{"title":"API Authentication","sidebarTitle":"Authentication","icon":"key","href":"/guides/payments/authentication"},{"title":"Dashboard","icon":"gauge","href":"/guides/payments/dashboard"},{"title":"Quick Reference Guide","icon":"bolt","href":"/guides/payments/quick-reference"}]},{"group":"Core Guides","pages":[{"title":"Account Management","icon":"building-columns","href":"/guides/payments/accounts"},{"title":"Transactions","icon":"arrow-right-arrow-left","href":"/guides/payments/transactions"},{"title":"Fee Structure","icon":"percent","href":"/guides/payments/fees"}]},{"group":"Ramp Requests","pages":[{"title":"List all ramp requests","openapi":"api-reference/Fundflow-API.yaml GET /v1/ramp-requests","href":"/api-reference/Fundflow-API/ramp-requests/list-all-ramp-requests"},{"title":"Create a ramp request","openapi":"api-reference/Fundflow-API.yaml POST /v1/ramp-requests","href":"/api-reference/Fundflow-API/ramp-requests/create-a-new-ramp-request"},{"title":"Get ramp request by ID","openapi":"api-reference/Fundflow-API.yaml GET /v1/ramp-requests/{id}","href":"/api-reference/Fundflow-API/ramp-requests/get-ramp-request-by-id"},{"title":"Approve a ramp request","openapi":"api-reference/Fundflow-API.yaml POST /v1/ramp-requests/{id}/approve","href":"/api-reference/Fundflow-API/ramp-requests/approve-a-ramp-request"},{"title":"Reject a ramp request","openapi":"api-reference/Fundflow-API.yaml POST /v1/ramp-requests/{id}/reject","href":"/api-reference/Fundflow-API/ramp-requests/reject-a-ramp-request"},{"title":"Cancel a ramp request","openapi":"api-reference/Fundflow-API.yaml POST /v1/ramp-requests/{id}/cancel","href":"/api-reference/Fundflow-API/ramp-requests/cancel-a-ramp-request"},{"title":"Edit the amount of a ramp request","openapi":"api-reference/Fundflow-API.yaml PUT /v1/ramp-requests/{id}/amount","href":"/api-reference/Fundflow-API/ramp-requests/edit-the-amount-of-a-ramp-request"},{"title":"Initiate an off-ramp request with transaction hash","openapi":"api-reference/Fundflow-API.yaml PATCH /v1/ramp-requests/{id}/initiate","href":"/api-reference/Fundflow-API/ramp-requests/initiate-a-ramp-request-with-transaction-hash"},{"title":"Update transaction hash","openapi":"api-reference/Fundflow-API.yaml PATCH /v1/ramp-requests/{id}/tx-hash","href":"/api-reference/Fundflow-API/ramp-requests/update-transaction-hash"},{"title":"Get available on-ramp currency pairs","openapi":"api-reference/Fundflow-API.yaml GET /v1/ramp-requests/on-ramp/pairs","href":"/api-reference/Fundflow-API/ramp-requests/get-available-on-ramp-currency-pairs"},{"title":"Get available off-ramp currency pairs","openapi":"api-reference/Fundflow-API.yaml GET /v1/ramp-requests/off-ramp/pairs","href":"/api-reference/Fundflow-API/ramp-requests/get-available-off-ramp-currency-pairs"},{"title":"Export ramp requests","openapi":"api-reference/Fundflow-API.yaml GET /v1/ramp-requests/export","href":"/api-reference/Fundflow-API/ramp-requests/export-ramp-requests"}]},{"group":"Fees","pages":[{"title":"Get company fee configuration","openapi":"api-reference/Fundflow-API.yaml GET /v1/fees","href":"/api-reference/Fundflow-API/fees/get-company-fee-configuration"},{"title":"Calculate fee for a ramp request","description":"Preview the fee for a given ramp amount before creating a request.","openapi":"api-reference/Fundflow-API.yaml POST /v1/fees/calculate","href":"/api-reference/Fundflow-API/fees/calculate-fee-for-a-ramp-request"}]},{"group":"Company","pages":[{"title":"Get company details","openapi":"api-reference/Fundflow-API.yaml GET /v1/company","href":"/api-reference/Fundflow-API/company/get-company-details"}]},{"group":"Company Wallets","pages":[{"title":"List company wallets","description":"Retrieve your company crypto wallets, filterable by status, chain, and address.","openapi":"api-reference/Fundflow-API.yaml GET /v1/company-wallets","href":"/api-reference/Fundflow-API/company-wallets/list-company-wallets"},{"title":"Whitelist a company wallet","openapi":"api-reference/Fundflow-API.yaml POST /v1/company-wallets","href":"/api-reference/Fundflow-API/company-wallets/create-a-company-wallet"},{"title":"Get company wallet by ID","openapi":"api-reference/Fundflow-API.yaml GET /v1/company-wallets/{id}","href":"/api-reference/Fundflow-API/company-wallets/get-company-wallet-by-id"},{"title":"Update company wallet","openapi":"api-reference/Fundflow-API.yaml PATCH /v1/company-wallets/{id}","href":"/api-reference/Fundflow-API/company-wallets/update-company-wallet"}]},{"group":"Company Bank Accounts","pages":[{"title":"List company bank accounts","openapi":"api-reference/Fundflow-API.yaml GET /v1/company-bank-accounts","href":"/api-reference/Fundflow-API/company-bank-accounts/list-company-bank-accounts"},{"title":"Whitelist a company bank account","openapi":"api-reference/Fundflow-API.yaml POST /v1/company-bank-accounts","href":"/api-reference/Fundflow-API/company-bank-accounts/create-a-company-bank-account"},{"title":"Get company bank account by ID","openapi":"api-reference/Fundflow-API.yaml GET /v1/company-bank-accounts/{id}","href":"/api-reference/Fundflow-API/company-bank-accounts/get-company-bank-account-by-id"},{"title":"Update company bank account","openapi":"api-reference/Fundflow-API.yaml PATCH /v1/company-bank-accounts/{id}","href":"/api-reference/Fundflow-API/company-bank-accounts/update-company-bank-account"}]},{"group":"Bank Account Configuration","pages":[{"title":"Get bank account configuration","openapi":"api-reference/Fundflow-API.yaml GET /v1/bank-accounts/config","href":"/api-reference/Fundflow-API/bank-account-configuration/get-bank-account-configuration"}]},{"group":"Deposit Wallets","pages":[{"title":"Get deposit wallets","openapi":"api-reference/Fundflow-API.yaml GET /v1/deposit-wallets","href":"/api-reference/Fundflow-API/deposit-wallets/list-deposit-wallets"}]},{"group":"Users","pages":[{"title":"List company users","openapi":"api-reference/Fundflow-API.yaml GET /v1/company/users","href":"/api-reference/Fundflow-API/users/list-company-users"},{"title":"Invite a user to the company","openapi":"api-reference/Fundflow-API.yaml POST /v1/company/users/invite","href":"/api-reference/Fundflow-API/users/invite-a-user-to-the-company"},{"title":"Update user role","openapi":"api-reference/Fundflow-API.yaml PUT /v1/company/users/{userId}/role","href":"/api-reference/Fundflow-API/users/update-user-role"},{"title":"Update user status","openapi":"api-reference/Fundflow-API.yaml PATCH /v1/company/users/{userId}/status","href":"/api-reference/Fundflow-API/users/update-user-status"},{"title":"Delete a company user","openapi":"api-reference/Fundflow-API.yaml DELETE /v1/company/users/{userId}","href":"/api-reference/Fundflow-API/users/delete-a-company-user"}]},{"group":"Fiat Currencies","pages":[{"title":"List all fiat currencies","openapi":"api-reference/Fundflow-API.yaml GET /v1/fiat-currencies","href":"/api-reference/Fundflow-API/fiat-currencies/list-all-fiat-currencies"},{"title":"Get fiat currency by ID","openapi":"api-reference/Fundflow-API.yaml GET /v1/fiat-currencies/{id}","href":"/api-reference/Fundflow-API/fiat-currencies/get-fiat-currency-by-id"}]},{"group":"Crypto Currencies","pages":[{"title":"List all crypto currencies","openapi":"api-reference/Fundflow-API.yaml GET /v1/crypto-currencies","href":"/api-reference/Fundflow-API/crypto-currencies/list-all-crypto-currencies"},{"title":"Get crypto currency by ID","openapi":"api-reference/Fundflow-API.yaml GET /v1/crypto-currencies/{id}","href":"/api-reference/Fundflow-API/crypto-currencies/get-crypto-currency-by-id"}]},{"group":"Blockchain Networks","pages":[{"title":"Get supported blockchain networks","openapi":"api-reference/Fundflow-API.yaml GET /v1/chains","href":"/api-reference/Fundflow-API/blockchain-networks/get-supported-blockchain-networks"}]},{"group":"Additional Resources","pages":[{"title":"Security \u0026 Best Practices","icon":"shield-halved","href":"/guides/payments/security"},{"title":"Glossary","icon":"book-open","href":"/guides/payments/glossary"},{"title":"Troubleshooting","icon":"wrench","href":"/guides/payments/troubleshooting"}]}]},{"tab":"Finance API","pages":[{"title":"Finance API","href":"/api-reference/introduction"}]},{"tab":"Upcoming","pages":[{"title":"Upcoming","href":"/guides/card-issuance/introduction"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/guides/finance/changelog"}]}]},"basePath":"","title":"Get company details - Venly Finance","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"]}