Search Institutions

post

https://api.sb.spidrsrv.com/ztm/v1/linked-institution/search

Use the linked-institution/search endpoint to search for financial institutions by name through a provider, in order to power an institution picker / search UI. Supply the provider, the productId, and the vendorServices you intend to use the institution for; results are filtered to institutions that support those services.

Each result includes the providerId (unique institution identifier for the provider, useful for deduping), institutionName, an optional institutionLogo, and the supportedServices the institution supports. The raw provider payload is nested under providerDetails. No provider credentials are exposed.

Body Params

POST /v1/linked-institution/search Request body

name

string

required

length ≥ 1

The institution name (or partial name) to search for

provider

string

enum

required

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

Allowed:

productId

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

vendorServices

array of strings

required

The service(s) needed for the linked institution session

vendorServices*

Allowed:

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200POST /v1/linked-institution/search Positive response

400POST /v1/linked-institution/search Negative response