Get Institution By Id

Use the linked-institution/get-by-id endpoint to look up a single financial institution by its provider-specific providerId (for example, a Plaid institution_id). Supply the provider and the productId.

The response includes the providerId, institutionName, an optional institutionLogo, and the supportedServices the institution supports, with the raw provider payload nested under providerDetails. No provider credentials are exposed.

Body Params

POST /v1/linked-institution/get-by-id Request body

string
required
length ≥ 1

Pass in the provider-specific institution ID to look up (e.g. the Plaid institution_id)

string
enum
required

Underlying vendor that was invoked. Each product is configured to use a specific set of vendors.

Allowed:
string
required

Pass in the Spidr product ID. Required when starting a new link; optional when a linkedInstitutionId is supplied (the product is derived from the linked institution).

countryCodes
array of strings
Defaults to US

Optional list of ISO-3166-1 alpha-2 country codes to restrict the institution search to. Defaults to [US].

countryCodes
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json