Risk Profiles
Risk profiles are representative of a commercial business entity or account, or a personal insured account. Risk profiles group data and properties together. A risk profile can either be commercial or personal.
The Risk Profile object
Risk profile objects represent a single commercial or personal risk profile. They contain the following properties and relationships:
Global Properties
These properties are available for all risk profile types.- Name
name- Type
- string
- Filterable
- Sortable
- Description
The name of the risk profile i.e. the insured's business or account name
- Name
segment- Type
- string
- Filterable
- Description
The segment UUID that the risk profile belongs to
- Name
phone- Type
- nullable string
- Filterable
- Description
The main insured or business 7 or 10-digit phone number for the risk profile
- Name
phone_ext- Type
- nullable string
- Description
The phone extension for the risk profile phone number
- Name
image- Type
- nullable string
- Description
When uploaded through Wunderite's UI, the URL of the risk profile image e.g. business logo or insured photo. This can't be an external URL.
Commercial-only Properties
These properties are available only for commercial risk profiles.- Name
website- Type
- nullable string
- Description
The website URL associated with the commercial risk profile. e.g. business or account website.
- Name
fax- Type
- nullable string
- Description
The 7 or 10-digit main fax number associated with the commercial risk profile
- Name
sic_code- Type
- nullable string
- Filterable
- Description
The Standard Industrial Classification (SIC) code representing the primary business activity of the commercial risk profile
- Name
naics_code- Type
- nullable string
- Filterable
- Description
The North American Industry Classification System (NAICS) code representing the primary business activity of the commercial risk profile
- Name
description_of_operations- Type
- nullable string
- Description
A detailed description of the operations and activities of the commercial risk profile. i.e. what does the business do (facts)
- Name
executive_summary- Type
- nullable string
- Description
A brief executive summary providing an overview of the commercial risk profile. i.e. why is the business a good risk (story)
Personal-only Properties
These properties are available only for personal risk profiles.- Name
email- Type
- nullable string
- Filterable
- Description
The primary insured email address for the personal risk profile
Global Relations
Learn more about including relations.- Name
address- Type
- Address
- Filterable
- Sortable
- Name
segment- Type
- Segment
- Filterable
- Name
team- Type
- Team
Commercial-only Relations
Learn more about including relations.- Name
naics_code- Type
- NAICS Code
- Filterable
- Name
sic_code- Type
- SIC Code
- Filterable
List all risk profiles
This endpoint allows you to retrieve a paginated list of all risk profiles (commercial and personal) in a team. By default, 50 risk profiles are shown per page.
Parameters
See the risk profile object for a list of all available filters and sorts.
Additional filters
In addition to the filters available on the risk profile object, you can also filter by the following properties.
- Name
profile_type- Type
- enum
- Filterable
- Description
The type of risk profile to filter by. By default (not providing, or as a nullish value), both commercial and personal profiles are returned.
Searchable
You can search for risk profiles by providing a search query in the filter[search] parameter.
The search query will be matched against a risk profile's name, email, phone number, or address.
Request
curl -G https://app.wunderite.com/api/v2/risks \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d per_page=50
Response
{ "data": [ { "object": "risk_profile", "uuid": "3f8cb14f-1bc8-4686-b59e-a6a0a26120c4", "data": { "name": "Pied Piper", "segment": "844f3468-ecb3-4da8-a8b2-29c0ec6e3475", "phone": "6505551212", "phone_ext": null,
Create risk profiles
This endpoint allows you to create new commercial or personal risk profiles in your team.
At least one risk_profile object must be provided in the request body.
You can also create an address in the same request if you provide the address property.
Required properties
- Name
name- Type
- string
- Description
The name of the risk profile i.e. the insured's business or account name
- Name
profile_type- Type
- enum
- Description
The type of risk profile to create. Needs to be provided outside of the
datablob, as a top-level property.
Optional properties
See all available properties in the risk profile properties section.
- Name
address- Type
- Address
- Description
An address object that should be created with the risk profile
Flags
Learn more about flags.
When creating a risk profile, Wunderite will automatically do the following:
- For commercial profiles, if an
addressis provided, a correspondingpremisewill be created using that address. - For commercial profiles, a first named insured
legal_entityobject will be created, automatically filling the name from the risk profile's name, and the description as the executive summary of the risk profile. - For commercial and personal profiles, the authenticated user (the user that is linked to the provided API token) will be added as a collaborator of the risk profile.
If you do not want these sub-resources to be created automatically, you can disable them using the following flags:
- Name
flags.create_premise- Type
- bool
- Description
Defaults to
trueif not provided.Specify whether you want Wunderite to automatically create a
premisewhen creating a commercial risk profile with anaddress.
- Name
flags.create_legal_entity- Type
- bool
- Description
Defaults to
trueif not provided.Specify whether you want Wunderite to automatically create a first named insured
legal_entitywhen creating a risk profile.
- Name
flags.create_default_collaborator- Type
- bool
- Description
Defaults to
trueif not provided.Specify whether you want Wunderite to automatically add the authenticated user as a collaborator of the risk profile.
Additionally, there are two other flags that can be used to skip errors concerning NAICS and SIC codes:
- Name
flags.ignore_naics_code_error- Type
- bool
- Description
Defaults to
falseif not provided.Specify whether you want to ignore errors when providing an invalid NAICS code.
- Name
flags.ignore_sic_code_error- Type
- bool
- Description
Defaults to
falseif not provided.Specify whether you want to ignore errors when providing an invalid SIC code.
Request
curl -X POST "https://app.wunderite.com/api/v1/risks/{risk}/data/risk_profiles" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"data": [
{
"object": "risk_profile",
"data": {
"name": "Pied Piper",
"segment": "844f3468-ecb3-4da8-a8b2-29c0ec6e3475",
"phone": "6505551212",
"phone_ext": null,
"website": "https:\/\/www.pidpiper.com",
"fax": "650-555-2121",
"sic_code": "7372",
"naics_code": "511210",
"description_of_operations": "Pied Piper is a cutting-edge tech startup specializing in data compression and decentralized internet protocols. Founded by Richard Hendricks and his team of brilliant engineers, Pied Piper aims to revolutionize the way data is stored, transferred, and accessed on the internet.",
"executive_summary": "Overall, Pied Piper's operations are focused on innovation, reliability, and risk management to deliver cutting-edge technologies that drive the future of the internet while minimizing potential liabilities for the company and its stakeholders.",
"image": null
},
"profile_type": "commercial"
}
]
}'
Response
{ "data": [ { "object": "risk_profile", "uuid": "3f8cb14f-1bc8-4686-b59e-a6a0a26120c4", "data": { "name": "Pied Piper", "segment": "844f3468-ecb3-4da8-a8b2-29c0ec6e3475", "phone": "6505551212", "phone_ext": null,
Request with sub resources
curl -X POST "https://app.wunderite.com/api/v1/risks/{risk}/data/risk_profiles?include=address" \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"data": [
{
"object": "risk_profile",
"data": {
"name": "Pied Piper",
"segment": "844f3468-ecb3-4da8-a8b2-29c0ec6e3475",
"phone": "6505551212",
"phone_ext": null,
"website": "https:\/\/www.pidpiper.com",
"fax": "650-555-2121",
"sic_code": "7372",
"naics_code": "511210",
"description_of_operations": "Pied Piper is a cutting-edge tech startup specializing in data compression and decentralized internet protocols. Founded by Richard Hendricks and his team of brilliant engineers, Pied Piper aims to revolutionize the way data is stored, transferred, and accessed on the internet.",
"executive_summary": "Overall, Pied Piper's operations are focused on innovation, reliability, and risk management to deliver cutting-edge technologies that drive the future of the internet while minimizing potential liabilities for the company and its stakeholders.",
"image": null,
"address": {
"object": "address",
"data": {
"address": "123 Main St",
"city": "Boston",
"state": "MA",
"zip": "02108"
}
}
},
"profile_type": "commercial"
}
]
}'
Response
{ "data": [ { "object": "risk_profile", "uuid": "b1ad0e3e-a998-47cb-be57-b2e24b94dc7c", "data": { "name": "Pied Piper", "segment": "844f3468-ecb3-4da8-a8b2-29c0ec6e3475", "phone": "6505551212", "phone_ext": null,
The Risk Profile model (legacy)
Properties
These properties are available for both commercial and personal profiles.
See below for properties that are only available for one type of profile.
- Name
uuid- Type
- string
- Description
- The risk profile UUID
- Name
name- Type
- string
- Description
- The name of the risk profile
- Name
logo- Type
- nullable string
- Description
- The risk profile's logo
- Name
phone- Type
- nullable string
- Description
- The risk profile's phone number
- Name
phone_ext- Type
- nullable string
- Description
- The extension to the risk profile's phone number, if applicable
- Name
is_personal- Type
- bool
- Description
A boolean flag marking the risk profile as a personal profile.
truemeans it is a personal profile,falsemeans it is a commercial profile.
- Name
created_at- Type
- timestamp
- Description
- The timestamp when the risk profile was created
- Name
updated_at- Type
- timestamp
- Description
- The timestamp when the risk profile was most recently updated
Commercial-only Properties
These properties are only available when the risk profile is a commercial profile.
- Name
website- Type
- nullable string
- Description
- The website specified for the risk profile
- Name
fax- Type
- nullable string
- Description
- The fax number specified for the risk profile
- Name
sic- Type
- nullable string
- Description
- The Standard Industrial Classification (SIC) code specified for the risk profile
- Name
naics- Type
- nullable string
- Description
- The North American Industry Classification System (NAICS) code specified for the risk profile
Personal-only Properties
These properties are only available when the risk profile is a personal profile.
- Name
email- Type
- nullable string
- Description
- The email address specified for the risk profile
Relations
List all risk profiles (legacy)
This endpoint allows you to retrieve a paginated list of all risk profiles in a team. By default, 25 risk profiles are shown per page.
Optional parameters
- Name
profile_type- Type
- nullable ProfileTypeEnum
- Description
The type of risk profile to filter by. Not providing, or leaving as
null, will return commercial profiles.- Name
commercial
- Name
personal
Request
curl -G https://app.wunderite.com/api/v1/risks \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json"
Response
{ "data": [ { "uuid": "66edc9e0-a056-4f22-bc47-06e81c997458", "name": "Acme Anvil Corporation", "email": null, "fax": "1-888-555-4568", "logo": "https://app.wunderite.com/proxy/media/avatar/6eff46ab-4e1b-4305-b626-bc7f1f3f7faf", "phone": "1-888-123-4567", "phone_ext": null,