Reports

Deliver CarJam Reports. Use a Development Connection. Charge an Account.

Test vs Production site

• Production: https://www.carjam.co.nz/
• Test: https://test.carjam.co.nz/

Prerequisites

• Register as a user on CarJam (test first, then production)
• Open an Account (test then production) and generate Account API Key.
• Get a development connection (test and when ready production) and generate Developer API Key.

Common Parameters

• key=API Key
• account_key=Account Key

Create Report

Endpoint URL
/a/report:create

Request: GET (or POST) Parameters

• plate=PLATE|VIN
• basic=1 to include basic vehicle information (to disable basic=0) available only if you are reselling into non-consumer market
• owners=1 to include ownership history. available only if you are reselling into non-consumer market.
• s241_purpose=PURPOSE to specify the intended purpose of personal ownership enquiry as required by NZTA. This parameter is required when owners=1 is specified AND the account and user are s241 authorized (for personal ownership details). The applicable purpose values for your account can be found in the member dashboard under the s241 section.
• ppsrf=1 to include PPSR (money owing information). available only if you are reselling into non-consumer market.
• ruch=1 to include RUC history. available only if you are reselling into non-consumer market.
• fullhistory=1 for CarJam Full History report when you are reselling into a consumer market
• dgfull=1 to include NZ Market Valuation

Example

/a/report:create?key=&account_key=Account_Key&basic=1&ppsrf=1&plate=PLATE

to create a report with basic and money owing information.

Response

{
    "ref": "35C4E91A",
    "completed": null,
    "created": 1470345253,
    "price_cents": 2334,
    "vehicle_title": ""
}

Two important fields to note:

• ref is a reference for this created report
• completed will be set to true when report is ready. Otherwise, you will have to keep polling.

Retrieve Report

Endpoint URL
/a/report:get

Request: GET Parameters

• ref=

Response

The report is ready when completed field is true. Otherwise, you will have to keep polling. There is an HTTP header Refresh which helps you to decide when to check again.

Examples

• Basic vehicle data only
• Report with basic, owners and money owing data
• Report with basic, owners, money owing data and valuation

Error Responses

{
    "code": -1,
    "message": "Missing Developer Key."
}