Policy

Policy

fieldtypedescriptionproperties
policy_idstring(uuid)ID of the policy
namestring | nullHuman-friendly name of policy
descriptionstring | nullHuman-friendly description of policy
carrier_policy_numberstring | nullThe carrier's identifier for the policy
policy_typestring | nullPolicy typeenum: 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, 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
effective_datestring(date-time) | nullThe date that the coverage provided by the policy is in force.
expiry_datestring(date-time) | nullThe date that the coverage provided by the policy is no longer in force.
renewal_datestring(date-time) | nullThe date that the coverage provided by the policy will renew. This will be the effective date of the new term.
canceled_datestring(date-time) | nullThe date that the policy was cancelled.
total_premium_centsinteger | nullTotal policy premium in cents
paid_in_fullboolean | nullWhether the policy is fully paid
amount_paid_centsinteger | nullAmount paid for the policy so far in cents
amount_due_centsinteger | nullAmount left to pay for the policy in cents
carrier_namestring | nullInsurance carrier name
statusstring | nullPolicy statusenum: ACTIVE, CANCELLED, EXPIRED, UNVERIFIED, PENDING_ACTIVATION, PENDING_CANCELLATION, RESCINDED
limited_accessbooleanWhether the carrier provided policy detail access
form_of_businessstring | nullCommercial policy form of businessenum: INDIVIDUAL, PARTNERSHIP, LIMITED_LIABILITY_COMPANY, S_CORPORATION, CORPORATION, JOINT_VENTURE, NOT_FOR_PROFIT_ORGANIZATION, TRUST
deductible_centsinteger | nullCommercial policy deductible in cents
is_monolinebooleanIndicates whether or not the account has a single policy
dwellingsarrayList of dwelling objectsReferences Dwelling
vehiclesarrayList of vehicle objectsReferences Vehicle
commercial_named_insuredsarrayList of commercial named insuredsReferences CommercialNamedInsured
named_insuredsarrayList of named insured objectsReferences NamedInsured
forms_and_endorsementsarrayList 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