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 para revogar ligação bancária: parar o acesso
O endpoint Revogar uma Ligação Bancária da Didit interrompe o acesso ao banco, e as consultas bancárias param no momento em que o pede.
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 e passa a revoked quando o banco confirma.Autorizações
A chave de API da sua aplicação, obtida em Developers -> API keys na Business Console. A chave principal tem acesso total. Uma chave com nome pode ter o âmbito limitado: nenhum, leitura ou escrita por recurso, limitada a alguns fluxos ou apenas a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que não foi enviada nenhuma chave, que a chave não tem acesso a este recurso ou ação, ou que o pedido veio de um endereço fora da sua lista de IP; 404 numa rota de sessão significa que a sessão está fora dos fluxos ou estados da chave. Uma chave sem acesso a multimédia recebe os URLs de imagem, vídeo e PDF como null, e uma chave sem escrita em sessões recebe os links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.
Cabeçalhos
Chave opcional, à sua escolha, para garantir a segurança de novas tentativas numa operação, com até 255 caracteres (um UUID funciona). Um pedido repetido com a mesma chave, endpoint, parâmetros de query e corpo recebe a primeira resposta, com o mesmo código de estado e o mesmo corpo, e não é executado nem faturado uma segunda vez. A mesma chave com outro endpoint, outros parâmetros de query ou outro corpo devolve 409 idempotency_key_reused. Enquanto o primeiro pedido ainda estiver em execução, devolve 409 idempotency_key_in_progress com Retry-After. Um pedido falhado (qualquer 4xx ou 5xx) não é guardado, pelo que pode ser enviado novamente com a mesma chave. As chaves pertencem à sua aplicação, quer chame a API com uma chave de API, quer com um token de acesso. Consulte Novas tentativas e idempotência.
1 - 255Resposta
A ligação com o estado de revogação.
A permissão da pessoa para a sua aplicação ler um banco. Uma renovação mantém o id da conexão e todos os ids de conta. Uma conexão eliminada responde apenas com id, status, status_reason, created_at e erasure: todos os outros campos estão ausentes, e não permanece nela nenhum dado do banco, da pessoa ou da conta.
pending: primeira sincronização em curso. active: consentimento válido. renewal_required: o consentimento terminou ou o banco quer que a pessoa volte a iniciar sessão; os dados podem ser lidos tal como na última sincronização, e nada é cobrado. paused: saldo insuficiente para o mês. revoked: acesso interrompido pela pessoa, pelo banco ou por si. deleted: restam apenas id, status, status_reason, created_at e erasure. failed: a primeira sincronização nunca teve êxito.
pending, active, renewal_required, paused, revoked, deleted, failed Motivo pelo qual a conexão se encontra neste estado. paused_by_customer está reservado. Numa conexão deleted: deleted_by_customer, consent_lapsed, retention_elapsed ou 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