Object detailing the aggregation institution.
The type of institution. We return one of the following values:
bank
fiscal
employment
The country codes where the institution is available, for example:
- 🇧🇷 BR (Brazil)
- 🇨🇴 CO (Colombia)
- 🇲🇽 MX (Mexico)
The URL of the institution's logo.
The URL of the institution's icon logo.
The URL of the institution's text logo.
The features that the institution supports. If the institution has no special features, then Belvo returns an empty array.
Here is a list of the available features:
token_required
indicates that the institution may require a token during link creation or when making any other requests.
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
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.
{ "id": 1003, "name": "erebor_mx_retail", "type": "bank", "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.png", "icon_logo": "https://statics.belvo.io/widget/images/institutions/erebor.svg", "text_logo": "https://statics.belvo.io/widget/images/institutions/erebor.svg", "form_fields": [ { … } ], "features": [ { … } ], "resources": [ "ACCOUNTS", "BALANCES", "INCOMES", "OWNERS", "RECURRING_EXPENSES", "RISK_INSIGHTS", "TRANSACTIONS" ], "integration_type": "credentials", "status": "healthy" }