Saltar para o conteúdo principal
GET
curl
O endpoint List Bank Connections da Didit devolve as suas ligações bancárias, filtradas por estado, acesso, banco, país, as suas próprias referências e data de fim do consentimento. Use consent_expires_before para encontrar consentimentos que precisam de ser renovados e end_user_reference para encontrar as ligações de um cliente. A lista é paginada com cursor.

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.

Parâmetros de consulta

status
enum<string>

Apenas ligações com este estado.

Opções disponíveis:
pending,
active,
renewal_required,
paused,
revoked,
deleted,
failed
access
enum<string>

Apenas este modo de acesso.

Opções disponíveis:
one_time,
ongoing
institution_id
string

Apenas este banco.

Maximum string length: 64
country
string

Apenas bancos deste país.

Pattern: ^[A-Z]{3}$
vendor_data
string

Apenas ligações com este vendor_data.

Maximum string length: 255
end_user_reference
string

Apenas ligações com este end_user.reference.

Maximum string length: 255

Apenas ligações cujo consentimento termina antes desta data e hora, por exemplo para enviar ligações de renovação.

created_after
string<date-time>

Apenas ligações criadas após esta data e hora.

limit
integer
padrão:100

Tamanho da página, de 1 a 500. Predefinição 100.

Intervalo necessário: 1 <= x <= 500
cursor
string

Cursor opaco do next_cursor da página anterior.

Resposta

Uma página de ligações.

Uma página de ligações.

items
object[]
obrigatório
next_cursor
string | null
obrigatório

Envie como cursor para a página seguinte. null na última página.

Última modificação em 22 de novembro de 2026