Lexis Nexis Perils

Capability: Perils

Market: UK

Business Capabilities

Compute insurance perils scores based on property details. The service returns risk scores for multiple peril types, including flood, subsidence, crime, storm, and escape of water. Underwriters use these scores to price risk accurately at a property level.

Exposed Endpoints

  • Check perils: POST /api/axa/v1/perils/check - Computes peril risk scores for a given property based on its address and characteristics.

Vault Configuration

  • lexisNexisPerils.baseUrl - Base URL of the LexisNexis Perils API.
  • lexisNexisPerils.username - Username for API authentication.
  • lexisNexisPerils.password - Password for API authentication.
  • lexisNexisPerils.scid - Source client identifier.
  • lexisNexisPerils.header.x-api-key - API key sent in request headers.
  • lexisNexisPerils.header.x-partner-id - Partner identifier sent in request headers.
NOTE  
Find API request structures and samples for Lexis Nexis connector in the Community.

Request Structures and Samples

POST /api/axa/v1/perils/check

Request structure:

Copy
{
    "header": {
        "requestId": "string",
        "clientRef": "string"
    },
    "subject": {
        "address": {
            "buildingNumber": "string",
            "buildingName": "string",
            "streetName": "string",
            "city": "string",
            "postcode": "string"
        },
        "property": {
            "propertyType": "house" | "flat" | "bungalow" | "maisonette",
            "buildYear": number,
            "numberOfStoreys": number
        }
    }
}

Sample request:

Copy
{
    "header": {
        "requestId": "req-001-2025",
        "clientRef": "policy-app-12345"
    },
    "subject": {
        "address": {
            "buildingNumber": "15",
            "buildingName": "",
            "streetName": "Riverside Drive",
            "city": "Oxford",
            "postcode": "OX1 4TH"
        },
        "property": {
            "propertyType": "house",
            "buildYear": 1992,
            "numberOfStoreys": 2
        }
    }
}

Sample response:

Copy
{
    "header": {
        "requestId": "req-001-2025",
        "status": "success"
    },
    "strategyOutput": {
        "overallRisk": "medium",
        "perils": [
            {
                "perilType": "flood",
                "riskScore": 6,
                "riskBand": "medium",
                "floodZone": "Zone 2",
                "riverDistance": 450,
                "historicalClaims": 2
            },
            {
                "perilType": "subsidence",
                "riskScore": 3,
                "riskBand": "low",
                "soilType": "clay",
                "treeProximity": "none"
            },
            {
                "perilType": "crime",
                "riskScore": 4,
                "riskBand": "low",
                "crimeRate": "below-average",
                "burglaryIndex": 72
            },
            {
                "perilType": "storm",
                "riskScore": 5,
                "riskBand": "medium",
                "exposureLevel": "moderate",
                "windSpeedFactor": 1.2
            },
            {
                "perilType": "escapeOfWater",
                "riskScore": 4,
                "riskBand": "low",
                "pipeworkAge": "modern",
                "claimsFrequency": "low"
            }
        ],
        "recommendations": [
            "Consider flood excess endorsement",
            "Standard terms apply for subsidence"
        ]
    }
}

Error Codes

Code Description
200 Perils check completed successfully.
400 Validation Error - Missing or invalid address/property fields.
401 Unauthorized - Invalid credentials or API key.
404 Not Found - Address could not be resolved to a property.
500 Internal Server Error.