Skip To Main Content
All modules

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.

insurance_queryInsuranceDashboardFindthrough vritto_find

List all non-archived insurance policies and claims. Use for coverage questions, renewal lookups, and to resolve policy or claim IDs before any write. Defaults to a compact summary: counts plus capped lean rows (policy type, provider, premium, renewal date, status; claim status, filed date, amount).

FieldTypeDescription
detailone of summary, fullResponse shape: "summary" (default, counts + capped lean policy/claim rows) or "full" (every record incl. deductibles, coverage details, contacts, and notes).
insurance_upsertInsurancePolicyCreate or Updatethrough vritto_create or vritto_update

Create or update one insurance policy. Omit policy.id to create (providerName required); include a real policy.id from insurance_queryInsuranceDashboard to update, sent fields merge over the existing record. Example: policy { providerName 'GEICO', type 'auto', premium 120, billingCadence 'monthly', deductible 500, expirationDate '2026-12-01' }.

FieldTypeDescription
policy*objectPolicy fields; providerName is required when creating.
policy.idstringExisting policy ID to update, from a prior insurance_queryInsuranceDashboard result. Omit to create a new policy.
policy.providerNamestringInsurer or provider name, e.g. 'GEICO'. Required when creating.
policy.sourceone of manual, import, bankWhere the record came from. Set by the ingestion pipeline; leave unset.
policy.websiteDomainstringProvider website domain, e.g. 'geico.com'. Also used to resolve the logo.
policy.logoUrlstringLogo image URL. Usually omit, the server resolves a logo automatically.
policy.policyNumberstringPolicy number.
policy.typeone of auto, home, renters, health, life, travel, pet, disability, umbrella, device, business, otherCoverage type (default 'other').
policy.statusone of active, pending, expired, cancelled, shoppingPolicy status. Defaults to 'active', or 'expired' when the expiration date has passed. Use 'shopping' for quotes under consideration.
policy.namedInsuredstringNamed insured people, e.g. 'Tharun; spouse'.
policy.coverageSummarystringShort summary of what the policy covers.
policy.currencystringISO 4217 currency code, e.g. 'USD' (default USD).
policy.premiumnumberPremium per billing cadence in the given currency (default 0).
policy.billingCadenceone of monthly, quarterly, semiannual, yearly, one_time, unknownHow often the premium is billed (default 'monthly').
policy.deductiblenumberDeductible amount (default 0).
policy.coverageLimitnumberCoverage limit amount (default 0).
policy.effectiveDatestringCoverage start date (YYYY-MM-DD).
policy.expirationDatestringCoverage end date (YYYY-MM-DD).
policy.renewalDatestringRenewal date (YYYY-MM-DD). Defaults to the expiration date.
policy.nextPaymentDatestringNext premium payment date (YYYY-MM-DD).
policy.renewalReminderDaysintegerDays before a renewal, expiration, or premium date to send the reminder (default 14, 0 = on the day).
policy.agentNamestringAgent or broker name.
policy.agentPhonestringAgent phone number.
policy.agentEmailstringAgent email address.
policy.customerServicePhonestringCustomer service or claims phone number.
policy.notesstringNotes or details.
policy.coveredPersonIdslist of stringPeople person ids this policy covers; replaces wholesale.
policy.tagslist of stringTags.
policy.assetIdslist of stringLinked Assets document IDs (policy documents, receipts, evidence). IDs come from the Assets module, resolve with files_queryFiles or an assets upload flow; never invented.
Example input
{
  "policy": {
    "providerName": "State Farm",
    "type": "auto",
    "status": "active",
    "premium": 684,
    "billingCadence": "semiannual",
    "renewalDate": "2027-02-14"
  }
}
insurance_deleteInsurancePolicyDeletethrough vritto_delete

Delete (archive and mark cancelled) one insurance policy. Only for explicit removal requests, to record that a policy lapsed or was replaced, prefer insurance_upsertInsurancePolicy with status 'cancelled' or 'expired'. Resolve the ID with insurance_queryInsuranceDashboard first.

FieldTypeDescription
policyId*stringPolicy ID from a prior insurance_queryInsuranceDashboard result, never invented.

Insurance Claiminsurance_claim

A claim against a policy.

insurance_upsertInsuranceClaimCreate or Updatethrough vritto_create or vritto_update

Create or update one claim against a policy. policyId is required and must come from insurance_queryInsuranceDashboard. Omit claim.id to create; include a real claim.id to update, sent fields merge over the existing record. Example: claim { policyId '<id>', status 'open', incidentDate '2026-07-01', amountClaimed 1800, notes 'Windshield replacement' }.

FieldTypeDescription
claim*objectClaim fields; policyId is required.
claim.idstringExisting claim ID to update, from a prior insurance_queryInsuranceDashboard result. Omit to create a new claim.
claim.policyId*stringID of the covering policy from a prior insurance_queryInsuranceDashboard result, never invented.
claim.claimNumberstringInsurer-assigned claim number.
claim.statusone of open, submitted, approved, paid, denied, closedClaim status (default 'open').
claim.incidentDatestringDate of the incident (YYYY-MM-DD).
claim.filedDatestringDate the claim was filed (YYYY-MM-DD).
claim.currencystringISO 4217 currency code for the claim amounts, e.g. 'INR'. Omit to inherit the covering policy's currency.
claim.amountClaimednumberAmount claimed (default 0).
claim.amountPaidnumberAmount paid out so far (default 0).
claim.adjusterNamestringAdjuster name.
claim.adjusterPhonestringAdjuster phone number.
claim.notesstringNotes, timeline updates, or a claim preparation checklist.
claim.assetIdslist of stringLinked Assets document IDs (policy documents, receipts, evidence). IDs come from the Assets module, resolve with files_queryFiles or an assets upload flow; never invented.
insurance_deleteInsuranceClaimDeletethrough vritto_delete

Delete (archive) one claim. Only for explicit removal requests, to record an outcome, prefer insurance_upsertInsuranceClaim with status 'closed', 'paid', or 'denied'. Resolve the ID with insurance_queryInsuranceDashboard first.

FieldTypeDescription
claimId*stringClaim ID from a prior insurance_queryInsuranceDashboard result, never invented.