Get Institution

Overview

Returns a single institution, including the list of Platforms supported by Basis at the Institution.

Use cases

  • Initialize Connect directly to a specific Platform. To do this, use the platform_id in your initialization token.
  • Provide a descriptive name of the Platform to users for them to identify their account easily. We recommend using the Platform's display_name for this - on "Connect your bank" buttons, for example.
  • Disambiguate Platforms when multiple Platforms exist at an Institution, or multiple Institutions have similar names. The homepage_url will be recognizable by the bank user as the website at which they manage their accounts online.
Path Params
uuid
required
Responses

Language
Credentials
OAuth2
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json