> ## 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 Get Bank Sync Run: Hasil per Akun

> Endpoint Didit untuk mengambil satu sinkronisasi: hasil per akun dan resource berupa jumlah data ditambah, diubah, dihapus, atau error.

Endpoint Get a Sync Run milik Didit mengembalikan satu sinkronisasi beserta hasilnya untuk setiap akun dan sumber daya: jumlah yang ditambahkan, diubah, dan dihapus, atau kesalahannya.
`sync_id` berasal dari [Segarkan koneksi](https://docs.didit.me/id/standalone-apis/bank-connection-refresh.md) atau dari webhook `bank.data.updated`.


## OpenAPI

````yaml id/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 Verifikasi Identitas. Lakukan autentikasi dengan header x-api-key.
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank Link, koneksi, akun, saldo, transaksi, institusi, dan cakupan. Data
      bank tersedia untuk aplikasi sandbox. Panggilan dari aplikasi produksi
      mengembalikan `404` hingga akses live diumumkan. Tidak ada biaya yang
      dikenakan di sandbox. Panggilan yang dibuat dengan kunci API memerlukan
      kunci yang memiliki izin Bank data (`bank-data`): baca untuk operasi baca,
      tulis untuk operasi yang mengubah sesuatu. Pemeriksaan akun adalah
      pengecualian: memerlukan akses tulis ke sesi, atau akses penuh, dan bukan
      izin Bank data. Bank data bukan bagian dari akses penuh: kunci akses penuh
      ditolak, dan panggilan menjawab `403 bank_data_access_denied` hingga Anda
      membuat kunci yang memiliki izin tersebut. Data bank mentah (akun, saldo,
      transaksi, dan umpan perubahan) juga menolak permintaan yang tidak
      menyertakan kunci API.


      Setiap penolakan di bawah `/v3/bank/` kecuali milik pemeriksaan akun
      memiliki badan JSON yang sama (`code`, `message`, `request_id`, `field`,
      `next_action`, `retry_after`). Jalur yang bukan operasi, ID yang bukan
      UUID, atau sub-resource yang tidak dikenal menjawab `404 not_found` untuk
      semua metode, dan kesalahan tak terduga apa pun menjawab `500
      internal_error` dengan `request_id`. Jika Bank data tidak tersedia, setiap
      operasi menjawab `404` standar platform, sama seperti rute yang tidak
      dikenal.
paths:
  /v3/bank/connections/{id}/sync-runs/{sync_id}/:
    get:
      tags:
        - Bank Data
      summary: Mendapatkan proses sinkronisasi
      description: >-
        Mengembalikan satu proses sinkronisasi beserta hasilnya per akun dan per
        sumber daya.


        Memerlukan kunci API dengan izin Bank data (`bank-data`): baca untuk
        operasi ini. Kunci dengan akses penuh tidak mencakup izin ini: berikan
        secara eksplisit saat membuat kunci, atau panggilan akan mengembalikan
        `403 bank_data_access_denied`.
      operationId: getBankSyncRun
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID koneksi.
        - name: sync_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID eksekusi sinkronisasi.
      responses:
        '200':
          description: Eksekusi sinkronisasi.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankSyncRun'
              examples:
                Succeeded:
                  summary: Eksekusi terjadwal
                  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: Sumber daya tidak ada dalam aplikasi dan lingkungan ini.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: Tidak ditemukan
                  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: >-
            Koneksi tidak aktif: koneksi telah dihapus, atau masa retensinya
            telah berakhir (`connection_not_active`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not active:
                  summary: Koneksi tidak aktif
                  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: >-
        Satu sinkronisasi dari sebuah koneksi. Hanya sinkronisasi awal,
        terjadwal, dan yang diminta yang ditampilkan.
      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: Apa yang dilakukan eksekusi, per rekening dan per sumber daya.
        error:
          type: object
          nullable: true
          description: >-
            Alasan seluruh proses gagal. `null` jika tidak. Kesalahan pada
            rekening dan sumber daya tunggal ada di `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: Isi kesalahan dari setiap operasi Bank data. Setiap kolom selalu ada.
      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: >-
            Kode error yang dapat dibaca mesin. Tentukan percabangan berdasarkan
            kode ini, jangan berdasarkan `message`.
        message:
          type: string
          description: >-
            Penjelasan dalam bahasa sederhana untuk pengembang. Redaksinya dapat
            berubah; jangan diurai.
        request_id:
          type: string
          description: ID permintaan ini. Sertakan ID ini saat menghubungi dukungan.
        field:
          type: string
          description: >-
            Kolom permintaan yang perlu diperbaiki, jika error berkaitan dengan
            satu kolom. Jika tidak, bernilai `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: >-
            Apa langkah berikutnya, agar klien dapat bertindak tanpa menebak.
            `null` jika tidak ada langkah berikutnya yang standar.
          nullable: true
        retry_after:
          type: integer
          description: >-
            Detik untuk menunggu sebelum mencoba lagi. Diisi pada error batas
            laju dan error sementara; jika tidak, `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` untuk hasil yang berlaku untuk seluruh koneksi.'
          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: Wajib diisi saat `outcome` bernilai `failed`.
      required:
        - account_id
        - resource
        - outcome
        - added
        - modified
        - removed
        - error
    RateLimitBudgetError:
      type: object
      description: >-
        Hanya dikembalikan untuk penolakan anggaran batas laju middleware.
        Kesalahan 429 lainnya, termasuk konflik idempotensi dan batas khusus
        endpoint, tidak menjamin bidang metadata ini.
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: Pesan penolakan anggaran yang sudah ada dan mudah dibaca manusia.
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: >-
            Referensi dukungan (tidak transparan): RL- diikuti 32 karakter
            heksadesimal UUID huruf kecil.
        limit:
          type: integer
          description: >-
            Anggaran untuk cakupan yang terlampaui; sama dengan
            X-RateLimit-Limit.
        remaining:
          type: integer
          minimum: 0
          description: >-
            Sisa anggaran, dibatasi hingga nol; sama dengan
            X-RateLimit-Remaining.
        reset:
          type: integer
          format: int64
          description: Waktu reset jendela dalam detik Unix; sama dengan X-RateLimit-Reset.
        window_seconds:
          type: integer
          description: >-
            Durasi jendela tetap dalam detik, bukan sisa waktu tunggu. Patuhi
            Retry-After sebelum mencoba lagi.
      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: Alasan sinkronisasi gagal.
      properties:
        code:
          type: string
          description: Kode error Didit.
        message:
          type: string
          description: Penjelasan dalam bahasa sederhana.
        at:
          type: string
          description: Kapan kejadian itu terjadi. `null` pada hasil per rekening.
          format: date-time
          nullable: true
      required:
        - code
        - message
        - at
  responses:
    Unauthorized:
      description: Tidak diotorisasi
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: Kunci API Tidak Valid
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        Kunci API tidak memiliki izin Bank data (`bank-data`), atau, untuk data
        bank mentah di aplikasi live, pengaturan aplikasi "Bank data in the API"
        dinonaktifkan. Data bank bukan bagian dari akses penuh: kunci akses
        penuh, kunci yang dibatasi pada sumber daya lain, dan permintaan yang
        diautentikasi tanpa kunci API (client credentials, untuk data mentah)
        semuanya ditolak dengan isi respons ini, jadi buat kunci dan berikan
        izin secara eksplisit. Penolakan terjadi sebelum pencarian apa pun,
        sehingga tidak memberi tahu apakah objek itu ada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: Data bank tidak diizinkan
              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: >-
        Anggaran baca middleware terlampaui. Patuhi Retry-After sebelum mencoba
        lagi.
      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: >-
        Terjadi kesalahan di sisi Didit. Setiap error tak terduga di bawah
        `/v3/bank/` dijawab dalam format error Bank, tidak pernah berupa halaman
        HTML: sebutkan `request_id` saat menghubungi dukungan.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: Kesalahan tak terduga
              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: >-
        Detik untuk menunggu, dibulatkan ke atas ke jendela berikutnya. Tersedia
        pada penolakan anggaran middleware.
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: >-
        Cakupan yang anggarannya terlampaui. Tersedia pada penolakan anggaran
        middleware.
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: >-
        Anggaran untuk cakupan yang terlampaui; sama dengan batas pada body.
        Hadir pada penolakan anggaran middleware.
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        Sisa anggaran, dibatasi hingga nol; sama dengan remaining pada body. Ada
        pada penolakan anggaran middleware.
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: >-
        Waktu reset dalam detik Unix; sama dengan reset di body. Tersedia pada
        penolakan anggaran middleware.
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Kunci API aplikasi Anda, dari Developers -> API keys di Business
        Console. Kunci utama memiliki akses penuh. Kunci bernama dapat dibatasi:
        tanpa akses, baca, atau tulis per sumber daya, dibatasi untuk beberapa
        alur kerja atau untuk sesi yang disetujui, ke daftar alamat IP tertentu,
        dan ke tanggal kedaluwarsa. 401 berarti kunci salah, dicabut, atau
        kedaluwarsa; 403 berarti tidak ada kunci yang dikirim, kunci tidak
        memiliki akses ke sumber daya atau tindakan ini, atau permintaan berasal
        dari alamat di luar daftar IP-nya; 404 pada rute sesi berarti sesi
        berada di luar alur kerja atau status yang diizinkan untuk kunci
        tersebut. Kunci tanpa akses media menerima URL gambar, video, dan PDF
        sebagai null, dan kunci tanpa akses tulis sesi menerima tautan dan token
        sesi sebagai null. Lihat https://docs.didit.me/console/api-keys.

````

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