> ## 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 revocare una connessione bancaria: interrompere l'accesso

> L'endpoint Revoke a Bank Connection di Didit interrompe l'accesso alla banca: i recuperi dei dati bancari si fermano nell'istante in cui lo richiedi.

L'endpoint Revoca una connessione bancaria di Didit interrompe l'accesso alla banca, e i recuperi dei dati bancari si fermano nel momento in cui lo richiedi.
Revocare non elimina nulla: per questo usa [eliminare](https://docs.didit.me/it/standalone-apis/bank-connection-delete.md).
Il consenso mostra `revocation_pending`, poi `revoked` quando la banca conferma.


## OpenAPI

````yaml it/openapi-25.json POST /v3/bank/connections/{id}/revoke/
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/connections/{id}/revoke/:
    post:
      tags:
        - Bank Data
      summary: Revoca una connessione bancaria
      description: >-
        Interrompe l'accesso alla banca. Le letture dei dati bancari si fermano
        nel momento in cui lo richiedi, anche mentre la conferma della banca è
        in attesa: il consenso riporta `revocation_pending`, poi `revoked`
        quando la banca conferma che l'accesso è stato terminato, oppure
        `revocation_failed` mentre la chiamata viene ripetuta automaticamente.
        `consent.ended_by` è `customer`.


        La revoca non elimina nulla: conti, saldi e transazioni salvati restano
        leggibili fino a `consent.retain_until`, l'impostazione di conservazione
        della tua applicazione, e non viene addebitato nulla. Per eliminarli
        subito, chiama `delete_connection`. Ripetendo la chiamata ottieni lo
        stato attuale.


        Serve una chiave API con l'autorizzazione Bank data (`bank-data`):
        scrittura per questa operazione, che modifica qualcosa. Una chiave con
        accesso completo non la include: concedila esplicitamente quando crei la
        chiave, altrimenti la chiamata risponde `403 bank_data_access_denied`.


        Revocare una connessione già eliminata risponde `200` con la connessione
        eliminata, quindi ripetere la chiamata è sicuro.
      operationId: revokeBankConnection
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: L'id della connessione.
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '200':
          description: La connessione con lo stato della revoca.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankConnection'
              examples:
                Revocation pending:
                  summary: Richiesta di interruzione dell'accesso
                  value:
                    id: 5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35
                    environment: live
                    access: ongoing
                    status: active
                    status_reason: null
                    institution:
                      id: es-banco-norte
                      name: Banco Norte
                      country: ESP
                      logo_url: https://static.example.com/banks/es-banco-norte.png
                    segment: business
                    data:
                      - accounts
                      - balances
                      - transactions
                    consent:
                      status: revocation_pending
                      version: 1
                      granted_at: '2026-11-21T12:04:11Z'
                      expires_at: '2027-05-20T12:04:11Z'
                      days_granted: 180
                      renewed_count: 0
                      scopes_requested:
                        - accounts
                        - balances
                        - transactions
                      scopes_granted:
                        - accounts
                        - balances
                        - transactions
                      accounts_granted:
                        - a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        - c3d84e19-2a7b-4f60-b5e1-9a0c6d3f8e72
                      renewal_action: bank_auth
                      renew_by: '2027-05-20T12:04:11Z'
                      reconfirm_by: null
                      renewable_until: '2026-12-21T15:10:00Z'
                      retain_until: '2026-12-21T15:10:00Z'
                      ended_at: '2026-11-21T15:10:00Z'
                      ended_by: customer
                    sync:
                      status: ok
                      initial_status: succeeded
                      initial_complete: true
                      history_complete: true
                      last_synced_at: '2026-11-21T12:04:40Z'
                      next_sync_at: '2026-11-22T06:00:00Z'
                      budgets:
                        - scope: connection
                          resource: all
                          limit: 4
                          remaining: 3
                          resets_at: '2026-11-22T00:00:00Z'
                      last_error: null
                      frequency_per_day: 1
                      live_syncs_left_today: 3
                    accounts:
                      - id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        name: Cuenta negocio
                        type: current
                        usage: business
                        currency: EUR
                        iban_last4: '1332'
                        status: open
                      - id: c3d84e19-2a7b-4f60-b5e1-9a0c6d3f8e72
                        name: Cuenta de ahorro
                        type: savings
                        usage: business
                        currency: EUR
                        iban_last4: '7708'
                        status: open
                    ownership:
                      compare: none
                      match: null
                      check_id: null
                      result: null
                    end_user:
                      reference: client-7731
                    manage_url: null
                    billing:
                      unit: connection_month
                      price_usd: '0.9000'
                      billed_through: '2026-11-30'
                    possible_duplicate_of: null
                    erasure: null
                    vendor_data: client-7731
                    created_at: '2026-11-21T12:03:02Z'
                    updated_at: '2026-11-21T12:04:40Z'
        '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/RateLimitedWrite'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X POST
            'https://verification.didit.me/v3/bank/connections/5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35/revoke/'
            \
              -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.revoke_connection(
                "11111111-2222-3333-4444-555555555555",
            )
            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.revokeConnection("11111111-2222-3333-4444-555555555555");

            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.RevokeConnection(ctx, \"11111111-2222-3333-4444-555555555555\", didit.BankRevokeConnectionParams{})\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().revokeConnection("11111111-2222-3333-4444-555555555555");

            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->revokeConnection('11111111-2222-3333-4444-555555555555');

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


            # Reads DIDIT_API_KEY.

            didit = Didit::Client.new


            result =
            didit.bank.revoke_connection("11111111-2222-3333-4444-555555555555")

            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.RevokeConnectionAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Chiave facoltativa per la sicurezza dei nuovi tentativi, da scegliere
        per una singola operazione, fino a 255 caratteri (va bene un UUID). Una
        richiesta ripetuta con la stessa chiave, lo stesso endpoint, la stessa
        query e lo stesso body riceve la prima risposta, con lo stesso status e
        lo stesso body, e non viene eseguita né fatturata una seconda volta. Con
        la stessa chiave ma un altro endpoint, query o body viene restituito
        `409` `idempotency_key_reused`; mentre la prima richiesta è ancora in
        esecuzione, viene restituito `409` `idempotency_key_in_progress` con
        `Retry-After`. Una richiesta non riuscita (qualsiasi `4xx` o `5xx`) non
        viene memorizzata, quindi puoi inviarla di nuovo con la stessa chiave.
        Le chiavi appartengono alla tua applicazione, sia che tu chiami con una
        chiave API sia con un token di accesso. Vedi [Nuovi tentativi e
        idempotenza](/it/integration/api-errors#nuovi-tentativi-e-idempotenza).
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    BankConnection:
      type: object
      description: >-
        Il consenso della persona alla tua applicazione per leggere una banca.
        Un rinnovo mantiene l'id della connessione e tutti gli id dei conti. Una
        connessione eliminata risponde solo con `id`, `status`, `status_reason`,
        `created_at` e `erasure`: tutti gli altri campi sono assenti e non resta
        alcun dato di banca, persona o conto.
      properties:
        id:
          type: string
          description: Identificativo della connessione.
          format: uuid
        environment:
          type: string
          enum:
            - live
            - sandbox
        access:
          type: string
          enum:
            - one_time
            - ongoing
        status:
          type: string
          enum:
            - pending
            - active
            - renewal_required
            - paused
            - revoked
            - deleted
            - failed
          description: >-
            `pending`: la prima sincronizzazione è in corso. `active`: consenso
            valido. `renewal_required`: il consenso è terminato o la banca
            chiede alla persona di accedere di nuovo; i dati restano leggibili
            così come sono stati sincronizzati l'ultima volta e non viene
            addebitato nulla. `paused`: saldo insufficiente per il mese.
            `revoked`: accesso interrotto dalla persona, dalla banca o da te.
            `deleted`: restano solo `id`, `status`, `status_reason`,
            `created_at` ed `erasure`. `failed`: la prima sincronizzazione non è
            mai riuscita.
        status_reason:
          type: string
          enum:
            - collection_complete
            - consent_expired
            - consent_lapsed
            - bank_requires_sign_in
            - revoked_by_end_user
            - revoked_by_bank
            - revoked_by_customer
            - insufficient_balance
            - paused_by_customer
            - first_sync_failed
            - deleted_by_customer
            - retention_elapsed
            - application_deleted
            - null
          description: >-
            Perché la connessione si trova in questo stato. `paused_by_customer`
            è riservato. Per una connessione `deleted`: `deleted_by_customer`,
            `consent_lapsed`, `retention_elapsed` o `application_deleted`.
          nullable: true
        institution:
          $ref: '#/components/schemas/BankInstitutionSummary'
        segment:
          type: string
          enum:
            - personal
            - business
            - null
          nullable: true
        data:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
          description: Gli ambiti accettati dalla persona.
        consent:
          $ref: '#/components/schemas/BankConnectionConsent'
        sync:
          $ref: '#/components/schemas/BankConnectionSync'
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/BankConnectionAccountSummary'
          description: >-
            Riepilogo di ogni conto della connessione. Leggi il conto completo
            con `get_account`.
        ownership:
          $ref: '#/components/schemas/BankConnectionOwnership'
        end_user:
          type: object
          properties:
            reference:
              type: string
              description: Il tuo id per la persona o l'azienda.
              nullable: true
          required:
            - reference
        manage_url:
          type: string
          description: >-
            La pagina di accesso personale della persona. `null` finché la
            pagina di accesso non è disponibile.
          nullable: true
          format: uri
        billing:
          $ref: '#/components/schemas/BankConnectionBilling'
        possible_duplicate_of:
          type: string
          description: >-
            Impostato quando questa connessione potrebbe duplicarne un'altra
            attiva, ma nessun `end_user.reference` ha consentito una
            corrispondenza certa.
          format: uuid
          nullable: true
        erasure:
          allOf:
            - $ref: '#/components/schemas/BankConnectionErasure'
          nullable: true
          description: Impostato dopo `delete_connection`; altrimenti `null`.
        vendor_data:
          type: string
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
        - id
        - status
        - status_reason
        - created_at
        - erasure
    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
    BankInstitutionSummary:
      type: object
      description: La banca a cui si riferisce una connessione o un link.
      properties:
        id:
          type: string
          description: >-
            Identificatore Didit della banca, uno slug stabile. Usalo come
            `institution_id`.
          example: es-banco-norte
        name:
          type: string
          description: Il nome della banca.
          example: Banco Norte
        country:
          type: string
          description: Paese della banca, ISO 3166-1 alpha-3.
          pattern: ^[A-Z]{3}$
          example: ESP
        logo_url:
          type: string
          description: Logo della banca, oppure `null`.
          nullable: true
          format: uri
      required:
        - id
        - name
        - country
        - logo_url
    BankConnectionConsent:
      type: object
      description: Il consenso della persona per questa connessione.
      properties:
        status:
          type: string
          enum:
            - granted
            - expired
            - revocation_pending
            - revoked
            - revocation_failed
          description: >-
            `revocation_pending` finché la banca non conferma che il consenso è
            stato revocato, poi `revoked`. `revocation_failed` viene sottoposto
            automaticamente a un nuovo tentativo. I recuperi dalla banca si
            interrompono nel momento in cui viene richiesta una revoca.
        version:
          type: integer
          description: >-
            Versione del consenso. Un rinnovo crea la versione successiva sulla
            stessa connessione.
        granted_at:
          type: string
          format: date-time
          nullable: true
        expires_at:
          type: string
          description: >-
            Quando termina il consenso della banca. Lo imposta la banca, fino a
            `consent_days`.
          format: date-time
          nullable: true
        days_granted:
          type: integer
          description: Durata del consenso in giorni, così come concessa dalla banca.
          nullable: true
        renewed_count:
          type: integer
          description: Quante volte il consenso è stato rinnovato.
        scopes_requested:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
        scopes_granted:
          type: array
          items:
            type: string
            enum:
              - accounts
              - balances
              - transactions
        accounts_granted:
          type: array
          items:
            type: string
            format: uuid
          description: Identificatori dei conti condivisi dalla persona.
        renewal_action:
          type: string
          enum:
            - reconfirm
            - bank_auth
            - null
          description: >-
            Come avviene un rinnovo: `reconfirm` indica che la persona conferma
            sulla schermata di Didit senza accedere alla banca, dove la banca e
            le norme del paese lo consentono. `bank_auth` indica un accesso alla
            banca.
          nullable: true
        renew_by:
          type: string
          description: 'La scadenza del consenso: rinnova prima per non avere interruzioni.'
          format: date-time
          nullable: true
        reconfirm_by:
          type: string
          description: >-
            Impostato quando `renewal_action` è `reconfirm`: l'ultimo momento
            utile per riconfermare.
          format: date-time
          nullable: true
        renewable_until:
          type: string
          description: >-
            L'ultimo momento in cui la stessa connessione può essere
            ripristinata dopo la fine del consenso. Dopo di esso la persona si
            connette di nuovo. Coincide con `retain_until`.
          format: date-time
          nullable: true
        retain_until:
          type: string
          description: >-
            Impostato al termine dell'accesso: indica per quanto tempo i dati
            memorizzati restano leggibili, secondo l'impostazione di
            conservazione della tua applicazione.
          format: date-time
          nullable: true
        ended_at:
          type: string
          format: date-time
          nullable: true
        ended_by:
          type: string
          enum:
            - end_user
            - bank
            - customer
            - unknown
            - null
          description: >-
            Chi ha terminato l'accesso, indicato in base alle evidenze.
            `unknown` quando né la banca né la sincronizzazione lo indicano.
          nullable: true
      required:
        - status
        - version
        - granted_at
        - expires_at
        - days_granted
        - renewed_count
        - scopes_requested
        - scopes_granted
        - accounts_granted
        - renewal_action
        - renew_by
        - reconfirm_by
        - renewable_until
        - retain_until
        - ended_at
        - ended_by
    BankConnectionSync:
      type: object
      description: Stato di sincronizzazione di una connessione.
      properties:
        status:
          type: string
          enum:
            - pending
            - ok
            - failing
          description: >-
            `failing` dopo 24 ore di tentativi non riusciti, che vengono
            ripetuti con backoff. Una banca che chiede alla persona di accedere
            di nuovo rende invece la connessione `renewal_required`.
        initial_status:
          type: string
          enum:
            - pending
            - succeeded
            - partial
            - failed
          description: >-
            Risultato della prima sincronizzazione. La connessione diventa
            `active` con `succeeded` o `partial`, e `failed` quando nessun conto
            è riuscito.
        initial_complete:
          type: boolean
          description: >-
            `true` solo quando `initial_status` è `succeeded`: conti, saldi e
            transazioni recenti sono leggibili.
        history_complete:
          type: boolean
          description: >-
            `true` quando il recupero della cronologia è terminato, per
            qualsiasi motivo. Gli intervalli che non è stato possibile
            recuperare si trovano in `history_coverage.missing_ranges` di ogni
            conto.
        last_synced_at:
          type: string
          description: >-
            Quando i dati sono stati recuperati l'ultima volta dalla banca, non
            quando li hai letti l'ultima volta.
          format: date-time
          nullable: true
        next_sync_at:
          type: string
          description: >-
            Quando è pianificata la successiva sincronizzazione automatica. La
            sincronizzazione automatica viene eseguita da una a quattro volte al
            giorno a seconda della banca (vedi `frequency_per_day`).
          format: date-time
          nullable: true
        budgets:
          type: array
          items:
            $ref: '#/components/schemas/BankSyncBudget'
          description: I limiti della banca per le letture senza la persona presente.
        last_error:
          allOf:
            - $ref: '#/components/schemas/BankSyncError'
          nullable: true
          description: L'ultimo errore di sincronizzazione, oppure `null`.
        frequency_per_day:
          type: integer
          minimum: 1
          maximum: 4
          description: >-
            Quante volte al giorno viene eseguita la sincronizzazione automatica
            per questa connessione, da una a quattro a seconda della banca. Dove
            la banca consente più letture senza la presenza dell'utente, restano
            sempre almeno due al giorno per le sincronizzazioni live.
        live_syncs_left_today:
          type: integer
          minimum: 0
          description: >-
            Quante sincronizzazioni live (`refresh_connection`) restano oggi nel
            limite della banca: il `remaining` del budget più restrittivo.
            `null` dove la banca non imposta alcun limite. Le sincronizzazioni
            live sono incluse nel prezzo mensile.
          nullable: true
      required:
        - status
        - initial_status
        - initial_complete
        - history_complete
        - last_synced_at
        - next_sync_at
        - budgets
        - last_error
        - frequency_per_day
        - live_syncs_left_today
    BankConnectionAccountSummary:
      type: object
      description: Forma breve di un conto all'interno di una connessione.
      properties:
        id:
          type: string
          description: >-
            ID dell'account. Stabile per tutta la durata della connessione,
            rinnovi inclusi.
          format: uuid
        name:
          type: string
          nullable: true
        type:
          type: string
          enum:
            - current
            - savings
            - card
            - loan
            - investment
            - other
        usage:
          type: string
          enum:
            - personal
            - business
            - unknown
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: Codice valuta ISO 4217.
        iban_last4:
          type: string
          description: Ultimi quattro caratteri dell'IBAN, se il conto ne ha uno.
          nullable: true
        status:
          type: string
          enum:
            - open
            - closed
            - access_removed
      required:
        - id
        - name
        - type
        - usage
        - currency
        - iban_last4
        - status
    BankConnectionOwnership:
      type: object
      description: >-
        Il confronto facoltativo del titolare del conto con una persona o
        un'azienda.
      properties:
        compare:
          type: string
          enum:
            - none
            - person
            - business
        match:
          type: string
          enum:
            - any_holder
            - all_holders
            - null
          nullable: true
        check_id:
          type: string
          description: >-
            Id del risultato dell'assetto proprietario quando è stato richiesto
            un confronto.
          format: uuid
          nullable: true
        result:
          type: string
          enum:
            - match
            - close_match
            - no_match
            - unknown
            - null
          description: >-
            Esito. `unknown` ogni volta che evidenze mancanti sul titolare
            potrebbero cambiarlo, e quando la banca non fornisce informazioni
            sul titolare.
          nullable: true
      required:
        - compare
        - match
        - check_id
        - result
    BankConnectionBilling:
      type: object
      description: Quanto costa questa connessione. La sandbox non viene mai addebitata.
      properties:
        unit:
          type: string
          description: >-
            Unità di fatturazione: `connection_month` per l'accesso continuo,
            `one_time` altrimenti.
          enum:
            - connection_month
            - one_time
        price_usd:
          type: string
          description: >-
            Il tuo prezzo odierno per il contatore mensile, per la tua
            applicazione e il paese, in USD, come stringa decimale con 4
            decimali. Una connessione viene addebitata per un mese solo se ogni
            ambito accettato ha pubblicato dati per almeno un conto in quel
            mese. `null` per le connessioni una tantum e nella sandbox.
            L'accesso continuo viene fatturato per connessione attiva al mese;
            il prezzo attuale è nella pagina dei prezzi
            (https://docs.didit.me/getting-started/pricing). Gli importi negli
            esempi sono indicativi; il prezzo per paese è indicato nella pagina
            dei prezzi.
          pattern: ^-?\d+(\.\d+)?$
          nullable: true
        billed_through:
          type: string
          description: L'ultima chiusura mensile già consolidata.
          format: date
          nullable: true
      required:
        - unit
        - price_usd
        - billed_through
    BankConnectionErasure:
      type: object
      description: Avanzamento di una cancellazione richiesta da te.
      properties:
        status:
          type: string
          enum:
            - pending
            - erased
            - failed
          description: >-
            `pending` mentre l'eliminazione è in corso, `erased` quando non
            restano copie memorizzate né accessi presso la banca, `failed`
            quando non è stata confermata entro 24 ore. Un'eliminazione non
            riuscita mantiene inaccessibili i dati della connessione, viene
            ripetuta e Didit viene avvisato.
        requested_at:
          type: string
          format: date-time
        erased_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Quando è terminata la cancellazione. `null` finché `status` non è
            `erased`.
      required:
        - status
        - requested_at
        - erased_at
    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
    BankSyncBudget:
      type: object
      description: Una quota del limite della banca sui recuperi senza la persona presente.
      properties:
        scope:
          type: string
          enum:
            - connection
            - account
          description: Rispetto a cosa la banca conteggia il budget.
        resource:
          type: string
          enum:
            - all
            - accounts
            - balances
            - transactions
        account_id:
          type: string
          description: Il conto, quando `scope` è `account`.
          format: uuid
          nullable: true
        limit:
          type: integer
          description: >-
            Quante volte al giorno Didit può recuperare dati dalla banca senza
            la presenza della persona, secondo la definizione della banca. È un
            tetto imposto dalla banca, non una garanzia.
        remaining:
          type: integer
          description: >-
            Letture ancora disponibili per i tuoi aggiornamenti nella finestra
            corrente. Le letture riservate alle sincronizzazioni automatiche
            sono già detratte, e una sincronizzazione automatica non usa mai le
            ultime due letture della giornata, quindi restano sempre disponibili
            due aggiornamenti su richiesta.
        resets_at:
          type: string
          description: Quando la finestra si reimposta.
          format: date-time
      required:
        - scope
        - resource
        - limit
        - remaining
        - resets_at
    BankSyncError:
      type: object
      description: Perché una sincronizzazione non è riuscita.
      properties:
        code:
          type: string
          description: Codice di errore Didit.
        message:
          type: string
          description: Spiegazione in linguaggio semplice.
        at:
          type: string
          description: Quando è avvenuto. `null` in un risultato per conto.
          format: date-time
          nullable: true
      required:
        - code
        - message
        - at
  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
    RateLimitedWrite:
      description: >-
        È stato superato il limite condiviso di scrittura di 300 richieste al
        minuto per chiave API. Rispetta `Retry-After` prima di riprovare.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          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
      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'
    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.