Risk Profiles

Risk profiles are an essential part of RiskAdvisor — they are the bread and butter between you, your clients, and agency. On this page, we’ll dive into the different risk profile endpoints you can use to manage risk profiles programmatically. We'll look at how to query, create, update, and delete risk profiles.

The risk profile model

The risk profile model contains all the information about the risk profiles between you and your clients. In addition, risk profiles include one or more products, and an optional co-client.

Properties

Name
id
Type
string
Description
Unique identifier for the risk profile.
Name
return_user_id
Type
string
Description
Unique identifier for the user who should receive quotes.
Name
customer_service_rep_id
Type
string
Description
Unique identifier for the customer service representative handling the client account.
Name
producer_id
Type
string
Description
Unique identifier for the user responsible for producing the quote.
Name
client_id
Type
string
Description
Unique identifier for the client in the risk profile.
Name
co_client_id
Type
string
Description
Unique identifier for the other client in the risk profile.
Name
requested_at
Type
date
Description
The date the risk profile was requested, in YYYY-MM-DD format.
Name
needed_at
Type
date
Description
The date the risk profile is needed by, in YYYY-MM-DD format.

GET/api/risk-profiles

List all risk profiles

This endpoint allows you to retrieve a paginated list of all your risk profiles. By default, a maximum of ten risk profiles are shown per page.

Optional attributes

Name
limit
Type
integer
Description
Limit the number of risk profiles returned.
Name
team_id
Type
integer
Description
Define from which team the risk profiles will be returned. Use 0 or null for all teams.
Name
show_drafts
Type
boolean
Description
Define whether draft risk profiles will also be returned.
Name
client_email
Type
string
Description
The client email we want to list risk profiles for.

Request

GET

/api/risk-profiles

curl -G https://app.riskadvisor.insure/api/risk-profiles \
  -H "Authorization: Bearer {token}" \
  -d limit=10

Response

{
  "has_more": false,
  "data": [
    {
      "id": "xgQQXg3hrtjh7AvZ",
      "client_id": "WAz8eIbvDR60rouK",
      // ..
    },
    {
      "id": "hSIhXBhNe8X1d8Et"
      // ...
    }
  ]
}

POST/api/risk-profiles

Create a risk profile

This endpoint allows you to add a new risk profile between you and a client. A client id is required to create a risk profile.

Required attributes

Name
insurance_type
Type
string
Description
home, auto, umbrella, or home_auto
Name
client_id
Type
string
Description
Unique identifier for the client in the risk profile.

Optional attributes

Name: co_client_id
Type: string
Description: Unique identifier for the other client in the risk profile.

Request

POST

/api/risk-profiles

curl https://app.riskadvisor.insure/api/risk-profiles \
  -H "Authorization: Bearer {token}" \
  -d 'client_id'="WAz8eIbvDR60rouK"

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "client_id": "WAz8eIbvDR60rouK",
  // ..
}

GET/api/risk-profiles/drivers

List drivers

This endpoint allows you to list the drivers from an existing auto risk profile.

Required attributes

Name
risk_profile_id
Type
integer
Description
Unique identifier for the risk profile you want to list the drivers.

Request

GET

/api/risk-profiles/drivers

curl -X GET https://app.riskadvisor.insure/api/riskprofiles/drivers \
  -H "Authorization: Bearer {token}" \
  -d 'risk_profile_id'=ID

Response

[
  {
    "id": null, //UUID
    "client_id": null,
    "first_name": null,
    "middle_name": null,
    "last_name": null,
    "date_of_birth": null, //yyyy-mm-dd
    "gender": null,
    "relationship": null,
    "education": null,
    "occupation": null,
    "marital_status": null,
    "licensed_state": null,
    "license_number": null,
    "license_status": null,
    "license_state": null,
    "licensed_age": null,
    "rated": null,
    "sr22_required": false,
    "is_app_driver": false,
    "is_delivery_driver": false,
    "discounts": []
  },
//...
]

POST/api/risk-profiles/drivers

Add drivers

This endpoint allows you to add drivers to an existing auto risk profile.

Required attributes

Name
risk_profile_id
Type
integer
Description
Unique identifier for the risk profile you want to add the driver.

Optional attributes

Name: first_name
Type: string
Description: The driver's first name.

Name: middle_name
Type: string
Description: The driver's middle name.

Name: last_name
Type: string
Description: The driver's last name.

Name: date_of_birth
Type: string
Description: The driver's date of birth in yyyy-mm-dd or ISO format.

Name: occupation
Type: string
Description: The driver's occupation.

Name: gender
Type: string
Description: The driver's gender. Options: Male, Female

Name: relationship
Type: string
Description: The driver's relationship.
Options: Self, Spouse, Child, Domestic Partner, Parent, Relative, Employee, Other

Name: education
Type: string
Description: The driver's education.

Name: marital_status
Type: string
Description: The driver's marital status.
Options: Single, Engaged, Married, Divorce, Widowed

Name: license_status
Type: string
Description: The driver's license status.
Options: Valid, Permit, Expired, Suspended, Cancelled, Not Licensed, Permanently Revoked

Name: license_number
Type: string
Description: The driver's license number.

Name: licensed_state
Type: string
Description: The driver's licensed two-letter state abbreviation. E.g. TX

Name: licensed_age
Type: string
Description: The driver's licensed age.

Name: rated
Type: string
Description: The driver's rated.
Options: Rated, Excluded, Non Rated, Never Licensed

Name: sr22_nullable
Type: boolean
Description: Is the driver's sr22 nullable?.

Name: is_delivery_driver
Type: boolean
Description: Is the driver a delivery driver.

Name: is_app_driver
Type: boolean
Description: Is the driver an app driver.

Name: discounts
Type: array
Description: An array with the driver's discounts.
Options: Good Student, Driver Training, Away At School.

Request

POST

/api/risk-profiles/drivers

curl -X POST https://app.riskadvisor.insure/api/riskprofiles/drivers \
  -H "Authorization: Bearer {token}" \
  -d 'risk_profile_id'=ID

Response

{
  "id": null, //UUID
  "client_id": null,
  "first_name": null,
  "middle_name": null,
  "last_name": null,
  "date_of_birth": null, //yyyy-mm-dd
  "gender": null,
  "relationship": null,
  "education": null,
  "occupation": null,
  "marital_status": null,
  "licensed_state": null,
  "license_number": null,
  "license_status": null,
  "license_state": null,
  "licensed_age": null,
  "rated": null,
  "sr22_required": false,
  "is_app_driver": false,
  "is_delivery_driver": false,
  "discounts": []
}

GET/api/risk-profiles/vehicles

List vehicles

This endpoint allows you to list the vehicles from an existing auto risk profile.

Required attributes

Name
risk_profile_id
Type
integer
Description
Unique identifier for the risk profile you want to list the vehicles.

Request

GET

/api/risk-profiles/vehicles

curl -X GET https://app.riskadvisor.insure/api/riskprofiles/vehicles \
  -H "Authorization: Bearer {token}" \
  -d 'risk_profile_id'=ID

Response

[
  {
    "id": null, // UUID
    "driver_id": null,
    "year": null,
    "make": null,
    "model": null,
    "hasVin": true,
    "vin": null,
    "garaged_state": null,
    "usage": null,
    "annual_miles": null,
    "one_way_miles": null,
    "purchased_at": null,
    "payments": {
        "makes_payment": false,
        "payment_type": null,
        "lessor": null,
        "lienholder": null
    },
    "coverage": {
        "full_glass": true,
        "stated_amount": null,
        "mi_collision_type": null,
        "collision_deductible": null,
        "ma_waive_collision_ded": false,
        "stated_amount_coverage": true,
        "towing_coverage_amount": null,
        "comprehensive_deductible": null,
        "ma_limited_collision_ded": null,
        "car_rental_coverage_amount": null
    }
  },
//...
]

POST/api/risk-profiles/vehicles

Add vehicles

This endpoint allows you to add vehicles to an existing auto risk profile.

Required attributes

Name
risk_profile_id
Type
integer
Description
Unique identifier for the risk profile you want to add the vehicle.

Optional attributes

Name: driver_id
Type: string
Description: The UUID of the driver who drives this vehicle.

Name: vin
Type: string
Description: The VIN of the vehicle.

Name: year
Type: string
Description: The year of the vehicle.

Name: make
Type: string
Description: The make of the vehicle.

Name: model
Type: string
Description: The model of the vehicle.

Name: purchased_at
Type: string
Description: The date of purchased of the vehicle in yyyy-mm-dd or ISO format.

Name: usage
Type: string
Description: The usage of the vehicle.
Options: Valid, Permit, Expired, Suspended, Cancelled, Not Licensed, Permanently Revoked

Name: garaged_state
Type: string
Description: The two-letter state abbreviation where the vehicle is garaged. E.g. TX

Name: annual_miles
Type: string
Description: How many miles in a year.

Name: one_way_miles
Type: string
Description: How many miles in one way to work.

Request

POST

/api/risk-profiles/vehicles

curl -X POST https://app.riskadvisor.insure/api/riskprofiles/vehicles \
  -H "Authorization: Bearer {token}" \
  -d 'risk_profile_id'=ID

Response

{
  "id": null, // UUID
  "driver_id": null,
  "year": null,
  "make": null,
  "model": null,
  "hasVin": true,
  "vin": null,
  "garaged_state": null,
  "usage": null,
  "annual_miles": null,
  "one_way_miles": null,
  "purchased_at": null,
  "payments": {
      "makes_payment": false,
      "payment_type": null,
      "lessor": null,
      "lienholder": null
  },
  "coverage": {
      "full_glass": true,
      "stated_amount": null,
      "mi_collision_type": null,
      "collision_deductible": null,
      "ma_waive_collision_ded": false,
      "stated_amount_coverage": true,
      "towing_coverage_amount": null,
      "comprehensive_deductible": null,
      "ma_limited_collision_ded": null,
      "car_rental_coverage_amount": null
  }
}