API Reference

Overview

Institutions are organizations where financial accounts are held. They are typically a company, such as J.P. Morgan Chase & Co., but can be other types of organization (e.g. a government).

Institutions have Platforms associated with them. Platforms are how users interact with their accounts at the Institution. For example, Bank of America has Business Advantage 360 - where SMB banking users interact with their accounts, and CashPro - where Commercial banking users interact with their accounts.

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--for example, using the Platform's display_name on "Connect your bank" buttons.
  • 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.
Log in to see full request history
Response

Response body
object
institutions
array of objects
required

A list of Institution objects representing the Institutions covered by Basis. Institutions are organizations where financial accounts are held. They are typically a company, such as J.P. Morgan Chase & Co., but can be other types of organization (e.g., a government).

Institutions*
object
uuid
required

Identifier for the Institution.

string
required

Name of the Institution.

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
uuid
required

Identifier for the Platform.

string
required

Name of the Platform as referenced by the Institution.

string
required

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

default personal mortgage smb commercial corporate treasury investment

uri
required

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

Language
Credentials
OAuth2
URL