> ## 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 Daftar Bank: Institusi dan Kemampuannya

> Endpoint Daftar Institusi Didit mengembalikan bank per negara beserta segmen, akses berkelanjutan, masa persetujuan, dan kedalaman riwayat.

Endpoint List Institutions dari Didit mengembalikan bank per negara beserta dukungannya: segmen, akses berkelanjutan, durasi persetujuan, kedalaman riwayat, dan kolom yang dikirimkannya.
Filter menurut `country`, `segment`, `access` dan `q`.
Lihat [Cakupan bank](https://docs.didit.me/id/core-technology/bank-verification/coverage.md).


## OpenAPI

````yaml id/openapi-25.json GET /v3/bank/institutions/
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/institutions/:
    get:
      tags:
        - Bank Data
      summary: Daftar institusi
      description: >-
        Menampilkan daftar bank per negara beserta kemampuannya: segmen, mode
        akses, persetujuan terpanjang dan riwayat terdalam yang ditawarkan bank,
        apakah bank melaporkan transaksi tertunda, kolom transaksi mana yang
        diketahui dikirim bank, dan cara pengguna masuk. Nilai berasal dari data
        yang teramati dan diperbarui setiap hari; nilai yang tidak pernah
        teramati adalah `null`. Data yang sama juga digunakan oleh pemilih bank,
        jadi gunakan untuk mengetahui apa yang diharapkan sebelum Anda membuat
        tautan. `access` hanya mencantumkan `ongoing` jika akses berkelanjutan
        tersedia.


        Membutuhkan kunci API dengan izin Data bank (`bank-data`): izin read
        untuk operasi ini. Kunci dengan akses penuh tidak menyertakannya:
        berikan secara eksplisit saat Anda membuat kunci, atau panggilan akan
        menjawab `403 bank_data_access_denied`.


        Daftar diurutkan berdasarkan nama, lalu id.


        Di aplikasi sandbox, daftar berisi Didit Test Bank, satu per negara yang
        dilayani Bank Link, dan tidak ada bank produksi.
      operationId: listBankInstitutions
      parameters:
        - name: country
          in: query
          required: false
          schema:
            type: string
            pattern: ^[A-Z]{3}$
          description: >-
            Hanya bank di negara ini, dalam kode ISO 3166-1 alpha-3. Negara yang
            tidak dilayani Bank Link menghasilkan `400 invalid_request` dengan
            `field: country`.
        - name: segment
          in: query
          required: false
          schema:
            type: string
            enum:
              - personal
              - business
          description: Hanya bank yang melayani segmen ini.
        - name: access
          in: query
          required: false
          schema:
            type: string
            enum:
              - one_time
              - ongoing
          description: Hanya bank yang menawarkan mode akses ini.
        - name: q
          in: query
          required: false
          schema:
            type: string
            maxLength: 100
          description: Cari berdasarkan nama atau id, tidak peka huruf besar/kecil.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 1
            maximum: 500
          description: Ukuran halaman, 1 hingga 500. Default 100.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Kursor opak dari `next_cursor` halaman sebelumnya.
      responses:
        '200':
          description: Satu halaman bank.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankInstitutionList'
              examples:
                Spain, ongoing access:
                  summary: Bank Spanyol yang menawarkan akses berkelanjutan
                  value:
                    items:
                      - id: es-banco-norte
                        name: Banco Norte
                        country: ESP
                        logo_url: https://static.example.com/banks/es-banco-norte.png
                        timezone: Europe/Madrid
                        segments:
                          - personal
                          - business
                        access:
                          - one_time
                          - ongoing
                        ongoing_access: true
                        consent_days_max: 180
                        history_days_max: 365
                        pending_transactions: true
                        pending_linkage: false
                        balance_types:
                          - booked
                          - available
                        transaction_fields:
                          - value_date
                          - counterparty_name
                          - counterparty_iban
                          - remittance
                          - bank_transaction_code
                          - bank_reference
                          - balance_after
                        sign_in: redirect
                        requires_end_user_email: true
                        corporate_accounts: true
                        bank_account_selection: false
                        separate_history_consent: false
                        reconfirmation: false
                        sync_frequency_hours: null
                        health: operational
                    next_cursor: null
        '400':
          description: >-
            Sebuah parameter tidak valid, atau `country` bukan negara yang
            dilayani Bank Link. `field` menyebutkannya.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Invalid cursor:
                  summary: Kursor tidak valid
                  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: Permintaan tidak valid
                  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/institutions/?country=ESP&segment=business&access=ongoing'
            \
              -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_institutions()
            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.listInstitutions();
            console.log(result);
        - lang: go
          label: Go
          source: "ctx := context.Background()\n// Reads DIDIT_API_KEY.\nclient := didit.NewClient()\n\nresult, err := client.Bank.ListInstitutions(ctx, didit.BankListInstitutionsParams{})\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().listInstitutions();
            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->listInstitutions();
            print_r($result->toArray());
        - lang: ruby
          label: Ruby
          source: |-
            require "didit"

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

            result = didit.bank.list_institutions
            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.ListInstitutionsAsync();
            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  schemas:
    BankInstitutionList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/BankInstitution'
        next_cursor:
          type: string
          nullable: true
      required:
        - items
        - next_cursor
    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
    BankInstitution:
      type: object
      description: >-
        Bank dan kemampuan yang didukungnya. Nilai berasal dari data kemampuan
        yang teramati dan diperbarui setiap hari; nilai yang tidak pernah
        teramati akan bernilai `null`, bukan tebakan.
      properties:
        id:
          type: string
          description: Pengidentifikasi bank milik Didit, berupa slug yang stabil.
          example: es-banco-norte
        name:
          type: string
        country:
          type: string
          pattern: ^[A-Z]{3}$
        logo_url:
          type: string
          format: uri
          nullable: true
        timezone:
          type: string
          description: Zona waktu IANA yang digunakan untuk tanggal bank.
          nullable: true
        segments:
          type: array
          items:
            type: string
            enum:
              - personal
              - business
        access:
          type: array
          items:
            type: string
            enum:
              - one_time
              - ongoing
          description: >-
            `ongoing` hanya dicantumkan jika akses berkelanjutan diaktifkan
            untuk bank tersebut.
        ongoing_access:
          type: boolean
          description: Apakah akses berkelanjutan tersedia di bank ini.
        consent_days_max:
          type: integer
          description: >-
            Persetujuan terpanjang yang diizinkan bank, dalam hari. `null` jika
            belum teramati.
          nullable: true
        history_days_max:
          type: integer
          description: >-
            Riwayat terdalam yang dikirimkan bank, dalam hari. `null` jika belum
            teramati.
          nullable: true
        pending_transactions:
          type: boolean
          nullable: true
          description: Apakah bank melaporkan transaksi yang tertunda.
        pending_linkage:
          type: boolean
          nullable: true
          description: >-
            Apakah bank mengaitkan transaksi yang tertunda dengan transaksi yang
            sudah dibukukan, yang menentukan `pending_id`.
        balance_types:
          type: array
          items:
            type: string
            enum:
              - booked
              - available
              - expected
        transaction_fields:
          type: array
          items:
            type: string
          description: >-
            Kolom transaksi yang diketahui dikirim oleh bank. Semua kolom lain
            bernilai `null`.
        sign_in:
          type: string
          enum:
            - redirect
            - app_approval
            - credentials
            - null
          description: Bagaimana orang tersebut login di bank.
          nullable: true
        requires_end_user_email:
          type: boolean
          nullable: true
          description: >-
            Apakah Bank Link memerlukan alamat email yang terverifikasi dari
            orang tersebut.
        corporate_accounts:
          type: boolean
          nullable: true
          description: Apakah rekening bisnis didukung.
        bank_account_selection:
          type: boolean
          nullable: true
          description: Apakah orang tersebut memilih rekening di bank, bukan di Bank Link.
        separate_history_consent:
          type: boolean
          nullable: true
          description: >-
            Apakah bank meminta satu konfirmasi lagi untuk membuka riwayat yang
            lebih lama.
        reconfirmation:
          type: boolean
          nullable: true
          description: >-
            Apakah perpanjangan dapat dikonfirmasi ulang di layar Didit tanpa
            login ke bank.
        sync_frequency_hours:
          type: integer
          description: >-
            Jumlah jam di antara sinkronisasi otomatis jika bank mengizinkan
            frekuensi yang lebih cepat. `null` berarti default harian.
          nullable: true
        health:
          type: string
          enum:
            - operational
            - degraded
            - down
      required:
        - id
        - name
        - country
        - logo_url
        - timezone
        - segments
        - access
        - ongoing_access
        - consent_days_max
        - history_days_max
        - pending_transactions
        - pending_linkage
        - balance_types
        - transaction_fields
        - sign_in
        - requires_end_user_email
        - corporate_accounts
        - bank_account_selection
        - separate_history_consent
        - reconfirmation
        - sync_frequency_hours
        - health
    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
  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.