Get Institution

get https://api.sandbox.usebasis.co/institutions/{institution_id}

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.

Responses

Response body

object

institution_id

uuid

required

Identifier for the Institution.

display_name

string

required

Name of the Institution.

institution_type

string

required

Primary type of service provided by the institution (e.g. banking, accounts-payable).

accounts-payable accounting bank credit-union investment-brokerage payroll revenue-processor tax-authority

platforms

array of objects

required

List of platform objects representing the Platforms available at the Institution. Platforms relate to how users interact with their accounts at the Institution.

For example, Bank of America will have Business Advantage 360 - where SMB banking users interact with their accounts, and CashPro - where Commercial banking users interact with their accounts.

Platforms*

object

platform_id

uuid

required

Identifier for the Platform.

display_name

string

required

Name of the Platform as referenced by the Institution.

platform_type

string

required

If applicable, indicator used to delineate between different Platforms at a given institution.

default personal mortgage smb commercial corporate treasury investment

homepage_url

uri

required

The URL where the institution has users log in to this Platform (for discoverability).

200Successful Response

422Validation Error