Imagin8 API Specification
Integration for Real time Intelligence

Obtaining Values for a Specified Vehicle Code

API Specification


Unless specified as Optional, all parameters are mandatory
API Suite: eValue8
Purpose: Returns the New, Retail and Trade values for a specified vehicle code and year model
Web Service: getvalues.php
Root URL: Live https://www.evalue8.co.za/evalue8webservice/
Root URL: Sandbox https://www.evalue8.co.za/evalue8webservice/sandbox/
Parameters Parameter Name Parameter Description
mmCode8-digit M&M Code, Including leading zeroes
nGuideGuide as numeric value in the format mmyyyy, no leading zeroes
mmYearYear Model of the vehicle
datasource (Optional)Valid values: "TRANSUNION". This optional parameter has been included due the possibility of the web services switching between multiple service providers. If omitted, Imagin8 will default to TRANSUNION, or the datasource associated with the clientref parameter where this is a reqiured parameter.
softThe Calling Application Name. The vendor will provide this detail to Imagin8
comidThe Computer Name of the workstation initiating the call
unameUsername selected by the customer, or assigned by Imagin8. This is a company-wide username across all users in the customer organisation.
passwordPassword selected by the customer, or assigned by Imagin8.
clientrefThe customers organisation's unique client number on Imagin8's customer records. This is stored on the eValue8 Application database files and is used to validate the caller's subscription validity
guide (Optional)If passed as a parameter, the value returned will be located from this guide. If no parameter is passed, the value is returned from the latest guide. The format is mmyyyy, no leading zeroes.
condition (Optional)

If passed, the condition and mileage are used to adjust the retail and trade values returned. If no value is passed, GO is used. Valid values are:

VP - Very Poor
PO - Poor
GO - Good
VG - Very Good
EX - Excellent

mileage (Optional)

if passed, the mileage and condition are used to adjust the retail and trade values returned. If not value is passed, AV is used. Valid values are:

VL - Very Low
LO - Low
AV - Average
HI - High
VH - Very High

options (Optional)Comma separated list of option codes to be included in the valuation. Option Codes available with a vehicle can be obtained in the GetExtras API call listed in this document. Only the option codes for which values are required should be included in this API call.
credentials (Optional)

Valid values: Live, Bulk, Sandbox. This optional parameter is used to identify the type of lookup. If no value is passed for this parameter, the API will default to Live. Description of parameters:

  • Live (Default) - A transactional lookup, billed at the standard rate
  • Bulk - Billed at 50% of the standard trnsaction rate. This is intended for bulk renewals. Implementation of this parameter within your software must be approved by Imagin8 prior to going live
  • Sandbox - Used to test your implementation of the API. Results returned are exactly the same as live results, but New, Retail and Trade values are either Zero or Old values (as determined by TransUnion).
vin (Optional)If included, the VIN number will be used to identify the vehicle instead of the Mead Code. VIN lookups are billed at a different transaction rate to standard Mead code lookups. VIN lookups have about an 80% success rate in identifying a vehicle (according to stats released by TransUnion).
reg (Optional)If included, the vehicle's Registration number is used to identify the vehicle (instead of the Mead Code) and return the vehicle value. Registration lookups have about a 50% success rate in identifying a vehicle (according to stats released by TransUnion).
lookuptype (Optional)(This parameter is being phased out. Although still available and fully functional, we encourage you to start using the credentials parameter below.) (optional) Valid values: Lookup, Renewal. This optional parameter is used to distinguish between ad-hoc, enquiry type lookups, as opposed to bulk Policy Renewal runs. Use of this option has bearing on the price per transaction.
Call Example https://www.evalue8.co.za/evalue8webservice/getvalues.php?mmCode=04041980&mmYear=2009&soft=eValue8&comid=MyComuterName&unameXYZBrokers&password=MyPassword&clientref=1111&guide=102016&options=1082,43,73&condtition=VG&mileage=LO&credentials=live
Return Values

cMMCode: is the 8-character Vehicle Code, including Leading Zeroes

nGuide: the guide from which the value was obtained in the format mmyyyy with no leading zeroes

nYear: the vehicle year model format yyyy

nNewValue: New value (Zero Decimal places)

nRetailValue: Retail value (Zero Decimal places)

nTradeValue: Trade value (Zero Decimal places)

lEstimatorFlag: value will be 0 or 1. If value is 1, this indicates that the value came from the Estimator tables.

cMake: Vehicle Make as Text string

cModel: Vehicle Model as Text String

cVIN: VIN Number (will only be returned if a VIN was passed as a parameter)

cReg: Registration number (will only be returned if a VIN was passed as a parameter)

Return Values Example {"result":0,"data":{"mmCode":"04030026","mmGuide":"122015","mmYear":"2014","mmNew":"335500","mmRetail":"278900","mmTrade":"251600","mmEstimator":"0","mmMakeShortCode":"AUDI","mvModel":"A3 SPORTBACK 1.4TFSI S"}}