Onboarding status and next step
get_onboarding_statusSUPERSEDED: prefer get_books_status, which covers connections PLUS every books queue (approvals, adjudications, reviews, transfers) with one prioritised next_step. This tool keeps the pure connect walk; since multi-bank an openbanking entry in connected[] also carries connections[] (one per bank, reconnect-required ones marked). The agent onboarding loop driver: which providers are connected, pending, or degraded (credential rejected by the provider — reconnect required), and the ONE next step to take. Loop contract: call this, do next_step (usually: relay next_step.ask to your human, then call next_step.tool if set), call this again — until next_step.action is 'done'. gate=true means the step is blocked on a human action. If next_step carries a warning, relay it to your human VERBATIM and do not proceed without their explicit confirmation. Reads connection state only — never calls provider APIs.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| org_id | No | Optional. Defaults to the organisation the authenticated API key is bound to, so you normally omit it and never need to ask the user for their organisation UUID. If provided, it must match the key’s org or the request is rejected. | 0e91146d-511c-469f-bdee-5c867b26ae0d |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pending | Yes | ||
| degraded | Yes | ||
| connected | Yes | ||
| next_step | Yes |