Sensitivity analysis across coverage options

POST

/v1/rate/{productType}/{programId}/matrix

Price one specific program across all combinations of one or more coverage options. Returns a grid with { coverage, pricing } per combination.

The response also includes options (available values per swept key — use these to build selectors) and applied_options (fixed selections held constant).

Only available for rating_method='factor' (internal) programs. External carrier programs return 400.

sweep is an array of coverage-option keys to vary. Values are pulled from the program's configured options — every combination is priced.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Matrix computed — one entry per coverage combination

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

cURL

Travel — sweep plan_max × plan_dedCommercial — sweep GL limit

curl --location '/v1/rate///matrix' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "country_of_residence": "IN",
    "destination_country": "US",
    "start_date": "2026-05-01",
    "end_date": "2026-06-01",
    "insureds": [
        {
            "date_of_birth": "1955-03-10",
            "relationship": "primary"
        },
        {
            "date_of_birth": "1958-07-22",
            "relationship": "spouse"
        }
    ],
    "coverage": {
        "sports_rider": true
    },
    "sweep": [
        "plan_max",
        "plan_ded"
    ]
}'

Response Example

200 - plan_max × plan_ded matrix

{
    "success": true,
    "data": {
        "sweep": [
            "plan_max",
            "plan_ded"
        ],
        "applied_options": {
            "sports_rider": true
        },
        "options": {
            "plan_max": [
                75000,
                150000,
                250000,
                300000,
                500000,
                1000000
            ],
            "plan_ded": [
                50,
                100,
                250,
                500,
                1000,
                2500,
                5000
            ]
        },
        "results": [
            {
                "coverage": {
                    "plan_max": "75000",
                    "plan_ded": "50"
                },
                "pricing": {
                    "premium": 28,
                    "fees": 1.96,
                    "taxes": 0,
                    "total": 29.96
                }
            },
            {
                "coverage": {
                    "plan_max": "75000",
                    "plan_ded": "100"
                },
                "pricing": {
                    "premium": 24.5,
                    "fees": 1.72,
                    "taxes": 0,
                    "total": 26.22
                }
            },
            {
                "coverage": {
                    "plan_max": "75000",
                    "plan_ded": "500"
                },
                "pricing": {
                    "premium": 21,
                    "fees": 1.47,
                    "taxes": 0,
                    "total": 22.47
                }
            }
        ]
    }
}

Modified at 2026-05-05 23:26:07

Rate eligible programs for a risk

List quote folios