Skip to main content
GET
/
institutions
/
{institutionId}
Get institution
curl --request GET \
  --url https://api-sb.meld.io/institutions/{institutionId} \
  --header 'Authorization: <api-key>'
{
  "aliases": [
    "<string>"
  ],
  "domain": "<string>",
  "id": "<string>",
  "images": {
    "icon": "<string>",
    "tile": "<string>",
    "wide": "<string>"
  },
  "isTest": true,
  "key": "<string>",
  "name": "<string>",
  "providers": {},
  "rank": 123,
  "subName": "<string>",
  "type": "<string>"
}

Authorizations

​
Authorization
string
header
default:BASIC <Meld API Key>
required

Path Parameters

​
institutionId
string
required

Institution id

Response

Institution is returned

​
aliases
string[]

List of aliases for the institution

​
domain
string

Base url for the institution

​
id
string

Institution's Meld Id

​
images
object

Images

​
isTest
boolean

If the institution is a test institution

​
key
string

The key of the institution in the paginated list of results

​
name
string

Name

​
providers
object

Mapped service provider institutions

​
rank
integer<int32>

Institution's popularity score, which is used to rank institutions in the bank linking connect widget

​
subName
string

Alternate name that may be provided by the service provider

​
type
string

Type of the institution