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.additional_consumer_data | Array[Additional Consumer Data] | This contains additional consumer data for specific connection_id. | No |
{
"connection_id": "ci_dd84f9c70d5349=",
"placement_id": "1",
"setup_id": "li_vfhypablff",
"data": {
"policy_data": {
"version": 2,
"carrier_display_name": "Farmers",
"carrier_logo": "https://cdn.getfize.com/sdk/assets/carriers/icons/farmers.png",
"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 != 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"
}