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

# Obter uma execução de Bank Sync na API: resultados por conta

> O endpoint Get a Sync Run da Didit devolve uma sincronização com o resultado por conta e recurso: adicionados, alterados e removidos, ou o erro.

O endpoint Obter uma execução de sincronização da Didit devolve uma sincronização com o respetivo resultado para cada conta e recurso: contagens de itens adicionados, modificados e removidos, ou o erro.
O `sync_id` vem de [Atualizar uma ligação](https://docs.didit.me/pt/standalone-apis/bank-connection-refresh.md) ou do webhook `bank.data.updated`.


## OpenAPI

````yaml pt/openapi-25.json GET /v3/bank/connections/{id}/sync-runs/{sync_id}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: API de verificação de identidade. Autentique-se com o cabeçalho x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, ligações, contas, saldos, transações, instituições e cobertura.
      Os dados bancários estão disponíveis para aplicações sandbox. As chamadas
      de uma aplicação de produção respondem com `404` até ao acesso em produção
      ser anunciado. Nada é cobrado no sandbox. Uma chamada feita com uma chave
      de API precisa de uma chave que tenha a permissão de dados bancários
      (`bank-data`): leitura para as leituras, escrita para as operações que
      alteram algo. A verificação de conta é a exceção: precisa de acesso de
      escrita a sessões, ou de acesso total, e não da permissão de dados
      bancários. Os dados bancários não fazem parte do acesso total: uma chave
      de acesso total é recusada, e a chamada responde com `403
      bank_data_access_denied` até criar uma chave que tenha a permissão. Os
      dados bancários em bruto (contas, saldos, transações e o feed de
      alterações) também recusam um pedido que não traga uma chave de API.


      Todas as recusas em `/v3/bank/`, exceto as da verificação de conta, têm o
      mesmo corpo JSON (`code`, `message`, `request_id`, `field`, `next_action`,
      `retry_after`). Um caminho que não é uma operação, um ID que não é um UUID
      ou um sub-recurso desconhecido responde com `404 not_found` em todos os
      métodos, e qualquer erro inesperado responde com `500 internal_error` com
      um `request_id`. Quando os dados bancários não estão disponíveis, todas as
      operações respondem com o `404` padrão da plataforma, exatamente como uma
      rota desconhecida.
paths:
  /v3/bank/connections/{id}/sync-runs/{sync_id}/:
    get:
      tags:
        - Bank Data
      summary: Obter uma execução de sincronização
      description: >-
        Devolve uma execução de sincronização com os resultados por conta e por
        recurso.


        É necessária uma chave de API com a permissão Dados bancários
        (`bank-data`): leitura para esta operação. Uma chave com acesso total
        não inclui esta permissão: atribua-a explicitamente ao criar a chave,
        caso contrário a chamada responde com `403 bank_data_access_denied`.
      operationId: getBankSyncRun
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: O id da ligação.
        - name: sync_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: O id da execução de sincronização.
      responses:
        '200':
          description: A execução de sincronização.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankSyncRun'
              examples:
                Succeeded:
                  summary: Uma execução agendada
                  value:
                    id: d4a9e7b2-1c58-4f03-96ab-5e2d8c7f0b14
                    connection_id: 5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35
                    trigger: scheduled
                    status: succeeded
                    started_at: '2026-11-21T06:00:02Z'
                    finished_at: '2026-11-21T06:00:19Z'
                    results:
                      - account_id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        resource: transactions
                        outcome: succeeded
                        added: 3
                        modified: 0
                        removed: 1
                        error: null
                      - account_id: a71f0c2e-5d38-4b96-a1c4-3e9f8d2b7a10
                        resource: balances
                        outcome: succeeded
                        added: 0
                        modified: 0
                        removed: 0
                        error: null
                      - account_id: c3d84e19-2a7b-4f60-b5e1-9a0c6d3f8e72
                        resource: transactions
                        outcome: succeeded
                        added: 0
                        modified: 0
                        removed: 0
                        error: null
                    error: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '404':
          description: O recurso não existe nesta aplicação e neste ambiente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: Não encontrado
                  value:
                    code: not_found
                    message: The resource does not exist.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
        '409':
          description: >-
            A ligação não está ativa: foi eliminada, ou o seu período de
            conservação terminou (`connection_not_active`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not active:
                  summary: Conexão não ativa
                  value:
                    code: connection_not_active
                    message: This connection is not active.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: create_link
                    retry_after: null
        '429':
          $ref: '#/components/responses/RateLimitedRead'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl
            'https://verification.didit.me/v3/bank/connections/5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35/sync-runs/d4a9e7b2-1c58-4f03-96ab-5e2d8c7f0b14/'
            \
              -H 'x-api-key: YOUR_API_KEY'
        - lang: python
          label: Python
          source: |-
            from didit import Didit

            # Reads DIDIT_API_KEY.
            client = Didit()

            result = client.bank.get_sync_run(
                "11111111-2222-3333-4444-555555555555",
                "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.getSyncRun(
              "11111111-2222-3333-4444-555555555555",
              "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.GetSyncRun(ctx, \"11111111-2222-3333-4444-555555555555\", \"11111111-2222-3333-4444-555555555555\")\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().getSyncRun("11111111-2222-3333-4444-555555555555",
            "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->getSyncRun('11111111-2222-3333-4444-555555555555',
            '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.get_sync_run(
              "11111111-2222-3333-4444-555555555555",
              "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.GetSyncRunAsync("11111111-2222-3333-4444-555555555555",
            "11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankSyncRun:
      type: object
      description: >-
        Uma sincronização de uma ligação. Só são listadas as sincronizações
        iniciais, agendadas e pedidas.
      properties:
        id:
          type: string
          format: uuid
        connection_id:
          type: string
          format: uuid
        trigger:
          type: string
          enum:
            - initial
            - scheduled
            - requested
        status:
          type: string
          enum:
            - queued
            - running
            - succeeded
            - partial
            - failed
        started_at:
          type: string
          format: date-time
          nullable: true
        finished_at:
          type: string
          format: date-time
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/BankSyncRunResult'
          description: O que a execução fez, por conta e por recurso.
        error:
          type: object
          nullable: true
          description: >-
            Motivo pelo qual a execução falhou no seu todo. `null` quando não
            falhou. Os erros de contas e recursos individuais estão em
            `results`.
          properties:
            code:
              type: string
            message:
              type: string
            at:
              type: string
              format: date-time
          required:
            - code
            - message
            - at
      required:
        - id
        - connection_id
        - trigger
        - status
        - started_at
        - finished_at
        - results
        - error
    BankDataError:
      type: object
      description: >-
        Corpo de erro de todas as operações de Dados bancários. Todos os campos
        estão sempre presentes.
      properties:
        code:
          type: string
          enum:
            - ongoing_access_not_available
            - segment_not_available
            - window_not_available
            - history_window_ambiguous
            - redirect_url_not_registered
            - link_origin_not_allowed
            - bank_data_access_denied
            - connection_not_active
            - consent_expired
            - renewal_not_needed
            - renewal_window_expired
            - access_removed
            - refresh_limit_reached
            - cursor_expired
            - page_expired
            - invalid_cursor
            - page_token_mismatch
            - contract_rate_missing
            - insufficient_credits
            - invalid_request
            - not_found
            - internal_error
          description: >-
            Código de erro legível por máquina. Baseie as decisões neste valor,
            nunca em `message`.
        message:
          type: string
          description: >-
            Explicação em linguagem simples para um programador. A redação pode
            mudar; não a analise.
        request_id:
          type: string
          description: Identificador deste pedido. Indique-o quando contactar o suporte.
        field:
          type: string
          description: >-
            O campo do pedido a corrigir, quando o erro diz respeito a um campo.
            Caso contrário, `null`.
          nullable: true
        next_action:
          type: string
          enum:
            - retry_later
            - renew_connection
            - create_link
            - restart_from_cursor
            - restart_read
            - top_up_balance
            - enable_bank_data_access
            - contact_support
            - null
          description: >-
            O que fazer a seguir, para que um cliente possa agir sem adivinhar.
            `null` quando não há um passo seguinte padrão.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Segundos a aguardar antes de tentar novamente. Definido em erros de
            limite de pedidos e erros temporários; caso contrário, `null`.
          nullable: true
      required:
        - code
        - message
        - request_id
        - field
        - next_action
        - retry_after
      example:
        code: ongoing_access_not_available
        message: >-
          This bank cannot keep access open. Use access one_time or choose
          another bank.
        request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
        field: institution_id
        next_action: create_link
        retry_after: null
    BankSyncRunResult:
      type: object
      properties:
        account_id:
          type: string
          description: '`null` para um resultado de toda a conexão.'
          format: uuid
          nullable: true
        resource:
          type: string
          enum:
            - accounts
            - balances
            - transactions
        outcome:
          type: string
          enum:
            - succeeded
            - failed
            - skipped
        added:
          type: integer
        modified:
          type: integer
        removed:
          type: integer
        error:
          allOf:
            - $ref: '#/components/schemas/BankSyncError'
          nullable: true
          description: Obrigatório quando `outcome` for `failed`.
      required:
        - account_id
        - resource
        - outcome
        - added
        - modified
        - removed
        - error
    RateLimitBudgetError:
      type: object
      description: >-
        Devolvido apenas numa recusa de orçamento de limite de pedidos do
        middleware. Outros erros 429, incluindo conflitos de idempotência e
        limites específicos de cada endpoint, não garantem estes campos de
        metadados.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Mensagem de recusa por orçamento já existente, legível por humanos.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Referência de suporte opaca: RL- seguido de 32 caracteres
            hexadecimais de UUID em minúsculas.
        limit:
          type: integer
          description: Orçamento do âmbito excedido; igual a X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: Orçamento restante, limitado a zero; igual a X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: >-
            Hora de reposição da janela em segundos Unix; é igual a
            X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Duração da janela fixa em segundos, não o tempo de espera restante.
            Respeite Retry-After antes de tentar novamente.
      example:
        detail: >-
          Write request rate limit exceeded. You can make up to 300 requests per
          minute.
        reference: RL-00000000000040008000000000000001
        limit: 300
        remaining: 0
        reset: 1794358860
        window_seconds: 60
    BankSyncError:
      type: object
      description: Motivo pelo qual uma sincronização falhou.
      properties:
        code:
          type: string
          description: Código de erro da Didit.
        message:
          type: string
          description: Explicação em linguagem simples.
        at:
          type: string
          description: Quando aconteceu. `null` num resultado por conta.
          format: date-time
          nullable: true
      required:
        - code
        - message
        - at
  responses:
    Unauthorized:
      description: Não autorizado
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Chave de API inválida
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        A chave de API não tem a permissão Dados bancários (`bank-data`) ou, no
        caso de dados bancários em bruto numa aplicação em produção, a definição
        da aplicação "Bank data in the API" está desativada. Os dados bancários
        não fazem parte do acesso total: uma chave com acesso total, uma chave
        restrita a outros recursos e um pedido autenticado sem chave de API
        (credenciais de cliente, para dados em bruto) são todos recusados com
        este corpo de resposta. Crie uma chave e atribua-lhe a permissão
        explicitamente. A recusa acontece antes de qualquer pesquisa, por isso
        não indica se o objeto existe.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Dados bancários não permitidos
              value:
                code: bank_data_access_denied
                message: >-
                  Bank data calls need an API key that carries the Bank data
                  permission.
                request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                field: null
                next_action: enable_bank_data_access
                retry_after: null
    RateLimitedRead:
      description: >-
        Orçamento de leitura do middleware excedido. Respeite Retry-After antes
        de tentar novamente.
      headers:
        Retry-After:
          $ref: '#/components/headers/BudgetRetryAfter'
        X-RateLimit-Scope:
          $ref: '#/components/headers/BudgetXRateLimitScope'
        X-RateLimit-Limit:
          $ref: '#/components/headers/BudgetXRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/BudgetXRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/BudgetXRateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          example:
            detail: >-
              GET request rate limit exceeded. You can make up to 600 requests
              per minute.
            reference: RL-00000000000040008000000000000001
            limit: 600
            remaining: 0
            reset: 1794358860
            window_seconds: 60
    BankDataInternalError:
      description: >-
        Algo correu mal do lado da Didit. Qualquer erro inesperado em
        `/v3/bank/` responde no formato de erro do Bank, nunca com uma página
        HTML: indique o `request_id` ao suporte.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Um erro inesperado
              value:
                code: internal_error
                message: >-
                  Something went wrong on our side. Quote the request_id to
                  support.
                request_id: 3f6a1c8e92b54d07a1e38c4b7f0d2e59
                field: null
                next_action: contact_support
                retry_after: null
  headers:
    BudgetRetryAfter:
      description: >-
        Segundos a aguardar, arredondados por excesso para a janela seguinte.
        Presente nas recusas de orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        O âmbito cujo orçamento foi excedido. Presente nas recusas de orçamento
        do middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Orçamento do âmbito excedido; igual ao limite do corpo. Presente nas
        recusas por orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Orçamento restante, limitado a zero; igual a remaining do corpo.
        Presente nas recusas por orçamento do middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Hora de reposição em segundos Unix; é igual a reset no corpo. Presente
        nas recusas de orçamento do middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        A chave de API da sua aplicação, obtida em Developers -> API keys na
        Business Console. A chave principal tem acesso total. Uma chave com nome
        pode ter o âmbito limitado: nenhum, leitura ou escrita por recurso,
        limitada a alguns fluxos ou apenas a sessões aprovadas, a uma lista de
        endereços IP e a uma data de validade. 401 significa que a chave está
        errada, revogada ou expirada; 403 significa que não foi enviada nenhuma
        chave, que a chave não tem acesso a este recurso ou ação, ou que o
        pedido veio de um endereço fora da sua lista de IP; 404 numa rota de
        sessão significa que a sessão está fora dos fluxos ou estados da chave.
        Uma chave sem acesso a multimédia recebe os URLs de imagem, vídeo e PDF
        como null, e uma chave sem escrita em sessões recebe os links e tokens
        de sessão como null. Consulte https://docs.didit.me/console/api-keys.

````

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