v1

latestOpenAPI 3.0.22026-08-061464031.4 MB

Institutions

List institutions

▶️ Usage

With the List Institutions method, you can:

List all institutions Belvo has available.

📖 Pagination

This method returns a paginated response (default: 100 items per page). You can use the page_size query parameter to increase the number of items returned to a maximum of 1000 items. You can use the page query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our <a href="https://developers.belvo.com/docs/belvo-pagination-tips" target="_blank">Pagination Tips</a> article.

🔦 Filtering Responses

Please see the query list below for a list of fields that you can filter your responses by. For more information on how to use filters, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> article.

get/api/institutions/

Query parameters

page_sizeinteger

Example:100

Indicates how many results to return per page. By default we return 100 results per page.

ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000).

pageinteger

Example:1

A page number within the paginated result set.

display_namestring

Example:Erebor Bank

Return institutions that partially match this display name.

country_codestring

Example:MX

Return institutions only for this two-letter country code.

country_code__instring[]

Return institutions only for these two-letter country codes.

[
  "BR"
]

resources__allinstring[]

Return institutions that support this combination resources.

[
  "OWNERS"
]

namestring

Example:planet_mx_retail

Return an institution with this Belvo-designated name.

name__instring[]

Return institutions with one or more of these Belvo-designated names.

[
  "planet_mx_retail"
]

statusstring

Example:healthy

Return institutions with the given status. You can choose between healthy or down.

status__instring[]

Return institutions with one of the given statuses. You can choose between healthy or down.

[
  "healthy"
]

type'bank' | 'fiscal' | 'employment'

Example:fiscal

Return institutions of this type. You can choose between bank, fiscal, or employment.

type__instring[]

Return institutions of one of these types. You can choose between bank, fiscal, or employment.

[
  "fiscal"
]

websitestring

Example:https://www.erebor.mx

Return institutions with this website URL.

Response

countinteger

The total number of results in your Belvo account.

nextstring uri nullable

The URL to next page of results. Each page consists of up to 100 items. If there are not enough results for an additional page, the value is null.

In our documentation example, we use {endpoint} as a placeholder value. In production, this value will be replaced by the actual endpoint you are currently using (for example, accounts or owners).

previousstring uri nullable

The URL to the previous page of results. If there is no previous page, the value is null.

Example response

{
  "count": 130,
  "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2",
  "results": [
    {
      "id": 1003,
      "name": "erebor_mx_retail",
      "website": "https://www.erebor.com/",
      "display_name": "Erebor Mexico",
      "country_codes": [
        "MX"
      ],
      "primary_color": "#056dae",
      "logo": "https://belvo-api-media.s3.amazonaws.com/logos/erebor_logo.svg",
      "icon_logo": "https://statics.belvo.io/widget/images/institutions/erebor.svg",
      "text_logo": "https://statics.belvo.io/widget/images/institutions/erebor.svg",
      "form_fields": [
        {
          "name": "username",
          "type": "text",
          "label": "Client number",
          "validation": "^.{1,}$",
          "placeholder": "ABC333333A33",
          "validation_message": "Invalid client number",
          "values": [
            {
              "code": "001",
              "label": "Cédula de Ciudadanía",
              "validation": "^.{1,}$",
              "validation_message": "Invalid document number",
              "placeholder": "DEF4444908M22"
            }
          ]
        }
      ],
      "features": [
        {
          "name": "token_required",
          "description": "The institution may require a token during link creation or login"
        }
      ],
      "resources": [
        "ACCOUNTS",
        "BALANCES",
        "INCOMES",
        "OWNERS",
        "RECURRING_EXPENSES",
        "RISK_INSIGHTS",
        "TRANSACTIONS"
      ],
      "integration_type": "credentials",
      "status": "healthy",
      "openbanking_information": {
        "description": "A 1ss Bank é uma fintech fundada em janeiro de 2020, com a missão de ajudar empresas com grandes ecossistemas a se tornarem fintechs, integrando e automatizando seus processos financeiros através de APIs e plataforma white-label.",
        "participants": [
          "1ss Bank"
        ],
        "authorization_server_id": "aa18fcd3-2f0b-40b1-87db-8930b10b78b1"
      }
    }
  ]
}