Response Properties | Policies Details

Fetch All section Information of all policies of user

Response Properties

For HTTP Status Code = 200

PropertyTypeDescriptionNullable
connection_idStringUnique identification for each policy request.No
placement_idStringId of Fize modal in application. Eg; placement_1No
setup_idStringId of policy sync link.Yes
insurance_lineEnumInsurance line of current policy sync.No
status_code(Policy Sync Status Code)EnumPolicy sync status code value. This code can be utilized to take further action/decision as it provides the current status of policy sync. The value of this key will be the status of the policy sync request and not specific to a policy section or policy.Yes
status_message(Policy Sync Status Code)EnumPolicy sync status message value. The value of this key will be the status of the policy sync request and not specific to a policy section or policy.Yes
dataJSONThis contains data corresponding to policy request.No
data.policy_dataJSONThis contains policies data corresponding to policy request.No
data.policy_data.versionNumberThis contains policy version corresponding to policy request. Eg; 1.1No
data.policy_data.carrier_display_nameStringThis contains carrier's display name. Eg; AllstateNo
data.policy_data.carrier_logoStringThis contains url of carrier logo.No
data.policy_data.policy_types_requestedArrayRequested policy types.No
data.policy_data.policy_types_availableArrayAvailable policy types.No
data.policy_data.carrierStringThis contains carrier name.No
data.policy_data.policiesArray[Policy]This contains policies data of policy request for specific connection_id.No
data.policy_data.policies[].carrierStringThis contains the carrier name.No
data.policy_data.policies[].fz_policy_numberStringIt is the unique identification give by Fize platform assign to policyNo
data.policy_data.policies[].policy_typeStringIt is the policy type value of policy.No
data.policy_data.policies[].policy_product_titleStringPolicy product title from carrier's site.Yes
data.policy_data.policies[].policy_numberStringIt is the policy number value of policy.No
data.policy_data.policies[].policy_detailJSON (Auto Policy Detail or Homeowners Policy DetailThis contains the policy details based on the policy typeNo
{
    "connection_id": "ci_7909eff6def443=",
    "placement_id": 2,
    "setup_id": null,
    "insurance_line": "personal",
    "data": {
        "policy_data": {
            "version": 2.2,
            "carrier_display_name": "GEICO",
            "carrier_logo": "https://cdn.getfize.com/sdk/assets/carriers/icons/geico.png",
            "policy_types_requested": [
                "Auto",
                "Home",
                "FIZE_ALL_POLICIES"
            ],
            "policy_types_available": [
                "Auto",
                "Home"
            ],
            "carrier": "geico",
            "policies": [
                {
                    "carrier": "geico",
                    "fz_policy_number": "po_4e2b5fe5651f4892",
                    "policy_type": "Home",
                    "policy_product_title": "Home Policy P1234",
                    "policy_number": "P1234",
                    "policy_detail": {
                        "property_info": {
                            "mortgagee": [
                                {
                                    "company": "United Mortgage Associates",
                                    "address": {
                                        "entity_number": "1447",
                                        "street": "Winding",
                                        "city": "Providence",
                                        "state": "RI",
                                        "zip": "22903",
                                        "country": "USA",
                                        "raw_address": "1447, Winding Way, Providence, RI 22903"
                                    },
                                    "loan_number": "MORTG123456",
                                    "financing_type": "Conventional Mortgage"
                                }
                            ],
                            "property_address": {
                                "entity_number": "1447",
                                "street": "Winding",
                                "city": "Providence",
                                "state": "RI",
                                "zip": "22903",
                                "country": "USA",
                                "raw_address": "1447, Winding Way, Providence, RI 22903"
                            },
                            "loan_number": "MORTG123456",
                            "family_count": 1,
                            "year_built": 1958,
                            "stories_count": 1,
                            "bathrooms_count": 2,
                            "square_footage": 1346,
                            "basement_included": "Yes",
                            "garage_size": 448,
                            "garage_type": "Carport",
                            "construction": "Frame",
                            "siding": "Masonry Veneer",
                            "roof_type": "Asphalt-Fiberglass",
                            "roof_age_year": 9,
                            "foundation": "Slab",
                            "finished_basement_percentage": 100,
                            "employee_count": 5,
                            "apn": "PROV M:20 L:38",
                            "class": "AMUSEMENT_RECREATION",
                            "sub_type": "RESIDENTIAL",
                            "wall_type": "STONE_WOOD_FRAME",
                            "frame_type": "WOOD",
                            "roof_cover": "CONCRETE_TILE",
                            "roof_shape": "MANSARD",
                            "cooling_type": "AC_CENTRAL_PARTIAL",
                            "heating_type": "STEAM",
                            "heating_fuel": "ELECTRIC_HOT_WATER",
                            "energy_type": "FAIR",
                            "sewer_type": "PUBLIC_SEPTIC",
                            "building_shape": "RECTANGLE",
                            "construction_quality": "FAIR",
                            "has_fireplace": true,
                            "num_fireplaces": 1,
                            "fireplace_type": "HEATER_CIRCLE",
                            "has_pool": true,
                            "pool_type": "IN_GROUND_POOL",
                            "num_beds": 4,
                            "num_baths_full": 1,
                            "num_baths_partial": 0,
                            "num_units": 1,
                            "num_parking_spaces": 1,
                            "assessed_improvement_value": 27023800,
                            "assessed_land_value": 1836500,
                            "assessed_total_value": 28860300,
                            "market_improvement_value": 27024800,
                            "market_land_value": 1836500,
                            "market_total_value": 28861300,
                            "owner1_first_name": "William",
                            "owner1_last_name": "Martinez",
                            "owner2_first_name": "Karen",
                            "owner2_last_name": "Martinez",
                            "owner3_first_name": "Ben",
                            "owner3_last_name": "Martinez",
                            "owner4_first_name": "David Lee",
                            "owner4_last_name": "Hartstein Jr",
                            "purchase_date": "1956-02-02",
                            "purchase_price": 1736500,
                            "last_update_date": "2023-02-22"
                        },
                        "policy_coverage": {
                            "other_coverage": [],
                            "personal_property": {
                                "coverage_display_name": "Personal Property",
                                "percentage": 70,
                                "limit": 157500
                            },
                            "all_perils": {
                                "coverage_display_name": "ALL PERILS",
                                "amount": 1000,
                                "limit": 1000,
                                "deductible": 500,
                                "percentage": 2
                            },
                            "windstorm_hail": {
                                "coverage_display_name": "Windstorm/Hail",
                                "amount": 1000,
                                "percentage": 10,
                                "deductible": 500
                            },
                            "other_structures": {
                                "coverage_display_name": "Other Structures",
                                "percentage": 60,
                                "limit": 22500
                            },
                            "additional_living_expenses": {
                                "coverage_display_name": "Additional Living Expense",
                                "limit": 5000,
                                "term_months": 6
                            },
                            "medical_payments": {
                                "coverage_display_name": "Medical Payments",
                                "limit": 2000
                            },
                            "personal_liability": {
                                "coverage_display_name": "Personal Liability",
                                "limit": 30000
                            },
                            "dwelling": {
                                "coverage_display_name": "Dwelling Structures",
                                "limit": 225000
                            },
                            "loss_of_use": {
                                "coverage_display_name": "Loss Of Use",
                                "limit": 67500
                            }
                        }
                    }
                },
                {
                    "carrier": "geico",
                    "fz_policy_number": "po_73edc29652554e92",
                    "policy_type": "Auto",
                    "policy_product_title": "Auto 7224J016371",
                    "policy_number": "7224J016371",
                    "policy_detail": {
                        "drivers": [
                            {
                                "personal_info": {
                                    "first_name": "William",
                                    "last_name": "Martinez",
                                    "middle_name": "H.",
                                    "full_name": "William H. Martinez",
                                    "email": "[email protected]",
                                    "address": {
                                        "entity_number": "1447",
                                        "street": "Winding",
                                        "city": "Providence",
                                        "state": "RI",
                                        "zip": "22903",
                                        "country": "USA",
                                        "raw_address": "1447, Winding Way, Providence, RI 22903"
                                    },
                                    "phone": "9037442554",
                                    "gender": "Male",
                                    "marital_status": "Married",
                                    "birth_date": "1987-10-21",
                                    "age": 35,
                                    "relation": "Primary named insured",
                                    "education": "Engineer",
                                    "occupation": "Software Engineer",
                                    "full_time_student": "No"
                                },
                                "license": {
                                    "license_number": "D123-456-789-012",
                                    "license_issuing_state": "Rhode Island",
                                    "license_status": "Active",
                                    "driver_status": "Active"
                                }
                            }
                        ],
                        "vehicles": [
                            {
                                "raw_name": "2020 LAND ROVER DISCOVERY SPORT",
                                "model": "ROVER DISCOVERY SPORT 4 DOOR WAGON",
                                "sub_model": "Premium",
                                "make": "LAND ROVER",
                                "year": 2020,
                                "vin": "1C7GJFBG2MC631234",
                                "premium": 508,
                                "primary_use": "Pleasure/Personal",
                                "garaged_zip": "40220",
                                "annual_mileage": 12.97,
                                "has_alarm": 1,
                                "has_anti_lock_brakes": 1,
                                "ownership_status": "Owned",
                                "vehicle_coverage": {
                                    "other_coverage": [
                                        {
                                            "coverage_display_name": "Loan/Lease Payoff",
                                            "coverage_detail": "premium 10"
                                        },
                                        {
                                            "coverage_display_name": "Basic Personal Injury Protection",
                                            "coverage_detail": "premium 13, deductible 1000, limit 10000"
                                        },
                                        {
                                            "coverage_display_name": "Custom Parts and/or Equipment value",
                                            "coverage_detail": "premium 20"
                                        },
                                        {
                                            "coverage_display_name": "Personal Injury Protection",
                                            "coverage_detail": "per person limit 10000"
                                        },
                                        {
                                            "coverage_display_name": "Guest Personal Injury Protection",
                                            "coverage_detail": "premium 12"
                                        },
                                        {
                                            "coverage_display_name": "Property Damage Coverage",
                                            "coverage_detail": "per accident limit 100000"
                                        },
                                        {
                                            "coverage_display_name": "Medical Payments",
                                            "coverage_detail": "premium 9, per person limit 10000"
                                        }
                                    ],
                                    "uninsured_bodily_injury": {
                                        "coverage_display_name": "Uninsured motorist bodily injury",
                                        "per_person_limit": 100000,
                                        "per_accident_limit": 300000
                                    },
                                    "medical_payments": {
                                        "coverage_display_name": "Medical",
                                        "limit": 1000,
                                        "per_person_limit": 10000,
                                        "deductible": 500
                                    },
                                    "underinsured_bodily_injury": {
                                        "coverage_display_name": "Underinsured Motorist Bodily Injury",
                                        "per_person_limit": 10000,
                                        "per_accident_limit": 30000
                                    },
                                    "road_side_assistance": {
                                        "coverage_display_name": "Roadside assistance",
                                        "limit": 10000,
                                        "per_accident_limit": 1000
                                    },
                                    "property_damage_liability": {
                                        "coverage_display_name": "Bodily Injury & Property Damage Liability",
                                        "per_accident_limit": 300000
                                    },
                                    "rental_assistance": {
                                        "coverage_display_name": "Rental assistance",
                                        "limit": 50,
                                        "per_person_limit": 10000,
                                        "per_accident_limit": 1000,
                                        "per_day_limit": 100,
                                        "per_day_percentage": 80
                                    },
                                    "comprehensive": {
                                        "coverage_display_name": "Comprehensive",
                                        "deductible": 500
                                    },
                                    "collision": {
                                        "coverage_display_name": "Collision",
                                        "deductible": 500
                                    },
                                    "bodily_injury_liability": {
                                        "coverage_display_name": "Bodily injury liability",
                                        "per_person_limit": 100000,
                                        "per_accident_limit": 300000
                                    },
                                    "underinsured_property_damage": {
                                        "coverage_display_name": "Underinsured motorist property damage",
                                        "per_person_limit": 100000,
                                        "per_accident_limit": 100000,
                                        "deductible": 1000
                                    },
                                    "uninsured_property_damage": {
                                        "coverage_display_name": "Uninsured Motorist Property Damage",
                                        "limit": 10000,
                                        "per_person_limit": 10000,
                                        "per_accident_limit": 30000,
                                        "deductible": 1000
                                    },
                                    "uninsured_underinsured_property_damage": {
                                        "coverage_display_name": "Uninsured/underinsured property damage",
                                        "per_person_limit": 10000,
                                        "per_accident_limit": 30000,
                                        "deductible": 1000
                                    },
                                    "uninsured_underinsured_bodily_injury": {
                                        "coverage_display_name": "Uninsured/Underinsured Motorist bodily injury",
                                        "per_person_limit": 5000,
                                        "per_accident_limit": 5000
                                    }
                                },
                                "lien_holders": [
                                    {
                                        "company": "USA Secure Lien Services",
                                        "address": {
                                            "entity_number": "1447",
                                            "street": "Winding",
                                            "city": "Providence",
                                            "state": "RI",
                                            "zip": "22903",
                                            "country": "USA",
                                            "raw_address": "1447, Winding Way, Providence, RI 22903"
                                        },
                                        "loan_number": "LH123456789",
                                        "financing_type": "Fixed-Rate Financing"
                                    }
                                ],
                                "vehicle_discount": {
                                    "total_discount": null,
                                    "monthly_total_discount": 10,
                                    "discounts": [
                                        {
                                            "discount_type": "Smart Technology Discount",
                                            "discount": null,
                                            "monthly_discount": 7
                                        },
                                        {
                                            "discount_type": "Anti-theft Device Discount",
                                            "discount": null,
                                            "monthly_discount": 3
                                        }
                                    ]
                                }
                            }
                        ],
                        "policy_coverage": {
                            "other_coverage": [
                                {
                                    "coverage_display_name": "Guest Personal Injury Protection",
                                    "coverage_detail": "premium 12"
                                },
                                {
                                    "coverage_display_name": "Collision Coverage",
                                    "coverage_detail": "premium 32, deductible 500"
                                },
                                {
                                    "coverage_display_name": "Loan/Lease Payoff",
                                    "coverage_detail": "premium 10"
                                },
                                {
                                    "coverage_display_name": "Medical Payments",
                                    "coverage_detail": "per person limit 10000"
                                },
                                {
                                    "coverage_display_name": "Uninsured Motorist Property Damage",
                                    "coverage_detail": "per person limit 10000, per accident limit 30000, deductible 1000, limit 10000"
                                },
                                {
                                    "coverage_display_name": "Custom Parts and/or Equipment value",
                                    "coverage_detail": "premium 20"
                                },
                                {
                                    "coverage_display_name": "Personal Injury Protection",
                                    "coverage_detail": "per person limit 10000"
                                },
                                {
                                    "coverage_display_name": "Additional Personal Injury Protection",
                                    "coverage_detail": "premium 12"
                                },
                                {
                                    "coverage_display_name": "Basic Personal Injury Protection",
                                    "coverage_detail": "deductible 1000, limit 10000"
                                },
                                {
                                    "coverage_display_name": "Property Damage Coverage",
                                    "coverage_detail": "per accident limit 100000"
                                },
                                {
                                    "coverage_display_name": "Underinsured Motorist Bodily Injury",
                                    "coverage_detail": "per person limit 10000, per accident limit 30000"
                                }
                            ],
                            "uninsured_bodily_injury": {
                                "coverage_display_name": "Uninsured motorist bodily injury",
                                "per_person_limit": 100000,
                                "per_accident_limit": 300000
                            },
                            "underinsured_property_damage": {
                                "coverage_display_name": "Underinsured motorist property damage",
                                "per_person_limit": 100000,
                                "per_accident_limit": 100000,
                                "deductible": 1000
                            },
                            "property_damage_liability": {
                                "coverage_display_name": "Bodily Injury & Property Damage Liability",
                                "per_accident_limit": 300000
                            },
                            "comprehensive": {
                                "coverage_display_name": "Comprehensive",
                                "deductible": 500
                            },
                            "medical_payments": {
                                "coverage_display_name": "Medical",
                                "limit": 10000,
                                "per_person_limit": 10000,
                                "deductible": 500
                            },
                            "bodily_injury_liability": {
                                "coverage_display_name": "Bodily injury liability",
                                "per_person_limit": 100000,
                                "per_accident_limit": 300000
                            },
                            "road_side_assistance": {
                                "coverage_display_name": "Roadside assistance",
                                "limit": 10000,
                                "per_accident_limit": 1000
                            },
                            "collision": {
                                "coverage_display_name": "Collision",
                                "deductible": 500
                            },
                            "uninsured_property_damage": {
                                "coverage_display_name": "Uninsured Motorist",
                                "limit": 10000,
                                "per_person_limit": 100000,
                                "per_accident_limit": 300000,
                                "deductible": 500
                            },
                            "uninsured_underinsured_property_damage": {
                                "coverage_display_name": "Uninsured/underinsured property damage",
                                "per_person_limit": 10000,
                                "per_accident_limit": 30000,
                                "deductible": 1000
                            },
                            "uninsured_underinsured_bodily_injury": {
                                "coverage_display_name": "Uninsured/Underinsured Motorist bodily injury",
                                "per_person_limit": 5000,
                                "per_accident_limit": 5000
                            },
                            "underinsured_bodily_injury": {
                                "coverage_display_name": "Underinsured Motorist",
                                "per_person_limit": 100000,
                                "per_accident_limit": 300000
                            },
                            "rental_assistance": {
                                "coverage_display_name": "Rental assistance",
                                "limit": 50,
                                "per_person_limit": 10000,
                                "per_accident_limit": 1000,
                                "per_day_limit": 100,
                                "per_day_percentage": 80
                            }
                        }
                    }
                }
            ]
        }
    },
    "status_code": "SUCCESS",
    "status_message": "At least one policy with a declaration page is available."
}

For HTTP Status = 202 or 500

PropertyTypeDescriptionNullable
typeStringUnique identification for each policy request.No
codeEnum("success" , "failure")The value of this property defines whether the request made is succeeded or failed processing.No
http_status_codeIntegerThis property contains HTTP status code. Range: 202, 500.No
messageStringThis property contains a message corresponding to the code property.No
connection_idStringUnique identification for each policy request.No
placement_idStringId of Fize modal in the application. Eg; placement_1No
setup_idStringId of policy sync link.Yes
insurance_line(Insurance Line)EnumInsurance line of current policy sync.No
status_code(Policy Sync Status Code)EnumPolicy sync status code value. This code can be utilized to take further action/decision as it provides the current status of policy sync. The value of this key will be the status of the policy sync request and not specific to a policy section or policy.Yes
status_message (Policy Sync Status Code)EnumPolicy sync status message value. The value of this key will be the status of the policy sync request and not specific to a policy section or policy.Yes
{
    "type": "success",
    "code": "LOGIN_IN_PROGRESS",
    "http_status_code": 202,
    "message": "Validating account credentials.",
    "connection_id": "fzTestRmSK4AuFz=",
    "placement_id": "1",
    "setup_id": "li_prmddnzprx",
    "insurance_line": "personal",
    "status_code": "IN_PROGRESS",
    "status_message": "We are still in process of validating credentials submitted by the user.",
}

For HTTP Status != 200

PropertyTypeDescription
typeEnum("success" , "failure")Value of this property defines whether the request made is succeeded or failed processing.
codeCommon Status Code or Policy Status CodeDefines a status code to denote the status of Policy data acquisition by the client
http_status_codeInteger
Range: 100 - 199 or 201 - 599
This property contains HTTP status code. Range: 100 - 199 or 201 - 599. Excluding 202, 500
messageStringThis property contains message corresponding to code property
 {
    "type": "failure",
    "code": "INVALID_CONNECTION_ID",
    "http_status_code": 400,
    "message": "Provided connection_id is invalid. Please try again with valid connection_id."
 }

Schema Reference