Pular para o conteúdo principal
GET
curl
O endpoint List Bank Connections da Didit retorna suas conexões, filtradas por status, acesso, banco, país, suas próprias referências e data de término do consentimento. Use consent_expires_before para encontrar consentimentos que precisam ser renovados e end_user_reference para encontrar as conexõ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 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 consulta

status
enum<string>

Somente conexões com este status.

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

Somente este modo de acesso.

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

Somente este banco.

Maximum string length: 64
country
string

Somente bancos deste país.

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

Somente conexões com este vendor_data.

Maximum string length: 255
end_user_reference
string

Somente conexões com este end_user.reference.

Maximum string length: 255

Somente conexões cujo consentimento termina antes deste horário, por exemplo, para enviar links de renovação.

created_after
string<date-time>

Somente conexões criadas após este horário.

limit
integer
padrão:100

Tamanho da página, de 1 a 500. Padrão: 100.

Intervalo obrigatório: 1 <= x <= 500
cursor
string

Cursor opaco de next_cursor da página anterior.

Resposta

Uma página de conexões.

Uma página de conexões.

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

Envie como cursor para a próxima página. null na última página.

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