Create a new vehicle assessment

POST 
/v1/vehicle-assessments

Upload the images of the vehicle and get the assessment via webhooks

Request

application/json

Body

required

registration_number stringrequired

Registration number of the vehicle

assessment_type stringrequired

Possible values: [pre-policy, post-loss]

Type of assessment

pre_policy_assessment_id string

Required when assessment_type is post-loss. ID of the pre-policy assessment.

images object[]required
image urls of the vehicle
Array [
url string
URL of the file
part string
Possible values: [left, right, rear, front, dashboard, vin-plate, license-plate, video]
Side of the vehicle
]

Responses

201

OK

application/json

Schema

Schema

id integer

ID of the pre-policy assessment

assessment_id integer

ID of the post-loss assessment

claim_id integer

ID of the claim created for a post-loss assessment

info string

Information about the assessment

Example (from schema)

{
  "id": 0,
  "assessment_id": 0,
  "claim_id": 0,
  "info": "Processing images. Updates will be sent via webhooks."
}

400

Bad request.

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "400 Bad Request (Client Error)"
}

401

Unauthenticated - no valid API key was provided.

application/json

Schema

Schema

data string

Example (from schema)

{
  "data": "Invalid Token"
}

422

Unprocessable Content

application/json

Schema

Schema

message string
error object
property name* string[]
Array [
string
]

Example (from schema)

{
  "message": "The given data was invalid",
  "error": {}
}

Loading...