ERGO

Capability: Premium Calculation

Market: UK

Business Capabilities

Compute insurance premiums based on risk factors and coverage details. The connector integrates with ERGO's rating engine to provide real-time premium quotes for property insurance products.

Exposed Endpoints

  • Calculate premium: POST /api/ergo/v1/premium/calculate - Computes the insurance premium based on property details, occupancy type, building characteristics, and coverage requirements.

Vault Configuration

  • ergo.baseUrl - Base URL of the ERGO API.
  • ergo.apiKey - API key for authentication.
  • ergo.partnerId - Partner identifier for the ERGO platform.

Request Structures and Samples

POST /api/ergo/v1/premium/calculate

Request structure:

Copy
{
    "policy": {
        "productCode": "string",
        "startDate": "YYYY-MM-DD",
        "endDate": "YYYY-MM-DD"
    },
    "property": {
        "address": {
            "line1": "string",
            "city": "string",
            "postcode": "string",
            "countryCode": "string"
        },
        "occupancy": "owner-occupied" | "tenant" | "let-unfurnished" | "let-furnished" | "unoccupied",
        "buildingType": "detached" | "semi-detached" | "terraced" | "flat" | "bungalow",
        "yearBuilt": number,
        "numberOfBedrooms": number,
        "rebuildValue": number
    },
    "cover": {
        "buildingsSum": number,
        "contentsSum": number,
        "personalPossessions": number,
        "voluntaryExcess": number
    },
    "policyholder": {
        "dateOfBirth": "YYYY-MM-DD",
        "claimsHistory": number,
        "yearsNoClaims": number
    }
}

Occupancy and Building Type Rules:

  • occupancy determines the base rate multiplier. "unoccupied" attracts the highest loading.
  • buildingType affects the structural risk factor. "flat" and "terraced" have different flood/subsidence profiles.
  • rebuildValue is required when buildingsSum is provided and must not exceed 2x the buildings sum insured.
  • yearsNoClaims applies a discount (max 9 years = max discount).

Sample request:

Copy
{
    "policy": {
        "productCode": "HOME-STD-01",
        "startDate": "2025-01-15",
        "endDate": "2026-01-14"
    },
    "property": {
        "address": {
            "line1": "42 Oak Avenue",
            "city": "Bristol",
            "postcode": "BS1 4QR",
            "countryCode": "GB"
        },
        "occupancy": "owner-occupied",
        "buildingType": "semi-detached",
        "yearBuilt": 1985,
        "numberOfBedrooms": 3,
        "rebuildValue": 250000
    },
    "cover": {
        "buildingsSum": 300000,
        "contentsSum": 50000,
        "personalPossessions": 5000,
        "voluntaryExcess": 250
    },
    "policyholder": {
        "dateOfBirth": "1978-06-22",
        "claimsHistory": 0,
        "yearsNoClaims": 5
    }
}

Sample response:

Copy
{
    "quoteReference": "ERGO-Q-2025-00123456",
    "status": "quoted",
    "premium": {
        "annual": 342.50,
        "monthly": 29.85,
        "tax": 40.10,
        "totalAnnual": 382.60,
        "currency": "GBP"
    },
    "breakdown": {
        "buildingsPremium": 215.00,
        "contentsPremium": 95.50,
        "personalPossessionsPremium": 32.00,
        "ncdDiscount": -55.00,
        "excessDiscount": -12.50
    },
    "excess": {
        "compulsory": 100,
        "voluntary": 250,
        "total": 350
    },
    "validUntil": "2025-01-22T23:59:59Z"
}

Error Codes

Code Description
200 Quote calculated successfully.
400 Bad Request - Invalid or missing fields in the request payload.
401 Unauthorized - Invalid API key or partner ID.
422 Unprocessable Entity - Risk declined (e.g., property not insurable).
500 Internal Server Error.