> For the complete documentation index, see [llms.txt](https://motorweb.gitbook.io/motorweb/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://motorweb.gitbook.io/motorweb/motorweb-reports/asset-check.md).

# Asset Check

A VIR with RedBook valuation and fuel economy label in one report.

<mark style="color:green;">`GET`</mark> `https://robot.motorweb.co.nz/b2b/robotAssetCheck/{version}`

Asset Check combines a full vehicle report with a valuation and a fuel economy label. It returns everything a [VIR](/motorweb/motorweb-reports/vir.md) returns, plus RedBook valuation figures, a MotorWeb valuation and the Government fuel economy label.

Use it when you need to assess a vehicle as an asset rather than just check its history.

{% hint style="info" %}
For any transaction generated more than **30 days ago**, private owner and personally identifiable information is suppressed to meet our privacy obligations. Regenerate the report to see current owner information.
{% endhint %}

### **Environments**

<table><thead><tr><th width="214" align="center">Environment</th><th>Base URL</th></tr></thead><tbody><tr><td align="center">UAT</td><td><code>https://robot.uat.motorweb.co.nz</code></td></tr><tr><td align="center">Production</td><td><code>https://robot.motorweb.co.nz</code></td></tr></tbody></table>

### **Versions**

<table><thead><tr><th width="170" align="center">Version</th><th>Notes</th></tr></thead><tbody><tr><td align="center"><strong>2.0</strong></td><td><strong>Newest version.</strong> Adds <code>listing-history</code> and a RedBook-style <code>valuation</code> block. Makes the valuation elements optional.</td></tr><tr><td align="center">1.2</td><td>Long-standing default. Adds <code>imported-damaged</code> and <code>reported-stolen</code>.</td></tr><tr><td align="center">1.1 and earlier</td><td>Legacy versions, still accepted: 1.1 adds <code>mvrPortalApiResult</code>; 1.0 is the original release.</td></tr></tbody></table>

Each version has its own schema, `asset-check-{version}.xsd`.

{% hint style="info" %}
Version 1.2 is the long-standing default and is what most integrations use. Version **2.0 is the newest supported version** and is the one to target for new work.
{% endhint %}

### **Access**

Your account must hold the Asset Check privilege. Without it the request returns `400` with `MotorWeb-Error-Code: BAD-ACCOUNT`.

### **Headers**

No request headers are required.

| Result  | Content type |
| ------- | ------------ |
| Success | `text/xml`   |
| Error   | `text/plain` |

### **Body**

```
< no body required >
```

### **Query Parameters**

<table><thead><tr><th width="180">Name</th><th>Value</th></tr></thead><tbody><tr><td><code>plateOrVin</code></td><td>A registration plate (6 characters or fewer) or a VIN (exactly 17 characters). Required unless you supply <code>stockNumber</code>.</td></tr><tr><td><code>plate</code></td><td>As above, restricted to a plate.</td></tr><tr><td><code>vin</code></td><td>As above, restricted to a VIN.</td></tr><tr><td><code>stockNumber</code></td><td>Your own reference for a vehicle already held under your account.</td></tr><tr><td><code>specificReason</code></td><td>Why private owner information is required, under section 241 of the Land Transport Act. Mandatory on most accounts.</td></tr></tbody></table>

### **Response structure**

Elements appear in this order. The schema uses a sequence, so order is significant.

<table><thead><tr><th width="240">Element</th><th width="110" align="center">1.0 - 1.2</th><th width="110" align="center">2.0</th><th>Description</th></tr></thead><tbody><tr><td><code>fuel-economy-label</code></td><td align="center">Optional</td><td align="center">Optional</td><td>The Government fuel economy label data. See <a href="/motorweb/additional-services/fuel-economy-labels.md">Fuel Economy Labels</a>.</td></tr><tr><td><code>vir-analysis</code></td><td align="center">Required</td><td align="center">Required</td><td>The vehicle, owner, history and security interests. Same structure as <a href="/motorweb/motorweb-reports/vir.md">VIR</a>.</td></tr><tr><td><code>valuation</code></td><td align="center">Required</td><td align="center">Required</td><td>RedBook wholesale and retail values.</td></tr><tr><td><code>motorwebValuationResult</code></td><td align="center"><strong>Required</strong></td><td align="center">Optional</td><td>The MotorWeb valuation, derived from market data.</td></tr><tr><td><code>numberValuationResults</code></td><td align="center"><strong>Required</strong></td><td align="center">Optional</td><td>How many valuation results were found.</td></tr><tr><td><code>listing-history</code></td><td align="center">—</td><td align="center">Optional</td><td>Trade Me listing history. Version 2.0 only.</td></tr><tr><td><code>mvrPortalApiResult</code></td><td align="center">Optional</td><td align="center">Optional</td><td>Vehicle classification data. Added in 1.1, absent from 1.0.</td></tr></tbody></table>

{% hint style="info" %}
`motorwebValuationResult` and `numberValuationResults` are **required** in versions 1.0 to 1.2 and **optional** in 2.0. If you upgrade to 2.0, stop assuming they are present.
{% endhint %}

### **Response**

{% tabs %}
{% tab title="200" %}

```xml
<asset-check billing-user="MotorWeb Development" id="-1268760972" reference="25cb8247" timestamp="2025-03-07T16:51:26.522" user="MotorWeb Development">
    <fuel-economy-label version="1.0">
        <Explanation>
Cost per year is an estimate based on petrol price of $2.80 per litre and an average distance of 14000 km. Emissions and Energy Economy figures standardised to 3P WLTP.
        </Explanation>
        <LabelVersion>2023(a)</LabelVersion>
        <LabelID>V:JMFXTGA2WBZ004048:070325</LabelID>
        <Make>MITSUBISHI</Make>
        <Model>ASX</Model>
        <SubModel>SPORT</SubModel>
        <FuelStars>4</FuelStars>
        <FuelConsumption>8.8</FuelConsumption>
        <YearlyCost>3450</YearlyCost>
    </fuel-economy-label>
    <vir-analysis version="3.0">
        <vehicle>
            <imported-damaged>No</imported-damaged>
            <reported-stolen value="false">No</reported-stolen>
            <registration>
                <first-registration-date-in-new-zealand value="2011-04-05">5-Apr-2011</first-registration-date-in-new-zealand>
                <registration-status code="A">Active</registration-status>
                <cause-of-last-registration code="N">New</cause-of-last-registration>
                <registered-overseas value="false">No</registered-overseas>
                <last-registration-date value="2011-04-05">5-Apr-2011</last-registration-date>
            </registration>
            <licence>
                <expiry-date value="2016-12-31">
31-Dec-2016
                    <alert msg-code="VIR-07" type="alert">
                        <head>
Licence (registration sticker) expired on 31-Dec-2016
                        </head>
                        <inline>Licence expired</inline>
                    </alert>
                </expiry-date>
                <licence-type code="L">Licence</licence-type>
                <issue-date value="2015-12-01">1-Dec-2015</issue-date>
                <issue-time value="00:00:00+13:00">00:00</issue-time>
                <continuous value="true">Yes</continuous>
                <registration-lapse-date value="2017-12-31">31-Dec-2017</registration-lapse-date>
            </licence>
            <wof>
                <last-inspection-date value="2016-05-11">11-May-2016</last-inspection-date>
                <last-inspection-result code="P">Passed</last-inspection-result>
                <expiry-date value="2017-05-11">
11-May-2017
                    <alert msg-code="VIR-10" type="alert">
                        <head>Warrant Of Fitness (WOF) expired on 11-May-2017</head>
                        <inline>WOF expired</inline>
                    </alert>
                </expiry-date>
                <is-subject-to value="true">Yes</is-subject-to>
            </wof>
            <cof>
                <is-subject-to value="false">No</is-subject-to>
            </cof>
            <ruc data-retrieved="false">
                <is-subject-to value="false">No</is-subject-to>
            </ruc>
            <year-of-manufacture value="2011">2011</year-of-manufacture>
            <make>Mitsubishi</make>
            <model>ASX 2WD 2.0P CVT Sport</model>
            <mvr-model>ASX</mvr-model>
            <body-style code="SW">Wagon</body-style>
            <vehicle-type code="7">Passenger Car/Van</vehicle-type>
            <vin>JMFXTGA2WBZ004048</vin>
            <engine-number>4B11 HH3609</engine-number>
            <main-colour>BLACK</main-colour>
            <cc-rating unit="cc" value="1998">1,998</cc-rating>
            <power unit="KW" value="112">112</power>
            <country-of-origin code="JPN">Japan</country-of-origin>
            <assembly-type code="1">Imported Built-Up</assembly-type>
            <gross-vehicle-mass unit="Kg" value="1970">1,970</gross-vehicle-mass>
            <number-of-seats value="5">5</number-of-seats>
            <fuel-type code="1">Petrol</fuel-type>
            <max-rated-towed-mass-for-unbraked-trailer unit="Kg" value="750">750</max-rated-towed-mass-for-unbraked-trailer>
            <max-rated-towed-mass-for-braked-trailer unit="Kg" value="1050">1,050</max-rated-towed-mass-for-braked-trailer>
            <wheelbase unit="mm" value="2670">2,670</wheelbase>
            <vehicle-usage code="1">Private Passenger</vehicle-usage>
            <odometer-unit code="K">Km</odometer-unit>
            <imported-damaged>No</imported-damaged>
            <plate current="true" past-plate="0">
                <plate-number>888MIL</plate-number>
                <plate-type code="PP">Personalised</plate-type>
                <effective-date value="2011-04-06">6-Apr-2011</effective-date>
            </plate>
            <plate past-plate="1">
                <plate-number>FUW36</plate-number>
                <effective-date value="2011-04-05">5-Apr-2011</effective-date>
            </plate>
            <odometer-reading latest="true">
                <reading value="15698">15,698</reading>
                <reading-date value="2016-05-11">11-May-2016</reading-date>
                <reading-unit code="K">Km</reading-unit>
                <source code="IW">Warrant of Fitness Inspection</source>
            </odometer-reading>
            <odometer-reading latest="false">
                <reading value="1098">1,098</reading>
                <reading-date value="2012-07-18">18-Jul-2012</reading-date>
                <reading-unit code="K">Km</reading-unit>
                <source code="IW">Warrant of Fitness Inspection</source>
            </odometer-reading>
            <odometer-reading latest="false">
                <reading value="13">13</reading>
                <reading-date value="2011-04-05">5-Apr-2011</reading-date>
                <reading-unit code="K">Km</reading-unit>
                <source code="IW">Warrant of Fitness Inspection</source>
            </odometer-reading>
            <number-of-owners value="2">2</number-of-owners>
            <owner current="true" owner-number="2">
                <sex-company code="M">Male</sex-company>
                <owner-name>FIRSTNAME MIDDLENAME LASTNAME</owner-name>
                <owner-name-parts>
                    <first-name>FIRSTNAME</first-name>
                    <middle-names>MIDDLENAME</middle-names>
                    <last-name>LASTNAME</last-name>
                </owner-name-parts>
                <address label="Street address" usage="physical">
                    <line-1>314 TEST STREET</line-1>
                    <town>WESTPORT</town>
                    <postcode>7825</postcode>
                </address>
                <address-parts usage="physical">
                    <street-number>314</street-number>
                    <street-name>TEST STREET</street-name>
                    <town>WESTPORT</town>
                    <post-code>7825</post-code>
                </address-parts>
                <ownership-date value="2012-08-02">2-Aug-2012</ownership-date>
                <owner-status code="C">Complete</owner-status>
                <ownership-length days="4600">13 years</ownership-length>
            </owner>
            <owner owner-number="1" suppressed-reason="PastIndividual">
                <ownership-date value="2011-04-05">5-Apr-2011</ownership-date>
                <owner-status code="C">Complete</owner-status>
                <ownership-length days="485">16 months</ownership-length>
            </owner>
            <transmission>
                <type code="C" has-gears="false">CVT</type>
                <speeds copy-to="transmission" value="6">6</speeds>
            </transmission>
            <model-code>BE4SP45;</model-code>
            <model-variant>0</model-variant>
            <fuel-economy>
                <star-rating max-stars="6" value="2">2</star-rating>
                <consumption unit="litres/100Km" value="8.8">8.8</consumption>
            </fuel-economy>
            <emissions>
                <co2>
                    <star-rating max-stars="6" value="2">2</star-rating>
                    <quantity unit="g/Km" value="212">212</quantity>
                </co2>
                <pollutants>
                    <star-rating max-stars="6" value="3">3</star-rating>
                    <test-regime>A79/02</test-regime>
                </pollutants>
            </emissions>
            <safety>
                <driver>
                    <star-rating max-stars="5" value="3">3</star-rating>
                    <test-regime>Based on 2024 UCSR rating for 10-16 models</test-regime>
                </driver>
                <abs value="true">Yes</abs>
                <airbags>
                    <value>1st Row Side</value>
                    <value>Driver Knee</value>
                    <value>Front Passenger</value>
                    <value>2nd Row Head</value>
                    <value>1st Row Head</value>
                    <value>Driver</value>
                </airbags>
                <traction-control value="true">Yes</traction-control>
                <brake-assist value="true">Yes</brake-assist>
                <electronic-brake-force-distribution value="true">Yes</electronic-brake-force-distribution>
            </safety>
            <security>
                <factory-alarm value="true">Yes</factory-alarm>
                <central-locking value="true">Yes</central-locking>
                <engine-immobiliser value="true">Yes</engine-immobiliser>
            </security>
            <number-of-doors value="5">5</number-of-doors>
            <number-of-cylinders value="4">4</number-of-cylinders>
            <engine-configuration>In-line</engine-configuration>
            <fuel-delivery>Multi-Point Injected</fuel-delivery>
            <cam-description>DOHC with VVT & Lift</cam-description>
            <induction>Aspirated</induction>
            <torque unit="Nm" value="200">200</torque>
            <engine-location>Front</engine-location>
            <fuel-capacity unit="litres" value="63">63</fuel-capacity>
            <height unit="mm" value="1615">1,615</height>
            <length unit="mm" value="4295">4,295</length>
            <width unit="mm" value="1770">1,770</width>
            <front-tyre-size>215/65 R16</front-tyre-size>
            <rear-tyre-size>215/65 R16</rear-tyre-size>
        </vehicle>
        <security-interests>
            <ignored-secured-vehicle>
Vehicle (plate: POZZUM, vin: null, chassis: BC5-011134) was not searched for but returned in F33P58VV74USV8A8
            </ignored-secured-vehicle>
            <finance_statement fs_no="F33P58VV74USV8A8" version="0">
                <alert msg-code="VIR-271" type="alert">
                    <head>
We have found a financial security which matches aspects of your vehicle. It has probably been used as a security for a loan.
                    </head>
                    <inline>Possible security interest registered</inline>
                </alert>
                <fs_details>
                    <status>REGISTERED</status>
                    <registered_date value="2018-10-07T23:50:01.000">7-Oct-2018 23:50</registered_date>
                    <expiry_date value="2023-10-07T23:50:00.000">7-Oct-2023 23:50</expiry_date>
                </fs_details>
                <secured_party_details sp_group="12295928">
                    <secured_party>
                        <email_address>email@example.com</email_address>
                        <contact_phone>094158500</contact_phone>
                        <address_details>
                            <address type="C">
                                <line1>76 TEST ADDRESS ROAD</line1>
                                <suburb>Albany</suburb>
                                <city_town>Auckland</city_town>
                                <postcode>0632</postcode>
                                <country_code>NZ</country_code>
                            </address>
                        </address_details>
                        <sp_organisation name="GILROSE FINANCE COMPANY LIMITED">
                            <sp_person_acting>
                                <first_name>FIRSTNAME</first_name>
                                <last_name>LASTNAME</last_name>
                                <email_address>email@example.com</email_address>
                                <contact_phone>094151111</contact_phone>
                                <address_details>
                                    <address type="C">
                                        <line1>76 TEST ADDRESS ROAD</line1>
                                        <suburb>Albany</suburb>
                                        <city_town>Auckland</city_town>
                                        <postcode>P O Box 303-018</postcode>
                                        <country_code>NZ</country_code>
                                    </address>
                                </address_details>
                            </sp_person_acting>
                        </sp_organisation>
                    </secured_party>
                </secured_party_details>
                <debtors_details>
                    <debtor type="P">
                        <reference>100103577</reference>
                        <address_details>
                            <address type="C">
                                <line1>76 TEST ADDRESS ROAD</line1>
                                <suburb>Albany</suburb>
                                <city_town>Auckland</city_town>
                                <postcode>0632</postcode>
                                <country_code>NZ</country_code>
                            </address>
                        </address_details>
                        <db_person>
                            <first_name>Test</first_name>
                            <middle_names>Bob</middle_names>
                            <last_name>CUSTOMER</last_name>
                            <date_of_birth>01-01-1901</date_of_birth>
                        </db_person>
                    </debtor>
                </debtors_details>
                <collateral_details>
                    <collateral type="MV">
                        <co_item version="0" version_date="7-Oct-2018 23:50" version_date_value="2018-10-07T23:50:00.000">
                            <coi_description>MITSUBISHI ASX 2011 888MIL BLACK</coi_description>
                            <make>Mitsubishi</make>
                            <model>ASX</model>
                            <year>2011</year>
                            <colour>BLACK</colour>
                            <registration_number>888MIL</registration_number>
                        </co_item>
                    </collateral>
                </collateral_details>
            </finance_statement>
            <number-of-security-interests>1</number-of-security-interests>
        </security-interests>
    </vir-analysis>
    <valuation type="multi">
        <retail>
            <min-value value="5700">$5,700.00</min-value>
            <max-value value="5750">$5,750.00</max-value>
        </retail>
        <wholesale>
            <min-value value="3700">$3,700.00</min-value>
            <max-value value="3750">$3,750.00</max-value>
        </wholesale>
    </valuation>
    <motorwebValuationResult>
        <mwvaluation>
            <status>OK</status>
            <sampleSize>0</sampleSize>
            <averagePrice>17754</averagePrice>
            <averagePriceDisp>$17,754</averagePriceDisp>
            <highPrice>19004</highPrice>
            <highPriceDisp>$19,004</highPriceDisp>
            <lowPrice>16754</lowPrice>
            <lowPriceDisp>$16,754</lowPriceDisp>
            <rrpPriceDisp>Not Recorded</rrpPriceDisp>
            <listingId>5203103129</listingId>
            <listingLink>https://www.trademe.co.nz/5203103129</listingLink>
            <listingPrice>9990</listingPrice>
            <listingPriceDisp>$9,990</listingPriceDisp>
            <listingDate>05-Mar-2025</listingDate>
        </mwvaluation>
    </motorwebValuationResult>
    <numberValuationResults value="1">1</numberValuationResults>
    <mvrPortalApiResult>
        <classification>DEPRECATED</classification>
        <description>DEPRECATED</description>
    </mvrPortalApiResult>
</asset-check>
```

{% endtab %}

{% tab title="400" %}

```
No vehicle identifiers specified
```

or

```
Missing privacy data access reason
```

or

```
A version number must be supplied.
```

{% endtab %}
{% endtabs %}

### **XSD**

Version 1.2:

{% embed url="<https://www.motorweb.co.nz/action/robotSchema/asset-check-1.2.xsd>" %}

Version 2.0:

{% embed url="<https://www.motorweb.co.nz/action/robotSchema/asset-check-2.0.xsd>" %}

### **Retrieving an existing Asset Check**

Asset Check has its own retrieval endpoints. The general [Retrieve Existing Report](/motorweb/motorweb-reports/retrieve-existing-report.md) XML endpoint also returns Asset Check reports, but its HTML and PDF endpoints do not.

<table><thead><tr><th width="360">Path</th><th>Returns</th></tr></thead><tbody><tr><td><code>/b2b/robotAssetCheckXml/{version}</code></td><td><code>text/xml</code></td></tr><tr><td><code>/b2b/robotAssetCheckHtml/{version}</code></td><td><code>text/html</code></td></tr><tr><td><code>/b2b/robotAssetCheckPdf/{version}</code></td><td><code>application/pdf</code></td></tr></tbody></table>

All three accept `reference`, `vehicleId`, `stockNumber`, `plate` or `vin`. Supply exactly one.

{% hint style="info" %}
Only the XML endpoint acts on the version segment. The HTML and PDF endpoints accept any value there and ignore it.
{% endhint %}

```bash
curl --cert-type P12 --cert motorwebnz.p12:<CERTPASSWORD> \
  "https://robot.motorweb.co.nz/b2b/robotAssetCheckPdf/1.2?reference=25cb8247" \
  --output asset-check.pdf
```

### **Errors**

Errors return `text/plain` with the message in the body. A `MotorWeb-Error-Code` response header carries a machine-readable code.

<table><thead><tr><th width="80">HTTP</th><th width="180">Error code header</th><th>Message and cause</th></tr></thead><tbody><tr><td>400</td><td><code>BAD-PARAM</code></td><td><code>No vehicle identifiers specified</code></td></tr><tr><td>400</td><td><code>BAD-PARAM</code></td><td><code>Missing privacy data access reason</code> — supply <code>specificReason</code>.</td></tr><tr><td>500</td><td><code>EXTERNAL-ISSUE</code></td><td><code>A version number must be supplied.</code></td></tr><tr><td>500</td><td><code>EXTERNAL-ISSUE</code></td><td><code>Invalid Version: {version}</code> — accepted versions are 1.0, 1.1, 1.2 and 2.0.</td></tr><tr><td>400</td><td><code>NOT-FOUND</code></td><td>No vehicle matched the identifier you supplied.</td></tr><tr><td>400</td><td><code>BAD-ACCOUNT</code></td><td>Your account does not hold the Asset Check privilege.</td></tr><tr><td>400</td><td><code>MC-21</code>, <code>MC-22</code>, <code>MC-23</code></td><td>Errors passed through from NZTA.</td></tr><tr><td>400</td><td><code>EXTERNAL-ISSUE</code></td><td>NZTA or PPSR is unavailable. Check <a href="/motorweb/motorweb-reports/ping.md">Ping</a> and retry.</td></tr><tr><td>401</td><td>—</td><td>Certificate authentication failed.</td></tr></tbody></table>

**Example cURL command:**

```bash
# Production
curl --cert-type P12 --cert motorwebnz.p12:<CERTPASSWORD> \
  "https://robot.motorweb.co.nz/b2b/robotAssetCheck/1.2?plateOrVin=ABC123&specificReason=state+your+specific+reason"

# UAT
curl --cert-type P12 --cert motorwebnz-uat.p12:<CERTPASSWORD> \
  "https://robot.uat.motorweb.co.nz/b2b/robotAssetCheck/1.2?plateOrVin=ABC123&specificReason=state+your+specific+reason"
```

**Notes:**

* Authentication is mutual TLS with a MotorWeb-issued client certificate
* Your account must hold the Asset Check privilege
* Asset Check returns everything a VIR returns, plus valuation and fuel economy data
* Alerts can appear inside data elements. See [Alerts](/motorweb/motorweb-reports/alerts.md)
* Use the dedicated Asset Check render endpoints for HTML and PDF