Response Properties | Policy Documents Data

For HTTP Status Code = 200

PropertyTypeDescriptionNullable
connection_idStringUnique identification for each policy request.No
placement_idStringId of Fize modal in the application. Eg; placement_1No
setup_idStringId of policy sync link.Yes
insurance_lineEnumInsurance line of current policy sync.No
status_code(Policy Sync Status Code)EnumPolicy 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)EnumPolicy 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
dataJSONThis contains data corresponding to policy request.No
data.policy_dataJSONThis contains policies data corresponding to policy request.No
data.policy_data.versionNumberThis contains policy version corresponding to policy request. Eg; 1.1No
data.policy_data.carrier_display_nameStringThis contains carrier's display name. Eg; AllstateNo
data.policy_data.carrier_logoStringThis contains url of carrier logo.No
data.policy_data.policy_types_requestedArrayRequested policy types.No
data.policy_data.policy_types_availableArrayAvailable policy types.No
data.policy_data.carrierStringThis contains carrier name.No
data.policy_data.user_nameStringThis contains username of policy request for specific connection_id.No
data.policy_data.policiesArrayThis contains policies data of policy request for specific connection_id.No
data.policy_data.policies[].carrierStringThis contains carrier name.No
data.policy_data.policies[].fz_policy_numberStringIt is the unique identification give by Fize platform assign to policyNo
data.policy_data.policies[].policy_typeStringIt is the policy type value of policy.No
data.policy_data.policies[].policy_product_titleStringPolicy product title from carrier's site.Yes
data.policy_data.policies[].policy_numberStringIt is the policy number value of policy.No
data.policy_data.policies[].documentsJSON[Policy Documents]It is Documents data of policyNo
{
    "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",
                    "documents": {
                        "declaration_pages": [
                            {
                                "creation_date": null,
                                "name": "Declaration Page",
                                "document_url": "https://documents.getfize.com/demo/geico/home/dec-page.pdf"
                            },
                            {
                                "creation_date": "2023-09-14",
                                "name": "Amendment Page",
                                "document_url": "https://documents.getfize.com/demo/geico/home/dec-page.pdf"
                            }
                        ],
                        "other_documents": [
                            {
                                "creation_date": "2023-09-14",
                                "name": "Policy Document",
                                "document_url": "https://documents.getfize.com/demo/geico/home/dec-page.pdf"
                            }
                        ]
                    }
                },
                {
                    "carrier": "geico",
                    "fz_policy_number": "po_73edc29652554e92",
                    "policy_type": "Auto",
                    "policy_product_title": "Auto 7224J016371",
                    "policy_number": "7224J016371",
                    "documents": {
                        "id_cards": [
                            {
                                "creation_date": null,
                                "name": "Id Card",
                                "document_url": "https://documents.getfize.com/demo/geico/auto/id-card.pdf"
                            }
                        ],
                        "declaration_pages": [
                            {
                                "creation_date": null,
                                "name": "Declaration Page",
                                "document_url": "https://documents.getfize.com/demo/geico/auto/dec-page.pdf"
                            },
                            {
                                "creation_date": null,
                                "name": "Amendment Page",
                                "document_url": "https://documents.getfize.com/demo/geico/auto/dec-page.pdf"
                            }
                        ],
                        "other_documents": [
                            {
                                "creation_date": "2023-09-14",
                                "name": "Policy Document",
                                "document_url": "https://documents.getfize.com/demo/geico/auto/id-card.pdf"
                            },
                            {
                                "creation_date": "2023-09-14",
                                "name": "Policy Document",
                                "document_url": "https://documents.getfize.com/demo/geico/auto/dec-page.pdf"
                            }
                        ]
                    }
                }
            ]
        }
    },
    "status_code": "SUCCESS",
    "status_message": "At least one policy with a declaration page is available."
}

For HTTP Status = 202 or 500

PropertyTypeDescriptionNullable
typeStringUnique identification for each policy request.No
codeEnum("success" , "failure")The value of this property defines whether the request made is succeeded or failed processing.No
http_status_codeIntegerThis property contains HTTP status code. Range: 202, 500.No
messageStringThis property contains a message corresponding to the code property.No
connection_idStringUnique identification for each policy request.No
placement_idStringId of Fize modal in the application. Eg; placement_1No
setup_idStringId of policy sync link.Yes
insurance_line(Insurance Line)EnumInsurance line of current policy sync.No
status_code(Policy Sync Status Code)EnumPolicy 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)EnumPolicy 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

PropertyTypeDescription
typeEnum("success", "failure")The value of this property defines whether the request made succeeded or failed processing.
codeCommon Status Code or Policy Status CodeDefines a status code to denote the status of Policy data acquisition by the client
http_status_codeIntegerThis property contains the HTTP status code. Range: 100 - 199 or 201 - 599. Excluding 202, 500
messageStringThis property contains a message corresponding to the 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."
}

Schema Reference