Saltar para o conteúdo principal
GET
curl
O endpoint Get an Institution da Didit devolve um banco com as suas capacidades e o respetivo estado. Um valor nunca observado é null, e não uma estimativa.

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 caminho

id
string
obrigatório

O id da instituição, por exemplo es-banco-norte.

Resposta

O banco.

Um banco e o que suporta. Os valores provêm de dados de capacidade observados, atualizados diariamente; um valor nunca observado é null, e não uma estimativa.

id
string
obrigatório

Identificador da Didit do banco, um slug estável.

Exemplo:

"es-banco-norte"

name
string
obrigatório
country
string
obrigatório
Pattern: ^[A-Z]{3}$
logo_url
string<uri> | null
obrigatório
timezone
string | null
obrigatório

Fuso horário IANA em que estão as datas do banco.

segments
enum<string>[]
obrigatório
Opções disponíveis:
personal,
business
access
enum<string>[]
obrigatório

ongoing só é listado onde o acesso contínuo está ativado para o banco.

Opções disponíveis:
one_time,
ongoing
ongoing_access
boolean
obrigatório

Se o acesso contínuo está disponível neste banco.

O consentimento mais longo que o banco permite, em dias. null quando não foi observado.

history_days_max
integer | null
obrigatório

O período histórico mais extenso que o banco disponibiliza, em dias. null quando não foi observado.

pending_transactions
boolean | null
obrigatório

Se o banco reporta transações pendentes.

pending_linkage
boolean | null
obrigatório

Se o banco associa uma transação pendente à transação contabilizada, o que define pending_id.

balance_types
enum<string>[]
obrigatório
Opções disponíveis:
booked,
available,
expected
transaction_fields
string[]
obrigatório

Os campos de transação que o banco é conhecido por enviar. Todos os outros campos são null.

sign_in
enum<string> | null
obrigatório

Como a pessoa inicia sessão no banco.

Opções disponíveis:
redirect,
app_approval,
credentials,
null
requires_end_user_email
boolean | null
obrigatório

Se a Bank Link exige um endereço de e-mail verificado para a pessoa.

corporate_accounts
boolean | null
obrigatório

Se as contas empresariais são suportadas.

bank_account_selection
boolean | null
obrigatório

Se a pessoa escolhe as contas no banco em vez de no Bank Link.

Se o banco pede mais uma confirmação para libertar o histórico mais antigo.

reconfirmation
boolean | null
obrigatório

Se uma renovação pode ser reconfirmada no ecrã da Didit sem nova autenticação no banco.

sync_frequency_hours
integer | null
obrigatório

Horas entre sincronizações automáticas, quando o banco permite uma cadência mais rápida. null significa a predefinição diária.

health
enum<string>
obrigatório
Opções disponíveis:
operational,
degraded,
down
Última modificação em 22 de novembro de 2026