Introduction

This quick start guide introduces Location Risk Intelligence (LRI) API and describes how to use it.

Tip: If you have any API onboarding-related questions, view API - General topics FAQ. If you have any API security-related questions, refer to API - Security topics FAQ.

Use cases

LRI API allows to integrate LRI functionalities into customers' own applications and business processes. The primary use cases are the following:

1. Scoring of locations (single locations and portfolios). The customer sends the location (entering its address or geospatial coordinates), and the API delivers the enrichment results like natural hazard scores, climate change data, and others.
2. Scoring of areas and lines. The customer sends a certain area or line object, and the API delivers percentage distribution for this object: natural hazards, climate indices, and others.
3. Map services. LRI map layers are embedded into the customer's mapping application.

Step-by-step guides

Request the API

1. Contact our sales representative with a corresponding request.
2. Our representatives will conduct a kick-off meeting, show how the API works, provide samples, discuss technical implementation, and clarify open questions.

API onboarding

1. We invite the customer's technical representative to the MR developer portal.
2. On the developer portal, the customer creates a subscription.
3. We provide the customer with:
    
   • API account for production use (and for testing, if applicable).
   • All the required documentation:
     • Technical API specification.
     • Data documentation (what kind of data is available).
     • OpenAPI specification (used to generate API client code).
     • Postman collection of sample requests tailored to the customer's use case.

API technical specification

The technical documentation is attached to this article as a PDF file. You can download it at any time.