Risk Profiles
Risk profiles are a way to group data and properties together to create a risk profile. There are two types of risk profiles: commercial and personal.
The Risk Profile model
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.
true
means it is a personal profile,false
means 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
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,