---
title: "Get an institution's details"
method: GET
path: "/api/institutions/{id}/"
tags: ["Institutions"]
---

# Get an institution's details

`GET /api/institutions/{id}/`

Get the details of a specific institution.

## Path parameters

- `id` string, required

## Response `200`

Ok

- InstitutionPublicApi — Object detailing the aggregation institution.
  - `id` integer — The ID of the institution as designated by Belvo.
  - `name` string — 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`
  - `website` string, nullable — The URL of the institution's website.
  - `display_name` string — The customer-facing name of the institution.
  - `country_codes` string[] — The country codes where the institution is available, for example: - 🇧🇷 BR (Brazil) - 🇨🇴 CO (Colombia) - 🇲🇽 MX (Mexico)
  - `primary_color` string — The primary color on the institution's website.
  - `logo` string, nullable — The URL of the institution's logo.
  - `icon_logo` string, nullable — The URL of the institution's icon logo.
  - `text_logo` string, nullable — The URL of the institution's text logo.
  - `code` string, 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.
  - `form_fields` InstitutionsFormField[]
    - `name` string — The username, password, or username type field.
    - `type` string — The input type for the form field. For example, string.
    - `label` string — The label of the form field. For example: - Client number - Key Bancanet - Document
    - `validation` string — The type of input validation used for the field.
    - `placeholder` string — The placeholder text in the form field.
    - `validation_message` string — The message displayed when an invalid input is provided in the form field.
    - `values` InstitutionsFormFieldValues[] — If the form field is for documents, the institution may require additional input regarding the document type.
      - `code` string — The code of the document.
      - `label` string — The label for the field. For example: - Cédula de Ciudadanía - Cédula de Extranjería - Pasaporte
      - `validation` string — The type of input validation used for the field.
      - `validation_message` string — The message displayed when an invalid input is provided in the form field.
      - `placeholder` string — The placeholder text in the form field.
  - `features` InstitutionsFeature[] — 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.
    - `name` string — The name of the feature.
    - `description` string — The description of the feature.
  - `resources` string[] — 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`).
  - `openbanking_information` InstitutionOpenBankingInformation, nullable — Information about the institution on the Open Finance environment.
    - `description` string, nullable — A short description of the institution on the Open Finance environment. Extracted from Open Finance regulated institutions listing.
    - `participants` string[], nullable — List of brands' servers available from the institution in Open Finance. Extracted from Open Finance regulated institutions listing.
    - `authorization_server_id` string, uuid, nullable — The authorization server ID (UUID) of the institution on the Open Finance Environment.

## Other responses

- `401` — Unauthorized
- `403` — Access to Belvo API denied
- `404` — Not Found Error
- `408` — Request Timeout
- `500` — Unexpected Error

---

[API](https://skmtc.net/belvo/apis/belvo-api-docs.md) · [All operations](https://skmtc.net/belvo/apis/belvo-api-docs/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/belvo/belvo-api-docs/versions/3423c786ece5/schema)