> ## 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.

# Get Institution

> GET /v1/institutions/{institutionId}

Get a single supported institution by identifier.



## OpenAPI

````yaml /openapi.json get /v1/institutions/{institutionId}
openapi: 3.1.0
info:
  title: Waycore Bank Connections API
  description: >-
    Developer-first API for direct bank connections, accounts, and transactions.


    Design goals:

    - Flat records with minimal nesting.

    - Clear, bank-centric naming.

    - One canonical endpoint per resource.

    - Sparse fieldsets via `fields=`.

    - Historical browsing via `GET /transactions`.

    - Incremental ETL via `GET /transactions/sync`.

    - Discover supported institutions via `GET /institutions`.

    - Model downstream client businesses via `/entities` and explicit `entityId`
    ownership.


    Authentication:

    - Opaque API keys passed as `Authorization: Bearer <key>`.

    - Key format: `way_<environment>_<key_id>_<secret>`.

    - Keys are organization-bound, environment-bound (`live` or `test`),
    scope-carrying, and expiring.

    - Managed via the Waycore Console.
  version: 0.5.0
servers:
  - url: https://api.waycore.com
security: []
paths:
  /v1/institutions/{institutionId}:
    get:
      tags:
        - institutions
      summary: Get Institution
      description: |-
        GET /v1/institutions/{institutionId}

        Get a single supported institution by identifier.
      operationId: get_institution_v1_institutions__institutionId__get
      parameters:
        - name: institutionId
          in: path
          required: true
          schema:
            type: string
            title: Institutionid
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Institution'
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Not Found
        '429':
          headers:
            Retry-After:
              description: >-
                Number of seconds to wait before retrying, when rate limiting
                provides a specific backoff.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicErrorResponse'
          description: Internal Server Error
      security:
        - apiKeyBearer:
            - connections:read
components:
  schemas:
    Institution:
      properties:
        institutionId:
          type: string
          title: Institutionid
          description: Stable, immutable identifier for the institution.
        name:
          type: string
          title: Name
          description: Institution display name.
        canonicalPortalUrl:
          type: string
          title: Canonicalportalurl
          description: >-
            Waycore's default HTTPS portal URL used when creating a connection
            by institution ID.
        additionalPortalUrls:
          items:
            type: string
          type: array
          title: Additionalportalurls
          description: >-
            Additional HTTPS portal URLs that can be supplied for this
            institution, when known.
        setupGuideUrl:
          type: string
          title: Setupguideurl
          description: >-
            URL to the Waycore documentation page with setup instructions for
            this institution.
        status:
          $ref: '#/components/schemas/InstitutionStatus'
          description: >-
            Whether this institution is fully supported (`live`) or coming soon
            (`pending`).
        alternativeNames:
          items:
            type: string
          type: array
          title: Alternativenames
          description: Alternative names for this institution used for search matching.
        logoUrl:
          anyOf:
            - type: string
            - type: 'null'
          title: Logourl
          description: Public-facing URL to the institution's logo, when available.
      type: object
      required:
        - institutionId
        - name
        - canonicalPortalUrl
        - additionalPortalUrls
        - setupGuideUrl
        - status
        - alternativeNames
      title: Institution
    PublicErrorResponse:
      properties:
        type:
          title: Type
          type: string
        message:
          type: string
          title: Message
        requestId:
          anyOf:
            - type: string
            - type: 'null'
          title: Requestid
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
      type: object
      required:
        - type
        - message
      title: PublicErrorResponse
    InstitutionStatus:
      type: string
      enum:
        - live
        - pending
      title: InstitutionStatus
  securitySchemes:
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: way_<environment>_<key_id>_<secret>
      description: >-
        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.

````