Applicant fields
These sections are the same for Home, Auto and Bundle.
Top level
Section titled “Top level”| Field | Type | Required | Notes |
|---|---|---|---|
call.id |
string | Yes | Your unique id for this application, up to 200 characters. The idempotency key: see Retries and idempotency. |
call.agent_id / channel / started_at / ended_at / transcript_url |
string | No | Metadata, stored for audit. |
product |
string | No* | Home, Auto or Bundle. Strongly recommended: it decides which review flow the customer sees. |
sub_id |
string | No | Your own campaign or placement label, shown in your reporting. Lowercased to letters, digits, - and _; at most 100 characters. |
consent.sms_review_link |
boolean | No | Must be true for the review link to be texted. Ask the customer first. |
consent.recording_disclosed |
boolean | No | Stored for audit. |
test |
boolean | No | Marks the application as a test. A test key does this too, and also stops the customer from being messaged. |
customer
Section titled “customer”| Field | Type | Notes |
|---|---|---|
first_name, last_name |
string | |
email |
string | Lowercased/trimmed. |
phone |
string | 10 digits (US). +1, dashes, spaces tolerated. |
date_of_birth |
string | YYYY-MM-DD preferred. Must be ≥ 18 on the review page. |
ssn |
string | 9 digits (dashes/spaces ok). Encrypted at rest; masked in audit; must be exactly 9 or it’s dropped. |
address
Section titled “address”| Field | Type | Notes |
|---|---|---|
line_1, line_2, city |
string | |
state |
string | 2-letter (e.g. TX). Only TX and NJ are supported today — other states are accepted as a draft but flagged. |
postal_code |
string | 5-digit ZIP. |
The review page uses Google address autocomplete; if the address can’t be resolved to a valid state + ZIP, the customer is prompted to re-select it.
Demographics
Section titled “Demographics”| Field | Type | Valid values |
|---|---|---|
gender |
enum | Female, Male |
marital_status |
enum | Single, Married, Seperated, Divorced, Widowed, DomesticPartner |
industry |
enum | Agriclt/Forestry/Fish, Art/Design/Media, Banking/Finance/RE, Business/Sales/Offi, Construct/EnrgyTrds, Disabled, Education/Library, Engr/Archt/Sci/Math, Government/Military, Homemaker/Houseprsn, Info Tech, Insurance, Lgl/Law Enfcmt/Sec, Maint/Rpr/Hsekeep, Mfg/Production, Med/Soc Svcs/Relig, Other, Person.Care/Service, Rest/Hotel Services, Retired, Sports/Recreation, Student, Trvl/Trnsprt/Warehs, Unemployed |
occupation |
string | Send a value from the driver’s industry list in Occupation values by industry, or a common title from Recognized occupation aliases. Anything else resolves to Other. Required for most industries. |
residence_type |
enum | Own Home, Own Condo, Rent Home, Rent Condo, Rent Apartment, Live With Parents (spacing/label variants like Own are normalized). |
household_size, years_at_address, months_at_address |
integer | years_at_address < 3 makes a prior address required on review. |
is_mailing_address_different, has_co_applicant, order_credit_authorized, has_health_insurance_auto_accident, named_insured_foreclosure_repo_bankruptcy, named_insured_convicted_insurance_fraud, is_corporation |
boolean | Applicant yes/no flags for every product. |
co_applicant |
object | Second named insured (any product). Sending it implies has_co_applicant: true unless the flag is set explicitly. Fields below. |
demographics.co_applicant
Section titled “demographics.co_applicant”| Field | Type | Valid values |
|---|---|---|
first_name, last_name |
string | Required when a co-applicant is present. |
middle_name |
string | Optional. |
gender |
enum | Female, Male |
marital_status |
enum | Same list as demographics.marital_status. |
relationship |
enum | Spouse, Parent, Child, Sibling, Relative, Other (relationship-to-insured values). |
date_of_birth |
string | YYYY-MM-DD. Co-applicant must be 16+. |
industry |
enum | Same list as demographics.industry (maps to co_applicant_employment_industry). |
occupation |
string | See Occupation values by industry / Recognized occupation aliases; anything else resolves to Other. |
demographics.co_applicant
Section titled “demographics.co_applicant”| Field | Type | Valid values |
|---|---|---|
first_name, last_name |
string | Required when a co-applicant is present. |
middle_name |
string | Optional. |
gender |
enum | Female, Male |
marital_status |
enum | Same list as demographics.marital_status. |
relationship |
enum | Spouse, Parent, Child, Sibling, Relative, Other (relationship-to-insured values). |
date_of_birth |
string | YYYY-MM-DD. Co-applicant must be 16+. |
industry |
enum | Same list as demographics.industry (maps to co_applicant_employment_industry). |
occupation |
string | See Occupation values by industry / Recognized occupation aliases; anything else resolves to Other. |