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.user_name | String | This contains username of policy request for specific connection_id. | 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[].documents | JSON[Policy Documents] | It is Documents data of policy | No |
{
"connection_id": "ci_abf621e5bab043=",
"placement_id": "1",
"data": {
"policy_data": {
"version": 2,
"carrier_display_name": "GEICO",
"carrier_logo": "https://cdn.getfize.com/sdk/assets/carriers/icons/geico.png",
"carrier": "geico",
"policies": [
{
"carrier": "geico",
"fz_policy_number": "po_0c700ca28e5b4015",
"policy_type": "Home",
"policy_number": "P1234",
"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": []
}
}
]
}
}
}
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"
}