> ## 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 obter um banco: uma instituição e suas capacidades

> O endpoint de obtenção de instituição da Didit retorna um banco com suas capacidades e seu status.

O endpoint Get an Institution da Didit retorna um banco com suas capacidades e seu status.
Um valor que nunca foi observado é `null`, não uma suposição.


## OpenAPI

````yaml pt-br/openapi-25.json GET /v3/bank/institutions/{id}/
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, conexões, contas, saldos, transações, instituições e cobertura.
      Os dados bancários estão disponíveis para aplicações do sandbox. As
      chamadas de uma aplicação em produção respondem `404` até que o acesso em
      produção seja anunciado. Nada é cobrado no sandbox. Uma chamada feita com
      chave de API exige uma chave que tenha a permissão de dados bancários
      (`bank-data`): leitura para consultas e escrita para operações que alteram
      algo. A verificação de conta é a exceção: ela exige acesso de escrita a
      sessões, ou acesso total, e não a permissão de dados bancários.


      Os dados bancários não fazem parte do acesso total: uma chave com acesso
      total é recusada, e a chamada responde `403 bank_data_access_denied` até
      que você crie uma chave que tenha a permissão. Os dados brutos do banco
      (contas, saldos, transações e o feed de alterações) também recusam uma
      requisição sem chave de API.


      Toda recusa em `/v3/bank/`, exceto a da verificação de conta, tem 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 subrecurso desconhecido responde `404 not_found` para todos os
      métodos, e qualquer erro inesperado responde `500 internal_error` com um
      `request_id`. Quando os dados bancários não estão disponíveis, toda
      operação responde o `404` padrão da plataforma, exatamente como ocorre com
      uma rota desconhecida.
paths:
  /v3/bank/institutions/{id}/:
    get:
      tags:
        - Bank Data
      summary: Obter uma instituição
      description: >-
        Retorna um banco com suas capacidades. O id é o slug da Didit, conforme
        listado por `list_institutions`.


        Exige 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 inclui essa
        permissão: conceda-a explicitamente ao criar a chave, ou a chamada
        retornará `403 bank_data_access_denied`.
      operationId: getBankInstitution
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: O ID da instituição, por exemplo `es-banco-norte`.
      responses:
        '200':
          description: O banco.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankInstitution'
              examples:
                Spanish bank:
                  summary: Um banco espanhol que oferece acesso contínuo
                  value:
                    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
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '404':
          description: O recurso não existe nesta aplicação e neste ambiente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: Não encontrado
                  value:
                    code: not_found
                    message: The resource does not exist.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
        '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/es-banco-norte/'
            \
              -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.get_institution(
                "your-id",
            )
            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.getInstitution("your-id");
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.GetInstitution(ctx, \"your-id\")\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().getInstitution("your-id");
            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->getInstitution('your-id');
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.bank.get_institution("your-id")
            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.GetInstitutionAsync("your-id");
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankInstitution:
      type: object
      description: >-
        Um banco e o que ele suporta. Os valores vêm de dados de capacidade
        observados, atualizados diariamente; um valor nunca observado é `null`,
        não um palpite.
      properties:
        id:
          type: string
          description: Identificador do banco na Didit, 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 das 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` aparece na lista apenas 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 histórico mais profundo que o banco entrega, em dias. `null`
            quando não foi observado.
          nullable: true
        pending_transactions:
          type: boolean
          nullable: true
          description: Se o banco informa transações pendentes.
        pending_linkage:
          type: boolean
          nullable: true
          description: >-
            Se o banco vincula uma transação pendente à transação lançada, 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 da transação que se sabe que o banco envia. Todos os
            outros campos são `null`.
        sign_in:
          type: string
          enum:
            - redirect
            - app_approval
            - credentials
            - null
          description: Como a pessoa faz login no banco.
          nullable: true
        requires_end_user_email:
          type: boolean
          nullable: true
          description: Se o Bank Link exige um endereço de e-mail verificado para a pessoa.
        corporate_accounts:
          type: boolean
          nullable: true
          description: Se 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 liberar o histórico mais
            antigo.
        reconfirmation:
          type: boolean
          nullable: true
          description: >-
            Se uma renovação pode ser reconfirmada na tela da Didit sem um login
            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 o padrão diário.
          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
    BankDataError:
      type: object
      description: >-
        Corpo de erro de toda operação 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. Decida o fluxo com base neste
            valor, nunca em `message`.
        message:
          type: string
          description: >-
            Explicação em linguagem simples para o desenvolvedor. O texto pode
            mudar; não o processe.
        request_id:
          type: string
          description: >-
            Identificador desta requisição. Informe-o ao entrar em contato com o
            suporte.
        field:
          type: string
          description: >-
            O campo da requisição a ser corrigido, quando o erro se refere a um
            único 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 em seguida, para que um cliente possa agir sem
            adivinhar. `null` quando não há uma próxima etapa padrão.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Segundos a aguardar antes de tentar novamente. Definido em erros de
            limite de requisições 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
    RateLimitBudgetError:
      type: object
      description: >-
        Retornado somente em uma recusa de orçamento de limite de requisições do
        middleware. Outros erros 429, incluindo conflitos de idempotência e
        limites específicos de endpoint, não garantem esses 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 minúsculos de um UUID.
        limit:
          type: integer
          description: Orçamento do escopo 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: >-
            Horário de redefiniçã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 restante de espera.
            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,
        para dados brutos do banco em uma aplicação em produção, a configuração
        da aplicação "Bank data in the API" está desativada. Dados bancários não
        fazem parte do acesso total: uma chave com acesso total, uma chave
        restrita a outros recursos e uma requisição autenticada sem chave de API
        (credenciais de cliente, para dados brutos) são todas recusadas com este
        corpo, então crie uma chave e conceda a permissão explicitamente. A
        recusa acontece antes de qualquer busca, então ela não informa se um
        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: >-
        Limite de leitura do middleware excedido. Respeite o 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 deu errado do lado da Didit. Qualquer erro inesperado em
        `/v3/bank/` responde no formato de erro Bank, nunca com uma página HTML:
        informe 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 para cima até a próxima janela.
        Presente nas recusas de orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        O escopo cujo orçamento foi excedido. Presente nas recusas de orçamento
        do middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Orçamento do escopo excedido; igual ao limite do corpo. Presente nas
        recusas de orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Orçamento restante, limitado a zero; igual a remaining no corpo.
        Presente nas recusas de orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Horário da redefinição em segundos Unix; igual à redefinição 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 no
        Business Console. A chave principal tem acesso completo. Uma chave
        nomeada pode ter escopo limitado: nenhum, leitura ou escrita por
        recurso, restrita a alguns fluxos ou a sessões aprovadas, a uma lista de
        endereços e a uma data de validade. 401 significa que a chave está
        incorreta, revogada ou expirada; 403 significa que nenhuma chave foi
        enviada, que a chave não tem acesso a este recurso ou ação, ou que a
        requisição partiu de um endereço fora da lista de endereços da chave;
        404 em uma rota de sessão significa que a sessão está fora dos fluxos ou
        status permitidos para a chave. Uma chave sem acesso a mídia recebe as
        URLs de imagem, vídeo e PDF como null, e uma chave sem escrita de
        sessões recebe os links e tokens de sessão como null. Veja
        https://docs.didit.me/console/api-keys.

````

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