> ## 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 Listar Bancos: Instituições e Capacidades

> A Didit devolve os bancos por país, com o que cada um suporta: segmentos, acesso contínuo, duração do consentimento e campos disponíveis.

O endpoint List Institutions da Didit devolve os bancos por país, com indicação do que cada um suporta: segmentos, acesso contínuo, duração do consentimento, profundidade do histórico e os campos que envia.
Filtre por `country`, `segment`, `access` e `q`.
Consulte [Cobertura bancária](https://docs.didit.me/pt/core-technology/bank-verification/coverage.md).


## OpenAPI

````yaml pt/openapi-25.json GET /v3/bank/institutions/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, ligações, contas, saldos, transações, instituições e cobertura.
      Os dados bancários estão disponíveis para aplicações sandbox. As chamadas
      de uma aplicação de produção respondem com `404` até ao acesso em produção
      ser anunciado. Nada é cobrado no sandbox. Uma chamada feita com uma chave
      de API precisa de uma chave que tenha a permissão de dados bancários
      (`bank-data`): leitura para as leituras, escrita para as operações que
      alteram algo. A verificação de conta é a exceção: precisa de acesso de
      escrita a sessões, ou de acesso total, e não da permissão de dados
      bancários. Os dados bancários não fazem parte do acesso total: uma chave
      de acesso total é recusada, e a chamada responde com `403
      bank_data_access_denied` até criar uma chave que tenha a permissão. Os
      dados bancários em bruto (contas, saldos, transações e o feed de
      alterações) também recusam um pedido que não traga uma chave de API.


      Todas as recusas em `/v3/bank/`, exceto as da verificação de conta, têm o
      mesmo corpo JSON (`code`, `message`, `request_id`, `field`, `next_action`,
      `retry_after`). Um caminho que não é uma operação, um ID que não é um UUID
      ou um sub-recurso desconhecido responde com `404 not_found` em todos os
      métodos, e qualquer erro inesperado responde com `500 internal_error` com
      um `request_id`. Quando os dados bancários não estão disponíveis, todas as
      operações respondem com o `404` padrão da plataforma, exatamente como uma
      rota desconhecida.
paths:
  /v3/bank/institutions/:
    get:
      tags:
        - Bank Data
      summary: Listar instituições
      description: >-
        Lista os bancos por país com as respetivas capacidades: segmentos, modos
        de acesso, o consentimento mais longo e o maior histórico que o banco
        oferece, se reporta transações pendentes, que campos de transação se
        sabe que envia e como a pessoa inicia sessão. Os valores provêm de dados
        observados e são atualizados diariamente; um valor que nunca tenha sido
        observado é `null`. Estes mesmos dados alimentam o seletor de bancos,
        pelo que pode consultá-los para saber o que esperar antes de criar uma
        ligação. `access` lista `ongoing` apenas quando o acesso contínuo está
        disponível.


        Precisa de uma chave de API com a permissão Dados bancários
        (`bank-data`): leitura para esta operação. Uma chave com acesso total
        não a inclui: conceda-a explicitamente ao criar a chave, ou a chamada
        responde `403 bank_data_access_denied`.


        A lista está ordenada por nome e, depois, por id.


        Numa aplicação de sandbox, a lista inclui o Didit Test Bank, um por cada
        país servido pelo Bank Link, e nenhum banco real.
      operationId: listBankInstitutions
      parameters:
        - name: country
          in: query
          required: false
          schema:
            type: string
            pattern: ^[A-Z]{3}$
          description: >-
            Apenas bancos deste país, um código ISO 3166-1 alpha-3. Um país que
            o Bank Link não serve responde com `400 invalid_request` e `field:
            country`.
        - name: segment
          in: query
          required: false
          schema:
            type: string
            enum:
              - personal
              - business
          description: Apenas bancos que servem este segmento.
        - name: access
          in: query
          required: false
          schema:
            type: string
            enum:
              - one_time
              - ongoing
          description: Apenas bancos que oferecem este modo de acesso.
        - name: q
          in: query
          required: false
          schema:
            type: string
            maxLength: 100
          description: >-
            Pesquisa por nome ou id, sem distinção entre maiúsculas e
            minúsculas.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: Tamanho da página, de 1 a 500. Predefinição 100.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Cursor opaco do `next_cursor` da página anterior.
      responses:
        '200':
          description: Uma página de bancos.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankInstitutionList'
              examples:
                Spain, ongoing access:
                  summary: Um banco espanhol que oferece acesso contínuo
                  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: >-
            Um parâmetro é inválido, ou `country` não é um país servido pelo
            Bank Link. `field` indica qual.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Invalid cursor:
                  summary: Cursor invá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: Pedido inválido
                  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: >-
        Corpo de erro de todas as operações de Dados bancários. Todos os campos
        estão sempre 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 erro legível por máquina. Baseie as decisões neste valor,
            nunca em `message`.
        message:
          type: string
          description: >-
            Explicação em linguagem simples para um programador. A redação pode
            mudar; não a analise.
        request_id:
          type: string
          description: Identificador deste pedido. Indique-o quando contactar o suporte.
        field:
          type: string
          description: >-
            O campo do pedido a corrigir, quando o erro diz respeito a um campo.
            Caso contrário, `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: >-
            O que fazer a seguir, para que um cliente possa agir sem adivinhar.
            `null` quando não há um passo seguinte padrão.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Segundos a aguardar antes de tentar novamente. Definido em erros de
            limite de pedidos e erros temporários; caso contrário, `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: >-
        Um banco e o que suporta. Os valores provêm de dados de capacidade
        observados, atualizados diariamente; um valor nunca observado é `null`,
        e não uma estimativa.
      properties:
        id:
          type: string
          description: Identificador da Didit do banco, um slug estável.
          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: Fuso horário IANA em que estão as datas do banco.
          nullable: true
        segments:
          type: array
          items:
            type: string
            enum:
              - personal
              - business
        access:
          type: array
          items:
            type: string
            enum:
              - one_time
              - ongoing
          description: >-
            `ongoing` só é listado onde o acesso contínuo está ativado para o
            banco.
        ongoing_access:
          type: boolean
          description: Se o acesso contínuo está disponível neste banco.
        consent_days_max:
          type: integer
          description: >-
            O consentimento mais longo que o banco permite, em dias. `null`
            quando não foi observado.
          nullable: true
        history_days_max:
          type: integer
          description: >-
            O período histórico mais extenso que o banco disponibiliza, em dias.
            `null` quando não foi observado.
          nullable: true
        pending_transactions:
          type: boolean
          nullable: true
          description: Se o banco reporta transações pendentes.
        pending_linkage:
          type: boolean
          nullable: true
          description: >-
            Se o banco associa uma transação pendente à transação contabilizada,
            o que define `pending_id`.
        balance_types:
          type: array
          items:
            type: string
            enum:
              - booked
              - available
              - expected
        transaction_fields:
          type: array
          items:
            type: string
          description: >-
            Os campos de transação que o banco é conhecido por enviar. Todos os
            outros campos são `null`.
        sign_in:
          type: string
          enum:
            - redirect
            - app_approval
            - credentials
            - null
          description: Como a pessoa inicia sessão no banco.
          nullable: true
        requires_end_user_email:
          type: boolean
          nullable: true
          description: Se a Bank Link exige um endereço de e-mail verificado para a pessoa.
        corporate_accounts:
          type: boolean
          nullable: true
          description: Se as contas empresariais são suportadas.
        bank_account_selection:
          type: boolean
          nullable: true
          description: Se a pessoa escolhe as contas no banco em vez de no Bank Link.
        separate_history_consent:
          type: boolean
          nullable: true
          description: >-
            Se o banco pede mais uma confirmação para libertar o histórico mais
            antigo.
        reconfirmation:
          type: boolean
          nullable: true
          description: >-
            Se uma renovação pode ser reconfirmada no ecrã da Didit sem nova
            autenticação no banco.
        sync_frequency_hours:
          type: integer
          description: >-
            Horas entre sincronizações automáticas, quando o banco permite uma
            cadência mais rápida. `null` significa a predefinição diária.
          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: >-
        Devolvido apenas numa recusa de orçamento de limite de pedidos do
        middleware. Outros erros 429, incluindo conflitos de idempotência e
        limites específicos de cada endpoint, não garantem estes campos de
        metadados.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Mensagem de recusa por orçamento já existente, legível por humanos.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Referência de suporte opaca: RL- seguido de 32 caracteres
            hexadecimais de UUID em minúsculas.
        limit:
          type: integer
          description: Orçamento do âmbito excedido; igual a X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: Orçamento restante, limitado a zero; igual a X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: >-
            Hora de reposição da janela em segundos Unix; é igual a
            X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Duração da janela fixa em segundos, não o tempo de espera restante.
            Respeite Retry-After antes de tentar novamente.
      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: Não autorizado
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Chave de API inválida
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        A chave de API não tem a permissão Dados bancários (`bank-data`) ou, no
        caso de dados bancários em bruto numa aplicação em produção, a definição
        da aplicação "Bank data in the API" está desativada. Os dados bancários
        não fazem parte do acesso total: uma chave com acesso total, uma chave
        restrita a outros recursos e um pedido autenticado sem chave de API
        (credenciais de cliente, para dados em bruto) são todos recusados com
        este corpo de resposta. Crie uma chave e atribua-lhe a permissão
        explicitamente. A recusa acontece antes de qualquer pesquisa, por isso
        não indica se o objeto existe.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Dados bancários não 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: >-
        Orçamento de leitura do middleware excedido. Respeite Retry-After antes
        de tentar novamente.
      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 correu mal do lado da Didit. Qualquer erro inesperado em
        `/v3/bank/` responde no formato de erro do Bank, nunca com uma página
        HTML: indique o `request_id` ao suporte.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Um erro 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 a aguardar, arredondados por excesso para a janela seguinte.
        Presente nas recusas de orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        O âmbito cujo orçamento foi excedido. Presente nas recusas de orçamento
        do middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Orçamento do âmbito excedido; igual ao limite do corpo. Presente nas
        recusas por orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Orçamento restante, limitado a zero; igual a remaining do corpo.
        Presente nas recusas por orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Hora de reposição em segundos Unix; é igual a reset no corpo. Presente
        nas recusas de orçamento do middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        A chave de API da sua aplicação, obtida em Developers -> API keys na
        Business Console. A chave principal tem acesso total. Uma chave com nome
        pode ter o âmbito limitado: nenhum, leitura ou escrita por recurso,
        limitada a alguns fluxos ou apenas a sessões aprovadas, a uma lista de
        endereços IP e a uma data de validade. 401 significa que a chave está
        errada, revogada ou expirada; 403 significa que não foi enviada nenhuma
        chave, que a chave não tem acesso a este recurso ou ação, ou que o
        pedido veio de um endereço fora da sua lista de IP; 404 numa rota de
        sessão significa que a sessão está fora dos fluxos ou estados da chave.
        Uma chave sem acesso a multimédia recebe os URLs de imagem, vídeo e PDF
        como null, e uma chave sem escrita em sessões recebe os links e tokens
        de sessão como null. Consulte https://docs.didit.me/console/api-keys.

````

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