> ## 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 per ottenere una banca: un singolo istituto e le sue funzionalità

> L'endpoint di Didit per ottenere un istituto restituisce la banca con le sue funzionalità e il suo stato.

L'endpoint "Get an Institution" di Didit restituisce una singola banca con le sue funzionalità e il suo stato.
Un valore mai osservato è `null`, non una supposizione.


## OpenAPI

````yaml it/openapi-25.json GET /v3/bank/institutions/{id}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API di verifica dell'identità. Autenticati con l'header x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, connessioni, conti, saldi, transazioni, istituti e copertura. I
      dati bancari sono disponibili per le applicazioni sandbox. Le chiamate di
      un'applicazione in produzione restituiscono `404` finché l'accesso di
      produzione non viene annunciato. Nel sandbox non viene addebitato nulla.
      Una chiamata effettuata con una chiave API richiede una chiave che abbia
      l'autorizzazione dati bancari (`bank-data`): lettura per le letture,
      scrittura per le operazioni che modificano qualcosa. Il controllo del
      conto fa eccezione: richiede accesso in scrittura alle sessioni, oppure
      accesso completo, e non l'autorizzazione dati bancari. I dati bancari non
      fanno parte dell'accesso completo: una chiave con accesso completo viene
      rifiutata e la chiamata risponde `403 bank_data_access_denied` finché non
      crei una chiave che abbia l'autorizzazione. I dati bancari grezzi (conti,
      saldi, transazioni e flusso delle modifiche) rifiutano anche una richiesta
      che non contiene una chiave API.


      Ogni rifiuto sotto `/v3/bank/`, eccetto quello del controllo del conto, ha
      lo stesso corpo JSON (`code`, `message`, `request_id`, `field`,
      `next_action`, `retry_after`). Un percorso che non è un'operazione, un ID
      che non è un UUID o una sotto-risorsa sconosciuta risponde `404 not_found`
      per ogni metodo, e qualsiasi errore imprevisto risponde `500
      internal_error` con un `request_id`. Dove i dati bancari non sono
      disponibili, ogni operazione risponde con il `404` standard della
      piattaforma, esattamente come fa un percorso sconosciuto.
paths:
  /v3/bank/institutions/{id}/:
    get:
      tags:
        - Bank Data
      summary: Ottieni un istituto
      description: >-
        Restituisce una banca con le sue funzionalità. L'id è lo slug di Didit,
        come elencato da `list_institutions`.


        Richiede una chiave API con l'autorizzazione Bank data (`bank-data`):
        lettura per questa operazione. Una chiave con accesso completo non la
        include: concedila esplicitamente quando crei la chiave, altrimenti la
        chiamata risponde `403 bank_data_access_denied`.
      operationId: getBankInstitution
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: L'ID dell'istituto, per esempio `es-banco-norte`.
      responses:
        '200':
          description: La banca.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankInstitution'
              examples:
                Spanish bank:
                  summary: Una banca spagnola che offre accesso continuo
                  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: La risorsa non esiste in questa applicazione e in questo ambiente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: Non trovato
                  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: >-
        Una banca e le funzionalità che supporta. I valori provengono da dati
        sulle capacità osservati, aggiornati ogni giorno; un valore mai
        osservato è `null`, non una supposizione.
      properties:
        id:
          type: string
          description: Identificatore Didit della banca, uno slug stabile.
          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 orario IANA in cui sono espresse le date della banca.
          nullable: true
        segments:
          type: array
          items:
            type: string
            enum:
              - personal
              - business
        access:
          type: array
          items:
            type: string
            enum:
              - one_time
              - ongoing
          description: >-
            `ongoing` è elencato solo dove l'accesso continuo è attivo per la
            banca.
        ongoing_access:
          type: boolean
          description: Se l'accesso continuo è disponibile presso questa banca.
        consent_days_max:
          type: integer
          description: >-
            Il consenso più lungo consentito dalla banca, in giorni. `null` se
            non rilevato.
          nullable: true
        history_days_max:
          type: integer
          description: >-
            Il periodo storico più ampio che la banca fornisce, in giorni.
            `null` se non rilevato.
          nullable: true
        pending_transactions:
          type: boolean
          nullable: true
          description: Se la banca riporta le transazioni in sospeso.
        pending_linkage:
          type: boolean
          nullable: true
          description: >-
            Se la banca collega una transazione in sospeso alla transazione
            contabilizzata, cosa che imposta `pending_id`.
        balance_types:
          type: array
          items:
            type: string
            enum:
              - booked
              - available
              - expected
        transaction_fields:
          type: array
          items:
            type: string
          description: >-
            I campi della transazione che, a quanto risulta, la banca invia.
            Ogni altro campo è `null`.
        sign_in:
          type: string
          enum:
            - redirect
            - app_approval
            - credentials
            - null
          description: Come la persona accede alla banca.
          nullable: true
        requires_end_user_email:
          type: boolean
          nullable: true
          description: Se Bank Link richiede alla persona un indirizzo email verificato.
        corporate_accounts:
          type: boolean
          nullable: true
          description: Se sono supportati i conti aziendali.
        bank_account_selection:
          type: boolean
          nullable: true
          description: Se la persona sceglie i conti presso la banca anziché in Bank Link.
        separate_history_consent:
          type: boolean
          nullable: true
          description: >-
            Se la banca chiede un'ulteriore conferma per sbloccare la cronologia
            più vecchia.
        reconfirmation:
          type: boolean
          nullable: true
          description: >-
            Se un rinnovo può essere riconfermato sulla schermata di Didit senza
            un accesso alla banca.
        sync_frequency_hours:
          type: integer
          description: >-
            Ore tra una sincronizzazione automatica e l'altra, dove la banca
            consente una cadenza più frequente. `null` indica il valore
            giornaliero predefinito.
          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 dell'errore di ogni operazione Bank data. Ogni campo è sempre
        presente.
      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: >-
            Codice di errore leggibile dalla macchina. Usalo per la diramazione
            della logica, mai `message`.
        message:
          type: string
          description: >-
            Spiegazione in linguaggio semplice per uno sviluppatore. Il testo
            può cambiare; non analizzarlo.
        request_id:
          type: string
          description: >-
            Identificativo di questa richiesta. Citalo quando contatti il
            supporto.
        field:
          type: string
          description: >-
            Il campo della richiesta da correggere, quando l'errore riguarda un
            solo campo. Altrimenti `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: >-
            Cosa fare dopo, così un client può agire senza fare supposizioni.
            `null` quando non esiste un passaggio successivo standard.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Secondi da attendere prima di riprovare. Impostato in caso di limite
            di frequenza ed errori temporanei, altrimenti `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: >-
        Restituito solo per un rifiuto del budget del middleware del limite di
        frequenza. Altri errori 429, inclusi i conflitti di idempotenza e i
        limiti specifici dell'endpoint, non garantiscono questi campi di
        metadati.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Messaggio di rifiuto per budget leggibile, già esistente.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Riferimento di supporto opaco: RL- seguito da 32 caratteri
            esadecimali minuscoli di un UUID.
        limit:
          type: integer
          description: Budget per l'ambito superato; equivale a X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: Budget residuo, limitato a zero; equivale a X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: >-
            Orario di reset della finestra in secondi Unix; coincide con
            X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Durata della finestra fissa in secondi, non il tempo di attesa
            residuo. Rispetta Retry-After prima di riprovare.
      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: Non autorizzato
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Chiave API non valida
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        La chiave API non ha l'autorizzazione Bank data (`bank-data`) oppure,
        per i dati bancari grezzi in un'applicazione live, l'impostazione
        dell'applicazione "Bank data in the API" è disattivata. I dati bancari
        non fanno parte dell'accesso completo: una chiave con accesso completo,
        una chiave limitata ad altre risorse e una richiesta autenticata senza
        chiave API (client credentials, sui dati grezzi) vengono tutte rifiutate
        con questo messaggio, quindi crea una chiave e concedi l'autorizzazione
        in modo esplicito. Il rifiuto avviene prima di qualsiasi ricerca, quindi
        non dice nulla sull'esistenza di un oggetto.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Accesso ai dati bancari non consentito
              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: >-
        Budget di lettura del middleware superato. Rispetta Retry-After prima di
        riprovare.
      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: >-
        Si è verificato un problema lato Didit. Qualsiasi errore imprevisto
        sotto `/v3/bank/` risponde nel formato di errore Bank, mai con una
        pagina HTML: indica `request_id` al supporto.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Un errore imprevisto
              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: >-
        Secondi di attesa, arrotondati alla finestra successiva. Presente nei
        rifiuti per budget del middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        L'ambito il cui budget è stato superato. Presente nei rifiuti per budget
        del middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Budget per l'ambito superato; equivale al limite nel corpo. Presente nei
        rifiuti per budget del middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Budget residuo, limitato a zero; equivale a remaining nel corpo.
        Presente nei rifiuti per budget del middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Orario di reset in secondi Unix; coincide con il reset nel corpo.
        Presente nei rifiuti per budget del middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La chiave API della tua applicazione, da Developers -> API keys nella
        Business Console. La chiave primaria ha accesso completo. Una chiave con
        nome può avere ambiti limitati: nessuno, lettura o scrittura per
        risorsa, limitata ad alcuni workflow o solo alle sessioni approvate, a
        un elenco di indirizzi IP e a una data di scadenza. 401 significa che la
        chiave è errata, revocata o scaduta; 403 significa che non è stata
        inviata alcuna chiave, che la chiave non ha accesso a questa risorsa o
        azione, oppure che la richiesta proviene da un indirizzo esterno alla
        sua lista IP; 404 su una route di sessione significa che la sessione è
        al di fuori dei workflow o degli stati consentiti alla chiave. Una
        chiave senza accesso ai media riceve gli URL di immagini, video e PDF
        come null, e una chiave senza permesso di scrittura sulle sessioni
        riceve i link e i token delle sessioni come null. Vedi
        https://docs.didit.me/console/api-keys.

````

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