Saltar para o conteúdo principal
GET
curl
O endpoint Obter uma execução de sincronização da Didit devolve uma sincronização com o respetivo resultado para cada conta e recurso: contagens de itens adicionados, modificados e removidos, ou o erro. O sync_id vem de Atualizar uma ligação ou do webhook bank.data.updated.

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<uuid>
obrigatório

O id da ligação.

sync_id
string<uuid>
obrigatório

O id da execução de sincronização.

Resposta

A execução de sincronização.

Uma sincronização de uma ligação. Só são listadas as sincronizações iniciais, agendadas e pedidas.

id
string<uuid>
obrigatório
connection_id
string<uuid>
obrigatório
trigger
enum<string>
obrigatório
Opções disponíveis:
initial,
scheduled,
requested
status
enum<string>
obrigatório
Opções disponíveis:
queued,
running,
succeeded,
partial,
failed
started_at
string<date-time> | null
obrigatório
finished_at
string<date-time> | null
obrigatório
results
object[]
obrigatório

O que a execução fez, por conta e por recurso.

error
object | null
obrigatório

Motivo pelo qual a execução falhou no seu todo. null quando não falhou. Os erros de contas e recursos individuais estão em results.

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