To get live API access, your integration must pass certain tests. This will make sure that it meets our technical standards and best practices.
For each capability, the tests cover Essential and Enhanced functionalities. Your integration must pass at least one of the Essential functionality tests to get live access.
We recommend using the Enhanced functionalities to allow dealers to get the full benefits of the service.
We'll cover the tests for the following functionalities:
-
View future valuation (Essential)
There are three ways we check that tests are successful:
- Demonstration - We will expect you to show us your code or your UI
- Call log validation - We will check your API calls to our service to make sure the call is made correctly
- Database check - We will check our database to see whether the correct attribute has been updated
View Future Valuations (Essential)
If you would like to get a future valuation for a vehicle, use the Future Valuations API.
You'll need to include the following in the body of your Future Valuations API POST request:
- The derivative ID of the vehicle you are doing the request for
- The first registration date
- The future odometer reading miles
- The future valuation date
This will give you projected trade and retail valuations of a vehicle on the future date provided.
| Test | How we'll check it |
| Able to get the projected future valuation for a vehicle via the Future Valuations API | Demonstration and call log validation |
| Able to provide a valid future valuation date no more than 6 years in the future, no more than 15 years after plate end date, and a future odometer reading miles that is no greater than 200,000 | Demonstration |
| Calls should never be repeated on the same day, as future valuations data will only update daily | Demonstration |
| Optional checks | |
| Able to use the Vehicle Taxonomy capability to retrieve a derivative ID - relevant mandatory checks should be fulfilled in the Vehicle Taxonomy Go Live checks | Demonstration |