Response Properties | Additional Data Information

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.Yes
status_message(Policy Sync Status Code)EnumPolicy sync status message value.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 in policy sync request.No
data.policy_data.policy_types_availableArrayPolicy types available in user's account.No
data.policy_data.carrierStringThis contains carrier name.No
data.policy_data.additional_consumer_dataArray[Additional Consumer Data]This contains additional consumer data for specific connection_id.No
{
  "connection_id": "ci_dd84f9c70d5349=",
  "placement_id": "1",
  "setup_id": "li_vfhypablff",
  "insurance_line": "personal",
  "status_code": "IN_PROGRESS",
  "status_message": "We are in process of getting data, try after some time.",
  "data": {
    "policy_data": {
      "version": 2,
      "carrier_display_name": "Farmers",
      "carrier_logo": "https://cdn.getfize.com/sdk/assets/carriers/icons/farmers.png",
      "policy_types_requested": ["Auto", "Home"],
      "policy_types_available": ["Auto", "Home"],
      "carrier": "farmers",
      "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 = 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.Yes
status_message (Policy Sync Status Code)EnumPolicy sync status message value.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