> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# API para listar bancos: instituciones y capacidades

> Didit devuelve los bancos por país y lo que admite cada uno: segmentos, acceso continuo, duración del consentimiento, historial y campos.

El endpoint List Institutions de Didit devuelve los bancos por país y lo que admite cada uno: segmentos, acceso continuo, duración del consentimiento, profundidad del historial y los campos que envía.
Filtra por `country`, `segment`, `access` y `q`.
Consulta [Cobertura bancaria](https://docs.didit.me/es/core-technology/bank-verification/coverage.md).


## OpenAPI

````yaml es/openapi-25.json GET /v3/bank/institutions/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificación de identidad. Autentícate con el encabezado x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, conexiones, cuentas, saldos, transacciones, instituciones y
      cobertura. Los datos bancarios están disponibles para aplicaciones de
      sandbox. Las llamadas de una aplicación de producción responden `404`
      hasta que se anuncie el acceso en producción. En sandbox no se cobra nada.
      Una llamada hecha con una clave de API necesita una clave que tenga el
      permiso de datos bancarios (`bank-data`): lectura para las consultas,
      escritura para las operaciones que cambian algo. La verificación de cuenta
      es la excepción: necesita acceso de escritura a las sesiones, o acceso
      completo, y no el permiso de datos bancarios. Los datos bancarios no
      forman parte del acceso completo: una clave con acceso completo es
      rechazada, y la llamada responde `403 bank_data_access_denied` hasta que
      crees una clave que tenga el permiso. Los datos bancarios sin procesar
      (cuentas, saldos, transacciones y el flujo de cambios) también rechazan
      una solicitud que no incluya una clave de API.


      Cualquier rechazo bajo `/v3/bank/`, salvo el de la verificación de cuenta,
      tiene el mismo cuerpo JSON (`code`, `message`, `request_id`, `field`,
      `next_action`, `retry_after`). Una ruta que no es una operación, un ID que
      no es un UUID o un subrecurso desconocido responde `404 not_found` para
      todos los métodos, y cualquier error inesperado responde `500
      internal_error` con un `request_id`. Cuando los datos bancarios no están
      disponibles, todas las operaciones responden el `404` estándar de la
      plataforma, igual que lo hace una ruta desconocida.
paths:
  /v3/bank/institutions/:
    get:
      tags:
        - Bank Data
      summary: Listar instituciones
      description: >-
        Lista los bancos por país con sus capacidades: segmentos, modos de
        acceso, el consentimiento más largo y el historial más profundo que
        ofrece el banco, si informa de transacciones pendientes, qué campos de
        transacción se sabe que envía y cómo inicia sesión la persona. Los
        valores provienen de datos observados y se actualizan a diario; un valor
        nunca observado es `null`. Los mismos datos alimentan el selector de
        bancos, así que úsalos para saber qué esperar antes de crear un enlace.
        `access` solo incluye `ongoing` cuando hay acceso continuo disponible.


        Necesitas una clave de API con el permiso Datos bancarios (`bank-data`):
        lectura para esta operación. Una clave con acceso completo no lo
        incluye: concédelo explícitamente al crear la clave, o la llamada
        responde `403 bank_data_access_denied`.


        La lista se ordena por nombre y, después, por id.


        En una aplicación sandbox, la lista contiene el Didit Test Bank, uno por
        cada país que atiende Bank Link, y ningún banco real.
      operationId: listBankInstitutions
      parameters:
        - name: country
          in: query
          required: false
          schema:
            type: string
            pattern: ^[A-Z]{3}$
          description: >-
            Solo bancos de este país, en código ISO 3166-1 alpha-3. Si Bank Link
            no presta servicio en este país, responde `400 invalid_request` con
            `field: country`.
        - name: segment
          in: query
          required: false
          schema:
            type: string
            enum:
              - personal
              - business
          description: Solo bancos que atienden este segmento.
        - name: access
          in: query
          required: false
          schema:
            type: string
            enum:
              - one_time
              - ongoing
          description: Solo bancos que ofrecen este modo de acceso.
        - name: q
          in: query
          required: false
          schema:
            type: string
            maxLength: 100
          description: Busca por nombre o id, sin distinguir mayúsculas de minúsculas.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: Tamaño de página, de 1 a 500. Por defecto, 100.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Cursor opaco del `next_cursor` de la página anterior.
      responses:
        '200':
          description: Una página de bancos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankInstitutionList'
              examples:
                Spain, ongoing access:
                  summary: Un banco español que ofrece acceso continuo
                  value:
                    items:
                      - id: es-banco-norte
                        name: Banco Norte
                        country: ESP
                        logo_url: https://static.example.com/banks/es-banco-norte.png
                        timezone: Europe/Madrid
                        segments:
                          - personal
                          - business
                        access:
                          - one_time
                          - ongoing
                        ongoing_access: true
                        consent_days_max: 180
                        history_days_max: 365
                        pending_transactions: true
                        pending_linkage: false
                        balance_types:
                          - booked
                          - available
                        transaction_fields:
                          - value_date
                          - counterparty_name
                          - counterparty_iban
                          - remittance
                          - bank_transaction_code
                          - bank_reference
                          - balance_after
                        sign_in: redirect
                        requires_end_user_email: true
                        corporate_accounts: true
                        bank_account_selection: false
                        separate_history_consent: false
                        reconfirmation: false
                        sync_frequency_hours: null
                        health: operational
                    next_cursor: null
        '400':
          description: >-
            Un parámetro no es válido, o `country` no es un país que Bank Link
            admita. `field` indica cuál.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Invalid cursor:
                  summary: Cursor no válido
                  value:
                    code: invalid_cursor
                    message: The cursor or page token is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: cursor
                    next_action: null
                    retry_after: null
                Invalid request:
                  summary: Solicitud no válida
                  value:
                    code: invalid_request
                    message: The request is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: limit
                    next_action: null
                    retry_after: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '429':
          $ref: '#/components/responses/RateLimitedRead'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl
            'https://verification.didit.me/v3/bank/institutions/?country=ESP&segment=business&access=ongoing'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.bank.list_institutions()
            print(result)
        - lang: javascript
          label: Node.js
          source: |-
            import Didit from "@didit-protocol/sdk-node";

            // Reads DIDIT_API_KEY.
            const didit = new Didit();

            const result = await didit.bank.listInstitutions();
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.ListInstitutions(ctx, didit.BankListInstitutionsParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)"
        - lang: java
          label: Java
          source: |-
            import me.didit.Didit;

            // Reads DIDIT_API_KEY.
            Didit client = new Didit();

            var result = client.bank().listInstitutions();
            System.out.println(result);
        - lang: php
          label: PHP
          source: |-
            <?php

            require 'vendor/autoload.php';

            use Didit\DiditClient;

            // Reads DIDIT_API_KEY.
            $didit = new DiditClient();

            $result = $didit->bank->listInstitutions();
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

            # Reads DIDIT_API_KEY.
            didit = Didit::Client.new

            result = didit.bank.list_institutions
            puts result.to_h
        - lang: csharp
          label: .NET
          source: |-
            using System;
            using System.Text.Json;
            using Didit;

            // Reads DIDIT_API_KEY.
            using var client = new DiditClient();

            var result = await client.Bank.ListInstitutionsAsync();
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankInstitutionList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BankInstitution'
        next_cursor:
          type: string
          nullable: true
      required:
        - items
        - next_cursor
    BankDataError:
      type: object
      description: >-
        Cuerpo de error de cada operación de datos bancarios. Todos los campos
        están siempre presentes.
      properties:
        code:
          type: string
          enum:
            - ongoing_access_not_available
            - segment_not_available
            - window_not_available
            - history_window_ambiguous
            - redirect_url_not_registered
            - link_origin_not_allowed
            - bank_data_access_denied
            - connection_not_active
            - consent_expired
            - renewal_not_needed
            - renewal_window_expired
            - access_removed
            - refresh_limit_reached
            - cursor_expired
            - page_expired
            - invalid_cursor
            - page_token_mismatch
            - contract_rate_missing
            - insufficient_credits
            - invalid_request
            - not_found
            - internal_error
          description: >-
            Código de error legible por máquina. Decide según este valor, nunca
            según `message`.
        message:
          type: string
          description: >-
            Explicación en lenguaje sencillo para un desarrollador. La redacción
            puede cambiar; no la analices.
        request_id:
          type: string
          description: >-
            Identificador de esta solicitud. Cítalo cuando contactes con
            soporte.
        field:
          type: string
          description: >-
            El campo de la solicitud que hay que corregir, cuando el error se
            refiere a un solo campo. En caso contrario, `null`.
          nullable: true
        next_action:
          type: string
          enum:
            - retry_later
            - renew_connection
            - create_link
            - restart_from_cursor
            - restart_read
            - top_up_balance
            - enable_bank_data_access
            - contact_support
            - null
          description: >-
            Qué hacer a continuación, para que un cliente pueda actuar sin
            adivinar. `null` cuando no hay un siguiente paso estándar.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Segundos que esperar antes de reintentar. Se establece en errores de
            límite de solicitudes y errores temporales; en otros casos, `null`.
          nullable: true
      required:
        - code
        - message
        - request_id
        - field
        - next_action
        - retry_after
      example:
        code: ongoing_access_not_available
        message: >-
          This bank cannot keep access open. Use access one_time or choose
          another bank.
        request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
        field: institution_id
        next_action: create_link
        retry_after: null
    BankInstitution:
      type: object
      description: >-
        Un banco y lo que admite. Los valores proceden de datos de capacidades
        observados y se actualizan a diario; un valor nunca observado es `null`,
        no una suposición.
      properties:
        id:
          type: string
          description: Identificador del banco en Didit, un slug estable.
          example: es-banco-norte
        name:
          type: string
        country:
          type: string
          pattern: ^[A-Z]{3}$
        logo_url:
          type: string
          format: uri
          nullable: true
        timezone:
          type: string
          description: Zona horaria IANA en la que están las fechas del banco.
          nullable: true
        segments:
          type: array
          items:
            type: string
            enum:
              - personal
              - business
        access:
          type: array
          items:
            type: string
            enum:
              - one_time
              - ongoing
          description: >-
            `ongoing` solo aparece en los bancos donde el acceso continuo está
            activado.
        ongoing_access:
          type: boolean
          description: Si el acceso continuo está disponible en este banco.
        consent_days_max:
          type: integer
          description: >-
            El consentimiento más largo que permite el banco, en días. `null`
            cuando no se ha observado.
          nullable: true
        history_days_max:
          type: integer
          description: >-
            El historial más extenso que entrega el banco, en días. `null`
            cuando no se ha observado.
          nullable: true
        pending_transactions:
          type: boolean
          nullable: true
          description: Si el banco informa de las transacciones pendientes.
        pending_linkage:
          type: boolean
          nullable: true
          description: >-
            Si el banco vincula una transacción pendiente con su transacción
            contabilizada, lo que determina `pending_id`.
        balance_types:
          type: array
          items:
            type: string
            enum:
              - booked
              - available
              - expected
        transaction_fields:
          type: array
          items:
            type: string
          description: >-
            Los campos de transacción que se sabe que el banco envía. Todos los
            demás campos son `null`.
        sign_in:
          type: string
          enum:
            - redirect
            - app_approval
            - credentials
            - null
          description: Cómo inicia sesión la persona en el banco.
          nullable: true
        requires_end_user_email:
          type: boolean
          nullable: true
          description: >-
            Si Bank Link requiere una dirección de correo electrónico verificada
            de la persona.
        corporate_accounts:
          type: boolean
          nullable: true
          description: Si se admiten cuentas de empresa.
        bank_account_selection:
          type: boolean
          nullable: true
          description: >-
            Si la persona elige las cuentas en el banco en lugar de en Bank
            Link.
        separate_history_consent:
          type: boolean
          nullable: true
          description: >-
            Si el banco pide una confirmación adicional para liberar el
            historial más antiguo.
        reconfirmation:
          type: boolean
          nullable: true
          description: >-
            Si una renovación puede reconfirmarse en la pantalla de Didit sin
            iniciar sesión en el banco.
        sync_frequency_hours:
          type: integer
          description: >-
            Horas entre sincronizaciones automáticas cuando el banco permite una
            frecuencia mayor. `null` significa el valor diario por defecto.
          nullable: true
        health:
          type: string
          enum:
            - operational
            - degraded
            - down
      required:
        - id
        - name
        - country
        - logo_url
        - timezone
        - segments
        - access
        - ongoing_access
        - consent_days_max
        - history_days_max
        - pending_transactions
        - pending_linkage
        - balance_types
        - transaction_fields
        - sign_in
        - requires_end_user_email
        - corporate_accounts
        - bank_account_selection
        - separate_history_consent
        - reconfirmation
        - sync_frequency_hours
        - health
    RateLimitBudgetError:
      type: object
      description: >-
        Se devuelve solo en un rechazo del middleware por exceder el límite de
        solicitudes. Otros errores 429, incluidos los conflictos de idempotencia
        y los límites específicos de cada endpoint, no garantizan estos campos
        de metadatos.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Mensaje de rechazo por presupuesto existente y legible para humanos.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Referencia de soporte opaca: RL- seguido de 32 caracteres
            hexadecimales en minúscula de un UUID.
        limit:
          type: integer
          description: Presupuesto del ámbito superado; es igual a X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: >-
            Presupuesto restante, ajustado a cero; es igual a
            X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: >-
            Hora de reinicio de la ventana en segundos Unix; es igual a
            X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Duración de la ventana fija en segundos, no el tiempo restante de
            espera. Respete Retry-After antes de reintentar.
      example:
        detail: >-
          Write request rate limit exceeded. You can make up to 300 requests per
          minute.
        reference: RL-00000000000040008000000000000001
        limit: 300
        remaining: 0
        reset: 1794358860
        window_seconds: 60
  responses:
    Unauthorized:
      description: No autorizado
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Clave de API no válida
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        La clave de API no tiene el permiso de datos bancarios (`bank-data`) o,
        para datos bancarios sin procesar en una aplicación de producción, el
        ajuste de la aplicación "Bank data in the API" está desactivado. Los
        datos bancarios no forman parte del acceso completo: una clave con
        acceso completo, una clave restringida a otros recursos y una solicitud
        autenticada sin clave de API (credenciales de cliente, sobre datos sin
        procesar) se rechazan todas con este cuerpo, así que crea una clave y
        concédela explícitamente. El rechazo se produce antes de cualquier
        búsqueda, por lo que no indica si un objeto existe.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Datos bancarios no permitidos
              value:
                code: bank_data_access_denied
                message: >-
                  Bank data calls need an API key that carries the Bank data
                  permission.
                request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                field: null
                next_action: enable_bank_data_access
                retry_after: null
    RateLimitedRead:
      description: >-
        Se superó el presupuesto de lectura del middleware. Respete el
        encabezado Retry-After antes de reintentar.
      headers:
        Retry-After:
          $ref: '#/components/headers/BudgetRetryAfter'
        X-RateLimit-Scope:
          $ref: '#/components/headers/BudgetXRateLimitScope'
        X-RateLimit-Limit:
          $ref: '#/components/headers/BudgetXRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/BudgetXRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/BudgetXRateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          example:
            detail: >-
              GET request rate limit exceeded. You can make up to 600 requests
              per minute.
            reference: RL-00000000000040008000000000000001
            limit: 600
            remaining: 0
            reset: 1794358860
            window_seconds: 60
    BankDataInternalError:
      description: >-
        Algo ha fallado por parte de Didit. Cualquier error inesperado en
        `/v3/bank/` responde con el formato de error de Bank, nunca con una
        página HTML: incluye `request_id` en tu consulta al soporte.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Un error inesperado
              value:
                code: internal_error
                message: >-
                  Something went wrong on our side. Quote the request_id to
                  support.
                request_id: 3f6a1c8e92b54d07a1e38c4b7f0d2e59
                field: null
                next_action: contact_support
                retry_after: null
  headers:
    BudgetRetryAfter:
      description: >-
        Segundos de espera, redondeados al alza hasta la siguiente ventana.
        Presente en los rechazos por cuota del middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        El ámbito cuya cuota se superó. Presente en los rechazos por cuota del
        middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Presupuesto del ámbito superado; es igual al límite del cuerpo. Presente
        en los rechazos por presupuesto del middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Presupuesto restante, ajustado a cero; es igual a remaining del cuerpo.
        Está presente en los rechazos por presupuesto del middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Tiempo de reinicio en segundos Unix; es igual a reset del cuerpo.
        Presente en los rechazos por cuota del middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clave de API de tu aplicación, desde Developers -> API keys en la
        Business Console. La clave principal tiene acceso completo. Una clave
        con nombre puede tener permisos limitados: ninguno, lectura o escritura
        por recurso, restringida a algunos flujos o solo a sesiones aprobadas, a
        una lista de direcciones IP y a una fecha de caducidad. 401 significa
        que la clave es incorrecta, está revocada o ha caducado; 403 significa
        que no se envió ninguna clave, que la clave no tiene acceso a este
        recurso o acción, o que la solicitud procede de una dirección fuera de
        su lista de IP; 404 en una ruta de sesión significa que la sesión está
        fuera de los flujos o estados de la clave. Una clave sin acceso a
        contenido multimedia recibe las URL de imágenes, vídeos y PDF como null,
        y una clave sin permiso de escritura en sesiones recibe los enlaces y
        tokens de sesión como null. Consulta
        https://docs.didit.me/console/api-keys.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.