Skip to main content
POST

Authorizations

x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Body

application/json
country_codes
string[]
required

One or more ISO 3166-1 alpha-3 country codes to filter institutions by.

Example:
count
integer
required

Number of institutions to return per page. Min 1, max 500.

Required range: 1 <= x <= 500
Example:

10

offset
integer
required

Zero-based pagination offset.

Required range: x >= 0
Example:

0

Response

Institutions retrieved successfully

institutions
object[]

List of matching banking institutions.

total
integer

Total number of institutions matching the request. Useful for calculating pagination in browse mode.

Example:

1032

request_id
string

Unique identifier for this request, for support and debugging.

Example:

"2c6567ae44fa3f7"