Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Fetch Risk items

Endpoints

Method
Endpoint

GET

https://app.insurehero.io/api/shield/integrations/v1/risk-items/:riskItemId

GET

https://app.insurehero.io/api/shield/integrations/v1/risk-items

How to get the data

Get the data of a given Risk Item

GET https://app.insurehero.io/api/shield/integrations/v1/risk-items/:riskItemId

Headers

Name
Type
Description

Authorization*

string

Bearer access token

Path Parameters

Name
Type
Description

riskItemId*

string

Risk item identifier

Example response

{
    "data": {
        "id": "943511e3-de9a-4afb-a126-b434ebd1f84e",
        "authorized_claimants": [
            {
                "email": "luciamartinez@example.com",
                "name": "Lucia Martinez",
                "phone": "593999002823"
            },
            {
                "email": "marcoreyes@example.com",
                "name": "Marco Reyes",
                "phone": "593999002824"
            }
        ],
        "package_id": "12e02904-0ab6-41e5-a66f-14fe5d981960",
        "start_date": "2024-03-15T00:00:00+00:00",
        "end_date": "2024-03-31T23:59:59.999+00:00",
        "beneficiaries": [
            {
                "email": "anatorres@example.com",
                "phone": "593999002825"
            }
        ],
        "insured_subject": {
            "identifier_value": "GN789",
            "identifier_type": "Guide Number",
            "ruc": "1711186642001",
            "driver_id": "1714486642",
            "group_uid": "yourUID01",
            "group_name": "Ecuador Transport",
            "policy_note": "Insured against theft and damage",
            "guide_number": "GN789",
            "plate_number": "PICH1234",
            "subject_type": "cargo",
            "invoice_count": 10,
            "departure_city": "Guayaquil",
            "departure_date": "2024-01-24T09:00:00Z",
            "content_category": "Clothing",
            "departure_coords": "-2.170998, -79.922359",
            "destination_city": "Quito",
            "driver_full_name": "Luis Andrade",
            "primary_category": "Men's Apparel",
            "business_industry": "Consumo Masivo",
            "policy_observations": "Fragile items inside",
            "total_insured_value": 75000
        },
        "status": "ACTIVE",
        "uid": null,
        "assets": [],
        "metadata": {
            "delivery_stops": {
                "Delivery 1": {
                    "items": [
                        {
                            "item_sku": "LAP1234A",
                            "item_cost": 1200,
                            "item_name": "Laptop",
                            "item_expiry": "2024-12-31",
                            "item_quantity": 10
                        }
                    ],
                    "final_coords": "-0.180653, -78.467838",
                    "destination_invoice_id": "INV1001"
                }
            }
        },
        "policy_id": "c42a9583-9a58-4b0c-b332-21499780a35b"
    }
}

Get all Risk Items

Paginated list of all risk items. Page size cannot exceed 100 records at a time.

GET https://app.insurehero.io/api/shield/integrations/v1/risk-items

Headers

Name
Type
Description

Authorization*

string

Bearer access token

Query Parameters

Name
Type
Description

from*

string

Starting record index

to*

string

Ending record index

Example response

Additional Attributes

Risk Item Details

Name
Type
Description

id

string

Unique identifier for the risk item.

authorized_claimants

object []

List of people authorized to make claims related to this risk item.

package_id

string

Identifier of the associated package.

start_date

string

Date when the coverage starts.

end_date

string

Date when the coverage ends.

beneficiaries

object[]

List of beneficiaries covered by the insurance.

insured_subject

object

Information about the insured cargo or item.

status

string

Current status of the risk item.

uid

string

Unique identifier assigned to the risk item.

assets

object[]

Additional assets related to the risk item.

metadata

object

Additional metadata including delivery stops.

policy_id

string

Identifier of the associated policy.

Insured Subject Details

Name
Type
Description

identifier_value

string

Unique identifier for the insured subject.

identifier_type

string

Type of identifier.

ruc

string

RUC number of the insured company.

driver_id

string

Identifier of the driver responsible for transport.

group_uid

string

Group unique identifier.

group_name

string

Name of the insured group.

policy_note

string

Special notes related to the policy.

guide_number

string

Reference guide number.

plate_number

string

License plate number of the insured vehicle.

subject_type

string

Type of insured subject.

invoice_count

number

Number of invoices related to this risk item.

departure_city

string

City of departure for the insured item.

departure_date

string

Date and time of departure.

content_category

string

Category of the insured content.

departure_coords

string

GPS coordinates of the departure location.

destination_city

string

City of destination for the insured item.

driver_full_name

string

Full name of the responsible driver.

primary_category

string

Primary category of the insured item.

business_industry

string

Industry sector related to the insured subject.

policy_observations

string

Additional observations about the policy.

total_insured_value

number

Total insured value of the risk item.

Metadata - Delivery Stops

Name
Type
Description

delivery_stops

object

Information about the delivery stops.

final_coords

string

GPS coordinates of the final delivery destination.

destination_invoice_id

string

Invoice ID related to the delivery stop.

Delivery Items

Name
Type
Description

item_sku

string

Stock Keeping Unit (SKU) identifier of the item.

item_cost

number

Cost of the item.

item_name

string

Name of the item.

item_expiry

string

Expiration date of the item.

item_quantity

number

Quantity of items being delivered.

To access these resources, please remember to visit the Links and Resources section of the documentation.

PreviousWebhooks configurationNextFetch Claims

Last updated