Policy Packages

In Mexico, insurance policies are commonly structured into packages comprising various coverages. Typically, clients must choose one package from a range of 2 or 3 available packages. As clients opt for higher tiers, the scope of coverage expands. Consequently, each policy is linked to a specific package, and each package is associated with a predefined set of included coverages. Additionally, some of these coverages are optional. This API not only allows clients to select their preferred package but also provides the flexibility to customize it by including or excluding specific optional coverages.

Package Structure Overview

Qualitas packages are designed with a predefined set of coverages. For example, the "Full" package includes a set of coverages, each with specified sums and deductibles (where applicable). This means that a quote or policy can be generated by simply providing the package ID, without needing to specify or modify the coverages manually. The system will automatically use the default coverage configuration for the specified package.

However, there are certain scenarios where you may need to modify the default coverages. These include:

1. Modifying the insurance sum of a coverage.
2. Modifying the deductible percentage of a coverage (if applicable).
3. Removing a coverage from the package.
4. Adding an optional coverage that is not included by default.

Modifying the Insurance Sum or Deductible Percentage

Please note that only specific values are allowed for modifying the insurance sum and deductible percentage. To ensure valid modifications, refer to the allowed values for each coverage. These values can be found in the insured_sum_options and deductible_options arrays, which are part of the coverage object within the package object.

When you fetch the list of packages, the structure will be as follows:

{
    "data": [
        {
            "id": 1,
            "display": "Amplia",
            "display_en": "Full",
            "coverages": [
                {
                    "id": 1,
                    "short_name": "DM",
                    "display": "Daños Materiales",
                    "insured_sum_options": [ array of allowed sums ],
                    "deductible_options": [ array of allowed deductibles ]
                },
                {
                    "id": 3,
                    "short_name": "RT",
                    "display": "Robo Total",
                    "insured_sum_options": [ array of allowed sums ],
                    "deductible_options": [ array of allowed deductibles ]
                }
            ]
        }
    ]
}

Modifying a Coverage

To modify one or more coverages, you must define the Coverages array property as part of the package object. Here’s an example of how you can structure the request:

Example from .NET SDK:

var packageData = new TouristPolicyRequestPackage
{
    Id = "Full",
    Coverages = new List<TouristPolicyRequestPackageCoverage>
    {
        new TouristPolicyRequestPackageCoverage
        {
            Id = 1,
            Deductible = .10,
            Exclude = false,
            InsuredSum = 400000
        }
    }
};

Explanation of Fields

• Id: The ID of the coverage you wish to modify (this is required).
• Deductible: A decimal value representing the deductible percentage you want to apply to the coverage (optional).
• Exclude: A boolean value that determines whether to exclude the coverage from the policy, if it's an excludable coverage (optional).
• InsuredSum: An integer value representing the insured amount you wish to assign to the coverage (optional).

Key Notes

• The Deductible field should be a decimal that reflects the deductible percentage you want to apply (e.g., 0.5 for 5%).
• The Exclude field is only applicable for coverages that can be excluded. Setting this to true will remove the coverage from the policy.
• The InsuredSum must be selected from the list of allowed values for that coverage, as indicated by the insured_sum_options array. If you define an out-of-range amount, you’ll get a validation error from the server.

Properties

List packages by insurance company and policy type

curl -G https://covertier.com/api/v1/packages/{company_id}/{policy_type} \
     -H "Authorization: Bearer {TOKEN}"

{
    "data": [
        {
            "id": "1",
            "display": "Amplia",
            "display_en": "Full",
            "coverages": [
                {
                  "id": 1,
                  "short_name": "DM",
                  "display": "Daños Materiales",
                  "display_en": "Material Damage",
                  "is_add_on": false,
                  "is_excludable": false,
                  "insured_sum": 15000,
                  "deductible": 5,
                  "premium": 0
                },
                {
                  "id": 3,
                  "short_name": "RT",
                  "display": "Robo Total",
                  "display_en": "Theft",
                  "is_add_on": false,
                  "is_excludable": false,
                  "insured_sum": 0,
                  "deductible": 10,
                  "premium": 0
                },
                ...
            ]
        }
    ]
}