To let an assistant use these tools, grant Insurance operations on the consent screen, or just
Policies under its Fine-tune. The scope is policies.
Read tools work with Read only or Read & write access; write tools only with
Read & write.
Your assistant doesn't see these tools straight away. It finds them with search_tools or
describe_tools, and runs one with use_tool, passing its name and
arguments. Most assistants do this for you: just ask for what you want.
What your assistant is told about this group
The policies you've sold, with each one's history of events and payments. Changes have real effects. cancel_policy can't be undone (within the cooling-off period the customer is refunded automatically). endorse_policy makes a mid-term change and issues a new version of the policy: run preview_policy_endorsement first to see the new premium. resend_policy_pack emails the customer their documents again. Confirm with the user before making any change.
The descriptions below are the ones your assistant reads, so they're written for it. When a connection covers more than one
organisation, the assistant passes org (the organisation's slug, from list_orgs) to say which one.
list_policies
Read List policies
The book of business: current policy versions only, newest bound first.
Arguments
| Field | Type | Description |
|---|---|---|
| state | string |
One of: "live", "cancelled", "expired", "claimed"
|
| decision | string |
One of: "accept_standard", "accept_rated", "mixed"
|
| product_id | string | |
| policy_number | string | Substring match |
| limit | integer | Default 25, cap 100 |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
get_policy
Read Get a policy
One policy in full: components, premium schedule status and captured risk factors.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_policy_events
Read List a policy's events
The policy's lifecycle event ledger, newest first.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Policy id |
| limit | integer | Default 25, cap 100 |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
list_policy_payments
Read List a policy's payments
The policy's payment ledger, newest first.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Policy id |
| limit | integer | Default 25, cap 100 |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
resend_policy_pack
Write Resend a policy pack
Re-dispatch the policy pack (schedule PDF + documents) to the customer's email, reflecting the current cover.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Policy id |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
cancel_policy
Write Cancel a policy
Staff cancellation. Cooling-off is auto-detected from the bind date (refund recorded, collections halted, benefits ended). Irreversible: confirm with the operator before calling.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Policy id |
| reason_code required | string |
One of: "customer_request", "non_payment", "material_non_disclosure"
|
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
preview_policy_endorsement
Read Preview a policy endorsement
Re-quote an endorsement WITHOUT committing: see the new premium first. Same arguments as endorse_policy.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Policy id |
| sum_assured_pence | integer | |
| term_years | integer | |
| risk_factors | object | smoker, smoking_frequency, height_cm, weight_kg |
| contact | object | Customer contact fields to change |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |
endorse_policy
Write Endorse a policy
Apply a mid-term change: cover amount, term, underwriting factors or customer contact details. Today's date applies immediately (a new policy version); a future effective_from is queued for the daily sweep. Run preview_policy_endorsement first to see the repriced premium.
Arguments
| Field | Type | Description |
|---|---|---|
| id required | string | Policy id |
| sum_assured_pence | integer | |
| term_years | integer | |
| risk_factors | object | smoker, smoking_frequency, height_cm, weight_kg |
| contact | object | Customer contact fields to change |
| effective_from | string | ISO date; omit for today |
| org | string | Organisation slug: required when this authorization covers more than one organisation (see list_orgs) |