Lead Validation
Identify issues with inbound part-exchanges and car buying leads early in the process to save big on time and money.
Key Features
Pay-on-Results
Only pay when vehicle's are flagged. Ensures guaranteed ROI through time and data savings.
Salvage Check
Flags vehicles offered for sale at salvage auction, including unrecorded write-offs
Taxi Check
Flags vehicles previously licensed as taxis.
Stolen Check
Flags vehicles currently recorded as stolen on the Police National Computer
Import Check
Identifies imported vehicles likely to be less desirable as stock
Scrapped Check
Identifies vehicles recorded as scrapped with the DVLA
Sample Response
V2
Documentation
Introduction
Cleanse inbound leads by submitting a VRM. The service returns a fail (status code 200) or pass (status code 206) result. If result = fail the reason(s) for failure are identified in the response, enabling you to apply different handling rules for the lead and provide information to users.
Header
When making calls to our API, include the following header:
x-api-key:your-api-key-here
Example Request
https://api.oneautoapi.com/oneauto/vehiclevalidation?vehicle_registration_mark=AB21ABC&maximum_age_months=12&maximum_number_keepers=5&maximum_keeper_changes_last_12_months=2&minimum_months_since_last_keeper_change=6
Example Sandbox Request
https://sandbox.oneautoapi.com/oneauto/vehiclevalidation?vehicle_registration_mark=AB21ABC&maximum_age_months=12&maximum_number_keepers=5&maximum_keeper_changes_last_12_months=2&minimum_months_since_last_keeper_change=6
Request Parameters
vehicle_registration_mark
mandatory, string, e.g. AB21ABC
Vehicle registration number
maximum_age_months
optional, string, e.g. 12
the maximum age of a vehicle that can pass
maximum_number_keepers
optional, string, e.g. 5
the maximum number of keepers in order to pass
maximum_keeper_changes_last_12_months
optional, string, e.g. 2
the maximum number of keepers in the past 12 months
minimum_months_since_last_keeper_change
optional, string, e.g. 6
the minimum number of months since the last keeper change in order to pass
Sample Response
{
"success": true,
"result": {
"vehicle_registration_mark": "AB21ABC",
"result": "fail",
"fail_reason_qty": 6,
"fail_reason_data_items": [
{
"is_possible_taxi": true,
"taxi_records": [
{
"taxi_record_id": 123456,
"manufacturer_desc": "NISSAN",
"model_range_desc": "Qashqai",
"manufacturer_model_desc": "NISSAN Qashqai",
"licence_start_date": "2020-01-02",
"licence_expiry_date": "2020-01-01",
"is_wheelchair_adapted": false,
"carguide_fuel_type_desc": "Petrol",
"licence_holder_name": "TBC"
}
],
"salvage_auction_record_found": true,
"salvage_auction_records": [
{
"salvage_auction_record_id": 1234567,
"salvage_auction_lot_desc": "Nissan Qashqai",
"salvage_auction_lot_date": "2020-01-01",
"mileage": 12345,
"primary_damage_desc": "Slight Front Damage",
"secondary_damage_desc": "Unable to select 5th gear, steering poor.",
"external_image_urls": "http://exampleauctionhouse/example/12345"
}
]
}
],
"is_scrapped": true,
"is_exported": false,
"is_imported": false,
"is_non_eu_import": false,
"is_stolen": true,
"stolen_vehicle_data_items": [
{
"datetime_added_pnc": "2020-01-01T08:00:02Z",
"date_reported": "2020-01-01",
"police_force": "COUNTY POLICE"
}
],
"exceeds_maximum_age_months": true,
"exceeds_maximum_number_keepers": true,
"exceeds_maximum_keeper_changes_last_12_months": false,
"is_less_than_minimum_months_since_last_keeper_change": false,
"dvla_manufacturer_desc": "NISSAN",
"dvla_model_desc": "QASHQAI ACENTA PREMIUM DCI",
"dvla_fuel_desc": "DIESEL",
"dvla_body_desc": "5 DOOR HATCHBACK",
"registration_date": "2020-01-01",
"manufactured_year": 2020,
"vehicle_identification_number": "ABCDE123456F78910",
"first_registration_date": "2020-01-01",
"used_before_first_registration": false,
"co2_gkm": 123,
"engine_number": "A12345678",
"scrapped_date": "2020-01-01",
"exported_date": "2020-01-01",
"colour": "RED",
"v5c_qty": 1,
"date_v5c_issued": "2020-01-01",
"keeper_change_list": [
{
"number_previous_keepers": 1,
"date_of_last_keeper_change": "2020-01-01"
}
]
},
"error": "If there is an error the message would go here"
}Response Parameters
success
e.g. true
Whether the api call was successful
vehicle_registration_mark
e.g. AB21ABC
Vehicle registration number (VRM).
result
e.g. fail
Has the vehicle passed all lead validation tests.
fail_reason_qty
e.g. 6
The number of lead validation failures.
is_possible_taxi
e.g. true
Has the vehicle been previously used as a taxi.
taxi_record_id
e.g. 123456
The taxi record ID.
manufacturer_desc
e.g. NISSAN
Manufacturer description
model_range_desc
e.g. Qashqai
Model range description
manufacturer_model_desc
e.g. NISSAN Qashqai
The model range description.
licence_start_date
e.g. 2020-01-02
The taxi and private hire licence start date.
licence_expiry_date
e.g. 2020-01-01
The taxi and private hire licence expiry date.
is_wheelchair_adapted
e.g. false
Is the vehicle wheelchair adapated.
carguide_fuel_type_desc
e.g. Petrol
The fuel type
licence_holder_name
e.g. TBC
This field has been deprecated and will always return null.
salvage_auction_record_found
e.g. true
Salvage record has been found
salvage_auction_record_id
e.g. 1234567
Salvage record id
salvage_auction_lot_desc
e.g. Nissan Qashqai
Salvage auction lot description
salvage_auction_lot_date
e.g. 2020-01-01
The salvage auction date
mileage
e.g. 12345
The current mileage of the vehicle in full
primary_damage_desc
e.g. Slight Front Damage
The primary damage description
secondary_damage_desc
e.g. Unable to select 5th gear, steering poor.
The secondary damage description
external_image_urls
e.g. http://exampleauctionhouse/example/12345
The URL returns external image of vehicle.
is_scrapped
e.g. true
Has the vehicle been scrapped.
is_exported
e.g. false
Vehicle is exported
is_imported
e.g. false
Vehicle is imported
is_non_eu_import
e.g. false
Vehicle is non-eu import
is_stolen
e.g. true
Is the vehicle stolen
datetime_added_pnc
e.g. 2020-01-01T08:00:02Z
The date and time the vehicle was added to the police national computer
date_reported
e.g. 2020-01-01
The date vehicle was reported as stolen.
police_force
e.g. COUNTY POLICE
The investigating police force.
exceeds_maximum_age_months
e.g. true
Has the maximum age of the vehicle been exceeded.
exceeds_maximum_number_keepers
e.g. true
Has the maximum number keepers of the vehicle been exceeded.
exceeds_maximum_keeper_changes_last_12_months
e.g. false
Has the maximum number keepers of the vehicle in the last 12 months been exceeded.
is_less_than_minimum_months_since_last_keeper_change
e.g. false
Was the last keeper within the minimum number of months change specified.
dvla_manufacturer_desc
e.g. NISSAN
DVLA manufacturer description
dvla_model_desc
e.g. QASHQAI ACENTA PREMIUM DCI
DVLA model description
dvla_fuel_desc
e.g. DIESEL
DVLA fuel description
dvla_body_desc
e.g. 5 DOOR HATCHBACK
DVLA body description
registration_date
e.g. 2020-01-01
Date the vehicle was first registered in the UK
manufactured_year
e.g. 2020
Year of manufacture.
vehicle_identification_number
e.g. ABCDE123456F78910
Vehicle identification number (VIN).
first_registration_date
e.g. 2020-01-01
Date of first registration
used_before_first_registration
e.g. false
Vehicle was used before DVLA/DLNI first registration
co2_gkm
e.g. 123
CO2 in g/km
engine_number
e.g. A12345678
Vehicle engine number
scrapped_date
e.g. 2020-01-01
The date the vehicle was scrapped.
exported_date
e.g. 2020-01-01
Date vehicle was exported
colour
e.g. RED
Exterior colour of vehicle
v5c_qty
e.g. 1
The v5c quantity
date_v5c_issued
e.g. 2020-01-01
The date the v5 was issued
number_previous_keepers
e.g. 1
The number of previous keepers.
date_of_last_keeper_change
e.g. 2020-01-01
The date of last keeper change.
error
e.g. If there is an error the message would go here
Details of what went wrong with the api call
Status Codes
200
success, chargeable
Request has been successfully received and a response has been sent.
202
accepted, non-chargeable
Request has been received and accepted for processing, but the action has not yet been completed.
204
no content, non-chargeable
Request has been successfully received but there is no content to return e.g. if an invalid VRM has been sent.
206
partial content, non-chargeable
Request has been successfully received but limited content is returned e.g. if an invalid VRM has been sent.
400
bad request, non-chargeable
Request was not received e.g. if any required parameters are missing.
403
forbidden, non-chargeable
Request was rejected e.g. if the API key is invalid or the service is not enabled.
429
too many requests, non-chargeable
API key rate limit/quota has been exceeded.
500
internal server error, non-chargeable
We are unable to process the request e.g. if the API is under extremely heavy load.
503
service unavailable, non-chargeable
Service is temporarily unavailable. Contact help@oneautoapi.com