Skip to main content

Update Lifecycle

Status Transitions

Timing Expectations

  • Snapshot Updates: Return synchronously in the POST response. No lifecycle to track. The response is immediately completed (or failed).
  • Direct Updates: Asynchronous. Typical completion time varies by institution. Most complete within seconds, some may take up to a few minutes. Design your UI to show a loading state and handle the webhook.

Webhook Events

Subscribe to update.update to react when data is ready. The webhook payload includes the path to retrieve the full Update object.

Idempotency

If you need to retry a failed Update, use idempotency keys to avoid creating duplicate requests.