Skip to main content
POST
/
v1
/
risk-score
/
ppa-garaging
{
  "job_type": "ppa-garaging-risk-score",
  "policy_holder_id": "policy-holder-123",
  "version": "v1",
  "vehicle_risk_scores": [
    {
      "vehicle_id": "vehicle-123",
      "vehicle_risk_score": 0.621,
      "metadata": {
        "coverage": [
          {
            "usstate": "OH",
            "years": [
              2020,
              2021,
              2022,
              2023
            ]
          }
        ],
        "effective_date": "2020-01-01T00:00:00",
        "garaging_location": {
          "latitude": 39.9526,
          "longitude": -95.96728,
          "urbanicity": "rural",
          "usstate": "OH"
        }
      }
    }
  ],
  "errors": null
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
policy_holder_id
string
required

Unique identifier for the policyholder.

Examples:

"policy-holder-123"

​
vehicles
VehicleGaragingData · object[]
required

List of vehicles with their garaging locations. Max 50 vehicles per request.

Required array length: 1 - 50 elements
​
version
enum<string>
default:v2

Version of the risk scoring model used.

Available options:
v1,
v2
​
effective_date
string<date-time> | null

Start date of the policy. Defaults to the current date and time unless overridden, typically for backtesting. Will not pull in data after this date.

Response

Successful Response

​
policy_holder_id
string
required

Unique identifier for the policyholder.

Examples:

"policy-holder-123"

​
vehicle_risk_scores
PPA_VehicleGaragingRiskScore · object[]
required

Risk scores for each vehicle based on their garaging locations.

​
errors
PPA_VehicleGaragingRiskScoreError · object[]
required

Any vehicles that could not be scored.

Examples:

null

​
job_type
string
default:ppa-garaging-risk-score

Type of job that was run.

Allowed value: "ppa-garaging-risk-score"
Examples:

"ppa-garaging-risk-score"

​
version
enum<string>
default:v2

Version of the risk scoring model used.

Available options:
v1,
v2
Examples:

"v1"

"v2"