# Enumerar instituciones

## ▶️ Uso

Con el método List Institutions, puedes:

1. Listar todas las instituciones disponibles en Belvo.

## 📖 Paginación

Este método devuelve una respuesta paginada (por defecto: 100 elementos por página). Puedes usar el parámetro de consulta  para aumentar el número de elementos devueltos hasta un máximo de 1000 elementos. Puedes usar el parámetro de consulta  para navegar a través de los resultados. Para más detalles sobre cómo navegar por las respuestas paginadas de Belvo, consulta nuestro artículo Consejos de paginación.

## 🔦 Filtrado de Respuestas

Consulta la lista de consultas a continuación para ver una lista de campos por los que puedes filtrar tus respuestas. Para más información sobre cómo usar filtros, consulta nuestro artículo Filtrado de respuestas.

Endpoint: GET /api/institutions/
Version: 1.223.0
Security: basicAuth

## Query parameters:

  - `page_size` (integer)
    Indica cuántos resultados devolver por página. Por defecto, devolvemos 100 resultados por página.

ℹ️ El número mínimo de resultados devueltos por página es 1 y el máximo es 1000. Si introduces un valor mayor que 1000, nuestra API usará por defecto el valor máximo (1000).
    Example: 100

  - `page` (integer)
    Un número de página dentro del conjunto de resultados paginados.
    Example: 1

  - `display_name` (string)
    Devuelve las instituciones que coinciden parcialmente con este nombre para mostrar.
    Example: "Erebor Bank"

  - `country_code` (string)
    Devuelve instituciones solo para este código de país de dos letras.
    Example: "MX"

  - `country_code__in` (array)
    Devuelve instituciones solo para estos códigos de país de dos letras.
    Example: ["BR"]

  - `resources__allin` (array)
    Devuelve las instituciones que apoyan esta combinación de recursos.
    Example: ["OWNERS"]

  - `name` (string)
    Devuelve una institución con este nombre designado por Belvo.
    Example: "planet_mx_retail"

  - `name__in` (array)
    Devuelve instituciones con uno o más de estos nombres designados por Belvo.
    Example: ["planet_mx_retail"]

  - `status` (string)
    Devuelve las instituciones con el estado dado. Puedes elegir entre  o .
    Example: "healthy"

  - `status__in` (array)
    Devolver instituciones con uno de los estados dados. Puedes elegir entre  o .
    Example: ["healthy"]

  - `type` (string)
    Devolver instituciones de este tipo. Puede elegir entre ,  o .
    Enum: "bank", "fiscal", "employment"

  - `type__in` (array)
    Devuelve instituciones de uno de estos tipos. Puedes elegir entre ,  o .
    Enum: "bank", "fiscal", "employment"

  - `website` (string)
    Devuelve instituciones con esta URL de sitio web.
    Example: "https://www.erebor.mx"

## Response 200 fields (application/json):

  - `count` (integer)
    El número total de resultados en tu cuenta de Belvo.
    Example: 130

  - `next` (string,null)
    La URL a la siguiente página de resultados. Cada página consta de hasta 100 elementos. Si no hay suficientes resultados para una página adicional, el valor es .

En nuestro ejemplo de documentación, usamos  como un valor de marcador de posición. En producción, este valor será reemplazado por el endpoint real que estás utilizando actualmente (por ejemplo,  o ).
    Example: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"

  - `previous` (string,null)
    La URL a la página anterior de resultados. Si no hay una página anterior, el valor es .

  - `results` (array)
    Matriz de objetos de institución.

  - `results.id` (integer)
    El ID de la institución según lo designado por Belvo.
    Example: 1003

  - `results.name` (string)
    El nombre de la institución, según lo designado por Belvo.
    Example: "erebor_mx_retail"

  - `results.type` (string)
    El tipo de institución. Devolvemos uno de los siguientes valores:

  - 
  - 
  -
    Enum: "bank", "fiscal", "employment"

  - `results.website` (string,null)
    La URL del sitio web de la institución.
    Example: "https://www.erebor.com/"

  - `results.display_name` (string)
    El nombre de cara al cliente de la institución.
    Example: "Erebor Mexico"

  - `results.country_codes` (array)
    Los códigos de país donde la institución está disponible, por ejemplo:
- 🇧🇷 BR (Brasil)
- 🇨🇴 CO (Colombia)
- 🇲🇽 MX (México)
    Example: ["MX"]

  - `results.primary_color` (string)
    El color primario en el sitio web de la institución.
    Example: "#056dae"

  - `results.logo` (string,null)
    La URL del logotipo de la institución.
    Example: "https://belvo-api-media.s3.amazonaws.com/logos/erebor_logo.png"

  - `results.icon_logo` (string,null)
    La URL del logotipo del icono de la institución.
    Example: "https://statics.belvo.io/widget/images/institutions/erebor.svg"

  - `results.text_logo` (string,null)
    La URL del logotipo de texto de la institución.
    Example: "https://statics.belvo.io/widget/images/institutions/erebor.svg"

  - `results.form_fields` (array)

  - `results.form_fields.name` (string)
    El campo de nombre de usuario, contraseña o tipo de nombre de usuario.
    Example: "username"

  - `results.form_fields.type` (string)
    El tipo de entrada para el campo del formulario. Por ejemplo, string.
    Example: "text"

  - `results.form_fields.label` (string)
    La etiqueta del campo del formulario. Por ejemplo:
- Client number
- Key Bancanet
- Document
    Example: "Client number"

  - `results.form_fields.validation` (string)
    El tipo de validación de entrada utilizada para el campo.
    Example: "^.{1,}$"

  - `results.form_fields.placeholder` (string)
    El texto del marcador de posición en el campo del formulario.
    Example: "ABC333333A33"

  - `results.form_fields.validation_message` (string)
    El mensaje que se muestra cuando se proporciona una entrada no válida en el campo del formulario.
    Example: "Invalid client number"

  - `results.form_fields.values` (array)
    Si el campo del formulario es para documentos, la institución puede requerir información adicional sobre el tipo de documento.

  - `results.form_fields.values.code` (string)
    El código del documento.
    Example: "001"

  - `results.form_fields.values.label` (string)
    La etiqueta para el campo. Por ejemplo:
- Cédula de Ciudadanía
- Cédula de Extranjería
- Pasaporte
    Example: "Cédula de Ciudadanía"

  - `results.features` (array)
    Las características que la institución admite. Si la institución no tiene características especiales, entonces Belvo devuelve un array vacío.

Aquí hay una lista de las características disponibles:
-  indica que la institución puede requerir un token durante la creación del enlace o al realizar cualquier otra solicitud.

  - `results.features.name` (string)
    El nombre de la característica.
    Example: "token_required"

  - `results.features.description` (string)
    La descripción de la característica.
    Example: "The institution may require a token during link creation or login"

  - `results.resources` (array)
    Una lista de recursos de Belvo que puedes usar con la institución. Esta lista incluye uno o más de los siguientes recursos:

  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  - 
  -
    Example: ["ACCOUNTS","BALANCES","INCOMES","OWNERS","RECURRING_EXPENSES","RISK_INSIGHTS","TRANSACTIONS"]

  - `results.integration_type` (string)
    El tipo de tecnología utilizada para acceder a la institución. Devolvemos uno de los siguientes valores:

- : Utiliza la tecnología de scraping de Belvo, combinada con las credenciales del usuario, para realizar solicitudes.
- : Utiliza la API de open finance del banco para realizar solicitudes.
    Enum: "credentials", "openfinance"

  - `results.status` (string)
    Indica si la integración de Belvo con la institución está actualmente activa () o en mantenimiento ().
    Enum: "healthy", "down"

## Response 403 fields (application/json):

  - `code` (string)
    Un código de error único () que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar 403 access_to_resource_denied.
    Example: "access_to_resource_denied"

  - `message` (string)
    Una breve descripción del error.

Para los errores , la descripción es:

  - .
    Example: "You don't have access to this resource."

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 404 fields (application/json):

  - `code` (string)
    Un código de error único () que te permite clasificar y manejar el error de manera programática.
    Example: "not_found"

  - `message` (string)
    Una breve descripción del error.

Para errores , la descripción es:

  -
    Example: "Not found"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 408 fields (application/json):

  - `code` (string)
    Un código de error único () que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 408 request_timeout.
    Example: "request_timeout"

  - `message` (string)
    Una breve descripción del error.

Para los errores de , la descripción es:

  - .
    Example: "The request timed out, you can retry asking for less data by changing your query parameters"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"

## Response 500 fields (application/json):

  - `code` (string)
    Un código de error único () que te permite clasificar y manejar el error de manera programática.

ℹ️ Consulta nuestro DevPortal para obtener más información sobre cómo manejar errores 500 unexpected_error.
    Example: "unexpected_error"

  - `message` (string)
    Una breve descripción del error.

Para los errores , la descripción es:

- .
    Example: "Belvo is unable to process the request due to an internal system issue or to an unsupported response from an institution"

  - `request_id` (string)
    Un ID único de 32 caracteres de la solicitud (que coincide con un patrón regex de: ). Proporcione este ID al contactar al equipo de soporte de Belvo para acelerar las investigaciones.
    Example: "9e7b283c6efa449c9c028a16b5c249fb"