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 | This contains policies data of policy request for specific connection_id. | No |
| data.policy_data.policies[].fz_policy_number | String | It is the unique identification give by Fize platform assign to policy. | No |
| data.policy_data.policies[].policy_type | String | It is the policy type value of policy. | No |
| data.policy_data.policies[].policy_number | String | It is the policy number value of policy. | No |
| data.policy_data.policies[].policy_holder | JSON[Policy Holder] | Key/Value JSON for policy holder data. | No |
{
"connection_id": "fswo32u03420183=",
"placement_id": 1,
"data": {
"policy_data": {
"version": 2,
"carrier_display_name": "Allstate",
"carrier_logo": "https://cdn.getfize.com/sdk/assets/carriers/icons/allstate.png",
"carrier": "allstate",
"policies": [
{
"carrier": "allstate",
"fz_policy_number": "po_5c30616fa7434dbb",
"policy_type": "Home",
"policy_number": "P1234",
"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"
}
}
]
}
}
}
For HTTP Status Code != 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 | 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"
}