Insurance
Fields marked * are required. Updates keep every field they are not given. An AI app can ask vritto_describe for the same details, filtered to what its connection may use.
Insurance Policyinsurance_policy
An insurance policy with premiums, renewal, and coverage. The same operations reach claims against a policy (type 'claim').
insurance_findFindthrough vritto_findRead Insurance: one record by id, or policies and claims filtered by status, policy type, dates (a policy's renewal, a claim's filing), policy or text. No filter gives counts plus compact policy and claim rows (type, provider, premium, renewal, status; claim status, filed date, amount). detail 'full' for deductibles, coverage, contacts and notes.
Note: No filter returns a compact summary of policies and claims; from/to reads policies renewing (or claims filed) in a period.
| Field | Type | Description |
|---|---|---|
| type | one of policy, claim | Which records to read; omit for both. |
| id | string | Return just this record. |
| policyId | string | Claims against this policy. |
| policyType | one of auto, home, renters, health, life, travel, pet, disability, umbrella, device, business, other | Type 'policy': only this kind of coverage. |
| status | one of active, pending, expired, cancelled, shopping, open, submitted, approved, paid, denied, closed | Only records in this status. |
| from | string | Earliest date, inclusive: a policy's renewal (else expiration), a claim's filing (else incident). |
| to | string | Latest date, inclusive, on the same dates. ALWAYS pass from/to when the question concerns a period. |
| query | string | Text to match: a provider, policy or claim number, named insured or adjuster. |
| limit | integer | Rows to return per type, default 25. |
| detail | one of summary, full | "summary" (default) compact rows; "full" every record incl. deductibles, coverage details, contacts, and notes. |
Example input
{}insurance_addCreate or Updatethrough vritto_create or vritto_updateAdd one record: a policy (providerName, type, premium with its currency and billingCadence, dates), or a claim (type 'claim': policyId from insurance_find, incidentDate, amountClaimed). A real record.id updates that record instead; sent fields merge. Example: record { providerName 'GEICO', type 'auto', premium 120, currency 'USD', billingCadence 'monthly', deductible 500, expirationDate '2026-12-01' }.
| Field | Type | Description |
|---|---|---|
| type | one of policy, claim | Record type: 'policy' (default) an insurance policy; 'claim' a claim against a policy. |
| record | object | The record's fields; a policy needs providerName, a claim its policyId. |
| record.id | string | Leave out to add; a real id updates that record, only the fields you send change. |
| record.providerName | string | Insurer or provider name, e.g. 'GEICO'. Required when creating. |
| record.source | one of manual, import, bank | Where the record came from. Set by the ingestion pipeline; leave unset. |
| record.websiteDomain | string | Provider website domain, e.g. 'geico.com'. Also used to resolve the logo. |
| record.policyNumber | string | Policy number. |
| record.type | one of auto, home, renters, health, life, travel, pet, disability, umbrella, device, business, other | Coverage type (default 'other'). |
| record.status | one of active, pending, expired, cancelled, shopping, open, submitted, approved, paid, denied, closed | A policy is active (default), pending, expired, cancelled or shopping (a quote); a claim open (default), submitted, approved, paid, denied or closed. |
| record.namedInsured | string | Named insured people, e.g. 'Tharun; spouse'. |
| record.coverageSummary | string | Short summary of what the policy covers. |
| record.currency | string | ISO 4217 code of the record's money, as the user or the document states it ('USD', 'INR'). A claim takes its policy's when left out. Never assume USD. |
| record.premium | number | Premium per billing cadence in the given currency (default 0). |
| record.billingCadence | one of monthly, quarterly, semiannual, yearly, one_time, unknown | How often the premium is billed (default 'monthly'). |
| record.deductible | number | Deductible amount (default 0). |
| record.coverageLimit | number | Coverage limit amount (default 0). |
| record.effectiveDate | string | Coverage start date (YYYY-MM-DD). |
| record.expirationDate | string | Coverage end date (YYYY-MM-DD). |
| record.renewalDate | string | Renewal date (YYYY-MM-DD). Defaults to the expiration date. |
| record.nextPaymentDate | string | Next premium payment date (YYYY-MM-DD). |
| record.renewalReminderDays | integer | Days before a renewal, expiration, or premium date to send the reminder (default 14, 0 = on the day). |
| record.agentName | string | Agent or broker name. |
| record.agentPhone | string | Agent phone number. |
| record.agentEmail | string | Agent email address. |
| record.customerServicePhone | string | Customer service or claims phone number. |
| record.notes | string | Notes; on a claim, timeline updates or a preparation checklist. |
| record.coveredPersonIds | list of string | People person ids this policy covers; replaces wholesale. |
| record.tags | list of string | Tags. |
| record.assetIds | list of string | Linked Files document IDs (policy documents, receipts, evidence). Resolve them with files_find or after an upload; never invented. |
| record.claimNumber | string | Insurer-assigned claim number. |
| record.incidentDate | string | Date of the incident (YYYY-MM-DD). |
| record.filedDate | string | Date the claim was filed (YYYY-MM-DD). |
| record.amountClaimed | number | Amount claimed (default 0). |
| record.amountPaid | number | Amount paid out so far (default 0). |
| record.adjusterName | string | Adjuster name. |
| record.adjusterPhone | string | Adjuster phone number. |
| record.policyId | string | Type 'claim': the covering policy. Required for a claim. |
| policy | object | Older form of record, for a policy. |
| policy.providerName | string | |
| claim | object | Older form of record, for a claim. |
| claim.policyId | string |
Example input
{
"record": {
"providerName": "State Farm",
"type": "auto",
"status": "active",
"premium": 684,
"currency": "USD",
"billingCadence": "semiannual",
"renewalDate": "2027-02-14"
}
}insurance_changeUpdatethrough vritto_updateChange one policy or claim by record.id (set type 'claim' for a claim); only sent fields change. A settled claim is its status and amountPaid; a lapsed policy is its status. Resolve the id with insurance_find first.
| Field | Type | Description |
|---|---|---|
| type | one of policy, claim | Record type: 'policy' (default) an insurance policy; 'claim' a claim against a policy. |
| record* | object | The record's id plus the fields to change. |
| record.id* | string | Record ID from a prior insurance_find result, never invented. |
| record.providerName | string | Insurer or provider name, e.g. 'GEICO'. Required when creating. |
| record.source | one of manual, import, bank | Where the record came from. Set by the ingestion pipeline; leave unset. |
| record.websiteDomain | string | Provider website domain, e.g. 'geico.com'. Also used to resolve the logo. |
| record.policyNumber | string | Policy number. |
| record.type | one of auto, home, renters, health, life, travel, pet, disability, umbrella, device, business, other | Coverage type (default 'other'). |
| record.status | one of active, pending, expired, cancelled, shopping, open, submitted, approved, paid, denied, closed | A policy is active (default), pending, expired, cancelled or shopping (a quote); a claim open (default), submitted, approved, paid, denied or closed. |
| record.namedInsured | string | Named insured people, e.g. 'Tharun; spouse'. |
| record.coverageSummary | string | Short summary of what the policy covers. |
| record.currency | string | ISO 4217 code of the record's money, as the user or the document states it ('USD', 'INR'). A claim takes its policy's when left out. Never assume USD. |
| record.premium | number | Premium per billing cadence in the given currency (default 0). |
| record.billingCadence | one of monthly, quarterly, semiannual, yearly, one_time, unknown | How often the premium is billed (default 'monthly'). |
| record.deductible | number | Deductible amount (default 0). |
| record.coverageLimit | number | Coverage limit amount (default 0). |
| record.effectiveDate | string | Coverage start date (YYYY-MM-DD). |
| record.expirationDate | string | Coverage end date (YYYY-MM-DD). |
| record.renewalDate | string | Renewal date (YYYY-MM-DD). Defaults to the expiration date. |
| record.nextPaymentDate | string | Next premium payment date (YYYY-MM-DD). |
| record.renewalReminderDays | integer | Days before a renewal, expiration, or premium date to send the reminder (default 14, 0 = on the day). |
| record.agentName | string | Agent or broker name. |
| record.agentPhone | string | Agent phone number. |
| record.agentEmail | string | Agent email address. |
| record.customerServicePhone | string | Customer service or claims phone number. |
| record.notes | string | Notes; on a claim, timeline updates or a preparation checklist. |
| record.coveredPersonIds | list of string | People person ids this policy covers; replaces wholesale. |
| record.tags | list of string | Tags. |
| record.assetIds | list of string | Linked Files document IDs (policy documents, receipts, evidence). Resolve them with files_find or after an upload; never invented. |
| record.claimNumber | string | Insurer-assigned claim number. |
| record.incidentDate | string | Date of the incident (YYYY-MM-DD). |
| record.filedDate | string | Date the claim was filed (YYYY-MM-DD). |
| record.amountClaimed | number | Amount claimed (default 0). |
| record.amountPaid | number | Amount paid out so far (default 0). |
| record.adjusterName | string | Adjuster name. |
| record.adjusterPhone | string | Adjuster phone number. |
| record.policyId | string | Type 'claim': the covering policy. Required for a claim. |
Example input
{
"record": {
"id": "pol_auto",
"premium": 135
}
}insurance_removeDeletethrough vritto_deleteRemove (archive) one policy (marked cancelled) or claim. Only for explicit removal requests: to record that a policy lapsed or a claim was settled, use insurance_change with its status. Resolve the id with insurance_find first.
Note: Set type 'claim' for a claim. A removed policy is marked cancelled.
| Field | Type | Description |
|---|---|---|
| id | string | The record to remove. |
| type | one of policy, claim | Record type: 'policy' (default) an insurance policy; 'claim' a claim against a policy. |
| policyId | string | Older name for a policy's id. |
| claimId | string | Older name for a claim's id. |