Car Analysis

Generate PDF reports of vehicles for users

AutoGrab can service PDF reports over API that can then be handled in your application.

Generate a CarAnalysis report

post

Generate a CarAnalysis report

Authorizations

ApiKeyAuth

ApiKeystringRequired

Query parameters

regionstring · enumOptional

The region to perform this request in

Possible values:

Body

application/json

vinstringOptional

regostringOptional

statestringOptional

pricing_record_idstringOptional

The ID of a previous valuation

lead_idstringOptional

The ID of a lead

odometernumberOptional

The odometer reading of the vehicle, if known

marketplace_image_urlstringOptional

public url to marketplace image to display on report

marketplace_pricenumberOptional

price to display in replacement of a valuation

marketplace_price_typestring · enumOptional

to display what type of marketplace price is being provided

Possible values:

brandstringOptional

Controls theming of the report

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

post

/v2/reports/car-analysis

HTTPcURLJavaScriptPython

POST /v2/reports/car-analysis HTTP/1.1
Host: api.autograb.com.au
ApiKey: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "vin": "text",
  "rego": "text",
  "state": "text",
  "pricing_record_id": "text",
  "lead_id": "text",
  "odometer": 1,
  "marketplace_image_url": "text",
  "marketplace_price": 1,
  "marketplace_price_type": "EGC",
  "brand": "text",
  "sources": [
    "ppsr"
  ]
}

{
  "success": true,
  "certificate": {
    "id": "text",
    "status": "pending",
    "url": "text"
  }
}

Report Features

The report endpoint has the ability to determine the content of the report based on the information that is handed to it.

Vehicle Identification

Where-ever possible it is recommended to provide as much vehicle information as possible. What the data is used for is controlled by the sources array.

• VIN

• Registration/State - If registration is provided, state is mandatory

• Odometer

Valuation

A previous valuation can be included in the report generation by adding the following data. What data is used for the valuation is determined on priority:

Price Record ID

If the pricing record ID is passed in the request, the associated valuation will populate the report. A valuation ID is generated using the Valuation endpoint and contained in the response. So, a valuation call needs to be performed before generating the report.

Lead ID

A lead ID is obtained from the Sourcing endpoint and is the tier 2 valuation source.

Odometer

If no Pricing or Lead ID is provided but an odometer is, the odometer will be used to perform a valuation with the same logic as the Valuation endpoint.

Brand

Controls White labeling of the report

Marketplace Specific Fields

When using reports integrated within a marketplace additional fields can be included in the request to allow for data from the marketplace listing to be displayed in the report.

• Marketplace Image URL

  • URL to a public image from the marketplace listing, will replace the stock photo contained in a standard CarAnalysis Report

The Marketplace Image URL must end in a jpeg/jpg format. Magic links are not currently supported. i.e. www.marketplace.com/listing/vehicleimage.jpg. listing/vehicleimage/ will fail to generate.

• Marketplace Price

  • The price displayed on the listing on the marketplace.

  • Note it is not possible to use the marketplace price and the valuation source in the same report.

• Marketplace Price Type

  • Displays the type of price for the Marketplace price being provided.

Sources

What sources are available with your account are controlled at a feature level. To access particular sources, don't hesitate to get in touch with your AutoGrab representative.

The sources enum determines additional features that are included within the report PDF, the report is modular. However, it is recommended to include Vehicle Details at a minimum

PPSR

A PPSR report provided by the government will be attached to the end of the PDF

Vehicle Details

Populates the Vehicle Information at the top of the report. It is recommended that vehicle details always be included as it contains the minimum identifiable information into the report.

Odometer History

It will display a table of all recorded odometer listings that AutoGrab has. Based on the odometer from previous listings, it can highlight the possibility of odometer rollback events.

Build Data

It will populate a table with built-data information, which is the same data obtainable from the Factory Build Dataendpoint in PDF format.

Fitted Options

Not currently available

Valuation

Whether to include an AutoGrab valuation in the report

Report White Labeling

AutoGrab can create custom-branded templates for the Car Analysis report. Please reach out to your AutoGrab representative for more information on building a custom template.

Retrieve your CarAnalysis report

get

Retrieve your CarAnalysis report

Authorizations

ApiKeyAuth

ApiKeystringRequired

Path parameters

idstringRequired

ID of the CarAnalysis report

Query parameters

regionstring · enumOptional

The region to perform this request in

Possible values:

Responses

200

Success

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

get

/v2/reports/car-analysis/{id}

HTTPcURLJavaScriptPython

GET /v2/reports/car-analysis/{id} HTTP/1.1
Host: api.autograb.com.au
ApiKey: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "certificates": {
    "id": "text",
    "status": "pending",
    "url": "text"
  }
}

Obtaining Generated Reports

Due to the Car Analysis report reaching out to external endpoints and co-lating data the report is not generated immediately. It is recommended that the ID for the report be stored for future use or that the PDF be obtained again later.

To obtain the requested report, pass the ID from the POST to the get endpoint.

It is highly recommended that you delay the Get by at least 20 seconds before attempting the request to allow sufficient time for the report to be generated.

Example Report

269KB

Standard Car Analysis.pdf

PDF

Open