Allows you to query vehicle details, ownership details and securities details.
Request parameters:
- plate — plate or VIN
- key — API key
- basic — include basic information
- owners — include ownership history information (optional and defaults to ‘false’)
- owner — include current owner details
- ppsr — include PPSR (money owing information)
- rucs — include RUC history
- motfuel — include Motfuel/FuelSaver information
- translate — provide translations for the raw encoded values in the separate tags prefixed with ‘h’ (optional and defaults to ‘false’)
- cache — enable lookup of basic information in CarJam cache before going to NZTA
Request example:
http://www.carjam.co.nz/api/car/?plate=PLATE&key=YOUR_API_KEY[&basic=(1|0)][&translate=(1|0)][&owners=(1|0)][&owner=(1|0)][&rucs=(1|0)][&ppsr=(1|0)][&motfuel=(1|0)][&cache=(0|1|date string)]
Response
Error
If there is an error an xml returned will have a top-level tag ‘error’. Here is an example:
<error>
<code>-1</code>
<message>Requires an API key</message>
<class>wterror</class>
</error>
Success
For successful results a top level tag of ‘message’ is returned. Message will contain the following sub-tags:
- idh — includes free and basic facts details
- ioh — includes ownership information when requested
- ppsr — includes PPSR search summary and how many financing statements are registered
- ppsr_details — includes the details of each financing statement (up to 50)
- motfuel — includes FuelSaver details
Free and basic facts example
Some values are coded. Follow the links to the translation tables. You can also add &translate=1 which will return an extra message’s sub-tag ‘hidh’ containing the same information but in more human-readable form.
<message>
<idh>
<header>
<error_codes __array="true">0</error_codes>
<continuous_flag>Y</continuous_flag>
<not_found/>
</header>
<response_version>1</response_version>
<vehicle>
<plate>BEY656</plate>
<replacement_plate/>
<plate_type>ST</plate_type>
<year_of_manufacture>2003</year_of_manufacture>
<make>FIAT</make>
<model>DUCATO</model>
<submodel>2.8 CAB CHASSIS</submodel>
<body_style>LV</body_style>
<vehicle_type>08</vehicle_type>
<vin>7A8H60F0796016938</vin>
<chassis>RZH1020016938</chassis>
<engine_no>3729408</engine_no>
<main_colour>White</main_colour>
<second_colour/>
<cc_rating>2800</cc_rating>
<power>94</power>
<country_of_origin>ITA</country_of_origin>
<previous_country_of_registration/>
<assembly_type>1</assembly_type>
<gross_vehicle_mass>3500</gross_vehicle_mass>
<no_of_seats>7</no_of_seats>
<fuel_type>02</fuel_type>
<alternative_fuel_type>00</alternative_fuel_type>
<reported_stolen>Y</reported_stolen>
<reliable_odometer>N</reliable_odometer>
<date_of_latest_wof_inspection/>
<result_of_latest_wof_inspection/>
<expiry_date_of_last_successful_wof/>
<expiry_date/>
<maximum_rated_towed_mass_for_unbraked_trailer>750</maximum_rated_towed_mass_for_unbraked_trailer>
<maximum_rated_towed_mass_for_braked_trailer>2000</maximum_rated_towed_mass_for_braked_trailer>
<tare_weight>2700</tare_weight>
<no_of_axles>2</no_of_axles>
<axle_type>2</axle_type>
<wheelbase>3700</wheelbase>
<front_axle_group_rating>1850</front_axle_group_rating>
<rear_axle_group_rating>2120</rear_axle_group_rating>
<date_of_first_registration_in_nz>1048680000</date_of_first_registration_in_nz>
<registration_status>A</registration_status>
<licence_expiry_date>1227524400</licence_expiry_date>
<licence_type>L</licence_type>
<date_of_issue_for_latest_licence>1192359600</date_of_issue_for_latest_licence>
<time_of_issue_for_latest_licence/>
<continuous_licence>Y</continuous_licence>
<cause_of_latest_registration>N</cause_of_latest_registration>
<vehicle_usage>05</vehicle_usage>
<latest_odometer_reading>188612</latest_odometer_reading>
<date_of_odometer_reading>1142856000</date_of_odometer_reading>
<subject_to_wof>N</subject_to_wof>
<subject_to_cof_inspection>Y</subject_to_cof_inspection>
<subject_to_ruc>Y</subject_to_ruc>
<cancellation_date_of_registration/>
<date_of_last_registration>1048680000</date_of_last_registration>
<plates __array="true">
<registration_plate>BEY656</registration_plate>
<effective_date>1048680000</effective_date>
</plates>
<plates>
<registration_plate>ABC1234</registration_plate>
<effective_date>1028680000</effective_date>
</plates>
<ruc_licence_type>D</ruc_licence_type>
<ruc_vehicle_type>001</ruc_vehicle_type>
<ruc_licence_issue_date>1135162800</ruc_licence_issue_date>
<ruc_licence_start>196000</ruc_licence_start>
<ruc_licence_end>216000</ruc_licence_end>
<latest_odometer_reading_unit>K</latest_odometer_reading_unit>
<latest_odometer_reading_source_code>IC</latest_odometer_reading_source_code>
<current_vehicle_odometer_unit>K</current_vehicle_odometer_unit>
<imported_damaged>Y</imported_damaged>
<cancellation_reason_code/>
<registered_overseas>N</registered_overseas>
<day_of_first_registration_overseas/>
<month_of_first_registration_overseas>0</month_of_first_registration_overseas>
<year_of_first_registration_overseas/>
<inspection_agent/>
</vehicle>
<odometer_history __array="true">
<odometer_date>1142856000</odometer_date>
<odometer_reading>188612</odometer_reading>
<odometer_unit>K</odometer_unit>
<odometer_source>IC</odometer_source>
</odometer_history>
<odometer_history>
<odometer_date>1066042800</odometer_date>
<odometer_reading>128</odometer_reading>
<odometer_unit>K</odometer_unit>
<odometer_source>IC</odometer_source>
</odometer_history>
</idh>
</message>
Notes
- If attribute __array=”true” is present it indicates that it shall be an array of items (even if it’s just one item present)
- All times and dates is represented as UNIX time stamp.
- Click on the tag links to see allowed encoded values. There is also a table of “Tags and Codes”.