Skip to main content
GET
/
v1
/
institutions
/
{institutionId}
Get Institution
curl --request GET \
  --url https://api.waycore.com/v1/institutions/{institutionId} \
  --header 'Authorization: Bearer <token>'
{
  "institutionId": "<string>",
  "name": "<string>",
  "canonicalPortalUrl": "<string>",
  "additionalPortalUrls": [
    "<string>"
  ],
  "setupGuideUrl": "<string>",
  "alternativeNames": [
    "<string>"
  ],
  "logoUrl": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.waycore.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Opaque API key passed as Authorization: Bearer <key>. Keys are organization-bound, environment-bound (live or test), scope-carrying, and expiring. Create and manage keys via the console.

Path Parameters

​
institutionId
string
required

Response

Successful Response

​
institutionId
string
required

Stable, immutable identifier for the institution.

​
name
string
required

Institution display name.

​
canonicalPortalUrl
string
required

Waycore's default HTTPS portal URL used when creating a connection by institution ID.

​
additionalPortalUrls
string[]
required

Additional HTTPS portal URLs that can be supplied for this institution, when known.

​
setupGuideUrl
string
required

URL to the Waycore documentation page with setup instructions for this institution.

​
status
enum<string>
required

Whether this institution is fully supported (live) or coming soon (pending).

Available options:
live,
pending
​
alternativeNames
string[]
required

Alternative names for this institution used for search matching.

​
logoUrl
string | null

Public-facing URL to the institution's logo, when available.