Pular para o conteúdo principal
GET
curl
O endpoint Obter uma conexão bancária da Didit retorna uma conexão com o status, as datas de consentimento, o estado da sincronização, os resumos das contas e o custo. sync.initial_status informa quando os primeiros dados podem ser lidos, consent.expires_at indica quando você deve renovar e sync.budgets mostra quantas atualizações o banco ainda permite. Veja Conexões.

Autorizações

x-api-key
string
header
obrigatório

A chave de API da sua aplicação, obtida em Developers -> API keys no Business Console. A chave principal tem acesso completo. Uma chave nomeada pode ter escopo limitado: nenhum, leitura ou escrita por recurso, restrita a alguns fluxos ou a sessões aprovadas, a uma lista de endereços e a uma data de validade. 401 significa que a chave está incorreta, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição partiu de um endereço fora da lista de endereços da chave; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status permitidos para a chave. Uma chave sem acesso a mídia recebe as URLs de imagem, vídeo e PDF como null, e uma chave sem escrita de sessões recebe os links e tokens de sessão como null. Veja https://docs.didit.me/console/api-keys.

Parâmetros de caminho

id
string<uuid>
obrigatório

O ID da conexão.

Resposta

A conexão.

A permissão da pessoa para que sua aplicação leia um banco. Uma renovação mantém o id da conexão e todos os ids de conta. Uma conexão excluída responde apenas id, status, status_reason, created_at e erasure: todos os outros campos estão ausentes, e nenhum dado de banco, pessoa ou conta permanece nela.

id
string<uuid>
obrigatório

Identificador da conexão.

status
enum<string>
obrigatório

pending: primeira sincronização em andamento. active: consentimento válido. renewal_required: o consentimento terminou ou o banco quer que a pessoa entre novamente, com os dados disponíveis conforme a última sincronização e sem cobrança. paused: saldo insuficiente para o mês. revoked: acesso interrompido pela pessoa, pelo banco ou por você. 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

Por que a conexão está neste status. paused_by_customer é reservado. Em uma 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 ao qual uma conexão ou link se refere.

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

Os escopos que a pessoa aceitou.

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

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

Página de acesso da própria pessoa. null até que a página de acesso esteja disponível.

billing
object

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

possible_duplicate_of
string<uuid> | null

Definido quando esta conexão pode duplicar outra conexão ativa, mas nenhum end_user.reference permitiu uma correspondência específica.

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