> ## 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.

# Revocar una connexió bancària: API per aturar l'accés

> L'endpoint Revocar una connexió bancària de Didit atura l'accés al banc, i les consultes al banc s'aturen en el moment que ho demanes.

L'endpoint de Didit per revocar una connexió bancària atura l'accés al banc, i les consultes al banc s'aturen tan bon punt ho sol·licites.
Revocar no elimina res: per a això, fes servir [eliminar](https://docs.didit.me/ca/standalone-apis/bank-connection-delete.md).
El consentiment mostra `revocation_pending` i, després, `revoked` quan el banc ho confirma.


## OpenAPI

````yaml ca/openapi-25.json POST /v3/bank/connections/{id}/revoke/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificació d'identitat. Autentica't amb la capçalera x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, connexions, comptes, saldos, transaccions, entitats i
      cobertura. Les dades bancàries estan disponibles per a aplicacions en
      sandbox. Les crides d'una aplicació en producció responen `404` fins que
      s'anunciï l'accés en producció. No es cobra res en sandbox. Una crida feta
      amb una clau d'API necessita una clau que tingui el permís Bank data
      (`bank-data`): lectura per a les lectures, escriptura per a les operacions
      que canvien alguna cosa. La comprovació de comptes n'és l'excepció:
      necessita accés d'escriptura a sessions, o accés complet, i no el permís
      Bank data. Bank data no forma part de l'accés complet: una clau amb accés
      complet es rebutja, i la crida respon `403 bank_data_access_denied` fins
      que creïs una clau que tingui el permís. Les dades bancàries en brut
      (comptes, saldos, transaccions i el feed de canvis) també rebutgen una
      sol·licitud que no porti cap clau d'API.


      Cada rebuig sota `/v3/bank/` excepte el de la comprovació de comptes té el
      mateix cos JSON (`code`, `message`, `request_id`, `field`, `next_action`,
      `retry_after`). Un camí que no és una operació, un identificador que no és
      un UUID o un subrecurs desconegut respon `404 not_found` per a qualsevol
      mètode, i qualsevol error inesperat respon `500 internal_error` amb un
      `request_id`. Quan les dades bancàries no estan disponibles, cada operació
      respon el `404` estàndard de la plataforma, exactament com ho fa una ruta
      desconeguda.
paths:
  /v3/bank/connections/{id}/revoke/:
    post:
      tags:
        - Bank Data
      summary: Revoca una connexió bancària
      description: >-
        Atura l'accés al banc. Les consultes al banc s'aturen en el moment que
        ho demanes, fins i tot mentre la confirmació del banc està pendent: el
        consentiment mostra `revocation_pending`, després `revoked` quan el banc
        confirma que l'accés s'ha finalitzat, o `revocation_failed` mentre la
        crida es reintenta automàticament. `consent.ended_by` és `customer`.


        Revocar no elimina res: els comptes, els saldos i les transaccions
        emmagatzemats continuen essent llegibles fins a `consent.retain_until`,
        la configuració de conservació de la teva aplicació, i no es cobra res.
        Per eliminar-los ara, crida `delete_connection`. Repetir la crida
        retorna l'estat actual.


        Cal una clau d'API amb el permís Bank data (`bank-data`): escriptura per
        a aquesta operació, que modifica alguna cosa. Una clau amb accés complet
        no l'inclou: concedeix-lo explícitament en crear la clau, o la crida
        respon `403 bank_data_access_denied`.


        Revocar una connexió que s'ha eliminat respon `200` amb la connexió
        eliminada, de manera que repetir la crida és segur.
      operationId: revokeBankConnection
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: L'id de la connexió.
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '200':
          description: La connexió amb l'estat de revocació.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankConnection'
              examples:
                Revocation pending:
                  summary: Sol·licitud d'aturada d'accés
                  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: El recurs no existeix en aquesta aplicació ni en aquest entorn.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: No trobat
                  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: >-
        Clau opcional de seguretat per a reintents que tu tries per a una
        operació, de fins a 255 caràcters (un UUID funciona). Una sol·licitud
        repetida amb la mateixa clau, endpoint, consulta i cos rep la primera
        resposta, amb el mateix codi d'estat i el mateix cos, i no s'executa ni
        es factura una segona vegada. La mateixa clau amb un altre endpoint,
        consulta o cos retorna `409` `idempotency_key_reused`, i mentre la
        primera sol·licitud encara s'està processant, `409`
        `idempotency_key_in_progress` amb `Retry-After`. Una sol·licitud fallida
        (qualsevol `4xx` o `5xx`) no s'emmagatzema, de manera que pots tornar-la
        a enviar amb la mateixa clau. Les claus pertanyen a la teva aplicació,
        tant si crides amb una clau d'API com amb un token d'accés. Consulta
        [Reintents i
        idempotència](/ca/integration/api-errors#reintents-i-idempotència).
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    BankConnection:
      type: object
      description: >-
        El permís de la persona perquè la teva aplicació llegeixi un banc. Una
        renovació manté l'id de la connexió i tots els ids de compte. Una
        connexió eliminada només respon amb `id`, `status`, `status_reason`,
        `created_at` i `erasure`: la resta de camps no hi són, i no hi queda cap
        dada del banc, de la persona ni del compte.
      properties:
        id:
          type: string
          description: Identificador de la connexió.
          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 primera sincronització s'està executant. `active`:
            consentiment vàlid. `renewal_required`: el consentiment ha
            finalitzat o el banc vol que la persona torni a iniciar sessió; les
            dades es poden llegir tal com es van sincronitzar per última vegada
            i no es factura res. `paused`: saldo insuficient per al mes.
            `revoked`: accés aturat per la persona, pel banc o per vosaltres.
            `deleted`: només queden `id`, `status`, `status_reason`,
            `created_at` i `erasure`. `failed`: la primera sincronització mai no
            ha reeixit.
        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: >-
            Per què la connexió té aquest estat. `paused_by_customer` està
            reservat. En una connexió `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: Els àmbits que la persona ha acceptat.
        consent:
          $ref: '#/components/schemas/BankConnectionConsent'
        sync:
          $ref: '#/components/schemas/BankConnectionSync'
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/BankConnectionAccountSummary'
          description: >-
            Resum de cada compte de la connexió. Llegeix el compte complet amb
            `get_account`.
        ownership:
          $ref: '#/components/schemas/BankConnectionOwnership'
        end_user:
          type: object
          properties:
            reference:
              type: string
              description: El vostre identificador de la persona o l'empresa.
              nullable: true
          required:
            - reference
        manage_url:
          type: string
          description: >-
            La pàgina d'accés pròpia de la persona. `null` fins que la pàgina
            d'accés estigui disponible.
          nullable: true
          format: uri
        billing:
          $ref: '#/components/schemas/BankConnectionBilling'
        possible_duplicate_of:
          type: string
          description: >-
            S'estableix quan aquesta connexió pot duplicar una altra d'activa,
            però cap `end_user.reference` no ha permès una coincidència
            determinada.
          format: uuid
          nullable: true
        erasure:
          allOf:
            - $ref: '#/components/schemas/BankConnectionErasure'
          nullable: true
          description: S'estableix després de `delete_connection`; en cas contrari, `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: >-
        Cos de l'error de cada operació de dades bancàries. Tots els camps hi
        són sempre presents.
      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: >-
            Codi d'error llegible per màquina. Decideix a partir d'aquest codi,
            mai a partir de `message`.
        message:
          type: string
          description: >-
            Explicació en llenguatge senzill per a un desenvolupador. La
            redacció pot canviar; no l'analitzis.
        request_id:
          type: string
          description: >-
            Identificador d'aquesta sol·licitud. Indica'l quan contactis amb el
            suport.
        field:
          type: string
          description: >-
            El camp de la sol·licitud que cal corregir, quan l'error fa
            referència a un sol camp. Altrament, `null`.
          nullable: true
        next_action:
          type: string
          enum:
            - retry_later
            - renew_connection
            - create_link
            - restart_from_cursor
            - restart_read
            - top_up_balance
            - enable_bank_data_access
            - contact_support
            - null
          description: >-
            Què cal fer a continuació, perquè un client pugui actuar sense
            endevinar. `null` quan no hi ha un pas següent estàndard.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Segons a esperar abans de reintentar. S'estableix en els errors de
            límit de freqüència i en els errors temporals; en cas contrari,
            `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: El banc al qual pertany una connexió o un enllaç.
      properties:
        id:
          type: string
          description: >-
            Identificador del banc de Didit, un slug estable. Utilitza'l com a
            `institution_id`.
          example: es-banco-norte
        name:
          type: string
          description: El nom del banc.
          example: Banco Norte
        country:
          type: string
          description: País del banc, ISO 3166-1 alpha-3.
          pattern: ^[A-Z]{3}$
          example: ESP
        logo_url:
          type: string
          description: Logotip del banc, o `null`.
          nullable: true
          format: uri
      required:
        - id
        - name
        - country
        - logo_url
    BankConnectionConsent:
      type: object
      description: El consentiment de la persona per a aquesta connexió.
      properties:
        status:
          type: string
          enum:
            - granted
            - expired
            - revocation_pending
            - revoked
            - revocation_failed
          description: >-
            `revocation_pending` fins que el banc confirma que el consentiment
            s'ha finalitzat, i després `revoked`. `revocation_failed` es
            reintenta automàticament. Les consultes al banc s'aturen en el
            moment en què se sol·licita una revocació.
        version:
          type: integer
          description: >-
            Versió del consentiment. Una renovació crea la versió següent en la
            mateixa connexió.
        granted_at:
          type: string
          format: date-time
          nullable: true
        expires_at:
          type: string
          description: >-
            Quan acaba el consentiment del banc. El fixa el banc, fins a
            `consent_days`.
          format: date-time
          nullable: true
        days_granted:
          type: integer
          description: Durada del consentiment en dies, tal com l'ha concedit el banc.
          nullable: true
        renewed_count:
          type: integer
          description: Quantes vegades s'ha renovat el consentiment.
        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: Identificadors dels comptes que la persona comparteix.
        renewal_action:
          type: string
          enum:
            - reconfirm
            - bank_auth
            - null
          description: >-
            Com funciona una renovació: `reconfirm` és quan la persona confirma
            a la pantalla de Didit sense iniciar sessió al banc, quan el banc i
            les normes del país ho permeten. `bank_auth` és un inici de sessió
            al banc.
          nullable: true
        renew_by:
          type: string
          description: >-
            La finalització del consentiment: renova'l abans per no tenir cap
            interrupció.
          format: date-time
          nullable: true
        reconfirm_by:
          type: string
          description: >-
            S'estableix quan `renewal_action` és `reconfirm`: l'últim moment per
            reconfirmar.
          format: date-time
          nullable: true
        renewable_until:
          type: string
          description: >-
            El darrer moment en què es pot reactivar la mateixa connexió després
            que acabi el consentiment. Passat aquest moment, la persona ha de
            tornar a connectar-se. És igual que `retain_until`.
          format: date-time
          nullable: true
        retain_until:
          type: string
          description: >-
            S'estableix quan finalitza l'accés: quant de temps es pot llegir la
            informació emmagatzemada, segons la configuració de conservació de
            la teva aplicació.
          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: >-
            Qui ha finalitzat l'accés, segons les evidències. `unknown` quan ni
            el banc ni la sincronització ho indiquen.
          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: Estat de sincronització d'una connexió.
      properties:
        status:
          type: string
          enum:
            - pending
            - ok
            - failing
          description: >-
            `failing` després de 24 hores d'intents fallits, que es reintenten
            amb esperes progressives. Un banc que demana a la persona que torni
            a iniciar sessió fa que la connexió passi a `renewal_required`.
        initial_status:
          type: string
          enum:
            - pending
            - succeeded
            - partial
            - failed
          description: >-
            Resultat de la primera sincronització. La connexió passa a `active`
            amb `succeeded` o `partial`, i a `failed` quan cap compte no ha
            reeixit.
        initial_complete:
          type: boolean
          description: >-
            `true` només quan `initial_status` és `succeeded`: els comptes, els
            saldos i les transaccions recents es poden llegir.
        history_complete:
          type: boolean
          description: >-
            `true` quan la càrrega de l'historial anterior ha acabat, per
            qualsevol motiu. Els intervals que no ha pogut obtenir són a
            `history_coverage.missing_ranges` de cada compte.
        last_synced_at:
          type: string
          description: >-
            Quan es van obtenir per última vegada les dades del banc, no quan
            les vas llegir per última vegada.
          format: date-time
          nullable: true
        next_sync_at:
          type: string
          description: >-
            Quan està prevista la propera sincronització automàtica. La
            sincronització automàtica s'executa entre una i quatre vegades al
            dia segons el banc (vegeu `frequency_per_day`).
          format: date-time
          nullable: true
        budgets:
          type: array
          items:
            $ref: '#/components/schemas/BankSyncBudget'
          description: Els límits del banc per a les consultes sense la persona present.
        last_error:
          allOf:
            - $ref: '#/components/schemas/BankSyncError'
          nullable: true
          description: El darrer error de sincronització, o `null`.
        frequency_per_day:
          type: integer
          minimum: 1
          maximum: 4
          description: >-
            Quantes vegades al dia s'executa la sincronització automàtica per a
            aquesta connexió, entre una i quatre vegades segons el banc. Quan el
            banc permet més lectures sense la presència de la persona, sempre en
            queden almenys dues al dia per a les sincronitzacions en directe.
        live_syncs_left_today:
          type: integer
          minimum: 0
          description: >-
            Quantes sincronitzacions en directe (`refresh_connection`) queden
            avui dins del límit del banc: el `remaining` del pressupost més
            restrictiu. `null` quan el banc no fixa cap límit. Les
            sincronitzacions en directe estan incloses en el preu mensual.
          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 abreujada d'un compte dins d'una connexió.
      properties:
        id:
          type: string
          description: >-
            Identificador del compte. Estable durant tota la vida de la
            connexió, inclosos els renovaments.
          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: Codi de moneda ISO 4217.
        iban_last4:
          type: string
          description: Últims quatre caràcters de l'IBAN, quan el compte en té un.
          nullable: true
        status:
          type: string
          enum:
            - open
            - closed
            - access_removed
      required:
        - id
        - name
        - type
        - usage
        - currency
        - iban_last4
        - status
    BankConnectionOwnership:
      type: object
      description: >-
        La comparació opcional del titular del compte amb una persona o una
        empresa.
      properties:
        compare:
          type: string
          enum:
            - none
            - person
            - business
        match:
          type: string
          enum:
            - any_holder
            - all_holders
            - null
          nullable: true
        check_id:
          type: string
          description: >-
            Identificador del resultat de titularitat quan es va demanar una
            comparació.
          format: uuid
          nullable: true
        result:
          type: string
          enum:
            - match
            - close_match
            - no_match
            - unknown
            - null
          description: >-
            Veredicte. `unknown` sempre que la manca d'evidències del titular
            pogués canviar-lo, i quan el banc no comparteix cap titular.
          nullable: true
      required:
        - compare
        - match
        - check_id
        - result
    BankConnectionBilling:
      type: object
      description: Quant costa aquesta connexió. El sandbox no es cobra mai.
      properties:
        unit:
          type: string
          description: >-
            Unitat de facturació: `connection_month` per a l'accés continu,
            `one_time` en cas contrari.
          enum:
            - connection_month
            - one_time
        price_usd:
          type: string
          description: >-
            El preu que et correspon avui per al comptador mensual, per a la
            teva aplicació i el país, en USD, com a cadena decimal amb 4
            decimals. Una connexió es factura per un mes només quan cada abast
            acceptat ha publicat dades per a almenys un compte en aquest mes.
            `null` per a les connexions d'un sol ús i al sandbox. L'accés
            continu es factura per connexió activa i mes; el preu actual és a la
            pàgina de preus (https://docs.didit.me/getting-started/pricing). Els
            imports dels exemples són il·lustratius; el preu per país es mostra
            a la pàgina de preus.
          pattern: ^-?\d+(\.\d+)?$
          nullable: true
        billed_through:
          type: string
          description: El darrer final de mes ja liquidat.
          format: date
          nullable: true
      required:
        - unit
        - price_usd
        - billed_through
    BankConnectionErasure:
      type: object
      description: Progrés d'una eliminació que has sol·licitat.
      properties:
        status:
          type: string
          enum:
            - pending
            - erased
            - failed
          description: >-
            `pending` mentre s'executa l'eliminació, `erased` quan no queda cap
            còpia emmagatzemada ni cap accés al banc, `failed` quan no s'ha
            pogut confirmar en 24 hores. Una eliminació fallida manté tancades
            les dades de la connexió, es reintenta i s'avisa Didit.
        requested_at:
          type: string
          format: date-time
        erased_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Quan va acabar l'eliminació. `null` fins que `status` sigui
            `erased`.
      required:
        - status
        - requested_at
        - erased_at
    RateLimitBudgetError:
      type: object
      description: >-
        Només es retorna en un rebuig del pressupost del middleware de límit de
        freqüència. Altres errors 429, inclosos conflictes d'idempotència i
        límits específics de l'endpoint, no garanteixen aquests camps de
        metadades.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: >-
            Missatge de denegació de pressupost existent, comprensible per a
            humans.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Referència de suport opaca: RL- seguit de 32 caràcters hexadecimals
            en minúscula d'un UUID.
        limit:
          type: integer
          description: Pressupost de l'àmbit superat; és igual a X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: >-
            Pressupost restant, amb un mínim de zero; és igual que
            X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: >-
            Temps de reinici de la finestra en segons Unix; és igual que
            X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Durada de la finestra fixa en segons, no l'espera restant. Respecta
            Retry-After abans de reintentar.
      example:
        detail: >-
          Write request rate limit exceeded. You can make up to 300 requests per
          minute.
        reference: RL-00000000000040008000000000000001
        limit: 300
        remaining: 0
        reset: 1794358860
        window_seconds: 60
    BankSyncBudget:
      type: object
      description: >-
        Un tram del límit del banc per a les consultes fetes sense la persona
        present.
      properties:
        scope:
          type: string
          enum:
            - connection
            - account
          description: Contra què compta el banc el pressupost.
        resource:
          type: string
          enum:
            - all
            - accounts
            - balances
            - transactions
        account_id:
          type: string
          description: El compte, quan `scope` és `account`.
          format: uuid
          nullable: true
        limit:
          type: integer
          description: >-
            Quantes vegades al dia Didit pot obtenir dades del banc sense la
            presència de la persona, tal com les defineix el banc. És un sostre
            fixat pel banc, no una garantia.
        remaining:
          type: integer
          description: >-
            Consultes que et queden per a les actualitzacions en la finestra
            actual. Les lectures reservades per a les sincronitzacions
            automàtiques ja es descompten, i una sincronització automàtica mai
            no pren les dues últimes lectures del dia, així que sempre queden
            dues actualitzacions a demanda.
        resets_at:
          type: string
          description: Quan es reinicia la finestra.
          format: date-time
      required:
        - scope
        - resource
        - limit
        - remaining
        - resets_at
    BankSyncError:
      type: object
      description: Per què ha fallat una sincronització.
      properties:
        code:
          type: string
          description: Codi d'error de Didit.
        message:
          type: string
          description: Explicació en llenguatge senzill.
        at:
          type: string
          description: Quan va passar. `null` en un resultat per compte.
          format: date-time
          nullable: true
      required:
        - code
        - message
        - at
  responses:
    Unauthorized:
      description: No autoritzat
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Clau d'API no vàlida
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        La clau d'API no té el permís Bank data (`bank-data`) o, per a dades
        bancàries sense processar en una aplicació de producció, la configuració
        de l'aplicació "Bank data in the API" està desactivada. Les dades
        bancàries no formen part de l'accés complet: una clau amb accés complet,
        una clau restringida a altres recursos i una sol·licitud autenticada
        sense clau d'API (credencials de client, sobre dades sense processar)
        són rebutjades amb aquest cos, així que crea una clau i concedeix-lo
        explícitament. El rebuig es produeix abans de cap cerca, de manera que
        no diu res sobre si un objecte existeix.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Dades bancàries no permeses
              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: >-
        S'ha superat el límit compartit d'escriptura de 300 sol·licituds per
        minut per clau d'API. Respecta `Retry-After` abans de tornar a
        intentar-ho.
      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: >-
        Hi ha hagut un error per part de Didit. Qualsevol error inesperat sota
        `/v3/bank/` respon amb el format d'error de Bank, mai amb una pàgina
        HTML: cita el `request_id` quan contactis amb el servei de suport.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Un error inesperat
              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: >-
        Nombre de segons que cal esperar, arrodonit fins a la finestra següent.
        Present en els rebutjos del pressupost del middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        L'àmbit que ha superat el seu pressupost. Present en els rebutjos del
        pressupost del middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Pressupost de l'àmbit superat; és igual al límit del cos. Hi és present
        en les denegacions de pressupost del middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Pressupost restant, amb un mínim de zero; és igual que remaining del
        cos. Hi és present a les denegacions del pressupost del middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Temps de reinici en segons Unix; és igual que reset del cos. Present en
        els rebutjos del pressupost del middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clau d'API de la teva aplicació, des de Developers -> API keys a la
        Business Console. La clau principal té accés complet. Una clau amb nom
        es pot limitar: cap, lectura o escriptura per recurs, limitada a alguns
        fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a
        una data de caducitat. 401 vol dir que la clau és incorrecta, revocada o
        caducada; 403 vol dir que no s'ha enviat cap clau, que la clau no té
        accés a aquest recurs o acció, o que la sol·licitud ve d'una adreça fora
        de la seva llista d'adreces IP; 404 en una ruta de sessió vol dir que la
        sessió queda fora dels fluxos de treball o estats de la clau. Una clau
        sense accés a multimèdia rep les URL d'imatges, vídeos i PDF com a null,
        i una clau sense escriptura de sessions rep els enllaços i els tokens de
        sessió com a null. Vegeu https://docs.didit.me/console/api-keys.

````

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