> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# API para listar conexiones bancarias: filtrar por estado y consentimiento

> Didit devuelve tus conexiones bancarias filtradas por estado, acceso, banco, país, referencias propias y fecha de fin del consentimiento.

El endpoint List Bank Connections de Didit devuelve tus conexiones bancarias, filtradas por estado, acceso, banco, país, tus propias referencias y fecha de vencimiento del consentimiento.
Usa `consent_expires_before` para encontrar los consentimientos que necesitan renovarse y `end_user_reference` para encontrar las conexiones de un usuario final.
La lista se pagina mediante `cursor`.


## OpenAPI

````yaml es/openapi-25.json GET /v3/bank/connections/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificación de identidad. Autentícate con el encabezado x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, conexiones, cuentas, saldos, transacciones, instituciones y
      cobertura. Los datos bancarios están disponibles para aplicaciones de
      sandbox. Las llamadas de una aplicación de producción responden `404`
      hasta que se anuncie el acceso en producción. En sandbox no se cobra nada.
      Una llamada hecha con una clave de API necesita una clave que tenga el
      permiso de datos bancarios (`bank-data`): lectura para las consultas,
      escritura para las operaciones que cambian algo. La verificación de cuenta
      es la excepción: necesita acceso de escritura a las sesiones, o acceso
      completo, y no el permiso de datos bancarios. Los datos bancarios no
      forman parte del acceso completo: una clave con acceso completo es
      rechazada, y la llamada responde `403 bank_data_access_denied` hasta que
      crees una clave que tenga el permiso. Los datos bancarios sin procesar
      (cuentas, saldos, transacciones y el flujo de cambios) también rechazan
      una solicitud que no incluya una clave de API.


      Cualquier rechazo bajo `/v3/bank/`, salvo el de la verificación de cuenta,
      tiene el mismo cuerpo JSON (`code`, `message`, `request_id`, `field`,
      `next_action`, `retry_after`). Una ruta que no es una operación, un ID que
      no es un UUID o un subrecurso desconocido responde `404 not_found` para
      todos los métodos, y cualquier error inesperado responde `500
      internal_error` con un `request_id`. Cuando los datos bancarios no están
      disponibles, todas las operaciones responden el `404` estándar de la
      plataforma, igual que lo hace una ruta desconocida.
paths:
  /v3/bank/connections/:
    get:
      tags:
        - Bank Data
      summary: Listar conexiones bancarias
      description: >-
        Lista las conexiones de tu aplicación, de la más reciente a la más
        antigua, con paginación por cursor. Todos los filtros se aplican dentro
        de tu aplicación y entorno.


        Necesitas una clave de API con el permiso Datos bancarios (`bank-data`):
        lectura para esta operación. Una clave con acceso completo no lo
        incluye: concédelo explícitamente al crear la clave, o la llamada
        responde `403 bank_data_access_denied`.


        En esta lista, `sync.budgets` muestra solo los presupuestos que ya
        existen; `GET /v3/bank/connections/{id}/` abre los presupuestos de hoy.
      operationId: listBankConnections
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - pending
              - active
              - renewal_required
              - paused
              - revoked
              - deleted
              - failed
          description: Solo conexiones en este estado.
        - name: access
          in: query
          required: false
          schema:
            type: string
            enum:
              - one_time
              - ongoing
          description: Solo este modo de acceso.
        - name: institution_id
          in: query
          required: false
          schema:
            type: string
            maxLength: 64
          description: Solo este banco.
        - name: country
          in: query
          required: false
          schema:
            type: string
            pattern: ^[A-Z]{3}$
          description: Solo bancos de este país.
        - name: vendor_data
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
          description: Solo conexiones con este `vendor_data`.
        - name: end_user_reference
          in: query
          required: false
          schema:
            type: string
            maxLength: 255
          description: Solo conexiones con este `end_user.reference`.
        - name: consent_expires_before
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: >-
            Solo conexiones cuyo consentimiento termina antes de este momento,
            por ejemplo para enviar enlaces de renovación.
        - name: created_after
          in: query
          required: false
          schema:
            type: string
            format: date-time
          description: Solo conexiones creadas después de este momento.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: Tamaño de página, de 1 a 500. Por defecto, 100.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Cursor opaco del `next_cursor` de la página anterior.
      responses:
        '200':
          description: Una página de conexiones.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankConnectionList'
              examples:
                Page:
                  summary: Una conexión
                  value:
                    items:
                      - 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: granted
                          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: null
                          retain_until: null
                          ended_at: null
                          ended_by: null
                        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'
                    next_cursor: null
        '400':
          description: Un parámetro no es válido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Invalid cursor:
                  summary: Cursor no válido
                  value:
                    code: invalid_cursor
                    message: The cursor or page token is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: cursor
                    next_action: null
                    retry_after: null
                Invalid request:
                  summary: Solicitud no válida
                  value:
                    code: invalid_request
                    message: The request is not valid.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: limit
                    next_action: null
                    retry_after: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '429':
          $ref: '#/components/responses/RateLimitedRead'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl
            'https://verification.didit.me/v3/bank/connections/?status=active&country=ESP&limit=50'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.bank.list_connections()
            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.listConnections();
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.ListConnections(ctx, didit.BankListConnectionsParams{})\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().listConnections();
            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->listConnections();
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.bank.list_connections
            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.ListConnectionsAsync();
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankConnectionList:
      type: object
      description: Una página de conexiones.
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BankConnection'
        next_cursor:
          type: string
          description: >-
            Pásalo como `cursor` para la página siguiente. `null` en la última
            página.
          nullable: true
      required:
        - items
        - next_cursor
    BankDataError:
      type: object
      description: >-
        Cuerpo de error de cada operación de datos bancarios. Todos los campos
        están siempre presentes.
      properties:
        code:
          type: string
          enum:
            - ongoing_access_not_available
            - segment_not_available
            - window_not_available
            - history_window_ambiguous
            - redirect_url_not_registered
            - link_origin_not_allowed
            - bank_data_access_denied
            - connection_not_active
            - consent_expired
            - renewal_not_needed
            - renewal_window_expired
            - access_removed
            - refresh_limit_reached
            - cursor_expired
            - page_expired
            - invalid_cursor
            - page_token_mismatch
            - contract_rate_missing
            - insufficient_credits
            - invalid_request
            - not_found
            - internal_error
          description: >-
            Código de error legible por máquina. Decide según este valor, nunca
            según `message`.
        message:
          type: string
          description: >-
            Explicación en lenguaje sencillo para un desarrollador. La redacción
            puede cambiar; no la analices.
        request_id:
          type: string
          description: >-
            Identificador de esta solicitud. Cítalo cuando contactes con
            soporte.
        field:
          type: string
          description: >-
            El campo de la solicitud que hay que corregir, cuando el error se
            refiere a un solo campo. En caso contrario, `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é hacer a continuación, para que un cliente pueda actuar sin
            adivinar. `null` cuando no hay un siguiente paso estándar.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Segundos que esperar antes de reintentar. Se establece en errores de
            límite de solicitudes y errores temporales; en otros casos, `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
    BankConnection:
      type: object
      description: >-
        El permiso de la persona para que tu aplicación lea un banco. Una
        renovación conserva el id de la conexión y todos los ids de cuenta. Una
        conexión eliminada responde solo `id`, `status`, `status_reason`,
        `created_at` y `erasure`: no aparece ningún otro campo y no queda en
        ella ningún dato del banco, de la persona ni de la cuenta.
      properties:
        id:
          type: string
          description: Identificador de la conexión.
          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 sincronización está en curso. `active`:
            consentimiento válido. `renewal_required`: el consentimiento terminó
            o el banco pide a la persona que vuelva a iniciar sesión; los datos
            siguen legibles tal como se sincronizaron por última vez y no se
            cobra nada. `paused`: saldo insuficiente para el mes. `revoked`:
            acceso detenido por la persona, por el banco o por usted. `deleted`:
            solo quedan `id`, `status`, `status_reason`, `created_at` y
            `erasure`. `failed`: la primera sincronización nunca se realizó
            correctamente.
        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: >-
            Por qué la conexión tiene este estado. `paused_by_customer` está
            reservado. En una conexión `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: Los alcances que la persona aceptó.
        consent:
          $ref: '#/components/schemas/BankConnectionConsent'
        sync:
          $ref: '#/components/schemas/BankConnectionSync'
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/BankConnectionAccountSummary'
          description: >-
            Resumen de cada cuenta de la conexión. Lee la cuenta completa con
            `get_account`.
        ownership:
          $ref: '#/components/schemas/BankConnectionOwnership'
        end_user:
          type: object
          properties:
            reference:
              type: string
              description: Su id para la persona o empresa.
              nullable: true
          required:
            - reference
        manage_url:
          type: string
          description: >-
            La página de acceso propia de la persona. `null` hasta que la página
            de acceso esté disponible.
          nullable: true
          format: uri
        billing:
          $ref: '#/components/schemas/BankConnectionBilling'
        possible_duplicate_of:
          type: string
          description: >-
            Se establece cuando esta conexión puede duplicar otra activa, pero
            ningún `end_user.reference` permitió confirmar una coincidencia
            determinada.
          format: uuid
          nullable: true
        erasure:
          allOf:
            - $ref: '#/components/schemas/BankConnectionErasure'
          nullable: true
          description: Se establece tras `delete_connection`; en caso contrario, `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
    RateLimitBudgetError:
      type: object
      description: >-
        Se devuelve solo en un rechazo del middleware por exceder el límite de
        solicitudes. Otros errores 429, incluidos los conflictos de idempotencia
        y los límites específicos de cada endpoint, no garantizan estos campos
        de metadatos.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Mensaje de rechazo por presupuesto existente y legible para humanos.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Referencia de soporte opaca: RL- seguido de 32 caracteres
            hexadecimales en minúscula de un UUID.
        limit:
          type: integer
          description: Presupuesto del ámbito superado; es igual a X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: >-
            Presupuesto restante, ajustado a cero; es igual a
            X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: >-
            Hora de reinicio de la ventana en segundos Unix; es igual a
            X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Duración de la ventana fija en segundos, no el tiempo restante de
            espera. Respete Retry-After antes 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
    BankInstitutionSummary:
      type: object
      description: El banco al que corresponde una conexión o un enlace.
      properties:
        id:
          type: string
          description: >-
            Identificador del banco en Didit, un slug estable. Úsalo como
            `institution_id`.
          example: es-banco-norte
        name:
          type: string
          description: El nombre del banco.
          example: Banco Norte
        country:
          type: string
          description: País del banco, ISO 3166-1 alpha-3.
          pattern: ^[A-Z]{3}$
          example: ESP
        logo_url:
          type: string
          description: Logotipo del banco, o `null`.
          nullable: true
          format: uri
      required:
        - id
        - name
        - country
        - logo_url
    BankConnectionConsent:
      type: object
      description: El consentimiento de la persona para esta conexión.
      properties:
        status:
          type: string
          enum:
            - granted
            - expired
            - revocation_pending
            - revoked
            - revocation_failed
          description: >-
            `revocation_pending` hasta que el banco confirme que el
            consentimiento ha terminado; después, `revoked`. `revocation_failed`
            se reintenta automáticamente. Las consultas al banco se detienen en
            el momento en que se solicita una revocación.
        version:
          type: integer
          description: >-
            Versión del consentimiento. Una renovación crea la siguiente versión
            en la misma conexión.
        granted_at:
          type: string
          format: date-time
          nullable: true
        expires_at:
          type: string
          description: >-
            Cuándo termina el consentimiento del banco. Lo fija el banco, hasta
            `consent_days`.
          format: date-time
          nullable: true
        days_granted:
          type: integer
          description: Duración del consentimiento en días, tal como la concedió el banco.
          nullable: true
        renewed_count:
          type: integer
          description: Cuántas veces se renovó el consentimiento.
        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: IDs de las cuentas que comparte la persona.
        renewal_action:
          type: string
          enum:
            - reconfirm
            - bank_auth
            - null
          description: >-
            Cómo funciona una renovación: con `reconfirm`, la persona confirma
            en la pantalla de Didit sin iniciar sesión en el banco, cuando el
            banco y las normas del país lo permiten. `bank_auth` es un inicio de
            sesión en el banco.
          nullable: true
        renew_by:
          type: string
          description: >-
            La fecha de vencimiento del consentimiento: renuévalo antes para no
            tener interrupciones.
          format: date-time
          nullable: true
        reconfirm_by:
          type: string
          description: >-
            Se establece cuando `renewal_action` es `reconfirm`: el último
            momento para reconfirmar.
          format: date-time
          nullable: true
        renewable_until:
          type: string
          description: >-
            El último momento en que se puede reactivar la misma conexión
            después de terminar el consentimiento. Pasado ese momento, la
            persona vuelve a conectarse. Es igual a `retain_until`.
          format: date-time
          nullable: true
        retain_until:
          type: string
          description: >-
            Se establece cuando el acceso ha terminado: cuánto tiempo siguen
            legibles los datos almacenados, según la configuración de retención
            de tu aplicación.
          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én finalizó el acceso, según las pruebas. `unknown` si ni el
            banco ni la sincronización lo indican.
          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: Estado de sincronización de una conexión.
      properties:
        status:
          type: string
          enum:
            - pending
            - ok
            - failing
          description: >-
            `failing` tras 24 horas de intentos fallidos, que se reintentan con
            backoff. Un banco que pide a la persona que vuelva a iniciar sesión
            hace que la conexión pase a `renewal_required` en su lugar.
        initial_status:
          type: string
          enum:
            - pending
            - succeeded
            - partial
            - failed
          description: >-
            Resultado de la primera sincronización. La conexión pasa a `active`
            con `succeeded` o `partial`, y a `failed` cuando ninguna cuenta se
            ha sincronizado correctamente.
        initial_complete:
          type: boolean
          description: >-
            `true` solo cuando `initial_status` es `succeeded`: se pueden leer
            las cuentas, los saldos y las transacciones recientes.
        history_complete:
          type: boolean
          description: >-
            `true` cuando la carga del historial terminó, por cualquier motivo.
            Los rangos que no se pudieron obtener aparecen en
            `history_coverage.missing_ranges` de cada cuenta.
        last_synced_at:
          type: string
          description: >-
            Cuándo se obtuvieron por última vez los datos del banco, no cuándo
            los leíste por última vez.
          format: date-time
          nullable: true
        next_sync_at:
          type: string
          description: >-
            Cuándo está prevista la siguiente sincronización automática. La
            sincronización automática se ejecuta entre una y cuatro veces al día
            según el banco (ver `frequency_per_day`).
          format: date-time
          nullable: true
        budgets:
          type: array
          items:
            $ref: '#/components/schemas/BankSyncBudget'
          description: Los límites del banco para consultas sin la persona presente.
        last_error:
          allOf:
            - $ref: '#/components/schemas/BankSyncError'
          nullable: true
          description: El último error de sincronización, o `null`.
        frequency_per_day:
          type: integer
          minimum: 1
          maximum: 4
          description: >-
            Cuántas veces al día se ejecuta la sincronización automática de esta
            conexión, entre una y cuatro según el banco. Cuando el banco permite
            más lecturas sin intervención, siempre quedan al menos dos al día
            para las sincronizaciones en vivo.
        live_syncs_left_today:
          type: integer
          minimum: 0
          description: >-
            Cuántas sincronizaciones en vivo (`refresh_connection`) quedan hoy
            dentro del límite del banco: el `remaining` del presupuesto más
            restrictivo. `null` cuando el banco no fija ningún límite. Las
            sincronizaciones en vivo están incluidas en el precio 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 abreviada de una cuenta dentro de una conexión.
      properties:
        id:
          type: string
          description: >-
            ID de la cuenta. Se mantiene estable durante la vida de la conexión,
            incluidas las renovaciones.
          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: Código de moneda ISO 4217.
        iban_last4:
          type: string
          description: Últimos cuatro caracteres del IBAN, si la cuenta lo tiene.
          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ón opcional del titular de la cuenta con 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 resultado de propiedad cuando se solicitó una
            comparación.
          format: uuid
          nullable: true
        result:
          type: string
          enum:
            - match
            - close_match
            - no_match
            - unknown
            - null
          description: >-
            Veredicto. `unknown` siempre que la falta de pruebas sobre el
            titular pueda cambiarlo, y cuando el banco no comparte el titular.
          nullable: true
      required:
        - compare
        - match
        - check_id
        - result
    BankConnectionBilling:
      type: object
      description: Lo que cuesta esta conexión. El sandbox nunca genera cargos.
      properties:
        unit:
          type: string
          description: >-
            Unidad de facturación: `connection_month` para el acceso continuo,
            `one_time` en los demás casos.
          enum:
            - connection_month
            - one_time
        price_usd:
          type: string
          description: >-
            Su precio actual para el contador mensual, para su aplicación y el
            país, en USD, como cadena decimal con 4 decimales. Una conexión solo
            se cobra por un mes si cada alcance aceptado publicó datos de al
            menos una cuenta en ese mes. `null` para conexiones de lectura única
            y en el sandbox. El acceso continuo se factura por conexión activa y
            por mes; el precio actual está en la página de precios
            (https://docs.didit.me/getting-started/pricing). Los importes de los
            ejemplos son ilustrativos; el precio de cada país se muestra en la
            página de precios.
          pattern: ^-?\d+(\.\d+)?$
          nullable: true
        billed_through:
          type: string
          description: El último cierre de mes ya liquidado.
          format: date
          nullable: true
      required:
        - unit
        - price_usd
        - billed_through
    BankConnectionErasure:
      type: object
      description: Progreso de una eliminación que solicitaste.
      properties:
        status:
          type: string
          enum:
            - pending
            - erased
            - failed
          description: >-
            `pending` mientras se ejecuta la eliminación, `erased` cuando no
            queda ninguna copia almacenada ni acceso en el banco, `failed`
            cuando no pudo confirmarse en 24 horas. Una eliminación fallida
            mantiene cerrados los datos de la conexión, se reintenta y se envía
            una alerta a Didit.
        requested_at:
          type: string
          format: date-time
        erased_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Cuándo terminó la eliminación. `null` hasta que `status` sea
            `erased`.
      required:
        - status
        - requested_at
        - erased_at
    BankSyncBudget:
      type: object
      description: >-
        Un tramo del límite del banco para consultas sin la presencia de la
        persona.
      properties:
        scope:
          type: string
          enum:
            - connection
            - account
          description: Contra qué contabiliza el banco el presupuesto.
        resource:
          type: string
          enum:
            - all
            - accounts
            - balances
            - transactions
        account_id:
          type: string
          description: La cuenta, cuando `scope` es `account`.
          format: uuid
          nullable: true
        limit:
          type: integer
          description: >-
            Cuántas veces al día Didit puede consultar al banco sin que la
            persona esté presente, según lo define el banco. Es un techo fijado
            por el banco, no una garantía.
        remaining:
          type: integer
          description: >-
            Consultas restantes para tus actualizaciones en la ventana actual.
            Las consultas reservadas para las sincronizaciones automáticas ya
            están descontadas, y una sincronización automática nunca consume las
            dos últimas consultas del día, así que siempre quedan dos
            actualizaciones bajo demanda.
        resets_at:
          type: string
          description: Cuándo se reinicia la ventana.
          format: date-time
      required:
        - scope
        - resource
        - limit
        - remaining
        - resets_at
    BankSyncError:
      type: object
      description: Por qué falló una sincronización.
      properties:
        code:
          type: string
          description: Código de error de Didit.
        message:
          type: string
          description: Explicación en lenguaje sencillo.
        at:
          type: string
          description: Cuándo ocurrió. `null` en un resultado por cuenta.
          format: date-time
          nullable: true
      required:
        - code
        - message
        - at
  responses:
    Unauthorized:
      description: No autorizado
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Clave de API no válida
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        La clave de API no tiene el permiso de datos bancarios (`bank-data`) o,
        para datos bancarios sin procesar en una aplicación de producción, el
        ajuste de la aplicación "Bank data in the API" está desactivado. Los
        datos bancarios no forman parte del acceso completo: una clave con
        acceso completo, una clave restringida a otros recursos y una solicitud
        autenticada sin clave de API (credenciales de cliente, sobre datos sin
        procesar) se rechazan todas con este cuerpo, así que crea una clave y
        concédela explícitamente. El rechazo se produce antes de cualquier
        búsqueda, por lo que no indica si un objeto existe.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Datos bancarios no permitidos
              value:
                code: bank_data_access_denied
                message: >-
                  Bank data calls need an API key that carries the Bank data
                  permission.
                request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                field: null
                next_action: enable_bank_data_access
                retry_after: null
    RateLimitedRead:
      description: >-
        Se superó el presupuesto de lectura del middleware. Respete el
        encabezado Retry-After antes de reintentar.
      headers:
        Retry-After:
          $ref: '#/components/headers/BudgetRetryAfter'
        X-RateLimit-Scope:
          $ref: '#/components/headers/BudgetXRateLimitScope'
        X-RateLimit-Limit:
          $ref: '#/components/headers/BudgetXRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/BudgetXRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/BudgetXRateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          example:
            detail: >-
              GET request rate limit exceeded. You can make up to 600 requests
              per minute.
            reference: RL-00000000000040008000000000000001
            limit: 600
            remaining: 0
            reset: 1794358860
            window_seconds: 60
    BankDataInternalError:
      description: >-
        Algo ha fallado por parte de Didit. Cualquier error inesperado en
        `/v3/bank/` responde con el formato de error de Bank, nunca con una
        página HTML: incluye `request_id` en tu consulta al soporte.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Un error inesperado
              value:
                code: internal_error
                message: >-
                  Something went wrong on our side. Quote the request_id to
                  support.
                request_id: 3f6a1c8e92b54d07a1e38c4b7f0d2e59
                field: null
                next_action: contact_support
                retry_after: null
  headers:
    BudgetRetryAfter:
      description: >-
        Segundos de espera, redondeados al alza hasta la siguiente ventana.
        Presente en los rechazos por cuota del middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        El ámbito cuya cuota se superó. Presente en los rechazos por cuota del
        middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Presupuesto del ámbito superado; es igual al límite del cuerpo. Presente
        en los rechazos por presupuesto del middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Presupuesto restante, ajustado a cero; es igual a remaining del cuerpo.
        Está presente en los rechazos por presupuesto del middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Tiempo de reinicio en segundos Unix; es igual a reset del cuerpo.
        Presente en los rechazos por cuota del middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        La clave de API de tu aplicación, desde Developers -> API keys en la
        Business Console. La clave principal tiene acceso completo. Una clave
        con nombre puede tener permisos limitados: ninguno, lectura o escritura
        por recurso, restringida a algunos flujos o solo a sesiones aprobadas, a
        una lista de direcciones IP y a una fecha de caducidad. 401 significa
        que la clave es incorrecta, está revocada o ha caducado; 403 significa
        que no se envió ninguna clave, que la clave no tiene acceso a este
        recurso o acción, o que la solicitud procede de una dirección fuera de
        su lista de IP; 404 en una ruta de sesión significa que la sesión está
        fuera de los flujos o estados de la clave. Una clave sin acceso a
        contenido multimedia recibe las URL de imágenes, vídeos y PDF como null,
        y una clave sin permiso de escritura en sesiones recibe los enlaces y
        tokens de sesión como null. Consulta
        https://docs.didit.me/console/api-keys.

````

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