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
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.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[].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_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_abf621e5bab043=",
    "placement_id": "1",
    "data": {
        "policy_data": {
            "version": 2,
            "carrier_display_name": "GEICO",
            "carrier_logo": "https://cdn.getfize.com/sdk/assets/carriers/icons/geico.png",
            "carrier": "geico",
            "policies": [
                {
                    "carrier": "geico",
                    "fz_policy_number": "po_0c700ca28e5b4015",
                    "policy_type": "Home",
                    "policy_number": "P1234",
                    "policy_detail": {
                        "property_info": {
                            "mortgagee": [
                                {
                                    "company": "PRIVATE LABEL-Santander Consumer USA Inc",
                                    "address": {
                                        "entity_number": "1447",
                                        "street": "Winding",
                                        "city": "Providence",
                                        "state": "RI",
                                        "zip": "22903",
                                        "country": "USA",
                                        "raw_address": "1447, Winding Way, Providence, RI 22903"
                                    },
                                    "loan_number": "LN45656",
                                    "financing_type": "finance"
                                }
                            ],
                            "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": "LN45656",
                            "family_count": 1,
                            "year_built": 2010,
                            "stories_count": 2,
                            "bathrooms_count": 1,
                            "square_footage": 4000,
                            "basement_included": "No",
                            "garage_size": 500,
                            "garage_type": "Attached",
                            "construction": "Frame",
                            "siding": "Stucco",
                            "roof_type": "Asphalt-Fiberglass",
                            "roof_age_year": 10,
                            "foundation": "Basement",
                            "finished_basement_percentage": 100,
                            "employee_count": 0
                        },
                        "policy_coverage": {
                            "additional_living_expenses": {
                                "coverage_display_name": "ALE TERM",
                                "limit": 24
                            },
                            "deductible": {
                                "all_perils": {
                                    "coverage_display_name": "All perils",
                                    "amount": 1000,
                                    "limit": null,
                                    "deductible": null
                                },
                                "coverage_display_name": "Deductibles",
                                "windstorm_hail": {
                                    "coverage_display_name": "Windstorm/Hail",
                                    "amount": 1000
                                }
                            },
                            "dwelling": {
                                "coverage_display_name": "dwelling structures",
                                "limit": 3000
                            },
                            "loss_of_use": {
                                "coverage_display_name": "loss of use",
                                "limit": 3000
                            },
                            "medical": {
                                "coverage_display_name": "medical",
                                "limit": 3000
                            },
                            "personal_liability": {
                                "coverage_display_name": "personal liability",
                                "limit": 3000
                            },
                            "personal_property": {
                                "coverage_display_name": "personal property",
                                "percentage": 10,
                                "limit": 3000
                            },
                            "separate_structures": {
                                "coverage_display_name": "separate structures",
                                "percentage": 10,
                                "limit": 10000
                            },
                            "other_coverage": [
                              {
                                "coverage_display_name": "contents replacement cost",
                                "coverage_detail": "Yes $1,484.21"
                              },
                              {
                                "coverage_display_name": "fences",
                                "coverage_detail": "Covered $1,484.21"
                               },
                              {
                                "coverage_display_name": "guaranteed replacement cost on buildings",
                                "coverage_detail": "Yes $1,484.21"
                               }
                            ]
                        }
                    }
                }
            ]
        }
    }
}

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
messageStringThis property contains message corresponding to code property
 {
    "type": "failure",
    "code": "INVALID_CONNECTION_ID",
    "http_status_code": 400,
    "message": "Invalid connection_id"
 }

Schema Reference