v1

latestOpenAPI 3.1.02026-08-04253331435.1 KB

Accounts

Get Institution Summary

Return the account's activity summary, triggering a worker regeneration when it's missing or stale. The result and freshness are delivered via the account_summary_ready websocket event, so the client does not poll.

get/api/v3/accounts/{institution_id}/summary

Path parameters

institution_idstring required

Response

Successful Response

status'none' | 'generating' | 'ready' | 'failed' required

summarystring nullable

summary_generated_atstring date-time nullable

sectionsobject[] nullable