# Obtener los detalles de una institución

Obtén los detalles de una institución específica.

Endpoint: GET /api/institutions/{id}/
Version: 1.223.0
Security: basicAuth

## Path parameters:

  - `id` (string, required)
    El  sobre el cual deseas obtener información detallada.

## Response 200 fields (application/json):

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

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

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

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

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

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

  - `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"]

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

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

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

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

  - `form_fields` (array)

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

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

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

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

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

  - `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"

  - `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.

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

  - `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"

  - `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.

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

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

  - `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"]

  - `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"

  - `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"