Skip to main content
An Institution is a catalog record for a supported bank or banking platform. It is not a live connection and it does not imply that you have already onboarded access. Use the institutions endpoints to discover the correct institutionId before you create a connection for a supported institution.

​
Institution vs connection

ObjectWhat it represents
InstitutionA supported bank record in Waycore’s public catalog.
ConnectionA live, entity-owned integration with that institution, or with a bank portal URL, after delegated-user setup and activation.
In other words: institutions are discoverable first, and they are the preferred input when the bank is already supported.

​
Discovery flow

  1. Call GET /v1/institutions
  2. Use the query parameter to search by institution name or identifier
  3. Choose an institutionId
  4. Pair it with an entityId in POST /v1/connections
  5. Optionally pass portalUrl too when that supported institution has multiple login portals
If the institution is not yet supported, skip catalog lookup and create the connection with entityId plus portalUrl instead. That lets you begin onboarding now while Waycore adds support later.

​
Key fields

  • institutionId — Stable Waycore identifier used when creating connections.
  • name — Display name for the bank or banking platform.

​
Searching

GET /v1/institutions supports a query parameter for name or identifier search. Results are cursor-paginated, so you can browse the full catalog or power a searchable picker in your product. For supported institutions, institutionId is the preferred connection input. For unsupported or newly requested institutions, use portalUrl directly in the connection create call.

​
Endpoints

List institutions

Get institution

Create connection

​
Required scopes

ScopeUsed by
connections:readList, get
connections:writeCreate a connection with the selected institution or portal URL