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"
}Revoke a Bank Connection API: Stop Access
Didit’s Revoke a Bank Connection endpoint stops access to the bank, and bank fetches stop the moment you ask.
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, then revoked when the bank confirms.Authorizations
Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.
Headers
Optional retry-safety key you choose for one operation, up to 255 characters (a UUID works). A request repeated with the same key, endpoint, query and body is answered with the first response, same status and same body, and runs and bills nothing a second time. The same key with another endpoint, query or body returns 409 idempotency_key_reused, and while the first request is still running, 409 idempotency_key_in_progress with Retry-After. A failed request (any 4xx or 5xx) is not stored, so you can send it again with the same key. Keys belong to your application, whether you call with an API key or an access token. See Retries and idempotency.
1 - 255Response
The connection with the revocation status.
The person's permission for your application to read one bank. A renewal keeps the connection id and every account id. A deleted connection answers only id, status, status_reason, created_at and erasure: every other field is absent, and no bank, person or account data remains in it.
pending: first sync running. active: consent valid. renewal_required: the consent ended or the bank wants the person to sign in again, data readable as last synced and nothing charged. paused: balance too low for the month. revoked: access stopped by the person, the bank or you. deleted: only id, status, status_reason, created_at and erasure remain. failed: the first sync never succeeded.
pending, active, renewal_required, paused, revoked, deleted, failed Why the connection is in this status. paused_by_customer is reserved. On a deleted connection: deleted_by_customer, consent_lapsed, retention_elapsed or 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