Saltar para o conteúdo principal
GET
curl
O endpoint Get an Account da Didit devolve uma conta com os respetivos identificadores, titulares, atualidade da sincronização e cobertura do histórico. sync.last_synced_at indica a última vez em que a Didit obteve dados do banco. Os identificadores completos exigem a permissão para aceder aos dados bancários na sua chave de API. Consulte Contas, saldos e transações.

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

account_id
string<uuid>
obrigatório

O id da conta.

Resposta

A conta.

Uma conta dentro de uma ligação.

id
string<uuid>
obrigatório

ID da conta. Pertence à ligação e nunca muda enquanto existir, incluindo as renovações.

connection_id
string<uuid>
obrigatório
name
string | null
obrigatório
product
string | null
obrigatório

O nome do produto do banco.

type
enum<string>
obrigatório
Opções disponíveis:
current,
savings,
card,
loan,
investment,
other
usage
enum<string>
obrigatório
Opções disponíveis:
personal,
business,
unknown
currency
string
obrigatório

Código de moeda ISO 4217.

Pattern: ^[A-Z]{3}$
holder_name
string | null
obrigatório

Nome do titular, quando o banco o partilha.

holders
object[]
obrigatório

Titulares que o banco partilha. Para a propriedade, só contam holder e joint_holder.

identifiers
object
obrigatório

Identificadores completos, devolvidos a chamadores do lado do servidor com a permissão de dados bancários.

account_ref
string | null
obrigatório

Identifica a mesma conta bancária em diferentes ligações de uma aplicação e de um ambiente: um hash com chave dos identificadores próprios do banco. null quando o banco não fornece um identificador fiável. Utilize-o para reconhecer uma conta bancária que já conhece.

account_ref_previous
string | null
obrigatório

O account_ref anterior, apenas para um alias verificado, como uma migração de banco.

status
enum<string>
obrigatório

access_removed: a pessoa removeu a conta do consentimento. Deixa de ser sincronizada.

Opções disponíveis:
open,
closed,
access_removed
scopes_granted
enum<string>[]
obrigatório
Opções disponíveis:
accounts,
balances,
transactions
sync
object
obrigatório
history_coverage
object
obrigatório

O que o banco entregou do histórico que pediu.

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