curl -X POST 'https://verification.didit.me/v3/bank/connections/5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35/revoke/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.bank.revoke_connection(
"11111111-2222-3333-4444-555555555555",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.bank.revokeConnection("11111111-2222-3333-4444-555555555555");
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Bank.RevokeConnection(ctx, "11111111-2222-3333-4444-555555555555", didit.BankRevokeConnectionParams{})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.bank().revokeConnection("11111111-2222-3333-4444-555555555555");
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->bank->revokeConnection('11111111-2222-3333-4444-555555555555');
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.bank.revoke_connection("11111111-2222-3333-4444-555555555555")
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Bank.RevokeConnectionAsync("11111111-2222-3333-4444-555555555555");
Console.WriteLine(JsonSerializer.Serialize(result));{
"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": "revocation_pending",
"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": "2026-12-21T15:10:00Z",
"retain_until": "2026-12-21T15:10:00Z",
"ended_at": "2026-11-21T15:10:00Z",
"ended_by": "customer"
},
"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"
}銀行接続を取り消すAPI:アクセスを停止
Didit の「銀行接続を取り消す」エンドポイントは銀行へのアクセスを停止し、リクエストした時点で銀行データの取得も即座に止まります。
curl -X POST 'https://verification.didit.me/v3/bank/connections/5e1d2a70-3b94-4c1f-8a6e-d2f07b9c1e35/revoke/' \
-H 'x-api-key: YOUR_API_KEY'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.bank.revoke_connection(
"11111111-2222-3333-4444-555555555555",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.bank.revokeConnection("11111111-2222-3333-4444-555555555555");
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Bank.RevokeConnection(ctx, "11111111-2222-3333-4444-555555555555", didit.BankRevokeConnectionParams{})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.bank().revokeConnection("11111111-2222-3333-4444-555555555555");
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->bank->revokeConnection('11111111-2222-3333-4444-555555555555');
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.bank.revoke_connection("11111111-2222-3333-4444-555555555555")
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Bank.RevokeConnectionAsync("11111111-2222-3333-4444-555555555555");
Console.WriteLine(JsonSerializer.Serialize(result));{
"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": "revocation_pending",
"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": "2026-12-21T15:10:00Z",
"retain_until": "2026-12-21T15:10:00Z",
"ended_at": "2026-11-21T15:10:00Z",
"ended_by": "customer"
},
"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"
}revocation_pendingと表示され、確認後はrevokedに変わります。承認
お客様のアプリケーションの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 を参照してください。
ヘッダー
1回の操作に対して任意で指定する、再試行の安全性を確保するためのキーです。255文字まで指定でき、UUIDも使用できます。同じキー、エンドポイント、クエリ、ボディで繰り返されたリクエストには、最初のレスポンスが同じステータスと同じボディで返され、2回目は実行も課金も行われません。同じキーを別のエンドポイント、クエリ、ボディで使うと 409 idempotency_key_reused が返されます。最初のリクエストがまだ処理中の場合は、Retry-After 付きの 409 idempotency_key_in_progress が返されます。失敗したリクエスト(4xx または 5xx)は保存されないため、同じキーで再送できます。キーは、APIキーとアクセストークンのどちらで呼び出す場合でも、お使いのアプリケーションに属します。詳しくは 再試行と冪等性 を参照してください。
1 - 255レスポンス
取り消しステータスを含む接続。
あなたのアプリケーションが1つの銀行を読み取るための本人の権限です。更新しても接続IDとすべてのアカウントIDは維持されます。削除された接続では、id、status、status_reason、created_at、erasureのみが返されます。それ以外のフィールドは存在せず、銀行、本人、アカウントのデータは一切残りません。
pending: 初回の同期が実行中です。active: 同意は有効です。renewal_required: 同意が終了したか、銀行が本人に再サインインを求めています。データは最後の同期時点のまま読み取り可能で、課金は発生しません。paused: 今月の残高が不足しています。revoked: 本人、銀行、またはあなたによりアクセスが停止されました。deleted: id、status、status_reason、created_at、erasure のみが残ります。failed: 初回の同期が一度も成功していません。
pending, active, renewal_required, paused, revoked, deleted, failed 接続がこのステータスになっている理由。paused_by_customer は予約済みです。deleted の接続の場合: deleted_by_customer、consent_lapsed、retention_elapsed、application_deleted。
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