{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Finverse API","colors":{"primary":"#009FFF","light":"#67CFFF","dark":"#004E7D"},"logo":{"light":"https://mintcdn.com/finverse/FcXUy2q84UCP-2qv/images/logo.svg?fit=max\u0026auto=format\u0026n=FcXUy2q84UCP-2qv\u0026q=85\u0026s=9fa78eb1508e7498cbf28f6ec85c2b48","dark":"https://mintcdn.com/finverse/FcXUy2q84UCP-2qv/images/logo.svg?fit=max\u0026auto=format\u0026n=FcXUy2q84UCP-2qv\u0026q=85\u0026s=9fa78eb1508e7498cbf28f6ec85c2b48"},"favicon":"https://mintcdn.com/finverse/ZbjEdqFlouvmTXg3/images/favicon.ico?fit=max\u0026auto=format\u0026n=ZbjEdqFlouvmTXg3\u0026q=85\u0026s=048e3947a09423567d07898d5f4a768c","navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.finverse.com"}},"footer":{"socials":{"github":"https://github.com/finversetech","linkedin":"https://www.linkedin.com/company/finverse"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"finverse","hasAudioNarration":false,"actualSubdomain":"finverse","customDomains":["docs2.finverse.com"],"gitSource":{"type":"github","owner":"finversetech","repo":"public-docs","deployBranch":"master","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae956d5e968ff68fad8ef5b:success","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":74},{"language":"default","tag":"Mandates","count":10},{"language":"default","tag":"Payment links","count":7},{"language":"default","tag":"Link","count":6},{"language":"default","tag":"Payment users","count":6},{"language":"default","tag":"Accounts","count":5},{"language":"default","tag":"Login identity","count":5},{"language":"default","tag":"Payment operations","count":5},{"language":"default","tag":"Customer","count":4},{"language":"default","tag":"Payment accounts","count":3}],"searchSettings":{"showContentSnippets":true}},"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/customer/get-institution","slug":"/api-reference/customer/get-institution","pageMetadata":{"title":"Get institution","description":"Get a specific institution by institutionId","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /institutions/{institutionId}","href":"/api-reference/customer/get-institution","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get a specific institution by institutionId\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get institution","description":"Get a specific institution by institutionId","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /institutions/{institutionId}","href":"/api-reference/customer/get-institution","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"security":["5db8a033-665a-4dfc-9171-7cb205934891"],"description":"Get a specific institution by institutionId","tags":["customer"],"operationId":"getInstitution","parameters":["38d22895-6515-4da5-ba70-b49074cfb9b9"],"responses":{"200":"83563a9a-f2d1-463a-ad1d-3ad9188fea83","400":"1614f7c3-780a-450a-b3c0-8deafdeffdfa","500":"ec8345fe-6810-484d-a6d8-07f33b50ea49"},"summary":"Get institution","method":"get","type":"path","servers":["3f78a58c-f65d-4e0f-a44d-f9cae58dc18d"],"path":"/institutions/{institutionId}","baseUrlOptions":["https://api.prod.finverse.net"],"title":"Get institution","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"38d22895-6515-4da5-ba70-b49074cfb9b9":{"description":"The institution id","name":"institutionId","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"The institution id","uniqueKey":"","typeLabel":"string"}}},"responses":{"83563a9a-f2d1-463a-ad1d-3ad9188fea83":{"description":"Successful","content":{"application/json":{"schema":{"required":["institution_id","countries","institution_type","products_supported","institution_name","user_type","status","login_details"],"properties":{"countries":{"type":"array","items":{"type":"string","uniqueKey":"countries.items.[INDEX]","typeLabel":"string"},"example":["HKG"],"isRequired":true,"uniqueKey":"countries","typeLabel":"string[]"},"institution_id":{"type":"string","example":123,"isRequired":true,"uniqueKey":"institution_id","typeLabel":"string"},"institution_name":{"type":"string","example":"Mock Bank","isRequired":true,"uniqueKey":"institution_name","typeLabel":"string"},"institution_type":{"type":"string","enum":["BANK","WALLET","TEST"],"example":"BANK","isRequired":true,"uniqueKey":"institution_type","typeLabel":"enum\u003cstring>"},"login_details":{"oneOf":[{"x-go-type":{"import":{"package":"gitlab.com/finverse/gitops/applications/api/models/custom"},"type":"LoginDetails"},"isRequired":true}],"isRequired":true,"uniqueKey":"login_details","typeLabel":"any"},"products_supported":{"type":"array","items":{"type":"string","enum":["ACCOUNTS","TRANSACTIONS","STATEMENTS","ACCOUNT_NUMBERS","IDENTITY","AUTO_DEBIT_SETUP"],"uniqueKey":"products_supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["ACCOUNTS","TRANSACTIONS","STATEMENTS","ACCOUNT_NUMBERS","IDENTITY","AUTO_DEBIT_SETUP"],"isRequired":true,"uniqueKey":"products_supported","typeLabel":"enum\u003cstring>[]"},"status":{"type":"string","enum":["SUPPORTED","ALPHA","BETA"],"example":"SUPPORTED","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"user_type":{"type":"array","items":{"type":"string","enum":["PERSONAL","INDIVIDUAL","BUSINESS"],"example":"INDIVIDUAL","uniqueKey":"user_type.items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":true,"uniqueKey":"user_type","typeLabel":"enum\u003cstring>[]"},"color":{"type":"string","example":"#FFFFFF","uniqueKey":"color","typeLabel":"string"},"login_actions":{"type":"array","items":{"properties":{"buttons":{"type":"array","items":{"required":["name","value","type"],"properties":{"name":{"description":"Name identifying the button","type":"string","isRequired":true,"uniqueKey":"login_actions.items.[INDEX].buttons.items.[INDEX].name","typeLabel":"string"},"type":{"description":"Type of button. Possible values: `SUBMIT`","type":"string","example":"SUBMIT","isRequired":true,"uniqueKey":"login_actions.items.[INDEX].buttons.items.[INDEX].type","typeLabel":"string"},"value":{"description":"Button value to be displayed to the user","type":"string","example":"Submit One time password","isRequired":true,"uniqueKey":"login_actions.items.[INDEX].buttons.items.[INDEX].value","typeLabel":"string"}},"type":"object","uniqueKey":"login_actions.items.[INDEX].buttons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"login_actions.items.[INDEX].buttons","typeLabel":"object[]"},"fields":{"type":"array","items":{"required":["name","type"],"properties":{"name":{"description":"Name identifying the field","type":"string","isRequired":true,"uniqueKey":"login_actions.items.[INDEX].fields.items.[INDEX].name","typeLabel":"string"},"type":{"description":"Type of field. Possible values: `INPUT`, `SELECT`","type":"string","example":"SELECT","isRequired":true,"uniqueKey":"login_actions.items.[INDEX].fields.items.[INDEX].type","typeLabel":"string"},"label":{"description":"User-facing label for the field","type":"string","uniqueKey":"login_actions.items.[INDEX].fields.items.[INDEX].label","typeLabel":"string"},"options":{"description":"List of possible options, from which user needs to select one value. Only used for field `type` = `SELECT`","type":"array","items":{"required":["label","value"],"properties":{"label":{"description":"User-facing label for the option","type":"string","example":"joe-iphone-13","isRequired":true,"uniqueKey":"login_actions.items.[INDEX].fields.items.[INDEX].options.items.[INDEX].label","typeLabel":"string"},"value":{"description":"Value for the option","type":"string","example":"Joe's iPhone 13 Pro Max","isRequired":true,"uniqueKey":"login_actions.items.[INDEX].fields.items.[INDEX].options.items.[INDEX].value","typeLabel":"string"}},"type":"object","uniqueKey":"login_actions.items.[INDEX].fields.items.[INDEX].options.items.[INDEX]","typeLabel":"object"},"uniqueKey":"login_actions.items.[INDEX].fields.items.[INDEX].options","typeLabel":"object[]"},"placeholder":{"description":"Initial field value to be displayed to the user","type":"string","uniqueKey":"login_actions.items.[INDEX].fields.items.[INDEX].placeholder","typeLabel":"string"}},"type":"object","uniqueKey":"login_actions.items.[INDEX].fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"login_actions.items.[INDEX].fields","typeLabel":"object[]"},"messages":{"type":"array","items":{"required":["name","type","value"],"properties":{"name":{"description":"The name of the message","type":"string","isRequired":true,"uniqueKey":"login_actions.items.[INDEX].messages.items.[INDEX].name","typeLabel":"string"},"type":{"description":"The type of the message. This will help how the UI renders this text.","type":"string","isRequired":true,"uniqueKey":"login_actions.items.[INDEX].messages.items.[INDEX].type","typeLabel":"string"},"value":{"description":"The actual text value.","type":"string","isRequired":true,"uniqueKey":"login_actions.items.[INDEX].messages.items.[INDEX].value","typeLabel":"string"}},"type":"object","uniqueKey":"login_actions.items.[INDEX].messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"login_actions.items.[INDEX].messages","typeLabel":"object[]"},"name":{"type":"string","example":"MOBILE_OTP","uniqueKey":"login_actions.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","example":"ACTION","uniqueKey":"login_actions.items.[INDEX].type","typeLabel":"string"}},"type":"object","uniqueKey":"login_actions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"login_actions","typeLabel":"object[]"},"login_methods":{"type":"array","items":{"properties":{"id":{"type":"string","example":"SMS OTP","uniqueKey":"login_methods.items.[INDEX].id","typeLabel":"string"},"is_default_method":{"oneOf":[{"type":"boolean","example":true,"uniqueKey":"login_methods.items.[INDEX].is_default_method.oneOf.0","typeLabel":"boolean"},{"type":"null","example":true,"uniqueKey":"login_methods.items.[INDEX].is_default_method.oneOf.1","typeLabel":"null"}],"uniqueKey":"login_methods.items.[INDEX].is_default_method","typeLabel":"boolean | null"},"login_fields":{"type":"array","items":{"properties":{"key":{"type":"string","example":"password","uniqueKey":"login_methods.items.[INDEX].login_fields.items.[INDEX].key","typeLabel":"string"},"name":{"type":"string","example":"Password","uniqueKey":"login_methods.items.[INDEX].login_fields.items.[INDEX].name","typeLabel":"string"},"type":{"description":"could be password, text, number","type":"string","example":"password","uniqueKey":"login_methods.items.[INDEX].login_fields.items.[INDEX].type","typeLabel":"string"}},"type":"object","uniqueKey":"login_methods.items.[INDEX].login_fields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"login_methods.items.[INDEX].login_fields","typeLabel":"object[]"},"name":{"type":"string","example":"SMS OTP","uniqueKey":"login_methods.items.[INDEX].name","typeLabel":"string"},"status":{"type":"string","enum":["SUPPORTED","ALPHA","BETA"],"example":"SUPPORTED","uniqueKey":"login_methods.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"login_methods.items.[INDEX]","typeLabel":"object"},"uniqueKey":"login_methods","typeLabel":"object[]"},"login_url":{"type":"string","example":"https://example.com/login","uniqueKey":"login_url","typeLabel":"string"},"parent_institution_name":{"type":"string","example":"Parent Mock Bank","uniqueKey":"parent_institution_name","typeLabel":"string"},"payment_info":{"required":["payments_supported"],"properties":{"payments_supported":{"type":"array","items":{"type":"string","enum":["MANDATE","DEBIT_AUTHORIZATION"],"uniqueKey":"payment_info.payments_supported.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["MANDATE","DEBIT_AUTHORIZATION"],"isRequired":true,"uniqueKey":"payment_info.payments_supported","typeLabel":"enum\u003cstring>[]"},"currencies_supported":{"type":"array","items":{"type":"string","uniqueKey":"payment_info.currencies_supported.items.[INDEX]","typeLabel":"string"},"example":["HKD","CNY"],"uniqueKey":"payment_info.currencies_supported","typeLabel":"string[]"},"other_info":{"properties":{"bank_code":{"type":"string","uniqueKey":"payment_info.other_info.bank_code","typeLabel":"string"}},"type":"object","uniqueKey":"payment_info.other_info","typeLabel":"object"}},"type":"object","uniqueKey":"payment_info","typeLabel":"object"},"portal_name":{"type":"string","example":"Personal Internet Banking","uniqueKey":"portal_name","typeLabel":"string"},"status_details":{"type":"object","example":{},"uniqueKey":"status_details","typeLabel":"object"},"tags":{"type":"array","items":{"type":"string","enum":["real","test"],"uniqueKey":"tags.items.[INDEX]","typeLabel":"enum\u003cstring>"},"example":["real"],"uniqueKey":"tags","typeLabel":"enum\u003cstring>[]"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"countries":["HKG"],"institution_id":123,"institution_name":"Mock Bank","institution_type":"BANK","login_details":"\u003cunknown>","products_supported":["ACCOUNTS","TRANSACTIONS","STATEMENTS","ACCOUNT_NUMBERS","IDENTITY","AUTO_DEBIT_SETUP"],"status":"SUPPORTED","user_type":["INDIVIDUAL"],"color":"#FFFFFF","login_actions":[{"buttons":[{"name":"\u003cstring>","type":"SUBMIT","value":"Submit One time password"}],"fields":[{"name":"\u003cstring>","type":"SELECT","label":"\u003cstring>","options":[{"label":"joe-iphone-13","value":"Joe's iPhone 13 Pro Max"}],"placeholder":"\u003cstring>"}],"messages":[{"name":"\u003cstring>","type":"\u003cstring>","value":"\u003cstring>"}],"name":"MOBILE_OTP","type":"ACTION"}],"login_methods":[{"id":"SMS OTP","is_default_method":true,"login_fields":[{"key":"password","name":"Password","type":"password"}],"name":"SMS OTP","status":"SUPPORTED"}],"login_url":"https://example.com/login","parent_institution_name":"Parent Mock Bank","payment_info":{"payments_supported":["MANDATE","DEBIT_AUTHORIZATION"],"currencies_supported":["HKD","CNY"],"other_info":{"bank_code":"\u003cstring>"}},"portal_name":"Personal Internet Banking","status_details":{},"tags":["real"],"updated_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"1614f7c3-780a-450a-b3c0-8deafdeffdfa":{"description":"Invalid Request","content":{"application/json":{"schema":{"properties":{"error":{"type":"object","required":["type","code","error_code","message","request_id"],"properties":{"code":{"type":"integer","example":40004,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"error_code":{"type":"string","example":"CREDENTIALS_INVALID","isRequired":true,"uniqueKey":"error.error_code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"description":"The request_id provided in the request header","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"type":{"description":"The error type","type":"string","enum":["LINK_ERROR","API_ERROR"],"example":"LINKING_ERROR","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"details":{"type":"string","uniqueKey":"error.details","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":40004,"error_code":"CREDENTIALS_INVALID","message":"\u003cstring>","request_id":"\u003cstring>","type":"LINKING_ERROR","details":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ec8345fe-6810-484d-a6d8-07f33b50ea49":{"description":"Internal Server Error","content":{"application/json":{"schema":{"properties":{"error":{"type":"object","required":["type","code","error_code","message","request_id"],"properties":{"code":{"type":"integer","example":40004,"isRequired":true,"uniqueKey":"error.code","typeLabel":"integer"},"error_code":{"type":"string","example":"CREDENTIALS_INVALID","isRequired":true,"uniqueKey":"error.error_code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"description":"The request_id provided in the request header","type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"type":{"description":"The error type","type":"string","enum":["LINK_ERROR","API_ERROR"],"example":"LINKING_ERROR","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"details":{"type":"string","uniqueKey":"error.details","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":40004,"error_code":"CREDENTIALS_INVALID","message":"\u003cstring>","request_id":"\u003cstring>","type":"LINKING_ERROR","details":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5db8a033-665a-4dfc-9171-7cb205934891":{"Oauth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://finverse-dev.us.auth0.com/oauth/token","scopes":{"account":"Account","balance":"Balance","credit":"Credit","institution":"Institution","investment":"Investment","link":"Link","test":"Test","transaction":"Transaction"}}},"scopes":["institution"]}}},"servers":{"3f78a58c-f65d-4e0f-a44d-f9cae58dc18d":{"url":"https://api.prod.finverse.net"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://finverse-dev.us.auth0.com/oauth/token","scopes":{"account":"Account","balance":"Balance","credit":"Credit","institution":"Institution","investment":"Investment","link":"Link","test":"Test","transaction":"Transaction"}}},"scopes":["institution"]},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"The access token received from the authorization server in the OAuth 2.0 flow.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Oauth2","name":"Authorization"}],"title":"Oauth2"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"finverse","siteName":"Finverse API","title":"Get institution - Finverse API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-30T09:08:24.760Z","originalFileLocation":"api-reference/customer/get-institution.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=\"Get a specific institution by institutionId\">\u003cmeta data-mint-head name=\"application-name\" content=\"Finverse API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/finverse/ESTMJRewM2q7nXhG/_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/finverse/ESTMJRewM2q7nXhG/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/finverse/ESTMJRewM2q7nXhG/_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/finverse/ESTMJRewM2q7nXhG/_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/finverse/ESTMJRewM2q7nXhG/_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/finverse/ESTMJRewM2q7nXhG/_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/finverse/ESTMJRewM2q7nXhG/_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/finverse/ESTMJRewM2q7nXhG/_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/finverse/ESTMJRewM2q7nXhG/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get institution - Finverse API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a specific institution by institutionId\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Finverse API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs2.finverse.com/api-reference/customer/get-institution\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://finverse.mintlify.site/_mintlify/api/og/v2?division=Customer\u0026amp;title=Get+institution\u0026amp;description=Get+a+specific+institution+by+institutionId\u0026amp;theme=cbf26bae0487384b20dc51fd\u0026amp;signature=cdedfea83302e8a3f908c63855d5930c5f741928a9fab04b9d4a7d81ded708ad\">\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 institution - Finverse API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a specific institution by institutionId\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://finverse.mintlify.site/_mintlify/api/og/v2?division=Customer\u0026amp;title=Get+institution\u0026amp;description=Get+a+specific+institution+by+institutionId\u0026amp;theme=cbf26bae0487384b20dc51fd\u0026amp;signature=cdedfea83302e8a3f908c63855d5930c5f741928a9fab04b9d4a7d81ded708ad\">\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/finverse/ESTMJRewM2q7nXhG/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Finverse API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#009FFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs2.finverse.com/api-reference/customer/get-institution\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/customer/get-institution.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs2.finverse.com/#organization\",\"name\":\"Finverse API\",\"url\":\"https://docs2.finverse.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/finverse/FcXUy2q84UCP-2qv/images/logo.svg?fit=max\u0026auto=format\u0026n=FcXUy2q84UCP-2qv\u0026q=85\u0026s=9fa78eb1508e7498cbf28f6ec85c2b48\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs2.finverse.com#website\",\"name\":\"Finverse API\",\"url\":\"https://docs2.finverse.com\",\"publisher\":{\"@id\":\"https://docs2.finverse.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs2.finverse.com/api-reference/customer/get-institution#webpage\",\"url\":\"https://docs2.finverse.com/api-reference/customer/get-institution\",\"name\":\"Get institution\",\"description\":\"Get a specific institution by institutionId\",\"dateModified\":\"2026-06-30T09:08:24.760Z\",\"isPartOf\":{\"@id\":\"https://docs2.finverse.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs2.finverse.com/api-reference/customer/get-institution#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs2.finverse.com/api-reference/customer/get-institution#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs2.finverse.com/api-reference/accounts/get-account-number\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Customer\",\"item\":\"https://docs2.finverse.com/api-reference/customer/refresh-login_identity_token\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get institution\",\"item\":\"https://docs2.finverse.com/api-reference/customer/get-institution\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs2.finverse.com/api-reference/customer/get-institution#apireference\",\"headline\":\"Get institution\",\"name\":\"Get institution\",\"description\":\"Get a specific institution by institutionId\",\"url\":\"https://docs2.finverse.com/api-reference/customer/get-institution\",\"mainEntityOfPage\":{\"@id\":\"https://docs2.finverse.com/api-reference/customer/get-institution#webpage\"},\"dateModified\":\"2026-06-30T09:08:24.760Z\",\"publisher\":{\"@id\":\"https://docs2.finverse.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs2.finverse.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Finverse API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Finverse API","nav":{"global":null,"groups":[{"group":"API Reference","pages":[{"group":"Accounts","pages":[{"title":"Get account number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /account_numbers/{accountId}","href":"/api-reference/accounts/get-account-number"},{"title":"List accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /accounts","href":"/api-reference/accounts/list-accounts"},{"title":"Get account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /accounts/{accountId}","href":"/api-reference/accounts/get-account"},{"title":"Get balance history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /balance_history/{accountId}","href":"/api-reference/accounts/get-balance-history"},{"title":"List card details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /card_details","href":"/api-reference/accounts/list-card-details"}]},{"group":"Public","pages":[{"title":"Generate customer_token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/customer/token","href":"/api-reference/public/generate-customer_token"},{"title":"Get cred submit jwks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /jwks","href":"/api-reference/public/get-cred-submit-jwks"},{"title":"Get payments jwks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payments/jwks","href":"/api-reference/public/get-payments-jwks"}]},{"group":"Link","pages":[{"title":"Exchange Link Code for login_identity_token and login_identity_id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/token","href":"/api-reference/link/exchange-link-code-for-login_identity_token-and-login_identity_id"},{"title":"Create link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /link","href":"/api-reference/link/create-link"},{"title":"Retrieve link/refresh status - for user-present refresh only","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /link/action/{loginIdentityId}","href":"/api-reference/link/retrieve-linkrefresh-status--for-user-present-refresh-only"},{"title":"Relink v2","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /link/relink/{loginIdentityId}","href":"/api-reference/link/relink-v2"},{"title":"Link status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /link/status/{loginIdentityId}","href":"/api-reference/link/link-status"},{"title":"Generate link_url","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /link/token","href":"/api-reference/link/generate-link_url"}]},{"group":"Customer","pages":[{"title":"Refresh login_identity_token","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/token/refresh","href":"/api-reference/customer/refresh-login_identity_token"},{"title":"Retrieve Institutions list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /institutions","href":"/api-reference/customer/retrieve-institutions-list"},{"title":"Get institutions for customer","description":"Get a customer-specific list of institutions for Finverse Link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /institutions/customer","href":"/api-reference/customer/get-institutions-for-customer"},{"title":"Get institution","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /institutions/{institutionId}","href":"/api-reference/customer/get-institution"}]},{"group":"Bills","pages":[{"title":"List bills","description":"List bills","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /bills","href":"/api-reference/bills/list-bills"},{"title":"Get bill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /bills/{billId}","href":"/api-reference/bills/get-bill"}]},{"group":"Statements","pages":[{"title":"Get composite statement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /composite_statement","href":"/api-reference/statements/get-composite-statement"},{"title":"Get statements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /statements","href":"/api-reference/statements/get-statements"},{"title":"Get statement","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /statements/{statementId}","href":"/api-reference/statements/get-statement"}]},{"group":"Disputes","pages":[{"title":"List Disputes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /disputes","href":"/api-reference/disputes/list-disputes"}]},{"group":"Identity \u0026 income","pages":[{"title":"Get identity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /identity","href":"/api-reference/identity_income/get-identity"},{"title":"Get income estimate by login identity id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /income","href":"/api-reference/identity_income/get-income-estimate-by-login-identity-id"}]},{"group":"Ledger","pages":[{"title":"Generate Finverse statement CSV","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ledger/statement","href":"/api-reference/ledger/generate-finverse-statement-csv"}]},{"group":"Login identity","pages":[{"title":"Get login identity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /login_identity","href":"/api-reference/login_identity/get-login-identity"},{"title":"Unlink Login Identity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /login_identity","href":"/api-reference/login_identity/unlink-login-identity"},{"title":"login_identity/refresh (User-present data refresh)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /login_identity/refresh","href":"/api-reference/login_identity/login_identityrefresh-user-present-data-refresh"},{"title":"Get login identity by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /login_identity/{loginIdentityId}","href":"/api-reference/login_identity/get-login-identity-by-id"},{"title":"Get login identity history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /login_identity/{loginIdentityId}/history","href":"/api-reference/login_identity/get-login-identity-history"}]},{"group":"Mandates","pages":[{"title":"List Mandates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mandates","href":"/api-reference/mandates/list-mandates"},{"title":"Create Mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mandates","href":"/api-reference/mandates/create-mandate"},{"title":"Get mandate auth","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mandates/auth","href":"/api-reference/mandates/get-mandate-auth"},{"title":"Submit auth checklist","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mandates/auth","href":"/api-reference/mandates/submit-auth-checklist"},{"title":"List Mandates including plaintext sensitive account data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mandates/details","href":"/api-reference/mandates/list-mandates-including-plaintext-sensitive-account-data"},{"title":"Set mandate institution","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mandates/institution_selection","href":"/api-reference/mandates/set-mandate-institution"},{"title":"Generate link_url","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mandates/link","href":"/api-reference/mandates/generate-link_url"},{"title":"Create Mandate with existing Sender Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mandates/sender_account","href":"/api-reference/mandates/create-mandate-with-existing-sender-account"},{"title":"Get mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mandates/{mandateId}","href":"/api-reference/mandates/get-mandate"},{"title":"Authorize Mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mandates/{mandateId}/authorize","href":"/api-reference/mandates/authorize-mandate"}]},{"group":"Payment accounts","pages":[{"title":"List Payment Accounts for Customer App, with payment method overview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment_accounts","href":"/api-reference/payment_accounts/list-payment-accounts-for-customer-app-with-payment-method-overview"},{"title":"Create Payment Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_accounts","href":"/api-reference/payment_accounts/create-payment-account"},{"title":"Delete Payment Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /payment_accounts/{paymentAccountId}","href":"/api-reference/payment_accounts/delete-payment-account"}]},{"group":"Payment links","pages":[{"title":"Get adyen card setup payment methods","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment_link/fvlink/adyen/payment_methods","href":"/api-reference/payment_links/get-adyen-card-setup-payment-methods"},{"title":"Submit adyen card setup payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_link/fvlink/adyen/payments","href":"/api-reference/payment_links/submit-adyen-card-setup-payment"},{"title":"Submit adyen card setup payment details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_link/fvlink/adyen/payments/details","href":"/api-reference/payment_links/submit-adyen-card-setup-payment-details"},{"title":"Create Payment Link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_links","href":"/api-reference/payment_links/create-payment-link"},{"title":"Complete kcp payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_links/kcp/payment","href":"/api-reference/payment_links/complete-kcp-payment"},{"title":"Get Payment Link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment_links/{paymentLinkId}","href":"/api-reference/payment_links/get-payment-link"},{"title":"Cancel Payment Link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_links/{paymentLinkId}/cancel","href":"/api-reference/payment_links/cancel-payment-link"}]},{"group":"Payment methods","pages":[{"title":"Get Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment_methods/{paymentMethodId}","href":"/api-reference/payment_methods/get-payment-method"},{"title":"Cancel Payment Method","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_methods/{paymentMethodId}/cancel","href":"/api-reference/payment_methods/cancel-payment-method"}]},{"group":"Payment users","pages":[{"title":"Create Payment User","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_users","href":"/api-reference/payment_users/create-payment-user"},{"title":"Get Payment User","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment_users/{paymentUserId}","href":"/api-reference/payment_users/get-payment-user"},{"title":"Update Payment User","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_users/{paymentUserId}","href":"/api-reference/payment_users/update-payment-user"},{"title":"List Payment Accounts for a Payment User","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment_users/{paymentUserId}/payment_accounts","href":"/api-reference/payment_users/list-payment-accounts-for-a-payment-user"},{"title":"Get Payment Methods by User","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payment_users/{paymentUserId}/payment_methods","href":"/api-reference/payment_users/get-payment-methods-by-user"},{"title":"Create Payment Method: direct debit mandate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payment_users/{paymentUserId}/payment_methods","href":"/api-reference/payment_users/create-payment-method:-direct-debit-mandate"}]},{"group":"Payment operations","pages":[{"title":"List Payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payments","href":"/api-reference/payments/list-payments"},{"title":"Create Payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payments","href":"/api-reference/payments/create-payment"},{"title":"Get payment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payments/{paymentId}","href":"/api-reference/payments/get-payment"},{"title":"Update Payment metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payments/{paymentId}","href":"/api-reference/payments/update-payment-metadata"},{"title":"Update Manual Payment status","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /testing/payments/{paymentId}/status","href":"/api-reference/payments/update-manual-payment-status"}]},{"group":"Payouts","pages":[{"title":"List Payouts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payouts","href":"/api-reference/payouts/list-payouts"},{"title":"Get payout by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /payouts/{payoutId}","href":"/api-reference/payouts/get-payout-by-id"},{"title":"Cancel payout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payouts/{payoutId}/cancel","href":"/api-reference/payouts/cancel-payout"}]},{"group":"payment","pages":[{"title":"Create a payout","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payouts","href":"/api-reference/payment/create-a-payout"},{"title":"Confirm a payout that was created with confirm = false, submitting it for processing","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /payouts/{payoutId}/confirm","href":"/api-reference/payment/confirm-a-payout-that-was-created-with-confirm-=-false-submitting-it-for-processing"}]},{"group":"Transactions","pages":[{"title":"List transactions by login identity id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transactions","href":"/api-reference/transactions/list-transactions-by-login-identity-id"},{"title":"List transactions by account id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transactions/{accountId}","href":"/api-reference/transactions/list-transactions-by-account-id"}]},{"group":"API Reference","pages":[{"title":"Trigger delayed error (during bank processing)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /scenario/{mandate_id}","href":"/api-reference/trigger-delayed-error-during-bank-processing"}]}]}]},"basePath":"","title":"Get institution - Finverse API","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}