Get Onboarding Status
get_onboarding_statusCheck the current onboarding status of the user's account.
WHEN TO CALL:
At the start of every conversation to determine if onboarding is needed
Immediately after receiving an onboarding-related error from any core tool
After calling submit_business_data to see updated missing fields and progress
RESPONSE INTERPRETATION:
status: 'NEW' → No data collected yet; call submit_business_data with any available fields
status: 'BUSINESS_DATA_PENDING' → Partial data saved; guidance.fieldsNeeded lists what's still missing
status: 'SUBMITTED' → All data submitted, awaiting carrier approval (~1 business day); do NOT re-submit
status: 'ACTIVE' or 'MANUAL_REVIEW' → Account is ready; all core tools are available
The 'guidance.fieldsNeeded' array is computed dynamically from the stored draft — it always reflects exactly what's still missing. The 'progress' object tracks overall completion percentage.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_onboarding_status"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| guidance | No | ||
| progress | No |