Skip to main content
POST
/
institutions
/
get_by_id
/institutions/get_by_id
curl --request POST \
  --url http://localhost:8080/plaid-compatible/institutions/get_by_id \
  --header 'Content-Type: application/json' \
  --header 'PLAID-CLIENT-ID: <api-key>' \
  --data '{
  "client_id": "<string>",
  "secret": "<string>",
  "institution_id": "<string>",
  "options": {}
}'
{
  "institution": {
    "institution_id": "<string>",
    "name": "<string>",
    "country_codes": [
      "GB"
    ],
    "url": "<string>",
    "primary_color": "<string>"
  },
  "request_id": "<string>"
}

Authorizations

​
PLAID-CLIENT-ID
string
header
required

Headers

​
Plaid-Version
string | null

Body

application/json

InstitutionsGetByIdRequest defines the request schema for /institutions/get_by_id

​
institution_id
string
required

The ID of the institution to get details about

​
client_id
string | null

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

​
secret
string | null

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

​
options
object | null

Specifies optional parameters for /institutions/get_by_id. If provided, must not be null.

Response

OK

InstitutionsGetByIdResponse defines the response schema for /institutions/get_by_id

​
institution
object
required

Details relating to a specific financial institution

​
request_id
string
required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.