YAyapily
Institutions

Get Institution

Used to retrieves details of a specific Institution within an application

get/institutions/{institutionId}

Request

  • Base URL
    https://api.yapily.com
  • Auth
    HTTP basic

Path parameters

institutionIdstring required

Mandatory. The Yapily institution Id for the Institution.

Response

Ok

idstring

Unique identifier for the Institution.

namestring

The friendly name of the Institution.

fullNamestring

The full name of the Institution.

environmentType'SANDBOX' | 'MOCK' | 'LIVE'

The environment type.

See Institution Configuration for more information

credentialsType'OAUTH1' | 'OAUTH2' | 'OAUTH2_NOSECRET' | 'OAUTH2_SIGNATURE' | 'OPEN_BANKING_UK_MANUAL' | 'OPEN_BANKING_UK_AUTO' | 'OPEN_BANKING_IBM' | 'OPEN_BANKING_AUTO' | 'OPEN_BANKING_AUTO_EMAIL' | 'OPEN_BANKING_MANUAL' | 'OPEN_BANKING_WITH_TPP_ID_AND_SECRET' | 'API_KEY' | 'OPEN_BANKING_NO_KEY' | 'OPEN_BANKING_NO_TRANSPORT' | 'TOKEN_IO'

The type of credentials required to register the Institution

featuresFeatureEnum[]

Changes

No recorded changes to this operation across all 4 revisions of this API.