Overview

Overview of the policy Json response

Overview Properties

FieldTypeNullableDescriptionPropertiesExample
connection_idString (UUID)Sync Unique
identification for
each policy request.
ci_08f8cc096c3243=
placement_idStringId of Fize modal
in the application.
placement_1
setup_idStringYesId of policy sync linkli_hkqkntdlfy
insurance_lineString (Enum)Insurance lineEnum:
personal,
commercial

Reference:
Insurance Line Enums
personal
dataObjectPolicy dataReference:
Policy Data
status_codeString (Enum)YesStatus codeEnum:
SUCCESS,
IN_PROGRESS,
CARRIER_SITE_ERROR,
USER_INPUT_LOGIN_ERROR,
INTERNAL_SERVER_ERROR,
NO_POLICY_AVAILABLE,
REQUESTED_POLICY_NOT_AVAILABLE,
UNSUPPORTED_CARRIER,
DEC_PAGE_NOT_AVAILABLE,
ACCOUNT_LOCKED,
ACCOUNT_PROMPT_CONFIRMATION

Reference:
Policy Sync Status Code Enums
status_messageStringYesStatus messageReference:
Policy Sync Status Code Enums

Sample JSON

{
    "connection_id": "ci_08f8cc096c3243=",
    "placement_id": "1",
    "setup_id": null,
    "insurance_line": "personal",
    "data": {
        "policy_data": {
            "version": 2.1,
            "policy_types_requested": [
                "Auto",
                "Home",
                "FIZE_ALL_POLICIES"
            ],
            "policy_types_available": [
                "Auto",
                "Home"
            ],
            "carrier_display_name": "State Farm",
            "carrier": "statefarm",
            "carrier_logo": "https://cdn.getfize.com/sdk/assets/carriers/icons/statefarm.png",
            "policies": [
                {
                    "carrier": "statefarm",
                    "fz_policy_number": "po_2667b944e4514684",
                    "policy_type": "Home",
                    "policy_product_title": "Home Policy P1234",
                    "policy_number": "P1234",
                    "policy_start_date": "2023-06-27",
                    "policy_end_date": "2024-06-27",
                    "policy_status": "Active",
                    "policy_premium": 1362,
                    "policy_monthly_premium": 113.5,
                    "policy_term_months": 12,
                    "policy_holder": {
                        "first_name": "William",
                        "last_name": "Martinez",
                        "middle_name": "H.",
                        "full_name": "William H. Martinez",
                        "birth_date": "1987-10-21",
                        "age": 35,
                        "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"
                    },
                    "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": 3,
                            "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
                        },
                        "policy_coverage": {
                            "additional_living_expenses": {
                                "coverage_display_name": "Additional Living Expense",
                                "limit": 5000,
                                "term_months": 6
                            },
                            "medical": {
                                "coverage_display_name": "Medical",
                                "limit": 2000
                            },
                            "deductible": {
                                "all_perils": {
                                    "coverage_display_name": "ALL PERILS",
                                    "amount": 1000,
                                    "limit": 1000,
                                    "deductible": 500,
                                    "percentage": 2
                                },
                                "coverage_display_name": "Deductibles",
                                "windstorm_hail": {
                                    "coverage_display_name": "Windstorm/Hail",
                                    "amount": 1000,
                                    "percentage": 10,
                                    "deductible": 500
                                }
                            },
                            "personal_property": {
                                "coverage_display_name": "Personal Property",
                                "percentage": 70,
                                "limit": 157500
                            },
                            "personal_liability": {
                                "coverage_display_name": "Personal Liability",
                                "limit": 30000
                            },
                            "loss_of_use": {
                                "coverage_display_name": "Loss Of Use",
                                "limit": 67500
                            },
                            "dwelling": {
                                "coverage_display_name": "Dwelling Structures",
                                "limit": 225000
                            },
                            "separate_structures": {
                                "coverage_display_name": "Separate Structures",
                                "percentage": 60,
                                "limit": 22500
                            },
                            "other_coverage": [
                                {
                                    "coverage_display_name": "guaranteed replacement cost on buildings",
                                  "coverage_detail": "Yes $1,400"
                                 }
                            ]
                        }
                    },
                    "documents": {
                        "declaration_pages": [
                            {
                                "creation_date": null,
                                "name": "Declaration Page",
                                "document_url": "https://documents.getfize.com/demo/statefarm/home/dec-page.pdf"
                            },
                            {
                                "creation_date": "2023-08-14",
                                "name": "Amendment Page",
                                "document_url": "https://documents.getfize.com/demo/statefarm/home/dec-page.pdf"
                            }
                        ],
                        "other_documents": [
                            {
                                "creation_date": "2023-08-14",
                                "name": "Policy Document",
                                "document_url": "https://documents.getfize.com/demo/statefarm/home/dec-page.pdf"
                            }
                        ]
                    },
                    "policy_discount": {
                        "total_discount": null,
                        "monthly_total_discount": 30,
                        "discounts": [
                            {
                                "discount_type": "Multi-Policy",
                                "discount": null,
                                "monthly_discount": 5
                            },
                            {
                                "discount_type": "Affinity",
                                "discount": null,
                                "monthly_discount": 10
                            },
                            {
                                "discount_type": "Fire Protective Device",
                                "discount": null,
                                "monthly_discount": 5
                            },
                            {
                                "discount_type": "Good Payer",
                                "discount": null,
                                "monthly_discount": 10
                            }
                        ]
                    }
                },
                {
                    "carrier": "statefarm",
                    "fz_policy_number": "po_6b0906e398ff473a",
                    "policy_type": "Auto",
                    "policy_product_title": "Auto 7224J016371",
                    "policy_number": "7224J016371",
                    "policy_holder": {
                        "first_name": "William",
                        "middle_name": "H.",
                        "last_name": "Martinez",
                        "full_name": "William H. Martinez",
                        "birth_date": "1987-10-21",
                        "age": 35,
                        "email": "[email protected]",
                        "phone": "9037442554",
                        "address": {
                            "entity_number": "1447",
                            "street": "Winding",
                            "city": "Providence",
                            "state": "RI",
                            "zip": "22903",
                            "country": "USA",
                            "raw_address": "1447, Winding Way, Providence, RI 22903"
                        },
                        "policy_start_date": "2024-08-21",
                        "policy_end_date": "2024-02-21",
                        "policy_status": "Active",
                        "policy_premium": 580.8,
                        "policy_monthly_premium": 96.8,
                        "policy_term_months": 6
                    },
                    "policy_detail": {
                        "drivers": [
                            {
                                "personal_info": {
                                    "first_name": "William",
                                    "middle_name": "H.",
                                    "last_name": "Martinez",
                                    "full_name": "William H. Martinez",
                                    "email": "[email protected]",
                                    "phone": "9037442554",
                                    "address": {
                                        "entity_number": "1447",
                                        "street": "Winding",
                                        "city": "Providence",
                                        "state": "RI",
                                        "zip": "22903",
                                        "country": "USA",
                                        "raw_address": "1447, Winding Way, Providence, RI 22903"
                                    },
                                    "gender": "Male",
                                    "marital_status": "Married",
                                    "birth_date": "1987-10-21",
                                    "age": 35,
                                    "relation": "Self",
                                    "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",
                                "garaged_zip": "40220",
                                "annual_mileage": 12.97,
                                "has_alarm": 1,
                                "has_anti_lock_brakes": 1,
                                "ownership_status": "Owned",
                                "vehicle_coverage": {
                                    "uninsured_underinsured_property_damage": {
                                        "coverage_display_name": "Uninsured/underinsured property damage",
                                        "per_person_limit": 10000,
                                        "per_accident_limit": 30000,
                                        "deductible": 1000
                                    },
                                    "road_side_assistance": {
                                        "coverage_display_name": "Roadside assistance",
                                        "limit": 10000,
                                        "per_accident_limit": 1000
                                    },
                                    "uninsured_bodily_injury": {
                                        "coverage_display_name": "Uninsured motorist bodily injury",
                                        "per_person_limit": 100000,
                                        "per_accident_limit": 300000
                                    },
                                    "comprehensive": {
                                        "coverage_display_name": "Comprehensive",
                                        "deductible": 500
                                    },
                                    "underinsured_bodily_injury": {
                                        "coverage_display_name": "Underinsured Motorist Bodily Injury",
                                        "per_person_limit": 10000,
                                        "per_accident_limit": 30000
                                    },
                                    "uninsured_property_damage": {
                                        "coverage_display_name": "Uninsured Motorist Property Damage",
                                        "limit": 10000,
                                        "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
                                    },
                                    "collision": {
                                        "coverage_display_name": "Collision",
                                        "deductible": 500
                                    },
                                    "medical_payments": {
                                        "coverage_display_name": "Medical",
                                        "limit": 1000,
                                        "per_person_limit": 10000,
                                        "deductible": 500
                                    },
                                    "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
                                    },
                                    "property_damage_liability": {
                                        "coverage_display_name": "Bodily Injury & Property Damage Liability",
                                        "per_accident_limit": 300000
                                    },
                                    "underinsured_property_damage": {
                                        "coverage_display_name": "Underinsured motorist property damage",
                                        "per_person_limit": 100000,
                                        "per_accident_limit": 100000,
                                        "deductible": 1000
                                    },
                                    "bodily_injury_liability": {
                                        "coverage_display_name": "Bodily injury liability",
                                        "per_person_limit": 100000,
                                        "per_accident_limit": 300000
                                    },
                                    "other_coverage": [
                                        {
                                            "coverage_display_name": "Loan/Lease Payoff",
                                            "coverage_detail": "premium 10"
                                        },
                                        {
                                            "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": "Property Damage Coverage",
                                            "coverage_detail": "per accident limit 100000"
                                        },
                                        {
                                            "coverage_display_name": "Medical Payments",
                                            "coverage_detail": "premium 9, per person limit 10000"
                                        },
                                        {
                                            "coverage_display_name": "Guest Personal Injury Protection",
                                            "coverage_detail": "premium 12"
                                        },
                                        {
                                            "coverage_display_name": "Basic Personal Injury Protection",
                                            "coverage_detail": "premium 13, deductible 1000, limit 10000"
                                        }
                                    ]
                                },
                                "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": "Anti-theft Device Discount",
                                            "discount": null,
                                            "monthly_discount": 3
                                        },
                                        {
                                            "discount_type": "Smart Technology Discount",
                                            "discount": null,
                                            "monthly_discount": 7
                                        }
                                    ]
                                }
                            }
                        ],
                        "policy_coverage": {
                            "underinsured_bodily_injury": {
                                "coverage_display_name": "Underinsured Motorist",
                                "per_person_limit": 100000,
                                "per_accident_limit": 300000
                            },
                            "collision": {
                                "coverage_display_name": "Collision",
                                "deductible": 500
                            },
                            "bodily_injury_liability": {
                                "coverage_display_name": "Bodily injury liability",
                                "per_person_limit": 100000,
                                "per_accident_limit": 300000
                            },
                            "medical_payments": {
                                "coverage_display_name": "Medical",
                                "limit": 10000,
                                "per_person_limit": 10000,
                                "deductible": 500
                            },
                            "comprehensive": {
                                "coverage_display_name": "Comprehensive",
                                "deductible": 500
                            },
                            "uninsured_property_damage": {
                                "coverage_display_name": "Uninsured Motorist",
                                "limit": 10000,
                                "per_person_limit": 100000,
                                "per_accident_limit": 300000,
                                "deductible": 500
                            },
                            "property_damage_liability": {
                                "coverage_display_name": "Bodily Injury & Property Damage Liability",
                                "per_accident_limit": 300000
                            },
                            "uninsured_underinsured_bodily_injury": {
                                "coverage_display_name": "Uninsured/Underinsured Motorist bodily injury",
                                "per_person_limit": 5000,
                                "per_accident_limit": 5000
                            },
                            "road_side_assistance": {
                                "coverage_display_name": "Roadside assistance",
                                "limit": 10000,
                                "per_accident_limit": 1000
                            },
                            "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
                            },
                            "uninsured_bodily_injury": {
                                "coverage_display_name": "Uninsured motorist bodily injury",
                                "per_person_limit": 100000,
                                "per_accident_limit": 300000
                            },
                            "uninsured_underinsured_property_damage": {
                                "coverage_display_name": "Uninsured/underinsured property damage",
                                "per_person_limit": 10000,
                                "per_accident_limit": 30000,
                                "deductible": 1000
                            },
                            "underinsured_property_damage": {
                                "coverage_display_name": "Underinsured motorist property damage",
                                "per_person_limit": 100000,
                                "per_accident_limit": 100000,
                                "deductible": 1000
                            },
                            "other_coverage": [
                                {
                                    "coverage_display_name": "Custom Parts and/or Equipment value",
                                    "coverage_detail": "premium 20"
                                },
                                {
                                    "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": "Medical Payments",
                                    "coverage_detail": "per person limit 10000"
                                },
                                {
                                    "coverage_display_name": "Additional Personal Injury Protection",
                                    "coverage_detail": "premium 12"
                                },
                                {
                                    "coverage_display_name": "Loan/Lease Payoff",
                                    "coverage_detail": "premium 10"
                                },
                                {
                                    "coverage_display_name": "Underinsured Motorist Bodily Injury",
                                    "coverage_detail": "per person limit 10000, per accident limit 30000"
                                },
                                {
                                    "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": "Uninsured Motorist Property Damage",
                                    "coverage_detail": "per person limit 10000, per accident limit 30000, deductible 1000, limit 10000"
                                },
                                {
                                    "coverage_display_name": "Personal Injury Protection",
                                    "coverage_detail": "per person limit 10000"
                                }
                            ]
                        }
                    },
                    "documents": {
                        "id_cards": [
                            {
                                "creation_date": null,
                                "name": "Id Card",
                                "document_url": "https://documents.getfize.com/demo/statefarm/auto/id-card.pdf"
                            }
                        ],
                        "declaration_pages": [
                            {
                                "creation_date": null,
                                "name": "Declaration Page",
                                "document_url": "https://documents.getfize.com/demo/statefarm/auto/dec-page.pdf"
                            },
                            {
                                "creation_date": null,
                                "name": "Amendment Page",
                                "document_url": "https://documents.getfize.com/demo/statefarm/auto/dec-page.pdf"
                            }
                        ],
                        "other_documents": [
                            {
                                "creation_date": "2023-08-14",
                                "name": "Policy Document",
                                "document_url": "https://documents.getfize.com/demo/statefarm/auto/dec-page.pdf"
                            },
                            {
                                "creation_date": "2023-08-14",
                                "name": "Policy Document",
                                "document_url": "https://documents.getfize.com/demo/statefarm/auto/id-card.pdf"
                            }
                        ]
                    },
                    "policy_discount": {
                        "total_discount": null,
                        "monthly_total_discount": 12,
                        "discounts": [
                            {
                                "discount_type": "Continuous Insurance Discount - Gold",
                                "discount": null,
                                "monthly_discount": 1
                            },
                            {
                                "discount_type": "Paperless",
                                "discount": null,
                                "monthly_discount": 2
                            },
                            {
                                "discount_type": "Three Year Safe Driving",
                                "discount": null,
                                "monthly_discount": 1
                            },
                            {
                                "discount_type": "Paid in Full",
                                "discount": null,
                                "monthly_discount": 3
                            },
                            {
                                "discount_type": "Gold",
                                "discount": null,
                                "monthly_discount": 1
                            },
                            {
                                "discount_type": "Online Quote",
                                "discount": null,
                                "monthly_discount": 1
                            },
                            {
                                "discount_type": "Smart Technology",
                                "discount": null,
                                "monthly_discount": 3
                            }
                        ]
                    }
                }
            ],
            "additional_consumer_data": {
                "standard": [],
                "custom": []
            }
        }
    },
    "status_code": "SUCCESS",
    "status_message": "At least one policy with a declaration page is available."
}