Save application facts the customer gave, in their own words. Every field is optional and merges into what's saved, so send only facts that are new or changed.
- Items with an id update that driver, car or home; items without one are added. included puts an item on the quote or leaves it off.
- Add a car by vin, by licensePlate and licensePlateState, or by year, make and model. Send year, make and model only when there's no VIN or plate, since those set them. A final price needs the VIN.
- Answer any other requirement in answers, by its path. A fact that has its own field here comes back rejected as typed_field if it's sent in answers.
- coverage and history.currentMonthlyPremiumCents are optional and never block quotes. Send them only when the customer asks for a coverage level or specific coverages, or says what they pay now.
- Drivers and cars Jerry found are in the status's suggested list, each with an id that starts with suggested:. Once the customer confirms one, send that id in drivers or vehicles with included: true.
Returns the status, with suggested. rejected lists values to correct with the customer, and clarify lists values to choose from. The rest of the write is saved either way.
View input schema
{
"type": "object",
"properties": {
"intentId": {
"type": "string",
"description": "The shopping intent id returned by an earlier shopping tool."
},
"sources": {
"type": "array",
"items": {
"type": "string",
"enum": [
"customer",
"document",
"financial_accounts"
]
},
"description": "Where these facts come from; defaults to ['customer']."
},
"permission": {
"type": "object",
"properties": {
"customerReply": {
"type": "string",
"maxLength": 1000,
"description": "The customer's exact reply."
}
},
"required": [
"customerReply"
],
"additionalProperties": true,
"description": "Required once when sources include anything but customer."
},
"application": {
"type": "object",
"properties": {
"customer": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 100,
"description": "Full legal name."
},
"dateOfBirth": {
"type": "string",
"description": "YYYY-MM-DD."
},
"address": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The whole address as one line, e.g. \"123 Main St Apt 4, Austin TX 78701\"."
},
"street": {
"type": "string"
},
"unit": {
"type": "string",
"description": "Apartment or unit."
},
"city": {
"type": "string"
},
"state": {
"type": "string",
"description": "Two-letter state code."
},
"zip": {
"type": "string",
"description": "Five-digit ZIP code."
},
"confirmation": {
"type": "string",
"description": "From an address_unverified clarify, once the customer confirms that address."
}
},
"additionalProperties": true,
"description": "Home address, where the vehicles are kept."
},
"previousAddress": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The whole address as one line, e.g. \"123 Main St Apt 4, Austin TX 78701\"."
},
"street": {
"type": "string"
},
"unit": {
"type": "string",
"description": "Apartment or unit."
},
"city": {
"type": "string"
},
"state": {
"type": "string",
"description": "Two-letter state code."
},
"zip": {
"type": "string",
"description": "Five-digit ZIP code."
},
"confirmation": {
"type": "string",
"description": "From an address_unverified clarify, once the customer confirms that address."
}
},
"additionalProperties": true,
"description": "Address before a recent move."
},
"email": {
"type": "string"
},
"trackDriving": {
"type": "boolean",
"description": "false: no driving tracking."
}
},
"additionalProperties": true
},
"history": {
"type": "object",
"properties": {
"currentlyInsured": {
"type": "boolean",
"description": "Has auto insurance now."
},
"insuredFor": {
"type": "string",
"enum": [
"LessThanSixMonths",
"SixToTwelveMonths",
"OneToThreeYears",
"ThreeToFiveYears",
"MoreThanFiveYears"
],
"description": "How long continuously insured."
},
"notInsuredReason": {
"type": "string",
"enum": [
"expired_last_30_days",
"driving_with_no_insurance",
"did_not_own_vehicle",
"did_not_drive_6_months",
"other"
]
},
"motorcycleCurrentlyInsured": {
"type": "boolean"
},
"motorcycleInsuredFor": {
"type": "string",
"enum": [
"LessThanOneYear",
"OneYear",
"TwoToThreeYears",
"FourToSixYears",
"MoreThanSevenYears"
]
},
"hadMotorcycleInsurance": {
"type": "boolean"
},
"violationsCount": {
"type": "string",
"enum": [
"None",
"OneToTwo",
"ThreeToFour",
"FiveOrMore",
"DoNotRemember"
],
"description": "Violations in the last 3 years."
},
"claims5y": {
"type": "boolean",
"description": "Any claim in the last 5 years."
},
"creditRange": {
"type": "string",
"enum": [
"LessThan550",
"Between550and659",
"Between660and750",
"MoreThan750",
"NotSure"
]
},
"currentCarrier": {
"type": "string",
"description": "Current auto insurer name, e.g. \"GEICO\"."
},
"currentMonthlyPremiumCents": {
"type": "number",
"description": "Car insurance paid now, per month in USD cents; quotes then show savings."
}
},
"additionalProperties": true
},
"drivers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Omit to add an item. A suggested: id adds what Jerry found; fields sent with it win."
},
"included": {
"type": "boolean",
"description": "Put on the quote (true) or leave off (false)."
},
"name": {
"type": "string",
"maxLength": 100
},
"dateOfBirth": {
"type": "string",
"description": "YYYY-MM-DD."
},
"relationship": {
"type": "string",
"enum": [
"Child",
"Domestic Partner",
"Employee",
"Insured",
"Other",
"Parent",
"Relative",
"Spouse",
"Roommate"
]
},
"gender": {
"type": "string",
"enum": [
"Male",
"Female"
]
},
"maritalStatus": {
"type": "string",
"enum": [
"Single",
"Married",
"Domestic Partner",
"Widowed",
"Separated",
"Divorced"
]
},
"excludedReason": {
"type": "string",
"enum": [
"Insured Elsewhere",
"License Suspended/Revoked",
"Never Licensed",
"Away at School",
"Military Deployed Overseas",
"Out of Country",
"Moved Out",
"Unknown Person"
],
"description": "Why a household member is not rated."
},
"licenseStatus": {
"type": "string",
"enum": [
"Valid",
"Permit",
"Expired",
"Suspended",
"Cancelled",
"Not Licensed",
"Permanently Revoked",
"State ID"
]
},
"licenseState": {
"type": "string",
"description": "Two-letter state code."
},
"licenseNumber": {
"type": "string"
},
"ageFirstLicensed": {
"type": "number"
},
"sr22Required": {
"type": "boolean"
},
"occupation": {
"type": "string",
"maxLength": 100,
"description": "Job in plain words, e.g. \"nurse\", or a candidate value from clarify."
},
"goodStudent": {
"type": "boolean"
},
"completedDriverTraining": {
"type": "boolean",
"description": "Completed a driver safety course."
},
"education": {
"type": "string",
"enum": [
"No High School Diploma",
"High School Diploma",
"Some College - No Degree",
"Vocational/Technical Degree",
"Associates Degree",
"Bachelors",
"Masters",
"Phd",
"Medical Degree",
"Law Degree"
]
},
"hasMotorcycleEndorsement": {
"type": "boolean"
},
"motorcycleEndorsementYear": {
"type": "string",
"description": "YYYY."
},
"motorcycleYearsExperience": {
"type": "number"
},
"completedMotorcycleSafetyCourse": {
"type": "boolean"
},
"ridesOffRoadOnly": {
"type": "boolean"
}
},
"additionalProperties": true
},
"maxItems": 8
},
"vehicles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Omit to add an item. A suggested: id adds what Jerry found; fields sent with it win."
},
"included": {
"type": "boolean",
"description": "Put on the quote (true) or leave off (false)."
},
"vin": {
"type": "string",
"description": "17-character VIN; sets year, make and model."
},
"prefillId": {
"type": "string",
"description": "suggested: id of the same found car"
},
"licensePlate": {
"type": "string",
"description": "With licensePlateState; sets year, make and model."
},
"licensePlateState": {
"type": "string",
"description": "Two-letter state code."
},
"year": {
"type": "string",
"description": "YYYY."
},
"make": {
"type": "string",
"maxLength": 50
},
"model": {
"type": "string",
"maxLength": 50
},
"ownership": {
"type": "string",
"enum": [
"Owned",
"Lien",
"Leased"
]
},
"purchaseDate": {
"type": "string",
"description": "YYYY-MM-DD, or YYYY-MM when only the month is known."
},
"usage": {
"type": "string",
"enum": [
"Business Use",
"Work Commute",
"Farm Use",
"Farm Business Use",
"Pleasure",
"Off-road"
]
},
"annualMileage": {
"type": "number",
"description": "Miles per year, e.g. 10 miles a day is 3650."
},
"rideshare": {
"type": "boolean"
},
"delivery": {
"type": "boolean"
},
"businessUse": {
"type": "boolean"
},
"hasDamage": {
"type": "boolean"
},
"hasBrandedTitle": {
"type": "boolean"
},
"valueDollars": {
"type": "number",
"description": "Value in dollars, for cars built before 1981."
}
},
"additionalProperties": true
},
"maxItems": 8
},
"motorcycles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Omit to add an item. A suggested: id adds what Jerry found; fields sent with it win."
},
"included": {
"type": "boolean",
"description": "Put on the quote (true) or leave off (false)."
},
"vin": {
"type": "string"
},
"year": {
"type": "string",
"description": "YYYY."
},
"make": {
"type": "string",
"maxLength": 50
},
"model": {
"type": "string",
"maxLength": 50
},
"engineCc": {
"type": "string",
"description": "Engine size in cc."
},
"hasAntiLockBrakes": {
"type": "boolean"
},
"antiTheftType": {
"type": "string",
"enum": [
"Active",
"Recovery",
"Both",
"None"
]
},
"usage": {
"type": "string",
"enum": [
"Pleasure",
"Commute",
"Off-road"
]
},
"annualMileage": {
"type": "number"
},
"ownership": {
"type": "string",
"enum": [
"Owned",
"Lien",
"Leased"
]
},
"purchaseDate": {
"type": "string",
"description": "YYYY-MM-DD, or YYYY-MM when only the month is known."
},
"valueDollars": {
"type": "number",
"description": "Value in dollars."
},
"hasBrandedTitle": {
"type": "boolean"
},
"hasRoadLicense": {
"type": "boolean"
}
},
"additionalProperties": true
},
"maxItems": 8
},
"homes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Omit to add an item. A suggested: id adds what Jerry found; fields sent with it win."
},
"included": {
"type": "boolean",
"description": "Put on the quote (true) or leave off (false)."
},
"address": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The whole address as one line, e.g. \"123 Main St Apt 4, Austin TX 78701\"."
},
"street": {
"type": "string"
},
"unit": {
"type": "string",
"description": "Apartment or unit."
},
"city": {
"type": "string"
},
"state": {
"type": "string",
"description": "Two-letter state code."
},
"zip": {
"type": "string",
"description": "Five-digit ZIP code."
},
"confirmation": {
"type": "string",
"description": "From an address_unverified clarify, once the customer confirms that address."
}
},
"additionalProperties": true
},
"occupancy": {
"type": "string",
"enum": [
"Owner",
"Secondary Home",
"Renter",
"Vacant"
]
},
"isClosing": {
"type": "boolean",
"description": "Still closing on the purchase."
},
"purchaseDate": {
"type": "string",
"description": "YYYY-MM-DD."
},
"hasMortgage": {
"type": "boolean"
},
"isInsured": {
"type": "boolean"
},
"notInsuredReason": {
"type": "string",
"enum": [
"new_purchase",
"expired_last_30_days",
"expired_over_30_days",
"owner_without_insurance",
"other"
]
},
"yearBuilt": {
"type": "number"
},
"squareFeet": {
"type": "number"
},
"stories": {
"type": "string",
"description": "Use the requirement's options."
},
"dwellingType": {
"type": "string",
"description": "Use the requirement's options."
},
"roofMaterial": {
"type": "string",
"description": "Use the requirement's options."
},
"roofUpdatedYear": {
"type": "number"
},
"plumbingTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CastIron",
"Galvanized",
"Polybutylene"
]
},
"description": "Empty when none apply."
},
"wiringTypes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"FuseBox",
"KnobAndTubeWiring",
"ElectricalServiceUnder100Amps",
"AluminumWiring"
]
},
"description": "Empty when none apply."
},
"hasDogs": {
"type": "boolean"
},
"dogBreeds": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Akita",
"AmericanBulldog",
"CaneCorso",
"Chow",
"Dingo",
"Doberman",
"Gshepard",
"PitBull",
"Mastiffs",
"Great Danes",
"Malamute",
"Presa Canarios",
"StaffordshireTerrie",
"Rottweiler",
"WolfHybrid",
"Husky",
"SaintBernard"
]
},
"description": "Listed breeds only; empty when none."
},
"hasDogBiteHistory": {
"type": "boolean"
},
"hasSwimmingPool": {
"type": "boolean"
},
"swimmingPoolType": {
"type": "string",
"enum": [
"Above Ground with Slide",
"Above Ground without Slide",
"In Ground with Slide",
"In Ground without Slide",
"Indoor"
]
},
"isSwimmingPoolFenced": {
"type": "boolean"
},
"hasExoticOrFarmAnimals": {
"type": "boolean"
},
"hasTrampoline": {
"type": "boolean"
},
"hasBusiness": {
"type": "boolean"
},
"hasDaycare": {
"type": "boolean"
},
"hasBurglarAlarm": {
"type": "string",
"enum": [
"None",
"Local",
"Central",
"Direct"
]
},
"hasFireAlarm": {
"type": "string",
"enum": [
"None",
"Local",
"Central",
"Direct"
]
},
"hasSprinkler": {
"type": "string",
"enum": [
"None",
"Partial",
"Full"
]
},
"inGatedCommunity": {
"type": "boolean"
}
},
"additionalProperties": true
},
"maxItems": 3
},
"startDates": {
"type": "object",
"properties": {
"car": {
"type": "string",
"description": "YYYY-MM-DD."
},
"home": {
"type": "string",
"description": "YYYY-MM-DD."
},
"motorcycle": {
"type": "string",
"description": "YYYY-MM-DD."
}
},
"additionalProperties": true
},
"coverage": {
"type": "object",
"properties": {
"plan": {
"type": "string",
"enum": [
"Basic plan",
"Basic + full coverage",
"Standard plan",
"Preferred plan",
"Custom plan"
],
"description": "Basic plan: state-minimum liability; Basic + full coverage: adds $1,000 comprehensive and collision; Standard plan: 50/100, $1,000 deductibles, towing, rental; Preferred plan: 100/300, $500 deductibles; Custom plan: the values under items and perAssetItems. Custom values start from the pre-made plan sent here, else the round's."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"car"
]
}
},
"required": [
"name",
"value",
"type"
],
"additionalProperties": true
},
"description": "Whole-policy values, e.g. BI"
},
"perAssetItems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "A car's id."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"additionalProperties": true
}
}
},
"required": [
"id",
"items"
],
"additionalProperties": true
},
"description": "Per car, e.g. CollisionDeductible"
}
},
"additionalProperties": true
},
"answers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The requirement's path, as status returned it."
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"description": "One of the requirement's options, by value or label (true or false for yes/no), or a list for a multi-select."
}
},
"required": [
"path",
"value"
],
"additionalProperties": true
},
"maxItems": 50,
"description": "Answers to requirements not typed above."
}
},
"additionalProperties": true
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string",
"enum": [
"user_stated",
"document",
"agent_inferred"
],
"description": "agent_inferred if you inferred any fact in this write, else document if any came from a shared document, else user_stated: the customer said it all."
},
"confidence": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "How sure you are, from 0 to 1."
}
},
"required": [
"source"
],
"additionalProperties": false,
"description": "Optional. Where this write's facts came from. Jerry doesn't save it."
},
"idempotencyKey": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Unique key for safely retrying this customer action"
}
},
"required": [
"intentId",
"application",
"idempotencyKey"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}