Check sync status of bank accounts | Open Ledger Documentation

curl -G https://api-staging.openledger.com/v1/banks/sync-status \
     -H "Authorization: Bearer <token>" \
     -d entityId=ent_123456

{
  "accounts": [
    {
      "id": "acc_123456",
      "accountName": "Chase Checking",
      "accountMask": "xxxx1234",
      "syncStatus": "in_progress",
      "transactionCount": 150,
      "estimatedTransactions": 200,
      "recentTransactionCount": 25,
      "accountAge": 15
    },
    {
      "id": "acc_789012",
      "accountName": "Wells Fargo Savings",
      "accountMask": "xxxx5678",
      "syncStatus": "completed",
      "transactionCount": 75,
      "estimatedTransactions": 75,
      "recentTransactionCount": 0,
      "accountAge": 45
    }
  ],
  "allSynced": false,
  "summary": {
    "total": 2,
    "completed": 1,
    "inProgress": 1,
    "pending": 0,
    "failed": 0
  },
  "transactionProgress": {
    "totalTransactions": 225,
    "syncedTransactions": 225,
    "estimatedTotal": 275,
    "progressPercentage": 82
  },
  "timestamp": "2024-03-20T10:30:00.000Z"
}

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

Authentication

AuthorizationBearer

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

allSyncedboolean

Whether all accounts have completed synchronization

summaryobject

Summary of sync status across all accounts

transactionProgressobject

Overall transaction-level progress across all accounts

timestampstringformat: "date-time"

Timestamp when the sync status was checked

messagestring

Optional message, present when no accounts are found

Errors

400

Bad Request Error

500

Internal Server Error