> ## 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：アクセス停止とデータ消去

> Didit の銀行接続削除エンドポイントは、銀行へのアクセスを停止し、接続に保存された口座・残高・取引データを削除します。

Didit の銀行接続削除エンドポイントは、銀行へのアクセスを停止し、その接続に保存された口座、残高、取引を削除します。
削除は元に戻せません。
接続を削除せずにアクセスを停止するには、[取り消し](https://docs.didit.me/ja/standalone-apis/bank-connection-revoke.md)を使用してください。
削除の影響を受けるもの、受けないものについては、[データ、同意、削除](https://docs.didit.me/ja/core-technology/bank-verification/data-consent-and-deletion.md)を参照してください。


## OpenAPI

````yaml ja/openapi-25.json DELETE /v3/bank/connections/{id}/
openapi: 3.0.0
info:
  version: 3.0.0
  title: Didit Verification API
  description: 本人確認API。x-api-keyヘッダーで認証します。
servers:
  - url: https://verification.didit.me
security: []
tags:
  - name: Bank Data
    description: >-
      Bank
      Link、接続、アカウント、残高、取引、金融機関、カバレッジ。銀行データはサンドボックスアプリケーションで利用できます。本番アプリケーションの呼び出しは、本番アクセスが発表されるまで
      `404`
      を返します。サンドボックスでは課金されません。APIキーを使った呼び出しには、銀行データ権限（`bank-data`）を持つキーが必要です。読み取りには読み取り権限、変更を伴う操作には書き込み権限が必要です。口座確認は例外で、セッションへの書き込みアクセスまたはフルアクセスが必要であり、銀行データ権限は不要です。銀行データはフルアクセスには含まれません。フルアクセスのキーは拒否され、権限を持つキーを作成するまで、呼び出しは
      `403 bank_data_access_denied`
      を返します。生の銀行データ（アカウント、残高、取引、変更フィード）も、APIキーを含まないリクエストを拒否します。


      `/v3/bank/`
      配下の拒否は、口座確認を除き、すべて同じJSONボディ（`code`、`message`、`request_id`、`field`、`next_action`、`retry_after`）を返します。操作ではないパス、UUIDではないID、未知のサブリソースは、すべてのメソッドで
      `404 not_found` を返し、予期しないエラーは `request_id` を伴う `500 internal_error`
      を返します。銀行データが利用できない場合、すべての操作はプラットフォームの標準 `404` を返します。これは未知のルートの場合とまったく同じです。
paths:
  /v3/bank/connections/{id}/:
    delete:
      tags:
        - Bank Data
      summary: 銀行接続の削除
      description: >-
        接続の銀行データを削除し、銀行へのアクセスを停止します。接続の口座、残高、取引、同期履歴、同意記録、所有構造の結果が削除されます。削除は取り消せません。


        削除はただちに開始されます。レスポンスは`202`で、`erasure.status`は`pending`になります。その時点から、接続のデータ操作（更新、同期実行、口座、残高、取引、変更フィード）は`409
        connection_not_active`を返します。その後、接続の`erasure.status`は`erased`になります。24時間以内に削除を確認できなかった場合は`failed`になり、削除に失敗したものは完了するまで再試行されます。削除された接続は最小限のレコードとして読み取られます。ID、`status:
        deleted`、理由、日付、`erasure`のステータスを含みますが、口座、残高、取引、同意、同期データは保持されません。


        影響を受けないもの：他の接続、すでに発生した料金（返金はされません）、およびすでにダウンロードしたデータ（お客様自身のコピーです）。呼び出しを繰り返すと、現在の状態が返されます。削除せずにアクセスを停止するには、`revoke_connection`を使用してください。


        この操作には、Bank
        dataの権限（`bank-data`）を持つAPIキーが必要です。この操作は書き込み（write）として扱われ、データを変更します。フルアクセスのキーには含まれないため、キーの作成時に明示的に付与してください。付与されていない場合、呼び出しは`403
        bank_data_access_denied`を返します。
      operationId: deleteBankConnection
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: 接続ID。
        - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '202':
          description: 削除を受け付けました。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankConnectionDeletion'
              examples:
                Accepted:
                  summary: 削除保留中
                  value:
                    id: 5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35
                    erasure:
                      status: pending
                      requested_at: '2026-11-21T15:10:00Z'
                      erased_at: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/BankDataAccessDenied'
        '404':
          description: このアプリケーションおよび環境には、このリソースが存在しません。
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankDataError'
              examples:
                Not found:
                  summary: 見つかりません
                  value:
                    code: not_found
                    message: The resource does not exist.
                    request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                    field: null
                    next_action: null
                    retry_after: null
        '429':
          $ref: '#/components/responses/RateLimitedWrite'
        '500':
          $ref: '#/components/responses/BankDataInternalError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: curl
          label: curl
          source: >-
            curl -X DELETE
            'https://verification.didit.me/v3/bank/connections/5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35/'
            \
              -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.delete_connection(
                "11111111-2222-3333-4444-555555555555",
            )
            print(result)
        - lang: javascript
          label: Node.js
          source: >-
            import Didit from "@didit-protocol/sdk-node";


            // Reads DIDIT_API_KEY.

            const didit = new Didit();


            const result = await
            didit.bank.deleteConnection("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.DeleteConnection(ctx, \"11111111-2222-3333-4444-555555555555\", didit.BankDeleteConnectionParams{})\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().deleteConnection("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->deleteConnection('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.delete_connection("11111111-2222-3333-4444-555555555555")

            puts result.to_h
        - lang: csharp
          label: .NET
          source: >-
            using System;

            using System.Text.Json;

            using Didit;


            // Reads DIDIT_API_KEY.

            using var client = new DiditClient();


            var result = await
            client.Bank.DeleteConnectionAsync("11111111-2222-3333-4444-555555555555");

            Console.WriteLine(JsonSerializer.Serialize(result));
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        1回の操作に対して任意で指定する、再試行の安全性を確保するためのキーです。255文字まで指定でき、UUIDも使用できます。同じキー、エンドポイント、クエリ、ボディで繰り返されたリクエストには、最初のレスポンスが同じステータスと同じボディで返され、2回目は実行も課金も行われません。同じキーを別のエンドポイント、クエリ、ボディで使うと
        `409` `idempotency_key_reused` が返されます。最初のリクエストがまだ処理中の場合は、`Retry-After`
        付きの `409` `idempotency_key_in_progress` が返されます。失敗したリクエスト（`4xx` または
        `5xx`）は保存されないため、同じキーで再送できます。キーは、APIキーとアクセストークンのどちらで呼び出す場合でも、お使いのアプリケーションに属します。詳しくは
        [再試行と冪等性](/ja/integration/api-errors#再試行と冪等性) を参照してください。
      schema:
        type: string
        minLength: 1
        maxLength: 255
  schemas:
    BankConnectionDeletion:
      type: object
      description: >-
        削除を受け付けました。接続の銀行データを削除しており、その間データ操作は `409 connection_not_active`
        を返します。接続を読み取ると、この `erasure` ステータスを持つ最小限のレコードが返されます。
      properties:
        id:
          type: string
          description: 接続ID。
          format: uuid
        erasure:
          $ref: '#/components/schemas/BankConnectionErasure'
      required:
        - id
        - erasure
    BankDataError:
      type: object
      description: すべての銀行データ操作のエラー本文。すべてのフィールドが常に含まれます。
      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: 機械可読なエラーコード。分岐にはこの値を使用してください。`message`では分岐しないでください。
        message:
          type: string
          description: 開発者向けの平易な説明。文言は変更されることがあるため、解析しないでください。
        request_id:
          type: string
          description: このリクエストの識別子。サポートに問い合わせる際は、この値を伝えてください。
        field:
          type: string
          description: エラーが1つのフィールドに関するものである場合に修正すべきリクエストフィールド。それ以外の場合は`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: 次に行うべき対応。クライアントが推測せずに行動できるようにするためのものです。標準の次のステップがない場合は `null`。
          nullable: true
        retry_after:
          type: integer
          description: 再試行するまでに待つ秒数です。レート制限と一時的なエラーの場合に設定され、それ以外の場合は `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
    BankConnectionErasure:
      type: object
      description: 依頼した削除の進行状況。
      properties:
        status:
          type: string
          enum:
            - pending
            - erased
            - failed
          description: >-
            削除の実行中は `pending`、保存済みのコピーと銀行へのアクセスが残っていないときは
            `erased`、24時間以内に確認できなかった場合は
            `failed`。削除が失敗した場合、接続のデータは閉じられたままになり、再試行され、Didit に通知されます。
        requested_at:
          type: string
          format: date-time
        erased_at:
          type: string
          format: date-time
          nullable: true
          description: 削除が完了した日時。`status` が `erased` になるまでは `null`。
      required:
        - status
        - requested_at
        - erased_at
    RateLimitBudgetError:
      type: object
      description: >-
        レート制限ミドルウェアの予算超過による拒否の場合にのみ返されます。その他の429エラー（冪等性の競合やエンドポイント固有の上限を含む）では、これらのメタデータフィールドは保証されません。
      required:
        - detail
        - reference
        - limit
        - remaining
        - reset
        - window_seconds
      properties:
        detail:
          type: string
          description: 既存の、人が読める形式のバジェット拒否メッセージです。
        reference:
          type: string
          pattern: ^RL-[0-9a-f]{32}$
          description: RL-で始まり、その後に小文字の16進数文字32文字（UUID形式）が続く不透明なサポート参照番号。
        limit:
          type: integer
          description: 超過した範囲のバジェット。X-RateLimit-Limit と同じ値です。
        remaining:
          type: integer
          minimum: 0
          description: 残りの予算。ゼロ未満にならないよう下限をゼロに制限しています。X-RateLimit-Remaining と等しくなります。
        reset:
          type: integer
          format: int64
          description: ウィンドウのリセット時刻（Unix秒）。X-RateLimit-Resetと同じ値です。
        window_seconds:
          type: integer
          description: 固定ウィンドウの期間（秒）です。残りの待機時間ではありません。再試行する前に Retry-Afterに従ってください。
      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: 認証されていません
      content:
        application/json:
          examples:
            Invalid API Key:
              summary: 無効なAPIキー
              value:
                detail: Invalid API Key.
    BankDataAccessDenied:
      description: >-
        APIキーに銀行データの権限(`bank-data`)がないか、本番環境のアプリケーションで生の銀行データを扱う場合は、アプリケーション設定
        "Bank data in the API"
        が無効になっています。銀行データはフルアクセスに含まれません。フルアクセスのキー、他のリソースに限定されたキー、APIキーを使わずに認証されたリクエスト(クライアント認証情報、生データの場合)は、いずれもこの内容で拒否されます。キーを作成し、明示的に権限を付与してください。この拒否はオブジェクトの検索より前に行われるため、オブジェクトが存在するかどうかは示しません。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Bank data not allowed:
              summary: 銀行データは許可されていません
              value:
                code: bank_data_access_denied
                message: >-
                  Bank data calls need an API key that carries the Bank data
                  permission.
                request_id: 3f6a1c8e-92b5-4d07-a1e3-8c4b7f0d2e59
                field: null
                next_action: enable_bank_data_access
                retry_after: null
    RateLimitedWrite:
      description: APIキーごとに毎分300リクエストという共有の書き込み上限を超えました。`Retry-After` の指示に従ってから再試行してください。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitBudgetError'
          example:
            detail: >-
              Write request rate limit exceeded. You can make up to 300 requests
              per minute.
            reference: RL-00000000000040008000000000000001
            limit: 300
            remaining: 0
            reset: 1794358860
            window_seconds: 60
      headers:
        Retry-After:
          $ref: '#/components/headers/BudgetRetryAfter'
        X-RateLimit-Scope:
          $ref: '#/components/headers/BudgetXRateLimitScope'
        X-RateLimit-Limit:
          $ref: '#/components/headers/BudgetXRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/BudgetXRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/BudgetXRateLimitReset'
    BankDataInternalError:
      description: >-
        Didit側で予期しないエラーが発生しました。`/v3/bank/` 配下で起きた予期しないエラーは、HTMLページではなく、必ず Bank
        のエラー形式で応答されます。サポートに問い合わせる際は `request_id` を伝えてください。
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BankDataError'
          examples:
            Internal error:
              summary: 予期しないエラー
              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: 次のウィンドウまでの待機秒数（切り上げ）。ミドルウェアの予算超過による拒否の場合にのみ含まれます。
      schema:
        type: integer
    BudgetXRateLimitScope:
      description: 予算を超過した範囲。ミドルウェアによる拒否の場合にのみ含まれます。
      schema:
        type: string
    BudgetXRateLimitLimit:
      description: 超過した範囲のバジェット。ボディの制限値と同じ値です。ミドルウェアのバジェットによる拒否の場合にのみ含まれます。
      schema:
        type: integer
    BudgetXRateLimitRemaining:
      description: >-
        残りの予算。ゼロ未満にならないよう下限をゼロに制限しています。ボディの remaining
        と等しくなります。ミドルウェアの予算による拒否の場合に存在します。
      schema:
        type: integer
    BudgetXRateLimitReset:
      description: リセット時刻はUnix秒です。本文のresetと同じ値です。ミドルウェアの予算超過による拒否レスポンスに含まれます。
      schema:
        type: integer
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        お客様のアプリケーションのAPIキーです。Business Console の Developers -> API keys
        から取得できます。プライマリーキーはすべてのアクセス権を持ちます。名前付きキーは範囲を制限できます。リソースごとに
        none、read、write
        を指定でき、一部のワークフローや承認済みセッションに限定できます。IPアドレスのリストや有効期限も設定できます。401
        はキーが誤っている、取り消されている、または期限切れであることを意味します。403
        はキーが送信されていない、そのリソースまたはアクションへのアクセス権がない、またはリクエストがIPリストに含まれないアドレスから送信されたことを意味します。セッションのルートでの404
        は、セッションがキーのワークフローまたはステータスの範囲外にあることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLが
        null で返されます。セッションの書き込み権限がないキーでは、セッションリンクとトークンが null で返されます。詳しくは
        https://docs.didit.me/console/api-keys を参照してください。

````

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