Policy

field	type	description	properties
policy_id	string(uuid)	ID of the policy
name	string \| null	Human-friendly name of policy
description	string \| null	Human-friendly description of policy
carrier_policy_number	string \| null	The carrier's identifier for the policy
policy_type	string \| null	Policy type	enum: `AUTO`, `NAMED_NON_OWNER`, `CLASSIC_CAR`, `BOAT`, `CONDO`, `FARMOWNER`, `FLOOD`, `HOMEOWNERS`, `LANDLORD`, `LIFE`, `MOTORCYCLE`, `TERM_LIFE`, `UNIVERSAL_LIFE`, `WHOLE_LIFE`, `RENTERS`, `SNOWMOBILE`, `UMBRELLA`, `RECREATIONAL_VEHICLE`, `FIRE`, `TRAILER`, `PERSONAL_ARTICLES`, `EARTHQUAKE`, `BUSINESS_OWNERS`, `COMMERCIAL_UMBRELLA`, `COMMERCIAL_AUTO`, `COMMERCIAL_FIRE`, `COMMERCIAL_AGRIBUSINESS`, `COMMERCIAL_PACKAGE`, `COMMERCIAL_PROPERTY`, `COMBO`, `OFFROAD_VEHICLE`, `WORKERS_COMPENSATION`, `MOBILE_HOME`, `PET`, `PERSONAL_LIABILITY`, `GENERAL_LIABILITY`, `ERRORS_AND_OMISSIONS`, `INLAND_MARINE`, `GARAGE`, `EXCESS_LIABILITY`, `CYBER`, `IDENTITY_THEFT`, `COMMERCIAL_CRIME`, `ARTISAN_AND_SERVICE_CONTRACTORS`, `FARM_POLLUTION_LIABILITY`, `FARM_UMBRELLA`, `MANAGEMENT_LIABILITY`, `GOLF_CART`, `YACHT`, `PERSONAL_WATERCRAFT`, `STANDARD_PROPERTY`, `CONTRACTORS_EQUIPMENT`, `WINDSTORM`
effective_date	string(date-time) \| null	The date that the coverage provided by the policy is in force.
expiry_date	string(date-time) \| null	The date that the coverage provided by the policy is no longer in force.
renewal_date	string(date-time) \| null	The date that the coverage provided by the policy will renew. This will be the effective date of the new term.
canceled_date	string(date-time) \| null	The date that the policy was cancelled.
total_premium_cents	integer \| null	Total policy premium in cents
paid_in_full	boolean \| null	Whether the policy is fully paid
amount_paid_cents	integer \| null	Amount paid for the policy so far in cents
amount_due_cents	integer \| null	Amount left to pay for the policy in cents
total_estimated_annual_premium_cents	integer \| null	Total estimated annual premium, in cents (Workers' Compensation)
total_minimum_premium_cents	integer \| null	Total minimum premium, in cents (Workers' Compensation)
total_deposit_premium_cents	integer \| null	Total deposit premium, in cents (Workers' Compensation)
carrier_name	string	Insurance carrier identifier. This is not a user-friendly name.
carrier_friendly_name	string \| null	Insurance carrier name. This is a user-friendly name.
status	string \| null	Policy status	enum: `ACTIVE`, `CANCELLED`, `EXPIRED`, `UNVERIFIED`, `PENDING_ACTIVATION`, `PENDING_CANCELLATION`, `RESCINDED`, `QUOTE`
state	string \| null	Policy jurisdiction, as a two-letter state code
limited_access	boolean	Whether the carrier provided policy detail access
form_of_business	string \| null	Commercial policy form of business	enum: `INDIVIDUAL`, `PARTNERSHIP`, `LIMITED_LIABILITY_COMPANY`, `S_CORPORATION`, `CORPORATION`, `JOINT_VENTURE`, `NOT_FOR_PROFIT_ORGANIZATION`, `TRUST`
deductible_cents	integer \| null	Commercial policy deductible in cents
is_monoline	boolean	Indicates whether or not the account has a single policy
policy_check	null \| object	Policy check data containing verification status and detail verification information	References PolicyCheck
dwellings	array	List of dwelling objects	References Dwelling
locations	array	List of location objects	References Location
vehicles	array	List of vehicle objects	References Vehicle
commercial_named_insureds	array	List of commercial named insureds	References CommercialNamedInsured
named_insureds	array	List of named insured objects	References NamedInsured
life	object \| null		References LifePolicy
forms_and_endorsements	array	List of forms and endorsements. Your plan must include policy forms in order to access this data in production. For more information, contact your Canopy Connect representative.	References PolicyForm
is_telematics_enabled	boolean \| null	Indicates whether Telematics is enabled for the policy (Auto policies only)
payment_frequency	string \| null	Frequency of payments for this policy	enum: `MONTHLY`, `QUARTERLY`, `SEMIANNUALLY`, `ANNUALLY`
last_payment_date	string(date-time) \| null	The date of the last payment
premium_groups	array	List of premium groups	References PremiumGroup