> 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/motor-check-redbook.md). # Motor Check + RedBook A Motor Check with RedBook codes attached. `GET` `https://robot.motorweb.co.nz/b2b/mc2rb/{version}` Returns the same data as a [Motor Check](/motorweb/motorweb-reports/motor-check.md), plus a `redbook-codes` element holding the RedBook models that match the vehicle. {% hint style="warning" %} This path has no `/generate/` segment. It is `/b2b/mc2rb/{version}`, not `/b2b/mc2rb/generate/{version}`. {% endhint %} ### **Environments**

Environment	Base URL
UAT	`https://robot.uat.motorweb.co.nz`
Production	`https://robot.motorweb.co.nz`

### **Versions**

Version	Notes
1.0	Current version. The only version accepted.

### **Access** Your account must hold the Motor Check + RedBook 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**

Name	Value
`plateOrVin`	A registration plate (6 characters or fewer) or a VIN (exactly 17 characters). Required unless you supply `vehicleId` or `stockNumber`.
`vehicleId`	The ID of a vehicle already held under your account.
`stockNumber`	Your own reference for a vehicle already held under your account.
`specificReason`	Why private owner information is required, under section 241 of the Land Transport Act. Mandatory on most accounts.
`widen`	Optional boolean. Defaults to `false`. See below.

#### widen RedBook matching filters candidate models on VIN, model code, engine, body style, capacity, doors, seats, fuel type, transmission, import status and other criteria. * `widen=false` (default) applies the standard filter chain. If no model matches, no codes are returned. * `widen=true` relaxes criteria whenever a filter removes every remaining candidate. This finds a match more often, at the cost of accuracy. ### **Response** {% tabs %} {% tab title="200" %} ```xml

5-Apr-2011

Active

New

5-Apr-2011

31-Dec-2016 Licence (registration sticker) expired on 31-Dec-2016 Licence expired

Licence

1-Dec-2015

Yes

2011

Mitsubishi ASX 2WD 2.0P CVT Sport

ASX

Wagon

Passenger Car/Van

JMFXTGA2WBZ001111

BLACK

1,998

Petrol

CVT

BE4SP45;

2.0P/CVT/SV/5S

NZVMITS2011AEAA

MITS11AA

2011 Mitsubishi ASX 2WD Wagon 5dr CVT 6sp 2.0i

``` {% endtab %} {% tab title="400" %} ``` No vehicle identifiers specified ``` or ``` There are no matching models in the RedBook database ``` {% endtab %} {% endtabs %} ### **Fields worth noting**

Element	Description
`redbook-codes`	Wraps the matches. Absent when no model matched.
`redbook-ref`	Repeats. One entry per matching RedBook model. More than one entry means the vehicle could not be narrowed to a single model.
`fifteen-digit`	The 15-character RedBook code.
`eight-digit`	The 8-character RedBook code.

{% hint style="info" %} The root element is `mc2rb`, not `vir`. The vehicle data sits inside `vir-analysis`, the same as a Motor Check. {% endhint %} ### **XSD** {% embed url="" %} ### **Errors** Errors return `text/plain` with the message in the body. A `MotorWeb-Error-Code` response header carries a machine-readable code.

HTTP	Error code header	Message and cause
400	`BAD-PARAM`	`No vehicle identifiers specified`
400	`BAD-PARAM`	`Cannot specify both vehicleId and plateOrVin`
400	`BAD-PARAM`	`specificReason not specified`
400	`NO-MATCH`	`There are no matching models in the RedBook database` — try `widen=true`.
400	`NOT-FOUND`	`Vehicle not found for vehicle ID: {id}`
400	`BAD-ACCOUNT`	Your account does not hold the Motor Check + RedBook privilege.
400	`MC-21`, `MC-22`, `MC-23`	Errors passed through from NZTA.
400	`EXTERNAL-ISSUE`	NZTA is unavailable. Check Ping and retry.
401	—	Certificate authentication failed.

**Example cURL command:** ```bash # Production curl --cert-type P12 --cert motorwebnz.p12: \ "https://robot.motorweb.co.nz/b2b/mc2rb/1.0?plateOrVin=ABC123&specificReason=state+your+specific+reason" # With widened matching curl --cert-type P12 --cert motorwebnz.p12: \ "https://robot.motorweb.co.nz/b2b/mc2rb/1.0?plateOrVin=ABC123&specificReason=state+your+specific+reason&widen=true" ``` **Notes:** * Authentication is mutual TLS with a MotorWeb-issued client certificate * Your account must hold the Motor Check + RedBook privilege * `redbook-ref` repeats. Handle more than one match * For RedBook valuations rather than codes, see [Chassis Check + RedBook Valuation](/motorweb/motorweb-reports/chassis-check-redbook-valuation.md) or [RedBook Match and Valuation](/motorweb/additional-services/redbook-match-and-valuation.md)