API OverviewAPI EndpointsBanks

Check sync status of bank accounts

Check the synchronization status of bank accounts for an entity, including real-time transaction progress

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

entityIdstringRequired
The ID of the entity to check sync status for

Response

Sync status retrieved successfully
accountslist of objects or null
allSyncedboolean or null
Whether all accounts have completed synchronization
summaryobject or null
Summary of sync status across all accounts
transactionProgressobject or null

Overall transaction-level progress across all accounts

timestampdatetime or null
Timestamp when the sync status was checked
messagestring or null
Optional message, present when no accounts are found

Errors