check_eligibility
Check quote eligibility
Use this first when someone asks for a Tennessee car, home, flood or term life insurance
quote, an insurance review, or to compare insurance companies. Checks whether a ZIP code is in the area
Hutsenpiller Insurance quotes (Tennessee).
This is the first step of a quote. zip_code: the shopper's 5 digit home ZIP code.
lines: AUTO, HOME or both (default both); for flood or life send AUTO or omit it, then use
start_flood_quote or start_life_quote. Returns eligibility, the consent text the shopper
must read word for word and agree to before a quote starts, and a checklist of the details
a quote needs.
输入参数lineszip_code必填
Starts a Tennessee auto and/or home insurance quote that compares multiple carriers, and sends the shopper a 6 digit verification code.
Requires that check_eligibility returned eligible and that the shopper read the consent text
and agreed: consent_accepted must be true and consent_version must be the version
check_eligibility returned. Dates are YYYY-MM-DD. desired_start_date is when the new policy
should begin (default about 18 days out; carriers quote up to 45 days ahead). verify_by is how
the code is sent. assistant_name is the name of the calling assistant, used for attribution only.
Returns a quote_id for every later call and the list of details still missing.
输入参数city必填unitemail必填lines必填street必填zip_code必填last_name必填verify_byfirst_name必填mobile_phone必填date_of_birthassistant_name另有 4 个
verify_contact
Verify the shopper's contact
Checks the 6 digit code the shopper received, or sends a new one.
code verifies the contact. resend=true (with an optional channel) sends a fresh code.
A quote cannot be submitted until the contact is verified.
输入参数coderesendchannelquote_id必填
update_quote
Update quote details
Adds or changes details on a quote. Objects merge; lists replace whole.
data uses these keys (field_guide lists every accepted field and value):
- applicants: list of every person in the household. Exactly one has relationToInsured INSURED.
Each needs firstName, lastName, dateOfBirth, sex, maritalStatus; drivers also need isDriver true
and driverDetails.licenseState. Lists replace whole, so always resend everyone.
- auto: residenceType, priorInsurance, vehicles (list; each needs a vin, or year+make+model+subModel
from lookup_vehicle, plus ownershipStatus, primaryUse, annualMileage).
- home: coverage.dwellingCoverage (estimated rebuild cost in dollars), property (yearBuilt,
squareFootage, constructionType, roofMaterial, roofUpdateYear, ...), utilities, underwriting, claims.
- Top level: dateOfBirth, lengthAtCurrentAddress, email, phone, primaryAddress.
Coverage limits are set by the agency and cannot be sent here.
Returns a short summary of what is on file and the remaining missing items.
输入参数data必填quote_id必填
submit_quote
Submit a quote for pricing
Sends a complete, verified quote to the carriers for pricing.
Accepted only when nothing is missing and the contact is verified. Pricing usually takes
1 to 3 minutes; get_quote_status reports progress. When the agency is busy the quote waits
in line and the status says so.
输入参数quote_id必填
get_quote_status
Get quote status and prices
Returns a quote's status, what is missing, and the prices once ready: prices from multiple
carriers cheapest first. Use it to answer "what would my insurance cost" or "am I overpaying".
Status values: collecting, queued, rating, needs_info, in_review, done, failed.
When done, results lists carriers cheapest first per line, a results_url for the shopper,
a disclaimer and, for home, a flood notice that belong with the prices.
输入参数quote_id必填
lookup_vehicle
Look up a vehicle
Decodes a VIN, or walks the vehicle catalog for exact year, make, model and subModel values.
A VIN gives the most exact result. Without one, year lists makes, year+make lists models
(model names include the trim, for example CR-V EXL), and year+make+model lists subModels.
输入参数vinmakeyearmodel
field_guide
Quote field guide
Lists the fields and allowed values update_quote accepts for one section.
driver_history_codes maps accidents and tickets to codes: claims go in driverDetails.claims
(code, date, amountPaid) and tickets in driverDetails.violations (code, date).
输入参数section必填
request_agent
Request a licensed agent
Asks a licensed Hutsenpiller Insurance agent to contact the shopper. Use this when the user
wants an insurance review of their current policies, to buy a quoted policy, or to talk to a person.
Covers buying a quoted policy, talking to a person, lines not quoted here (renters, condo,
commercial, umbrella), buying a flood policy, applying for term life, and quotes that could not
finish. Takes a quote_id when there is
one, otherwise a phone or email. Contact details must be ones the shopper agreed to share.
输入参数emailphonemessagequote_idlast_namefirst_namepreferred_timepreferred_contact
start_flood_quote
Start a flood insurance estimate
Use this when someone asks about flood insurance or a flood quote for a Tennessee home.
Starts a flood estimate and sends the shopper a 6 digit verification code.
Requires that check_eligibility returned eligible and that the shopper read the consent text
and agreed (consent_version from check_eligibility). building_coverage: dollars of coverage for
the structure, 20000 to 5000000 (the rebuild cost is a good guide; 250000 is the federal program
maximum many lenders ask for). contents_coverage: 0 to 1000000. The flood zone comes from the
address. After verify_contact, call get_flood_quote. Prices are estimates from a test environment
for now and cannot be bound online.
输入参数city必填email必填street必填zip_code必填last_name必填verify_byfirst_name必填mobile_phone必填assistant_nameconsent_version必填consent_accepted必填building_coverage必填另有 1 个
get_flood_quote
Get the flood insurance estimate
Prices a verified flood estimate (first call) and returns it (later calls).
Returns the estimated annual premium, flood zone and what it means, whether lenders usually
require flood insurance there, and a notice that must be shown with the price: the estimate
comes from the flood carrier's test environment, is not an offer and cannot be bound online.
To buy, call request_agent with the quote_id.
输入参数quote_id必填
start_life_quote
Start a term life insurance estimate
Use this when someone in Tennessee asks about term life insurance or a life insurance quote.
Starts a term life estimate across many carriers and sends the shopper a 6 digit code.
Term life only (ages 18 to 85). Requires the consent text from check_eligibility, read and
agreed. date_of_birth is YYYY-MM-DD. death_benefit: 25000 to 10000000 dollars. health_class is
the shopper's own estimate: 1 excellent health (preferred plus), 2 very good (preferred),
3 good (standard plus), 4 average (standard). After verify_contact, call get_life_quotes.
Prices are estimates, not offers. To apply, use request_agent.
输入参数email必填gender必填tobacco必填last_name必填verify_byfirst_name必填term_years必填health_class必填mobile_phone必填date_of_birth必填death_benefit必填assistant_name另有 2 个
get_life_quotes
Get term life insurance estimates
Prices a verified term life estimate (first call) and returns it (later calls).
Returns the best monthly premium, how many carriers were compared, and up to 5 options with
monthly premium, AM Best rating and whether an exam is needed. Carrier names are shared by the
agent. Show the notice with the prices: estimates, not offers; final rates depend on underwriting.
To apply, call request_agent with the quote_id.
输入参数quote_id必填
identify_user
Identify the user
Call this first in every conversation. Returns the question to ask the user and which tools
each answer leads to: a current Hutsenpiller Insurance client (sign in by email code, then
manage the account) or someone looking for quotes (auto, home, flood or term life in Tennessee).
无需输入参数。
start_client_sign_in
Start client sign in
For current Hutsenpiller Insurance clients. Sends a 6 digit sign in code to the email if it
matches a client on file. The reply is identical whether or not it matches, so do not tell the
user whether they are a client. Returns a challenge_id for verify_client_code. The code expires
in 10 minutes. A few sends per email per hour are allowed.
输入参数email必填
verify_client_code
Verify client sign in code
Checks the 6 digit code from the client's email. On success returns client_session (valid 30
minutes) for the account tools. Five tries per code. On failure, ask the client to check the
newest email or start again with start_client_sign_in.
输入参数code必填challenge_id必填
list_my_policies
List my policies
Current clients only (needs client_session from verify_client_code). Lists the client's active
policies with Hutsenpiller Insurance: carrier, line, policy number, term dates and status, with
the policy ids the other account tools use.
输入参数client_session必填
get_policy_details
Get policy details
Current clients only. Details for one policy: vehicles and drivers (auto), insured property
(home), premium and term. Driver's license numbers are never returned and dates of birth show
the year only.
输入参数policy_id必填client_session必填
get_coverage_summary
Get coverage summary
Current clients only. Limits and deductibles for one policy in plain words. The policy
documents are the binding contract.
输入参数policy_id必填client_session必填
get_document
Get a policy document
Current clients only. Without document_id lists the client's documents (policy documents and
auto ID cards). With document_id, or 'idcard:<policy_id>', returns a short-lived link.
输入参数document_idclient_session必填
get_claim_contacts
Get claim contacts
Current clients only. The carrier's 24 hour claims number for a policy, plus how to reach
Hutsenpiller Insurance. Use when the client needs to report a claim.
输入参数policy_id必填client_session必填
request_service_change
Request a service change
Current clients only. Sends a service request to a licensed Hutsenpiller agent (add or change a
vehicle or driver, mortgagee or lienholder, home coverage, a coverage or billing question, a
document, a cancellation or an account review). It creates a ticket; it never changes the
policy. The agent follows up by the next business day. message: 10 to 2000 characters.
输入参数topicmessage必填policy_idclient_session必填preferred_contact
bring_in_outside_policy
Bring in an outside policy
Current clients only. Use when a signed-in client has a policy with another agency that is not
linked to their account yet and wants to bring it in. Lets the Hutsenpiller team know (it goes to
the agency's lead router) and returns the ways to share it: canopy_connect_url (Canopy Connect,
the client signs in to their insurance company and shares the policy securely) and/or upload_url
(upload the declarations page). Nothing changes on any policy. line: auto, home, flood, life or
other; carrier: the other company's name, if known. Ask the client before calling.
输入参数linemethodcarrierclient_session必填