Risk item creation examples

Risk item for cargo insurance

In this example, we will create a risk item for a cargo insured against damage and/or theft.

/risk-items body payload:

{
  "package_uid": "TRANSPORTE_PRIVADO",
  "policy_uid": "12345678",
  "start_date": "2024-03-15T00:00:00.000Z",
  "end_date": "2024-03-31T23:59:59.999Z",
  "insured_subject": {
    "identifier_type": "Guide Number",
    "identifier_value": "GN789",
    "group_uid": "yourUID01",
    "group_name": "Ecuador Transport",
    "business_industry": "Consumo Masivo",
    "subject_type": "cargo",
    "invoice_count": 10,
    "total_insured_value": 75000.00,
    "guide_number": "GN789",
    "departure_city": "Guayaquil",
    "destination_city": "Quito",
    "departure_date": "2024-01-24T09:00:00Z",
    "plate_number": "PICH1234",
    "primary_category": "Men's Apparel",
    "content_category": "Clothing",
    "policy_observations": "Fragile items inside",
    "policy_note": "Insured against theft and damage",
    "driver_full_name": "Luis Andrade",
    "driver_id": "1714486642",
    "departure_coords": "-2.170998, -79.922359",
    "ruc": "1711186642001"
  },
  "uid": "YOURUID"
  "beneficiaries": [
    {
      "email": "[email protected]",
      "group_uid": "yourUID01",
      "name": "Ana Torres",
      "phone": "593999002825"
    }
  ],
  "authorized_claimants": [
    {
      "email": "[email protected]",
      "name": "Lucia Martinez",
      "phone": "593999002823"
    },
    {
    "email": "[email protected]",
    "name": "Marco Reyes",
    "phone": "593999002824"
    }
  ],
  "metadata": {
    "delivery_stops": {
      "Delivery 1": {
        "destination_invoice_id": "INV1001",
        "final_coords": "-0.180653, -78.467838",
        "items": [
          {
            "item_name": "Laptop",
            "item_sku": "LAP1234A",
            "item_quantity": 10,
            "item_cost": 1200,
            "item_expiry": "2024-12-31"
          }
        ]
      }
    }
  }
}

Risk item for a personal accident insurance

In this example, we will create a risk item for personal accident coverage for an insured subject.

/risk-items body payload:

/risk-items body payload:
{
  "package_uid": "ACCIDENTESPERSONALES",
  "policy_uid": "12345678",
  "start_date": "2024-03-15T00:00:00.000Z",
  "end_date": "2024-03-31T23:59:59.999Z",
  "insured_subject": {
    "group_uid": "yourUID01",
    "subject_type": "ID",
    "identifier_value": "17115426421",
    "identifier_type": "National ID",
    "name": "Pedro",
    "last_name": "Ramirez",
    "phone": "Pedro",
    "email": "[email protected]",
    "gender": "male",
    "dob": "2024-02-06 05:00:00+00"
  },
  "beneficiaries": [
    {
      "email": "[email protected]",
      "group_uid": "yourUID01",
      "name": "Ana Torres",
      "phone": "593999002825"
    }
  ],
  "authorized_claimants": [
    {
      "email": "[email protected]",
      "name": "Lucia Martinez",
      "phone": "593999002823"
    },
    {
    "email": "[email protected]",
    "name": "Marco Reyes",
    "phone": "593999002824"
    }
  ],
  "metadata": {}
}

A risk item will be returned if the endpoint call succeeds.

Risk item even example

In this example, we will create an event.

/risk-items/:riskItemId/events body payload:

{
    "event_data": {
        "start_date": "2024-03-15T00:00:00.000Z",
        "end_date": "2024-06-15T00:00:00.000Z",
        "coordinates": "40.7128, -74.0060" // Optional
    },
    "metadata": {
        "description": "Event description"
    }
}