Workers' Comp

Workers' compensation exposures are the business classifications and related details used to calculate the premiums for specific policy coverages.

On this page, we'll dive into the different workers' compensation exposure endpoints you can use to manage them programmatically.

The Workers' Comp object

A workers' compensation exposure object contains the following properties:

Commercial-only Properties

These properties are available only for commercial risk profiles.

Name
premise
Type
nullable string
Filterable
Description
The UUID of the premise associated with the workers' compensation exposure
Name
state
Type
string
Filterable
Sortable
Description
The U.S. state in which the workers' compensation exposure is located
Name
class_code
Type
string
Filterable
Description
The UUID of the workers' compensation class code. Check the compensation class codes list API for available codes.
Name
projected_payroll
Type
int
Filterable
Sortable
Description
The projected payroll for the workers' compensation exposure
Name
notes
Type
nullable string
Description
Any notes associated with the workers' compensation exposure

Commercial-only Relations

Learn more about including relations.

Name
attachments
Type
Attachment[]
Name
attachments.uploader
Type
User
Description
The user who uploaded the attachment
Name
class_code
Type
Workers Comp Code
Filterable
Name
premise
Type
Premise
Filterable

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

List workers' comp

This endpoint allows you to retrieve a paginated list of workers' compensation exposures.

Each exposure is returned as a workers' comp object.

Parameters

See the workers' comp object for a list of all available filters and sorts.

Additional filters

Name
class_code.code
Type
string
Filterable
Description
Filter exposures by their class code's numeric code
Name
class_code.description
Type
string
Filterable
Description
Filter exposures by their class code's description

Searchable

You can search for workers' compensation exposures by providing a search query in the filter[search] parameter. The search query will be matched against an exposure's state, its class code's numeric code or description, or its premise description or address.

Request

GET

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

curl -G https://app.wunderite.com/api/v1/risks/{risk}/data/workers_comp \
-H "Authorization: Bearer {token}" \
-d "filter[code]=0050" \
-d per_page=50

Response

{
    "data": [
        {
            "object": "workers_comp",
            "uuid": "103a08e1-9130-4630-b1fb-904719e8a374",
            "data": {
                "premise": null,
                "state": "CA",
                "class_code": "8d9af343-f2d1-11ef-a445-0242c0a87503",
                "projected_payroll": 1580896,
                "notes": null
            },
            "meta": {
                "created": "2024-04-23T18:22:32+00:00",
                "updated": "2025-02-04T15:39:29+00:00"
            },
            "relations": {
                "premise": null,
                "class_code": "8d9af343-f2d1-11ef-a445-0242c0a87503"
            }
        },
        {
            "object": "workers_comp",
            "uuid": "90bee6c5-23ed-46e2-ab61-04f629d7d023",
            "data": {
                "premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8",
                "state": "CA",
                "class_code": "8d9adc2d-f2d1-11ef-a445-0242c0a87503",
                "projected_payroll": 1270987,
                "notes": null
            },
            "meta": {
                "created": "2024-04-23T18:22:32+00:00",
                "updated": "2024-04-23T18:22:32+00:00"
            },
            "relations": {
                "premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8",
                "class_code": "8d9adc2d-f2d1-11ef-a445-0242c0a87503"
            }
        }
    ],
    "path": "https:\/\/app.wunderite.com\/api\/v1\/risks\/d10e34bb-4420-47de-ba9f-42a4a3f34b0e\/data\/workers_comp",
    "per_page": 50,
    "next_cursor": null,
    "next_page_url": null,
    "prev_cursor": null,
    "prev_page_url": null
}

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

Create workers' comp

This endpoint allows you to create new workers' compensation exposures in the corresponding commercial risk profile.

At least one workers' comp object must be provided in the request body.

Required properties

See all available properties in the properties section.

Name
state
Type
string
Description
The U.S. state (abbreviation) in which the workers' compensation exposure is located
Name
class_code
Type
string
Description
A class code UUID from the workers' comp class codes endpoint.
The class_code used must be in the same state as the workers' compensation exposure. Some class codes are available in all states, and some are state-specific.
Name
projected_payroll
Type
number
Description
The total annual payroll for the workers' compensation exposure

Request

POST

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

curl -X POST "https://app.wunderite.com/api/v1/risks/{risk}/data/workers_comp" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d '{
"data": [
    {
        "object": "workers_comp",
        "data": {
            "premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8",
            "state": "MA",
            "class_code": "8d7527e9-f2d1-11ef-a445-0242c0a87503",
            "projected_payroll": 100000,
            "notes": "Some notes"
        }
    }
]
}'

Response

{
    "data": [
        {
            "object": "workers_comp",
            "uuid": "945879c6-24fd-4f24-ba61-fbdccc526495",
            "data": {
                "premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8",
                "state": "MA",
                "class_code": "8d7527e9-f2d1-11ef-a445-0242c0a87503",
                "projected_payroll": 100000,
                "notes": "Some notes"
            },
            "meta": {
                "created": "2024-01-01T00:00:00+00:00",
                "updated": "2024-01-01T00:00:00+00:00"
            },
            "relations": {
                "premise": "a27deef4-2f2a-47c1-a49b-37e52054e5f8",
                "class_code": "8d7527e9-f2d1-11ef-a445-0242c0a87503"
            }
        }
    ]
}

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

Update workers' comp

This endpoint allows you to perform bulk updates on workers' compensation exposures.

At least one workers' comp object must be provided in the request body. Each object must contain at least one property from the workers' comp properties section.

Properties that are not provided will not be updated.

To clear a nullable property, provide a null value.

The class_code used must be in the same state as the workers' compensation exposure. Some class codes are available in all states, and some are state-specific. See the workers' comp class codes endpoint for more information.

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": "workers_comp",
        "uuid": "103a08e1-9130-4630-b1fb-904719e8a374",
        "data": {
            "premise": null,
            "state": "CA",
            "class_code": "8d7527e9-f2d1-11ef-a445-0242c0a87503",
            "projected_payroll": 1580896,
            "notes": null
        }
    }
]
}'

Response

{
    "data": [
        {
            "object": "workers_comp",
            "uuid": "103a08e1-9130-4630-b1fb-904719e8a374",
            "data": {
                "premise": null,
                "state": "CA",
                "class_code": "8d7527e9-f2d1-11ef-a445-0242c0a87503",
                "projected_payroll": 1580896,
                "notes": null
            },
            "profile_type": "commercial"
        }
    ]
}

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

Delete workers' comp

This endpoint allows you to bulk delete risk data, including workers' compensation exposures.

At least one workers' comp object must be provided in the request body to delete the corresponding exposure.

Required properties

Name
object
Type
string
Description
The object type of the data to delete. Must be workers_comp in this case.
Name
uuid
Type
string
Description
The UUID of the workers' compensation exposure 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": "workers_comp",
        "uuid": "103a08e1-9130-4630-b1fb-904719e8a374"
    }
]
}'

Response

{
    "data": [
        {
            "object": "workers_comp",
            "uuid": "103a08e1-9130-4630-b1fb-904719e8a374",
            "profile_type": "commercial"
        }
    ]
}