Monitoring Policy
List Policy Overview
Retrieves a paginated list of all policies. This endpoint supports filtering and pagination to help manage large numbers of policies effectively.
Endpoint: GET /policies
Headers:
x-tenant-id: Your tenant identifierAuthorization: Bearer token for authentication
Query Parameters:
page: Page number (zero-based)size: Number of items per pagestatus(optional): Filter by policy status (e.g., ACTIVE, CANCELED)from(optional): Filter policies starting from this date (ISO 8601 format)to(optional): Filter policies until this date (ISO 8601 format)
Example Request:
GET /policies?page=0&size=5 HTTP/1.1
Host: https://project1.riskwolf.com
Authorization: Bearer {your-token}
x-tenant-id: [Your-Tenant-ID]
Response:
{
"content": [
{
"id": "policy-id-1",
"status": "ACTIVE",
"inceptionDate": "2024-01-01",
"expiryDate": "2024-12-31",
"totalSumInsured": {
"amount": 1000,
"currency": "INR"
}
}
],
"totalElements": 1,
"totalPages": 1,
"size": 5,
"number": 0
}
List Index Definitions
Retrieves available index definitions that can be used for creating quotes. Index definitions specify the types of risks that can be insured.
Endpoint: GET /index-definitions
Headers:
x-tenant-id: Your tenant identifierAuthorization: Bearer token for authentication
Example Request:
GET /index-definitions HTTP/1.1
Host: https://project1.riskwolf.com
Authorization: Bearer {your-token}
x-tenant-id: [Your-Tenant-ID]
Response:
{
"content": [
{
"id": "index-def-1",
"name": "Rainfall Index",
"description": "Total rainfall over the period > Trigger",
"unit": "mm",
"type": "WEATHER"
},
{
"id": "index-def-2",
"name": "Wind Speed Index",
"description": "Maximum wind speed over trigger",
"unit": "km/h",
"type": "WEATHER"
}
]
}
Activate Policy
To activate a policy, apply the endpoint /policies/{policyId} using the PATCH method. This marks the policy as active.
Once a policy is active the automatic monitoring of triggers will start at the each cover's risk period start date.
Example Request:
PATCH /policies/policy-id-1 HTTP/1.1
Host: https://project1.riskwolf.com
x-tenant-id: [Your-Tenant-ID]
Example Response:
{
"expiryDate": "2025-11-30",
"externalRef": null,
"grossPremiumAmount": {
"amount": 528,
"currency": "INR"
},
"id": "0056c39d-1066-4e7f-8888-d437a09ac612",
"inceptionDate": "2024-12-01",
"lineItems": [
{
"coverages": [
{
"grossWrittenPremiumPct": 0.044,
"id": "6b8ecb89-de4c-4a98-9c1e-311d3d4a0c02",
"indexDefinition": {
"description": "Total rainfall over the period > Trigger",
"id": "00000000-0000-0000-0000-000000000011"
},
"monitoringTarget": {
"geometry": {
"type": "Point",
"coordinates": [
76.96348,
28.38254
]
},
"id": "ind__3__ind.12.5.1_1",
"name": "Gurgaon / Gurgaon"
},
"riskPeriodEnd": "2024-12-31",
"riskPeriodStart": "2024-12-01",
"triggerUnit": "mm",
"triggerValue": 70.0
},
{
"grossWrittenPremiumPct": 0.044,
"id": "fea756e2-f6f0-4800-aa41-02063fdd5f29",
"indexDefinition": {
"description": "Maximum wind speed is over the trigger",
"id": "00000000-0000-0000-0000-000000000201"
},
"monitoringTarget": {
"geometry": {
"type": "Point",
"coordinates": [
76.96348,
28.38254
]
},
"id": "ind__3__ind.12.5.1_1",
"name": "Gurgaon / Gurgaon"
},
"riskPeriodEnd": "2024-12-31",
"riskPeriodStart": "2024-12-31",
"triggerUnit": "km/h",
"triggerValue": 118.0
}
],
"id": "0d083500-8c28-4cc4-af6e-85111878f2ef",
"minPayout": {
"amount": 1000,
"currency": "INR"
},
"name": "01-12-2024 - 31-12-2024",
"payoutPerUnit": {
"amount": 0,
"currency": "INR"
},
"quantity": 1.0,
"sumInsured": {
"amount": 1000,
"currency": "INR"
},
"totalSumInsured": {
"amount": 1000,
"currency": "INR"
}
},
{
"coverages": [
{
"grossWrittenPremiumPct": 0.044,
"id": "2b8cac7f-97e9-436b-8f62-b13cdc985456",
"indexDefinition": {
"description": "Total rainfall over the period > Trigger",
"id": "00000000-0000-0000-0000-000000000011"
},
"monitoringTarget": {
"geometry": {
"type": "Point",
"coordinates": [
76.96348,
28.38254
]
},
"id": "ind__3__ind.12.5.1_1",
"name": "Gurgaon / Gurgaon"
},
"riskPeriodEnd": "2025-01-31",
"riskPeriodStart": "2025-01-01",
"triggerUnit": "mm",
"triggerValue": 110.0
},
{
"grossWrittenPremiumPct": 0.044,
"id": "f199223e-e469-43b1-9bad-ee61424d2333",
"indexDefinition": {
"description": "Maximum wind speed is over the trigger",
"id": "00000000-0000-0000-0000-000000000201"
},
"monitoringTarget": {
"geometry": {
"type": "Point",
"coordinates": [
76.96348,
28.38254
]
},
"id": "ind__3__ind.12.5.1_1",
"name": "Gurgaon / Gurgaon"
},
"riskPeriodEnd": "2025-01-30",
"riskPeriodStart": "2024-12-31",
"triggerUnit": "km/h",
"triggerValue": 118.0
}
],
"id": "1043af4f-38b8-460c-943f-1c80fb54b552",
"minPayout": {
"amount": 1000,
"currency": "INR"
},
"name": "01-01-2025 - 31-01-2025",
"payoutPerUnit": {
"amount": 0,
"currency": "INR"
},
"quantity": 1.0,
"sumInsured": {
"amount": 1000,
"currency": "INR"
},
"totalSumInsured": {
"amount": 1000,
"currency": "INR"
}
},
...
],
"name": "01-12-2024 - 30-11-2025",
"status": "ACCEPTED",
"totalSumInsured": {
"amount": 12000,
"currency": "INR"
}
}
## Cancel Policy
If you need to cancel an active policy, use the endpoint `/policies/{policyId}` with the `DELETE` method.
It will change state of the policy to `CANCELED` and included cover will not trigger afterwards.
**Example Request:**
```http
DELETE /policies/policy-id-1 HTTP/1.1
Host: https://project1.riskwolf.com
x-tenant-id: [Your-Tenant-ID]
Each of these endpoints requires authentication using a tenant ID in the header, ensuring authorized access to the Riskwolf API functionalities.
Adjust the quoteId and policyId in the paths accordingly based on the identifiers you receive from the API responses.