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 |
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. | Yes |
status_message(Policy Sync Status Code) | Enum | Policy sync status message value. | Yes |
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.policy_types_requested | Array | Requested policy types in policy sync request. | No |
data.policy_data.policy_types_available | Array | Policy types available in user's account. | 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",
"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
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. | Yes |
status_message (Policy Sync Status Code) | Enum | Policy 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
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. 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."
}