This section outlines details of valid responses from the policy endpoint
Response Properties
For HTTP Status Code = 200
| Property | Type | Description | Nullable |
|---|---|---|---|
| connection_id | String | Unique identification for each policy request. | No |
| placement_id | String | Id of Fize modal in application. Eg; placement_1 | No |
| data | JSON | This contains data corresponding to policy request. | No |
| data.policy_data | JSON | This contains policies data corresponding to policy request. | No |
| data.policy_data.version | Number | This contains policy version corresponding to policy request. Eg; 1.1 | No |
| data.policy_data.carrier_display_name | String | This contains carrier's display name. Eg; Allstate | No |
| data.policy_data.carrier_logo | String | This contains url of carrier logo. | No |
| data.policy_data.carrier | String | This contains carrier name. | No |
| data.policy_data.policies | Array[Policy] | This contains policies data of policy request for specific connection_id. | No |
| data.policy_data.additional_consumer_data | Object [Additional Consumer Data] | This contains additional consumer data for specific connection_id. | No |
{
"connection_id": "ci_d9783a7c890346=",
"placement_id": 2,
"data": {
"policy_data": {
"version": 2,
"carrier_display_name": "Travelers",
"carrier_logo": "https://cdn.getfize.com/sdk/assets/carriers/icons/travelers.png",
"carrier": "travelers",
"policies": [
{
"carrier": "travelers",
"fz_policy_number": "po_c389b89c52d34f45",
"policy_type": "Auto",
"policy_number": "7224J016371",
"policy_start_date": "2021-01-01",
"policy_end_date": "2021-07-01",
"policy_status": "Inactive",
"policy_premium": null,
"policy_monthly_premium": 39,
"policy_term_months": 6,
"policy_holder": {
"first_name": "Fize",
"last_name": "User",
"middle_name": "Demo",
"full_name": "Fize Demo User",
"birth_date": "1980-10-21",
"age": 42,
"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": "1234567890"
},
"documents": {
"id_cards": [
{
"creation_date": null,
"name": "Id Card",
"document_url": "https://documents-dev.getfize.com/demo/test/2021/12/31/LNTEtfysSK4AbXw%3D/PDF/IdCard.pdf"
}
],
"declaration_pages": [
{
"creation_date": null,
"name": "Declaration Page",
"document_url": "https://documents-dev.getfize.com/demo/test/2021/12/31/LNTEtfysSK4AbXw%3D/PDF/DeclarationPage.pdf"
}
],
"other_documents": []
},
"policy_detail": {
"drivers": [
{
"personal_info": {
"first_name": "Fize",
"last_name": "User",
"middle_name": "Demo",
"full_name": "Fize Demo User",
"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": "1234567890",
"gender": "Male",
"marital_status": "Married",
"birth_date": "1980-10-21",
"age": 42,
"relation": "self",
"education": "engineer",
"occupation": "job",
"full_time_student": "No"
},
"license": {
"license_number": "6040690",
"license_issuing_state": "Rhode Island",
"license_status": "Active",
"driver_status": "Active"
}
}
],
"vehicles": [
{
"raw_name": "GRAND CHEROKEE 4 DOOR WAGON",
"model": "GRAND CHEROKEE",
"sub_model": "4 DOOR WAGON",
"make": "JEEP",
"year": 2014,
"vin": "1C7GJFBG2MC631234",
"premium": 444,
"primary_use": "Pleasure",
"garaged_zip": "23234",
"annual_mileage": 40,
"has_alarm": 1,
"has_anti_lock_brakes": 1,
"ownership_status": "Leased",
"vehicle_coverage": {
"bodily_injury_liability": {
"coverage_display_name": "Bodily injury liability",
"per_person_limit": 103,
"per_accident_limit": 104
},
"collision": {
"coverage_display_name": "Collision Coverage",
"limit": 125,
"deductible": 126
},
"comprehensive": {
"coverage_display_name": "Comprehensive",
"deductible": 129
},
"medical_payments": {
"coverage_display_name": "Medical",
"limit": 112,
"per_person_limit": 123,
"deductible": 250
},
"property_damage_liability": {
"coverage_display_name": "Property Damage Coverage",
"per_accident_limit": 107
},
"rental_assistance": {
"coverage_display_name": "Rental assistance",
"limit": 80,
"per_accident_limit": 133,
"per_day_limit": 132
},
"road_side_assistance": {
"coverage_display_name": "Tow/road side assistance",
"limit": 136,
"per_accident_limit": 137
},
"underinsured_bodily_injury": {
"coverage_display_name": "Underinsured Motorist Bodily Injury",
"per_person_limit": 114,
"per_accident_limit": 115
},
"underinsured_property_damage": {
"coverage_display_name": "Underinsured motorist property damage",
"per_person_limit": 146,
"per_accident_limit": 147,
"deductible": 145
},
"uninsured_bodily_injury": {
"coverage_display_name": "Uninsured motorist bodily injury",
"per_person_limit": 118,
"per_accident_limit": 119
},
"uninsured_property_damage": {
"coverage_display_name": "Uninsured Motorist Property Damage",
"limit": 151,
"per_person_limit": 153,
"per_accident_limit": 152,
"deductible": 150
},
"uninsured_underinsured_bodily_injury": {
"coverage_display_name": "Uninsured/Underinsured Motorist bodily injury",
"per_person_limit": 110,
"per_accident_limit": 111
},
"uninsured_underinsured_property_damage": {
"coverage_display_name": "Uninsured/underinsured property damage",
"per_person_limit": 141,
"per_accident_limit": 142,
"deductible": 140
},
"other_coverage": [
{
"coverage_display_name": "accident forgivenes",
"coverage_detail": "per occurance limit $10.50/- per person limit $2,00 only"
}
]
},
"lien_holders": [
{
"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"
}
],
"vehicle_discount": {
"total_discount": null,
"monthly_total_discount": 404,
"discounts": [
{
"discount_type": "California Good Drive",
"discount": null,
"monthly_discount": 30
}
]
}
}
],
"policy_coverage": {
"bodily_injury_liability": {
"coverage_display_name": "Bodily injury liability",
"per_person_limit": 103,
"per_accident_limit": 104
},
"collision": {
"coverage_display_name": "Collision Coverage",
"limit": 125,
"deductible": 126
},
"comprehensive": {
"coverage_display_name": "Comprehensive",
"deductible": 129
},
"medical_payments": {
"coverage_display_name": "Medical",
"limit": 112,
"per_person_limit": 123,
"deductible": 250
},
"property_damage_liability": {
"coverage_display_name": "Property Damage Coverage",
"per_accident_limit": 107
},
"rental_assistance": {
"coverage_display_name": "Rental assistance",
"limit": 80,
"per_accident_limit": 133,
"per_day_limit": 132
},
"road_side_assistance": {
"coverage_display_name": "Tow/road side assistance",
"limit": 136,
"per_accident_limit": 137
},
"underinsured_bodily_injury": {
"coverage_display_name": "Underinsured Motorist Bodily Injury",
"per_person_limit": 114,
"per_accident_limit": 115
},
"underinsured_property_damage": {
"coverage_display_name": "Underinsured motorist property damage",
"per_person_limit": 146,
"per_accident_limit": 147,
"deductible": 145
},
"uninsured_bodily_injury": {
"coverage_display_name": "Uninsured motorist bodily injury",
"per_person_limit": 118,
"per_accident_limit": 119
},
"uninsured_property_damage": {
"coverage_display_name": "Uninsured motorist property damage",
"limit": 151,
"per_person_limit": 153,
"per_accident_limit": 152,
"deductible": 150
},
"uninsured_underinsured_bodily_injury": {
"coverage_display_name": "Uninsured/Underinsured Motorist bodily injury",
"per_person_limit": 110,
"per_accident_limit": 111
},
"uninsured_underinsured_property_damage": {
"coverage_display_name": "Uninsured/underinsured property damage",
"per_person_limit": 141,
"per_accident_limit": 142,
"deductible": 140
},
"other_coverage": [
{
"coverage_display_name": "accident forgivenes",
"coverage_detail": "per occurance limit $10.50/- per person limit $2,00 only"
}
]
}
},
"policy_discount": {
"total_discount": null,
"monthly_total_discount": 404,
"discounts": [
{
"discount_type": "California Good Drive",
"discount": null,
"monthly_discount": 30
}
]
}
},
{
"carrier": "travelers",
"fz_policy_number": "po_f9fcee3fca5e493d",
"policy_type": "Home",
"policy_number": "P1234",
"policy_start_date": "2021-01-01",
"policy_end_date": "2022-01-01",
"policy_status": "Inactive",
"policy_premium": null,
"policy_monthly_premium": 25,
"policy_term_months": 12,
"policy_holder": {
"first_name": "Fize",
"last_name": "User",
"middle_name": "Demo",
"full_name": "Fize Demo User",
"birth_date": "1980-10-21",
"age": 42,
"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": "1234567890"
},
"documents": {
"declaration_pages": [
{
"creation_date": null,
"name": "Declaration Page",
"document_url": "https://documents-dev.getfize.com/demo/test/2021/12/31/LNTEtfysSK4AbXw%3D/PDF/HomeDeclarationPage.pdf"
}
],
"other_documents": []
},
"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"
}
]
}
},
"policy_discount": {
"total_discount": null,
"monthly_total_discount": 404,
"discounts": [
{
"discount_type": "California Good Drive",
"discount": null,
"monthly_discount": 30
}
]
}
}
],
"additional_consumer_data": {
"standard": [
{
"question_id": "education",
"question": "Education",
"answer": "Bechlor"
},
{
"question_id": "gender",
"question": "Gender",
"answer": "Male"
}
],
"custom": [
{
"question": "What is your current insurance carrier",
"answer": "Geico"
}
]
}
}
}
}
For HTTP Status != 200
| Property | Type | Description |
|---|---|---|
| type | Enum("success" , "failure") | Value of this property defines whether the request made is succeeded or failed processing. |
| code | Common Status Code or Policy Status Code | Defines a status code to denote the status of Policy data acquisition by the client |
| http_status_code | Integer Range: 100 - 199 or 201 - 599 | This property contains HTTP status code. Range: 100 - 199 or 201 - 599 |
| message | String | This property contains message corresponding to code property |
{
"type": "failure",
"code": "INVALID_CONNECTION_ID",
"http_status_code": 400,
"message": "Invalid connection_id"
}