Sign in

v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Institutions

Get an institution's details

Get the details of a specific institution.

get/api/institutions/{id}/

Path parameters

idstring required

The institution.id you want to get detailed information about.

Response

Ok

idinteger

The ID of the institution as designated by Belvo.

namestring

The name of the institution, as designated by Belvo.

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

The type of institution. We return one of the following values:

  • bank
  • fiscal
  • employment
websitestring nullable

The URL of the institution's website.

display_namestring

The customer-facing name of the institution.

country_codesstring[]

The country codes where the institution is available, for example:

  • 🇧🇷 BR (Brazil)
  • 🇨🇴 CO (Colombia)
  • 🇲🇽 MX (Mexico)
primary_colorstring

The primary color on the institution's website.

logostring nullable

The URL of the institution's logo.

icon_logostring nullable

The URL of the institution's icon logo.

text_logostring nullable

The URL of the institution's text logo.

codestring nullable

This field is deprecated and will be removed in a future release. Please use the id field instead, which is the unique identifier for the institution.

resourcesstring[]

A list of Belvo resources that you can use with the institution. This list includes one or more of the following resources:

  • ACCOUNTS
  • BALANCES
  • BILLS
  • EMPLOYMENTS
  • EMPLOYMENT_RECORDS
  • FINANCIAL_STATEMENTS
  • INCOMES
  • INVESTMENTS
  • INVESTMENT_TRANSACTIONS
  • INVOICES
  • OWNERS
  • RECURRING_EXPENSES
  • RISK_INSIGHTS
  • TRANSACTIONS
  • TAX_COMPLIANCE_STATUS
  • TAX_RETENTIONS
  • TAX_RETURNS
  • TAX_STATUS
integration_type'credentials' | 'openfinance'

The type of technology used to access the institution. We return one of the following values:

  • credentials: Uses Belvo's scraping technology, combined with user credentials, to perform requests.
  • openfinance: Uses the bank's open finance API to perform requests.
status'healthy' | 'down'

Indicates whether Belvo's integration with the institution is currently active (healthy) or undergoing maintenance (down).

Example response

{
  "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"
  }
}