Check an intended change
check_actionCheck an intended change against the connected investor's mandate and return a rule-level verdict: ok, breach, cooling_off, no_rule, unavailable or unclassified. Accepts legs, each naming an ISIN or an asset class with an amount in euros or in percent of the portfolio; a single asset-class action (action_type, asset_class, amount_pct_of_portfolio) is also accepted. Every touched rule includes its current and projected state, plus evidence coverage and freshness. The verdict cites asset classes, the investor's rules and leg indices, never an instrument name. Each call saves a new check and verdict in the investor's history and returns its check_id, the identifier for that saved record. Stale or missing portfolio data produces an unavailable verdict with evidence recovery guidance and an optional next_step_href relative to the connected Investboard origin. A repeated call evaluates the then-current evidence and creates another saved check. Investboard never places, changes or transmits an order.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| legs | No | ||
| funding | No | Where the money for the buy legs comes from. within_book (the default): the book keeps its size and each leg moves only its own class, so a purchase paid from cash names its cash side as a sell leg of its own. new_money: money from outside the book, so the book grows by the buy legs; every class and position share is measured over the grown book, and an issuer's share over the equity book grown by the equity buys. The action_type does not set it: a contribute action is measured within the book unless funding is new_money. | |
| setup_id | No | ||
| rationale | No | ||
| action_type | Yes | ||
| asset_class | No | ||
| amount_pct_of_portfolio | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | Yes | ||
| reasons | Yes | ||
| check_id | Yes | Use this saved check id in record_decision or get_reflection_history. | |
| coverage | Yes | ||
| checked_at | Yes | ||
| unlocks_at | Yes | ||
| cited_bands | Yes | ||
| cited_rules | Yes | ||
| next_step_href | Yes | ||
| schema_version | Yes |