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. The same operations reach claims against a policy (type 'claim').

insurance_findFindthrough vritto_find

Read 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.

FieldTypeDescription
typeone of policy, claimWhich records to read; omit for both.
idstringReturn just this record.
policyIdstringClaims against this policy.
policyTypeone of auto, home, renters, health, life, travel, pet, disability, umbrella, device, business, otherType 'policy': only this kind of coverage.
statusone of active, pending, expired, cancelled, shopping, open, submitted, approved, paid, denied, closedOnly records in this status.
fromstringEarliest date, inclusive: a policy's renewal (else expiration), a claim's filing (else incident).
tostringLatest date, inclusive, on the same dates. ALWAYS pass from/to when the question concerns a period.
querystringText to match: a provider, policy or claim number, named insured or adjuster.
limitintegerRows to return per type, default 25.
detailone 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_update

Add 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' }.

FieldTypeDescription
typeone of policy, claimRecord type: 'policy' (default) an insurance policy; 'claim' a claim against a policy.
recordobjectThe record's fields; a policy needs providerName, a claim its policyId.
record.idstringLeave out to add; a real id updates that record, only the fields you send change.
record.providerNamestringInsurer or provider name, e.g. 'GEICO'. Required when creating.
record.sourceone of manual, import, bankWhere the record came from. Set by the ingestion pipeline; leave unset.
record.websiteDomainstringProvider website domain, e.g. 'geico.com'. Also used to resolve the logo.
record.policyNumberstringPolicy number.
record.typeone of auto, home, renters, health, life, travel, pet, disability, umbrella, device, business, otherCoverage type (default 'other').
record.statusone of active, pending, expired, cancelled, shopping, open, submitted, approved, paid, denied, closedA policy is active (default), pending, expired, cancelled or shopping (a quote); a claim open (default), submitted, approved, paid, denied or closed.
record.namedInsuredstringNamed insured people, e.g. 'Tharun; spouse'.
record.coverageSummarystringShort summary of what the policy covers.
record.currencystringISO 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.premiumnumberPremium per billing cadence in the given currency (default 0).
record.billingCadenceone of monthly, quarterly, semiannual, yearly, one_time, unknownHow often the premium is billed (default 'monthly').
record.deductiblenumberDeductible amount (default 0).
record.coverageLimitnumberCoverage limit amount (default 0).
record.effectiveDatestringCoverage start date (YYYY-MM-DD).
record.expirationDatestringCoverage end date (YYYY-MM-DD).
record.renewalDatestringRenewal date (YYYY-MM-DD). Defaults to the expiration date.
record.nextPaymentDatestringNext premium payment date (YYYY-MM-DD).
record.renewalReminderDaysintegerDays before a renewal, expiration, or premium date to send the reminder (default 14, 0 = on the day).
record.agentNamestringAgent or broker name.
record.agentPhonestringAgent phone number.
record.agentEmailstringAgent email address.
record.customerServicePhonestringCustomer service or claims phone number.
record.notesstringNotes; on a claim, timeline updates or a preparation checklist.
record.coveredPersonIdslist of stringPeople person ids this policy covers; replaces wholesale.
record.tagslist of stringTags.
record.assetIdslist of stringLinked Files document IDs (policy documents, receipts, evidence). Resolve them with files_find or after an upload; never invented.
record.claimNumberstringInsurer-assigned claim number.
record.incidentDatestringDate of the incident (YYYY-MM-DD).
record.filedDatestringDate the claim was filed (YYYY-MM-DD).
record.amountClaimednumberAmount claimed (default 0).
record.amountPaidnumberAmount paid out so far (default 0).
record.adjusterNamestringAdjuster name.
record.adjusterPhonestringAdjuster phone number.
record.policyIdstringType 'claim': the covering policy. Required for a claim.
policyobjectOlder form of record, for a policy.
policy.providerNamestring
claimobjectOlder form of record, for a claim.
claim.policyIdstring
Example input
{
  "record": {
    "providerName": "State Farm",
    "type": "auto",
    "status": "active",
    "premium": 684,
    "currency": "USD",
    "billingCadence": "semiannual",
    "renewalDate": "2027-02-14"
  }
}
insurance_changeUpdatethrough vritto_update

Change 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.

FieldTypeDescription
typeone of policy, claimRecord type: 'policy' (default) an insurance policy; 'claim' a claim against a policy.
record*objectThe record's id plus the fields to change.
record.id*stringRecord ID from a prior insurance_find result, never invented.
record.providerNamestringInsurer or provider name, e.g. 'GEICO'. Required when creating.
record.sourceone of manual, import, bankWhere the record came from. Set by the ingestion pipeline; leave unset.
record.websiteDomainstringProvider website domain, e.g. 'geico.com'. Also used to resolve the logo.
record.policyNumberstringPolicy number.
record.typeone of auto, home, renters, health, life, travel, pet, disability, umbrella, device, business, otherCoverage type (default 'other').
record.statusone of active, pending, expired, cancelled, shopping, open, submitted, approved, paid, denied, closedA policy is active (default), pending, expired, cancelled or shopping (a quote); a claim open (default), submitted, approved, paid, denied or closed.
record.namedInsuredstringNamed insured people, e.g. 'Tharun; spouse'.
record.coverageSummarystringShort summary of what the policy covers.
record.currencystringISO 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.premiumnumberPremium per billing cadence in the given currency (default 0).
record.billingCadenceone of monthly, quarterly, semiannual, yearly, one_time, unknownHow often the premium is billed (default 'monthly').
record.deductiblenumberDeductible amount (default 0).
record.coverageLimitnumberCoverage limit amount (default 0).
record.effectiveDatestringCoverage start date (YYYY-MM-DD).
record.expirationDatestringCoverage end date (YYYY-MM-DD).
record.renewalDatestringRenewal date (YYYY-MM-DD). Defaults to the expiration date.
record.nextPaymentDatestringNext premium payment date (YYYY-MM-DD).
record.renewalReminderDaysintegerDays before a renewal, expiration, or premium date to send the reminder (default 14, 0 = on the day).
record.agentNamestringAgent or broker name.
record.agentPhonestringAgent phone number.
record.agentEmailstringAgent email address.
record.customerServicePhonestringCustomer service or claims phone number.
record.notesstringNotes; on a claim, timeline updates or a preparation checklist.
record.coveredPersonIdslist of stringPeople person ids this policy covers; replaces wholesale.
record.tagslist of stringTags.
record.assetIdslist of stringLinked Files document IDs (policy documents, receipts, evidence). Resolve them with files_find or after an upload; never invented.
record.claimNumberstringInsurer-assigned claim number.
record.incidentDatestringDate of the incident (YYYY-MM-DD).
record.filedDatestringDate the claim was filed (YYYY-MM-DD).
record.amountClaimednumberAmount claimed (default 0).
record.amountPaidnumberAmount paid out so far (default 0).
record.adjusterNamestringAdjuster name.
record.adjusterPhonestringAdjuster phone number.
record.policyIdstringType 'claim': the covering policy. Required for a claim.
Example input
{
  "record": {
    "id": "pol_auto",
    "premium": 135
  }
}
insurance_removeDeletethrough vritto_delete

Remove (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.

FieldTypeDescription
idstringThe record to remove.
typeone of policy, claimRecord type: 'policy' (default) an insurance policy; 'claim' a claim against a policy.
policyIdstringOlder name for a policy's id.
claimIdstringOlder name for a claim's id.