Saltar para o conteúdo principal
POST
curl
O endpoint de revogação de uma conexão bancária da Didit interrompe o acesso ao banco, e as consultas de dados ao banco param no momento em que o pedido é feito. Revogar não elimina nada: para isso, use eliminar. O consentimento fica com o estado revocation_pending e passa a revoked quando o banco confirma.

Autorizações

x-api-key
string
header
obrigatório

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

Idempotency-Key
string

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.

Required string length: 1 - 255

Parâmetros de caminho

id
string<uuid>
obrigatório

O id da ligação.

Resposta

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.

id
string<uuid>
obrigatório

Identificador da ligação bancária.

status
enum<string>
obrigatório

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.

Opções disponíveis:
pending,
active,
renewal_required,
paused,
revoked,
deleted,
failed
status_reason
enum<string> | null
obrigatório

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.

Opções disponíveis:
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
erasure
object | null
obrigatório

Definido após delete_connection; caso contrário, null.

created_at
string<date-time>
obrigatório
environment
enum<string>
Opções disponíveis:
live,
sandbox
access
enum<string>
Opções disponíveis:
one_time,
ongoing
institution
object

O banco a que se destina uma ligação ou uma hiperligação.

segment
enum<string> | null
Opções disponíveis:
personal,
business,
null
data
enum<string>[]

Os âmbitos que a pessoa aceitou.

Opções disponíveis:
accounts,
balances,
transactions

O consentimento da pessoa para esta conexão.

sync
object

Estado de sincronização de uma conexão.

accounts
object[]

Resumo de todas as contas da conexão. Leia a conta completa com get_account.

ownership
object

A comparação opcional do titular da conta com uma pessoa ou empresa.

end_user
object
manage_url
string<uri> | null

A página de acesso própria da pessoa. null até a página de acesso estar disponível.

billing
object

Quanto custa esta conexão. O sandbox nunca é cobrado.

possible_duplicate_of
string<uuid> | null

Definido quando esta ligação pode duplicar outra ligação ativa, mas nenhuma referência de end_user.reference permitiu confirmar uma correspondência.

vendor_data
string | null
updated_at
string<date-time>
Última modificação em 22 de novembro de 2026