Additional Interests

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

The Additional Interest object

Additional Interest objects represent a single additional interest in a commercial or personal risk profile. They contain the following properties and relationships:

Global Properties

These properties are available for all risk profile types.

Name
description
Type
nullable string
Sortable
Description
The description of the additional interest
Name
name
Type
nullable string
Sortable
Description
The name of the additional interest
Name
website
Type
nullable string
Description
The website of the additional interest
Name
interest_type
Type
nullable enum
Filterable
Sortable
Description
The type of additional interest
Name
Named Insured
Description
Named Insured
Name
Certificate Holder
Description
Certificate Holder
Name
Lienholder
Description
Lienholder
Name
Loss Payee
Description
Loss Payee
Name
Additional Insured
Description
Additional Insured
Name
Mortgagee
Description
Mortgagee
Name
Lender's Loss Payee
Description
Lender's Loss Payee
Name
Breach of Warranty
Description
Breach of Warranty
Name
Co-Owner
Description
Co-Owner
Name
Employee as Lessor
Description
Employee as Lessor
Name
Leaseback Owner
Description
Leaseback Owner
Name
Owner
Description
Owner
Name
Registrant
Description
Registrant
Name
Trustee
Description
Trustee
Name
Other
Description
Other
Name
notes
Type
nullable string
Description
Any notes associated with the additional interest

Global Relations

Learn more about including relations.

Name
address
Type
Address
Filterable
Sortable
Name
attachments
Type
Attachment[]
Name
attachments.uploader
Type
User
Description
The user who uploaded the attachment

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

List all additional interests

This endpoint allows you to retrieve a paginated list of all additional interests in the corresponding risk profile.

Each additional interest is returned as an additional interest, corresponding with the risk profile type.

Parameters

See the additional interest object for a list of all available filters and sorts.

Searchable

You can search for additional interests by providing a search query in the filter[search] parameter. The search query will be matched against the additional interest's name, description, and address.

Request

GET

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

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

Response

{
    "data": [
        {
            "object": "additional_interest",
            "uuid": "1eaf59b3-04d5-49cf-b1e6-f029d7585dab",
            "data": {
                "description": "Acme Ventures is a venture capital firm specializing in early-stage investments in technology startups. With a focus on disruptive innovations, Acme Ventures provides funding and strategic support to entrepreneurs aiming to transform industries.",
                "name": "Acme Ventures",
                "notes": null,
                "website": "https:\/\/www.acmeventures.com",
                "interest_type": "Loss Payee"
            },
            "meta": {
                "created": "2024-04-18T20:24:11+00:00",
                "updated": "2024-04-18T20:24:11+00:00"
            },
            "relations": {
                "address": "58b1bf81-2685-4e72-8b1d-2e5823854800"
            }
        },
        {
            "object": "additional_interest",
            "uuid": "b26855ee-0433-4920-993d-3eac9bfbc986",
            "data": {
                "description": null,
                "name": "Venture Capital Partners",
                "notes": null,
                "website": "https:\/\/www.venturecapitalpartners.com",
                "interest_type": null
            },
            "meta": {
                "created": "2024-04-18T20:34:48+00:00",
                "updated": "2024-04-18T20:34:48+00:00"
            },
            "relations": {
                "address": "da96f65d-22f3-4209-a73e-bace54ac8b10"
            }
        }
    ],
    "path": "https:\/\/app.wunderite.com\/api\/v1\/risks\/d10e34bb-4420-47de-ba9f-42a4a3f34b0e\/data\/additional_interests",
    "per_page": 50,
    "next_cursor": null,
    "next_page_url": null,
    "prev_cursor": null,
    "prev_page_url": null
}

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

Create additional interests

This endpoint allows you to create new additional interests in the corresponding commercial risk profile.

Required properties

Name
name
Type
string
Description
The additional interest name

Optional properties

See all available properties in the additional interest properties section.

Name
description
Type
nullable string
Description
The additional interest description
Name
interest_type
Type
nullable enum
Description
The interest type name

Request

POST

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

curl -X POST "https://app.wunderite.com/api/v1/risks/{risk}/data/additional_interests" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \ 
-d '{
"data": [
    {
        "object": "additional_interest",
        "data": {
            "description": "An additional interest",
            "name": "Example Additional Interest",
            "notes": "Some additional notes",
            "website": "https:\/\/wunderite.com",
            "interest_type": "Lienholder"
        }
    }
]
}'

Response

{
    "data": [
        {
            "object": "additional_interest",
            "uuid": "083c22c5-b5df-43e1-b7d1-2a400e61df07",
            "data": {
                "description": "An additional interest",
                "name": "Example Additional Interest",
                "notes": "Some additional notes",
                "website": "https:\/\/wunderite.com",
                "interest_type": "Lienholder"
            },
            "meta": {
                "created": "2024-01-01T00:00:00+00:00",
                "updated": "2024-01-01T00:00:00+00:00"
            },
            "relations": {
                "address": null
            }
        }
    ]
}

Request with sub resources

POST

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

curl -X POST "https://app.wunderite.com/api/v1/risks/{risk}/data/additional_interests?include=address" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \ 
-d '{
"data": [
    {
        "object": "additional_interest",
        "data": {
            "description": "An additional interest",
            "name": "Example Additional Interest",
            "notes": "Some additional notes",
            "website": "https:\/\/wunderite.com",
            "interest_type": "Lienholder",
            "address": {
                "object": "address",
                "data": {
                    "address": "123 Main St",
                    "city": "Boston",
                    "state": "MA",
                    "zip": "02108"
                }
            }
        }
    }
]
}'

Response

{
    "data": [
        {
            "object": "additional_interest",
            "uuid": "a9ab90f5-bc8d-472b-a8dc-41f415c13a34",
            "data": {
                "description": "An additional interest",
                "name": "Example Additional Interest",
                "notes": "Some additional notes",
                "website": "https:\/\/wunderite.com",
                "interest_type": "Lienholder"
            },
            "meta": {
                "created": "2024-01-01T00:00:00+00:00",
                "updated": "2024-01-01T00:00:00+00:00"
            },
            "relations": {
                "address": {
                    "object": "address",
                    "uuid": "c3ad86ca-7522-42c5-97f6-94f00671c08b",
                    "data": {
                        "address": "123 Main St",
                        "address2": null,
                        "city": "Boston",
                        "state": "MA",
                        "zip": "02108",
                        "county": null,
                        "lat": null,
                        "lng": null
                    },
                    "meta": {
                        "created": "2024-01-01T00:00:00+00:00",
                        "updated": "2024-01-01T00:00:00+00:00"
                    }
                }
            }
        }
    ]
}

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

Update additional interests

This endpoint allows you to perform bulk updates on additional interests.

At least one additional interest object must be provided in the request body. Each object must contain at least one property from the additional interest properties section.

Properties that are not provided will not be updated.

To clear a nullable property, provide a null value.

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" \
-H "Content-Type: application/json" \ 
-d '{
"data": [
    {
        "object": "additional_interest",
        "uuid": "b26855ee-0433-4920-993d-3eac9bfbc986",
        "data": {
            "description": null,
            "name": "Venture Capital Partners",
            "notes": null,
            "website": "https:\/\/www.venturecapitalpartners.com",
            "interest_type": null
        }
    }
]
}'

Response

{
    "data": [
        {
            "object": "additional_interest",
            "uuid": "b26855ee-0433-4920-993d-3eac9bfbc986",
            "data": {
                "description": null,
                "name": "Venture Capital Partners",
                "notes": null,
                "website": "https:\/\/www.venturecapitalpartners.com",
                "interest_type": null
            },
            "profile_type": "commercial"
        }
    ]
}

Request with sub resources

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" \
-H "Content-Type: application/json" \ 
-d '{
"data": [
    {
        "object": "additional_interest",
        "uuid": "b26855ee-0433-4920-993d-3eac9bfbc986",
        "data": {
            "description": null,
            "name": "Venture Capital Partners",
            "notes": null,
            "website": "https:\/\/www.venturecapitalpartners.com",
            "interest_type": null,
            "address": {
                "object": "address",
                "data": {
                    "address": "785 Tech Plaza",
                    "address2": null,
                    "city": "Palo Alto",
                    "state": "CA",
                    "zip": "94301",
                    "county": "Santa Clara",
                    "lat": null,
                    "lng": null
                }
            }
        }
    }
]
}'

Response

{
    "data": [
        {
            "object": "additional_interest",
            "uuid": "b26855ee-0433-4920-993d-3eac9bfbc986",
            "data": {
                "description": null,
                "name": "Venture Capital Partners",
                "notes": null,
                "website": "https:\/\/www.venturecapitalpartners.com",
                "interest_type": null,
                "address": {
                    "object": "address",
                    "data": {
                        "address": "785 Tech Plaza",
                        "address2": null,
                        "city": "Palo Alto",
                        "state": "CA",
                        "zip": "94301",
                        "county": "Santa Clara",
                        "lat": null,
                        "lng": null
                    }
                }
            },
            "profile_type": "commercial"
        }
    ]
}

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

Delete additional interests

This endpoint allows you to bulk delete risk data, including additional interests.

At least one additional interest object must be provided in the request body to delete the corresponding additional interest.

Required properties

Name
object
Type
string
Description
The object type of the data to delete. Must be additional_interest in this case
Name
uuid
Type
string
Description
The UUID of the additional interest 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" \
-H "Content-Type: application/json" \ 
-d '{
"data": [
    {
        "object": "additional_interest",
        "uuid": "b26855ee-0433-4920-993d-3eac9bfbc986"
    }
]
}'

Response

{
    "data": [
        {
            "object": "additional_interest",
            "uuid": "b26855ee-0433-4920-993d-3eac9bfbc986",
            "profile_type": "commercial"
        }
    ]
}

Additional Interests

The Additional Interest object

Global Properties

Possible enum values

Global Relations

List all additional interests

Parameters

Searchable

Request

Response

Create additional interests

Required properties

Optional properties

Possible enum values

Request

Response

Request with sub resources

Response

Update additional interests

Request

Response

Request with sub resources

Response

Delete additional interests

Required properties

Request

Response