institutionId when a bank is already in the catalog.
A bank does not need to appear in
/v1/institutions before you can start onboarding it. If it is not listed, create the connection with entityId plus portalUrl; Waycore returns a setup-stage connection and delegated-user instructions while support is added.Institution vs connection
In other words: institutions are a convenience for known banks, not a prerequisite for onboarding a new one.
Connection input paths
For catalog records, call
GET /v1/institutions, search by institution name, identifier, portal URL, or portal domain, then use the returned institutionId in POST /v1/connections. For banks that are not listed, use the HTTPS bank portalUrl directly in POST /v1/connections.
Key fields
institutionId— Stable Waycore identifier used when creating connections.name— Display name for the bank or banking platform.canonicalPortalUrl— Default HTTPS portal URL for the institution.additionalPortalUrls— Other known HTTPS portal URLs that can be supplied when creating a connection.alternativeNames— Other names by which the institution is commonly known.logoUrl— URL of the institution’s logo, when available.setupGuideUrl— Link to Waycore’s user-facing setup guide for this institution.status—liveif the institution is fully supported, orpendingif it is in the catalog but not yet available for new connections.
Searching
GET /v1/institutions supports a query parameter for name, identifier, portal URL, or portal domain search. Results are cursor-paginated, so you can browse the full catalog or power a searchable picker in your product.
Use institutionId when a catalog record fits the bank. Use portalUrl directly in the connection create call when the bank is unsupported, newly requested, or better identified by a specific portal URL.