Skip to main content
GET
curl
Didit’s Get a Sync Run endpoint returns one sync with its result for each account and resource: added, modified and removed counts, or the error. The sync_id comes from Refresh a connection or from the bank.data.updated webhook.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

id
string<uuid>
required

The connection id.

sync_id
string<uuid>
required

The sync run id.

Response

The sync run.

One synchronisation of a connection. Only initial, scheduled and requested syncs are listed.

id
string<uuid>
required
connection_id
string<uuid>
required
trigger
enum<string>
required
Available options:
initial,
scheduled,
requested
status
enum<string>
required
Available options:
queued,
running,
succeeded,
partial,
failed
started_at
string<date-time> | null
required
finished_at
string<date-time> | null
required
results
object[]
required

What the run did, per account and resource.

error
object | null
required

Why the run failed as a whole. null when it did not. Errors of single accounts and resources are in results.

Last modified on November 22, 2026