Policy management
Get the data of all the policies
GET https://app.insurehero.io/api/shield/v1/policies
Headers
Query Params
Get the data of all the packages
GET https://app.insurehero.io/api/shield/v1/packages
Headers
Get the data of a variant
GET https://app.insurehero.io/api/shield/v1/variants/:variantId
Headers
Path Parameters
{
"data": {
"id": "12345678-90ab-cdef-1234-567890abcdef",
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2024-01-01T01:00:00.000Z",
"coverage_limits": 1000000,
"deductible": null,
"description": "Sample description for Insurance Plan.",
"name": "Sample Insurance Plan",
"gross_price": "5000",
"taxes": [
{
"name": "Sample Tax",
"value": "10"
}
],
"pricing_rules": {
"net_price": null
},
"pricing_type": "one_time",
"subject_schema": {
"sample_boolean_field": {
"type": "boolean",
"value": false,
"required": true
}
},
"deleted_at": null,
"conditions": "Sample conditions for Insurance Plan.",
"exclusions": "Sample exclusions for Insurance Plan.",
"markup": [
{
"owner": "platform",
"taxes": [
{
"name": "Coverage Tax",
"value": "15"
}
],
"net_price": null,
"gross_price": "290"
}
],
"channel_id": "34567890-1bcd-ef12-3456-7890abcdef12",
"coverage_id": "23456789-0abc-def1-2345-67890abcdef1",
"claim_schema": {
"sample_boolean_field": {
"type": "boolean",
"value": false,
"required": true
}
},
"uid": "5"
}
}
Get the data of all the variants
GET https://app.insurehero.io/api/shield/v1/variants
Headers
Query Params
{
"data": [
{
"id": "12345678-90ab-cdef-1234-567890abcdef",
"name": "Sample Insurance Plan A",
"description": "This is a sample description for Insurance Plan A.",
"coverage_id": "23456789-0abc-def1-2345-67890abcdef1",
"channel_id": "34567890-1bcd-ef12-3456-7890abcdef12",
"pricing_type": "one_time",
"conditions": "Sample conditions for Insurance Plan A.",
"exclusions": "Sample exclusions for Insurance Plan A.",
"subject_schema": {
"sample_boolean_field": {
"type": "boolean",
"value": false,
"required": true
}
},
"claim_schema": {
"sample_boolean_field": {
"type": "boolean",
"value": false,
"required": true
}
},
"uid": "5"
},
{
"id": "abcdef12-3456-7890-abcd-ef1234567890",
"name": "Sample Insurance Plan B",
"description": "This is a sample description for Insurance Plan B.",
"coverage_id": "bcdef123-4567-890a-bcde-f1234567890a",
"channel_id": "cdef1234-5678-90ab-cdef-1234567890ab",
"pricing_type": "one_time",
"conditions": "Sample conditions for Insurance Plan B.",
"exclusions": "Sample exclusions for Insurance Plan B.",
"subject_schema": {
"sample_boolean_field": {
"type": "boolean",
"value": false,
"required": true
}
},
"claim_schema": {
"sample_boolean_field": {
"type": "boolean",
"value": false,
"required": true
}
},
"uid": "6"
}
]
}
Get the data of a coverage
GET https://app.insurehero.io/api/shield/v1/coverages/:coverageId
Headers
Path Parameters
Query Params
{
"data": {
"id": "12345678-90ab-cdef-1234-567890abcdef",
"channel_id": "fc94d4a1-f834-481d-a6b2-138b823389c8",
"name": "Sample Property Insurance",
"type": "Property Insurance",
"description": "Sample description for Property Insurance",
"insurer_coverage_number": "ABC123",
"insurer_id": "98765432-10ab-cdef-9876-543210abcdef",
"country_id": "87654321-bcde-fghi-8765-432109876543",
"uid": "COVERAGEUID"
}
}
Get the data of all the coverages
GET https://app.insurehero.io/api/shield/v1/coverages
Headers
Query Params
{
"data": [
{
"id": "12345678-90ab-cdef-1234-567890abcdef",
"channel_id": "fc94d4a1-f834-481d-a6b2-138b823389c8",
"name": "Sample Property Insurance",
"type": "Property Insurance",
"description": "Sample description for Property Insurance",
"insurer_coverage_number": "ABC123",
"insurer_id": "98765432-10ab-cdef-9876-543210abcdef",
"country_id": "87654321-bcde-fghi-8765-432109876543",
"uid": "COVERAGEUID"
},
{
"id": "87654321-bcde-fghi-8765-432109876543",
"channel_id": "fc94d4a1-f834-481d-a6b2-138b823389c8",
"name": "Sample Auto Insurance",
"type": "Auto Insurance",
"description": "Sample description for Auto Insurance",
"insurer_coverage_number": "AUTO567",
"insurer_id": "12345678-90ab-cdef-1234-567890abcdef",
"country_id": "87654321-bcde-fghi-8765-432109876543",
"uid": "COVERAGEUID"
}
]
}
Last updated