Replace :session_key with the unique session_key returned from your previous request, and PAVE will return the corresponding session results.
Path Parameters
Type
Description
session_key
string
Unique session_key generated when the new session was created
Headers
Type
Description
API-Key
string
The API-Key that was provided for your account
API-Token
string
The API-Token used when the session was created
API-Timestamp
string
UTC Datetime string, example: 2021-05-30T12:49:19Z
Sample Request
curl --location --request GET 'https://openapi.paveapi.com/v1/sessions/UNG-5IXXXXXXXX/results' \
PAVE Inspection Results Data
This link below provides a PDF document that includes a detailed description of the various objects used in an inspection session JSON that is SESSION:COMPLETE.
These objects include the Session Object, which contains information about the inspection session, such as the session key, theme, status, and contact details. The Vehicle Object has information on the inspected vehicle, including the VIN, make, model, and odometer reading. The Photos Object contains information about the photos taken during the inspection, including the URL where they are stored and whether they were approved in the photo QA process. The Location Object provides details about the location of the inspection. Lastly, the Inspection Object contains information about the damages detected during the inspection, including the total number of damages and their maximum grade per item.
Sample Response (200: Ok)
The session is COMPLETE and the final results are available.
The session is not yet COMPLETE and might be in IDLE or PROCESSING status, and the final results are not available. See the Webhooks section to learn more about PAVE session statuses.
{
"message": "Session is not yet completed."
}
Sample Response (404: Not Found)
The session does not exist, please check the :session_key.
{
"message": "Session :session_key cannot be found."
}
Session Objects
Attribute
Type
Description
session_key
string
Session Key generated for User
theme
string
Theme provided to use for User Interface
active
string
Results status
status
string
Session status
redirect_url
string
URL provided to send User when the session completes
inspect_started_at
datetime
UTC Datetime for when User started the session
inspect_ended_at
datetime
UTC Datetime for when User finished the session
created_at
datetime
UTC Datetime for when session_key was created
updated_at
datetime
UTC Datetime for when session_key was updated
language
string
Language provided to use for User Interface
options
sms
Attribute
Type
Description
to
string
Destination mobile phone number provided to send to User
to_name
string
The name that was inputted as the Contact Name on the form or request.
from
string
Destination mobile phone number provided to send final results
by
string
Name provided to include in SMS Message sent to User
REJECTED: Door is open - please close and recapture
"rejection_code": "opened_door"​
REJECTED: Image Not Clear
"rejection_code": "image_not_clear"​
REJECTED: Make sure your plate number is visible in the photo provided
"rejection_code": "vrm_not_visible"​
REJECTED: Please recapture the photo, ensuring that the vehicle is fully in frame for this angle.
"rejection_code": "vehicle_is_not_in_frame​"
REJECTED: The Vehicle does not match our previous inspection records for this VIN.
"rejection_code": "mismatched_record"​
REJECTED: Too Dark
"rejection_code": "too_dark"​
REJECTED: Too Sunny
"rejection_code": too_sunny"​
REJECTED: View is obstructed, please recapture photo.
"rejection_code": "view_is_obstructed"​
REJECTED: We are having trouble reading your Odometer, please recapture Odometer photo.
"rejection_code": "no_odometer​"
REJECTED: Wrong View
"rejection_code": "wrong_view"​
REJECTED: Bad Weather
"rejection_code": "bad_weather"​
REJECTED: Make sure your VIN is visible in the VIN photo provided
"rejection_code": "vin_not_visible"​
REJECTED: Vehicle in photo does not match VIN provided or vehicle being inspected.
"rejection_code": "vin_mismatch"​
REJECTED: Please only capture your VIN from off the vehicle itself
"rejection_code": "vin_not_from_vehicle"
"Accepted"
"rejection_code": null
Note:
Since the VIN photo (Photo Code: 1) routes the data through PAVE's Capture API instead of the OpenAPI, the VIN photo will always show "rejection_code": null
Vehicle Objects
Attribute
Type
Description
vehicle_id
integer
PAVE system ID for vehicle
vin
string
The VIN inputted or extracted for the session
year
integer
The Year of the vehicle
make
string
The Make of the vehicle
model
string
The Model of the vehicle
body_type
string
The vehicle's body type
trim
string
The Trim detected of the vehicle
transmission
string
The Transmission detected for the vehicle
drivetrain
string
The Drivetrain of the vehicle
engine_type
string
The Engine Type of the vehicle
fuel_type
string
The Fuel Type of the vehicle
ext_col
string
The Exterior Color detected of the vehicle
int_col
string
The Interior Color detected of the vehicle
odom_reading
integer
The Odometer Reading inputted or extracted for the session
odom_unit
string
The Odometer unit of measure inputted or extracted for the session
The PAVE Capture UI detects the User's location for where they completed their inspection only when they give PAVE permission when asked by the browser. This location is not always their business or home address as it is the inspection location and may not be available for all sessions. When the User gives permission but they have not set the browser to share their location in their device settings PAVE will not return the location.
The detected_status provides a label that describes the condition that was determined by the inspection of the vehicle's interior and tires.
Attribute
Type
Description
interior
string
PAVE Label that describes the overall interior condition
tire
string
PAVE Label that describes the condition of the tires
detected_damages
The detected_damages provides the detail that describes the damages detected during the inspection.
Attribute
Type
Description
damage_group
string
The category of the damaged component type
component
string
The label of the component that is damaged
damage_name
string
The label of the damage type that was detected
component_label
string
The description of the component that is damaged
user_response
string
If the User accepted or denied the detected damages
source
string
If the damage was detected by PAVE or inputted manually
description
string
The description of the damage detected
tolerance
string
The tolerance range of the detected damage label used
repair_method
string
The method used to repair the damage
repair_type
string
The category of the type of repair
unit_measure
string
If the repair fixes all other damages or not (Per Item does not)
grade_score
integer
The level of severity as a score from 0-5
frame_grade_score
integer
The added level of severity if considered frame damage
photo: code
integer
The PAVE code for the image
photo: url
string
The URL to retrieve the image that was used to detect damage
uuid
string
PAVE's damage ID
cropped_url
string
The URL to retrieve the cropped image of the damage
cropped_code
integer
The number that is used identify the location of the damage on the annotated image
estimate_category
string
The category of estimate between Exterior and Tire/Wheel
labor_hrs
integer
Labor hour estimate to handle the damage
labor_total
integer
Labor total cost to handle the damage: Standard Labor Rate * Labor hour
part_materials
integer
Estimate cost of the damaged component that need repair/replace
total
integer
Total estimate cost: Labor + Part
estimate_included
boolean
Indicate if the cost of this component is already included in another damage report
estimate_tbd
boolean
Indicate if the cost of this component can be discussed between users
material
string
Material of the component
component_id
integer
PAVE ID of component
damage_type
string
Damage type that was detected
damage_type_id
integer
PAVE ID of damage type
severity
string
Severity of damage detected
severity_id
integer
PAVE ID of severity
aasc_item_code
integer
AutoGrade component code
aasc_damage_code
integer
AutoGrade damage code
aasc_severity_code
integer
AutoGrade severity code
status
string
Indicate if the damage is an old one (already identified in the previous inspection) newly detected in the current inspection compared to the previous one for the same vehicle or if it was identified in the previous inspection and has been repaired in this inspection.
The annotated_imagesprovides the URLs to retrieve the images PAVE generates that are annotated to highlight the exact location of all the detected damages. The highlighted number corresponds with the cropped_codenumber found in the damagesobject. These will be NULL if no damages are found.
The grading provides the overall grading that PAVE has given the session vehicle based on what damages are detected. These gradings are given in three separate grading bands to help align with industry standards in each region or use case.
"grading": {
"standard_A": 4,
"standard_B": "B-2",
"standard_C": "Very Good Condition",
PAVE GRADING MATRIX:
STANDARD A
STANDARD B
STANDARD C
PAVE Vehicle Condition Grading Scale
PAVE Book Value Grading Scale
vs Autograde
vs KBB
vs Black Book
5
A-1
Excellent Condition
Extra Clean
Excellent Condition
Extra Clean
4
B-2
Very Good Condition
Clean
Very Good Condition
Clean
3
C-3
Good Condition
Average
Good Condition
Average
2
D-4
Fair Condition
Below Average
Fair Condition
Rough
1
E-5
Poor Condition
Rough
Unclassified
Rough
0
U-6
Very Poor Condition
Unclassified
Unclassified
Rough
Component Damages
The component_damages provides an overall summary of how many items were detected per component and what the total estimates were for the session.
When each session gets completed PAVE will generate two detailed condition reports; one as a sharable PDF and the other as an HTML landing page that you can use for your purposes. Your PAVE account representative can help to customize the header of both to fit your brand needs.
