This section outlines details of valid responses from the endpoint
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 |
| setup_id | String | Id of policy sync link. | Yes |
| insurance_line | Enum | Insurance line of current policy sync. | No |
| status_code(Policy Sync Status Code) | Enum | Policy sync status code value. This code can be utilized to take further action/decision as it provides the current status of policy sync. The value of this key will be the status of the policy sync request and not specific to a policy section or policy. | Yes |
| status_message(Policy Sync Status Code) | Enum | Policy sync status message value. The value of this key will be the status of the policy sync request and not specific to a policy section or policy. | Yes |
| data | JSON | This contains data corresponding to the 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.policy_types_requested | Array | Requested policy types. | No |
| data.policy_data.policy_types_available | Array | Available policy types. | 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[].carrier | String | This contains carrier name. | No |
| data.policy_data.policies[].fz_policy_number | String | It is the unique identification given by Fize platform for the policy detail | No |
| data.policy_data.policies[].policy_type | String | It is the policy type value of policy. | No |
| data.policy_data.policies[].policy_product_title | String | Policy product title from carrier's site. | Yes |
| data.policy_data.policies[].policy_number | String | It is the policy number value of policy. | No |
| data.policy_data.policies[].policy_start_date | String | It is the policy start date value of policy. Format of this date string is YYYY-MM-DD | Yes |
| data.policy_data.policies[].policy_end_date | String | It is the policy end date value of policy. Format of this date string is YYYY-MM-DD | Yes |
| data.policy_data.policies[].policy_status | String | It is the status of policy in policy holder account. Eg; "Active" , "Cancelled" | Yes |
| data.policy_data.policies[].policy_premium | Number | It is the policy premium total value. | Yes |
| data.policy_data.policies[].policy_monthly_premium | Number | It is the policy premium monthly value. | Yes |
| data.policy_data.policies[].policy_term_months | Number | It is the policy premium term months value. | Yes |
{
"connection_id": "ci_7909eff6def443=",
"placement_id": 2,
"setup_id": null,
"insurance_line": "personal",
"data": {
"policy_data": {
"version": 2.2,
"carrier_display_name": "GEICO",
"carrier_logo": "https://cdn.getfize.com/sdk/assets/carriers/icons/geico.png",
"policy_types_requested": [
"Auto",
"Home",
"FIZE_ALL_POLICIES"
],
"policy_types_available": [
"Auto",
"Home"
],
"carrier": "geico",
"policies": [
{
"carrier": "geico",
"fz_policy_number": "po_4e2b5fe5651f4892",
"policy_type": "Home",
"policy_product_title": "Home Policy P1234",
"policy_number": "P1234",
"policy_start_date": "2023-06-27",
"policy_end_date": "2024-06-27",
"policy_status": "Active",
"policy_premium": 1362,
"policy_monthly_premium": 113.5,
"policy_term_months": 12
},
{
"carrier": "geico",
"fz_policy_number": "po_73edc29652554e92",
"policy_type": "Auto",
"policy_product_title": "Auto 7224J016371",
"policy_number": "7224J016371",
"policy_start_date": "2024-08-21",
"policy_end_date": "2024-02-21",
"policy_status": "Active",
"policy_premium": 580.8,
"policy_monthly_premium": 96.8,
"policy_term_months": 6
}
]
}
},
"status_code": "SUCCESS",
"status_message": "At least one policy with a declaration page is available."
}
For HTTP Status = 202 or 500
| Property | Type | Description | Nullable |
|---|---|---|---|
type | String | Unique identification for each policy request. | No |
code | Enum("success" , "failure") | The value of this property defines whether the request made is succeeded or failed processing. | No |
http_status_code | Integer | This property contains HTTP status code. Range: 202, 500. | No |
message | String | This property contains a message corresponding to the code property. | No |
connection_id | String | Unique identification for each policy request. | No |
placement_id | String | Id of Fize modal in the application. Eg; placement_1 | No |
setup_id | String | Id of policy sync link. | Yes |
insurance_line(Insurance Line) | Enum | Insurance line of current policy sync. | No |
status_code(Policy Sync Status Code) | Enum | Policy sync status code value. This code can be utilized to take further action/decision as it provides the current status of policy sync. The value of this key will be the status of the policy sync request and not specific to a policy section or policy. | Yes |
status_message (Policy Sync Status Code) | Enum | Policy sync status message value. The value of this key will be the status of the policy sync request and not specific to a policy section or policy. | 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 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 the HTTP status code. Range: 100 - 199 or 201 - 599. Excluding 202, 500 |
| message | String | This 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."
}