Response Properties | Policy Basic Data

This section outlines details of valid responses from the endpoint

For HTTP Status Code = 200

connection_idStringUnique identification for each policy request.No
placement_idStringId of Fize modal in application. Eg; placement_1No
dataJSONThis contains data corresponding to the 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.policiesArrayThis contains policies data of policy request for specific connection_id.No
data.policy_data.policies[].fz_policy_numberStringIt is the unique identification given by Fize platform for the policy detailNo
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_start_dateStringIt is the policy start date value of policy. Format of this date string is YYYY-MM-DDYes
data.policy_data.policies[].policy_end_dateStringIt is the policy end date value of policy. Format of this date string is YYYY-MM-DDYes
data.policy_data.policies[].policy_statusStringIt is the status of policy in policy holder account. Eg; "Active" , "Cancelled"Yes
data.policy_data.policies[].policy_premiumNumberIt is the policy premium total value.Yes
data.policy_data.policies[].policy_monthly_premiumNumberIt is the policy premium monthly value.Yes
data.policy_data.policies[].policy_term_monthsNumberIt is the policy premium term months value.Yes
    "connection_id": "ci_69ad619bf68743=",
    "placement_id": 1,
    "data": {
        "policy_data": {
            "version": 2,
            "carrier_display_name": "Allstate",
            "carrier_logo": "",
            "carrier": "allstate",
            "policies": [
                    "carrier": "allstate",
                    "fz_policy_number": "po_5c30616fa7434dbb",
                    "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

For HTTP Status Code != 200

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_codeIntegerThis property contains HTTP status code. Range: 100 - 199 or 201 - 599
messageStringThis property contains message corresponding to code property
    "type": "failure",
    "http_status_code": 400,
    "message": "Invalid connection_id"