Subjects of Insurance

Subjects of Insurance refer to the specific assets or items associated with each Building to be insured. The endpoint will allow you to add the individual risk coverages and amounts for each Building.

The subject of insurance object

The Subject of Insurance objects represent the individual coverages and amounts to be insured on each Building. These objects are optional and a Building may have one or many Subjects of Insurance. They contain the following properties and relationships:

Properties

  • Name
    building
    Type
    string
    Filterable
    Description
    The UUID of the building this subject of insurance belongs to.
  • Name
    type
    Type
    enum
    Filterable
    Sortable
    Description
    • Name
      b
      Description
      Building
    • Name
      busee
      Description
      Business Income without Extra Expense
    • Name
      busin
      Description
      Business Income with Extra Expense
    • Name
      buser
      Description
      Business Income with Extra Expense and Rental Value
    • Name
      busrn
      Description
      Business Income with Rental Value without Extra Expense
    • Name
      bpp
      Description
      Business Personal Property
    • Name
      ee
      Description
      Extra Expense
    • Name
      ff
      Description
      Furniture and Fixtures
    • Name
      maceq
      Description
      Machinery and Equipment
    • Name
      pp
      Description
      Personal Property
    • Name
      potop
      Description
      Property of Others
    • Name
      stk
      Description
      Stock
    • Name
      other
      Description
      Used for any other type of subject of insurance; make sure to set `display_value` when using this type.
  • Name
    amount
    Type
    int
    Filterable
    Sortable
    Description
    The dollar amount of the subject of insurance, in cents.
  • Name
    display_value
    Type
    nullable string
    Filterable
    Sortable
    Description
    The custom display value when `type` is `other`.

Meta

Relations

Learn more about including relations.

GET/api/v1/risks/{risk}/data/subjects_of_insurance

List subjects of insurance

This endpoint allows you to retrieve a paginated list of subjects of insurance by building. By default, 50 subjects of insurance are provided per page.

Required parameters

  • Name
    filter[building]
    Type
    string|string[]
    Description

    The UUID(s) of the building to filter the subjects of insurance by. Multiple UUIDs can be specified either as a comma-separated list or as an array.

    This parameter is not required if a filter[search] parameter has been provided.

Optional parameters

See the subject of insurance model for a list of all available filters and sorts.

Searchable

You can search for subjects of insurance by providing a search query in the filter[search] parameter. The search query will be matched against a subject of insurance's type, or its building's number or description.

Request

GET
/api/v1/risks/{risk}/data/subjects_of_insurance
curl -X GET -G https://app.wunderite.com/api/v1/risks/{risk}/data/subjects_of_insurance?filter[building]=8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json"

Response

{ "data": [ { "object": "subject_of_insurance", "uuid": "512d413f-5229-429c-9140-1f4c817cfe7f", "data": { "building": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b", "type": "bpp", "amount": 35000000, "display_value": null
}, "meta": { "created": "2022-05-27T16:29:05+00:00", "updated": "2022-05-27T16:29:05+00:00" }, "relations": { "building": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b" } }, { "object": "subject_of_insurance", "uuid": "0116b882-12bb-45e7-8dc1-2505d4a5d46c", "data": { "building": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b", "type": "b", "amount": 57000000, "display_value": null }, "meta": { "created": "2022-05-27T16:29:05+00:00", "updated": "2022-05-27T16:29:05+00:00" }, "relations": { "building": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b" } } ], "path": "https:\/\/app.wunderite.com\/api\/v1\/risks\/66edc9e0-a056-4f22-bc47-06e81c997458\/data\/subjects_of_insurance", "per_page": 50, "next_cursor": null, "next_page_url": null, "prev_cursor": null, "prev_page_url": null }

POST/api/v1/risks/{risk}/data/subjects_of_insurance

Create subjects of insurance

This endpoint allows you to upload a new attachment to a conversation. See the code examples for how to send the file to the Protocol API.

Required attributes

  • Name
    building
    Type
    string
    Description

    The UUID of the building that the subject of insurance should be associated with.

  • Name
    type
    Type
    enum
    Description

    The type of the subject of insurance.

  • Name
    amount
    Type
    integer
    Description

    The amount of the subject of insurance, in cents.

Optional attributes

  • Name
    display_value
    Type
    string
    Description

    A human-readable display value for the subject of insurance, when type is other.

Request

POST
/api/v1/risks/{risk}/data/subjects_of_insurance
curl -X POST https://app.wunderite.com/api/v1/risks/{risk}/data/subjects_of_insurance \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
    {
        "object": "subject_of_insurance",
        "data": {
            "building": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b",
            "type": "b",
            "amount": 1000000
        }
    }
]
}'

Response

{ "data": [ { "object": "subject_of_insurance", "uuid": "73fe2d98-dc2d-4939-98d2-2f6a2093a19e", "data": { "building": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b", "type": "b", "amount": 1000000, "display_value": null
}, "meta": { "created": "2024-01-01T00:00:00+00:00", "updated": "2024-01-01T00:00:00+00:00" }, "relations": { "building": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b" } } ] }

PATCH/api/v1/risks/{risk}/data

Update subjects of insurance

This endpoint allows you to perform bulk updates on subjects of insurance.

At least one subject of insurance object must be provided in the request body. Each object must contain at least one property from the subject of insurance properties section.

Properties that are not provided will not be updated.

Notes

When providing a type property of other (see the type enum), the display_value property will default to Other if none is supplied.

Request

PATCH
/api/v1/risks/{risk}/data
curl -X PATCH https://app.wunderite.com/api/v1/risks/{risk}/data \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
    {
        "object": "subject_of_insurance",
        "uuid": "512d413f-5229-429c-9140-1f4c817cfe7f",
        "data": {
            "building": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b",
            "type": "bpp",
            "amount": 35000000,
            "display_value": null
        }
    }
]
}'

Response

{ "data": [ { "object": "subject_of_insurance", "uuid": "512d413f-5229-429c-9140-1f4c817cfe7f", "data": { "building": "8f2c9f0a-cd6a-4ea7-9ed3-b5d013d01c5b", "type": "bpp", "amount": 35000000, "display_value": null
}, "profile_type": "commercial" } ] }

DELETE/api/v1/risks/{risk}/data

Delete subjects of insurance

This endpoint allows you to bulk delete risk data, including subjects of insurance.

At least one subject of insurance object must be provided in the request body to delete the corresponding subject of insurance.

Required properties

  • Name
    object
    Type
    string
    Description

    The object type of the data to delete. Must be subject_of_insurance in this case.

  • Name
    uuid
    Type
    string
    Description

    The UUID of the subject of insurance to delete.

Request

DELETE
/api/v1/risks/{risk}/data
curl -X DELETE https://app.wunderite.com/api/v1/risks/{risk}/data \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
    {
        "object": "subject_of_insurance",
        "uuid": "512d413f-5229-429c-9140-1f4c817cfe7f"
    }
]
}'

Response

{
    "data": [
        {
            "object": "subject_of_insurance",
            "uuid": "512d413f-5229-429c-9140-1f4c817cfe7f",
            "profile_type": "commercial"
        }
    ]
}