Create a new pre-evaluation

POST 
/v1/pre-evaluations

Request

application/json

Body

required

source stringrequired

Originating source of the pre-evaluation request

chassis_number stringrequired

Chassis number of the vehicle

manufacturer stringrequired

Manufacturer of the vehicle

model stringrequired

Model of the vehicle

year stringrequired

Year of manufacture of the vehicle

color stringrequired

Color of the vehicle

engine_no stringrequired

Engine number of the vehicle

usage stringrequired

Usage of the vehicle

license_number stringrequired

License number of the vehicle

license_expiry stringrequired

License expiry date of the vehicle

vehicle_value stringrequired

Value of the vehicle

vehicle_type stringrequired

Type of the vehicle

vehicle_details object[]required
Possible values: >= 4
Details of the vehicle. Must contain at least 4 items and must include the rear, front, left and right sides. Each image URL must be publicly accessible.
Array [
url string
Publicly accessible URL of the vehicle image
side string
Possible values: [left, right, rear, front, dashboard, vin-plate, license-plate, video]
Side of the vehicle
]
vehicle_regno string

Registration number of the vehicle

assessment_type stringrequired

Possible values: [pre_purchase, claims]

Type of assessment

Responses

201

OK

application/json

Schema

Schema

data PreEvaluationResponse
chassis_number string
Chassis number of the vehicle
manufacturer string
Manufacturer of the vehicle
model string
Model of the vehicle
year string
Year of manufacture of the vehicle
color string
Color of the vehicle
engine_no string
Engine number of the vehicle
usage string
Usage of the vehicle
license_number string
License number of the vehicle
license_expiry string
License expiry date of the vehicle
vehicle_value string
Value of the vehicle
vehicle_value_currency string
Currency of the vehicle value
vehicle_type string
Type of the vehicle
vehicle_details object[]
Details of the vehicle
Array [
url string
URL of the vehicle
side string
Side of the vehicle
]
vehicle_regno string
Registration number of the vehicle
assessment_type string
Type of assessment
created_at string
Date of creation of the pre-evaluation
ref string
Reference of the pre-evaluation
files object[]
Files of the pre-evaluation
Array [
url string
URL of the file
side string
Side of the file
status string
Status of the file
]

Example (from schema)

{
  "data": {
    "chassis_number": "string",
    "manufacturer": "string",
    "model": "string",
    "year": "string",
    "color": "string",
    "engine_no": "string",
    "usage": "string",
    "license_number": "string",
    "license_expiry": "string",
    "vehicle_value": "string",
    "vehicle_value_currency": "string",
    "vehicle_type": "string",
    "vehicle_details": [
      {
        "url": "string",
        "side": "string"
      }
    ],
    "vehicle_regno": "string",
    "assessment_type": "string",
    "created_at": "string",
    "ref": "string",
    "files": [
      {
        "url": "string",
        "side": "string",
        "status": "string"
      }
    ]
  }
}

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 source field is required.",
  "error": {
    "source": [
      "The source field is required."
    ],
    "chassis_number": [
      "The chassis number field is required."
    ]
  }
}

Loading...