Certificates

Generate certificates to meet you pricing or vehicle info needs.

AutoGrab can provide valuation and vehicle info certificates for you to offer through your own products in Australia. To request a certificate use the v2/certificates/generate endpoint and pass in the Valuation ID, that you have previously run as well as the type of certificate you'd like

CarAnalysis

Standard CarAnalysis

For a standard CarAnalysis certificate, you can submit a request as below to receive the payload with summary info as well as the URL of the pdf. This certificate does include a PPSR report. 

{
  "valuation_id": "8c7c62c4-f41b-48f6-8b18-bb09851cd0fe",
  "type": "car-analysis"
}

An example response is below. 

{
    "success": true,
    "certificate": {
        "id": "ef1798ec-e34b-456a-b0d6-16f873071b7a",
        "vin": "WVWZZZAWZKU065305",
        "rego": "BMT038",
        "rego_state": "VIC",
        "url": "https://storage.googleapis.com/ag-ppsr/ef1798ec-e34b-456a-b0d6-16f873071b7a/report.pdf",
        "certificate_created_at": "2023-11-21T09:12:39.000Z",
        "year": "2019",
        "make": "VOLKS",
        "model": "POLO",
        "body_type": "CAR/SEDAN",
        "colour": "WHITE",
        "has_safety_recalls": false,
        "has_secured_parties": true,
        "has_stolen_records": false,
        "has_written_off_records": false
    }
}

If you wish to view an example CarAnalysis including PPSR you can find one below.

CarAnalysis Without Valuation

There may be user experiences where you do not wish to show a valuation on your certificates. You can use car-analysis as the type to request this. The response you will receive will be the same as above but the PDF will not have a valuation present. 

{
  "type": "car-analysis",
  "vin": "WVWZZZAWZKU065305"
}

If you wish to view an example CarAnalysis excluding a Valuation you can find one below.

Car Analysis Standalone

This is a CarAnalysis report without a PPSR or Valuation. To request this certificate type use car-analysis-standalone. 

{
  "type": "car-analysis-standalone",
  "vin": "WVWZZZAWZKU065305"
}

An example response is below

{
    "success": true,
    "certificate": {
        "vin": "WVWZZZAWZKU065305",
        "url": "https://storage.googleapis.com/ag-pdf/1700518730355/report.pdf",
        "certificate_created_at": "2023-11-20T22:18:50.822Z"
    }
}

If you wish to view an example CarAnalysis Standalone you can find one below.

PPSR

Overview

The Personal Property Securities Register (PPSR) is a national online register managed by the federal government. Individuals and organisations can use the PPSR to register and search for debts and other security interests in personal property such as cars, boats and artworks.

In our context you are able to generate a standard report by sending the following params to the certificates endpoint.

{
     "rego": "BMT038",
     "state": "VIC",
    "type": "ppsr"
}

The response will contain structured information about the certificate as well as the PDF itself under the URL parameter. 

{
    "success": true,
    "certificate": {
        "id": "be5ae7cd-c54e-43c5-afdf-1febda8b40ba",
        "vin": "WVWZZZAWZKU065305",
        "rego": "BMT038",
        "rego_state": "VIC",
        "url": "https://storage.googleapis.com/ag-ppsr/be5ae7cd-c54e-43c5-afdf-1febda8b40ba/report.pdf",
        "certificate_created_at": "2023-11-21T09:06:51.000Z",
        "year": "2019",
        "make": "VOLKS",
        "model": "POLO",
        "body_type": "CAR/SEDAN",
        "colour": "WHITE",
        "has_safety_recalls": false,
        "has_secured_parties": true,
        "has_stolen_records": false,
        "has_written_off_records": false
    }
}

If you wish to view an example PPSR you can find one below.

PPSR Updates

To request updates for a Personal Property Securities Register (PPSR) certificate, utilize the endpoint /v2/certificates/{id}/updates by substituting {id} with the unique certificate ID you received upon generation. This allows you to check for any changes to the PPSR.

Upon successful request, a JSON response is returned indicating whether the certificate has expired ("has_expired": true), if any information has changed ("has_changed": true), and provides updated certificate details such as the vehicle's make, model, year, registration details, and whether it has any security interests, stolen records, safety recalls, or written off records.

{
  "success": true,
  "updates": {
    "has_expired": true,
    "has_changed": true,
    "certificate": {
      "id": "d94f4418-0574-48c2-b837-a2c15b16313d",
      "body_type": "CAR/STATION WAGON",
      "colour": "BLUE",
      "make": "SUBARU",
      "model": "OUTBACK",
      "rego": "1CF6ER",
      "rego_state": "VIC",
      "year": "2015",
      "has_safety_recalls": true,
      "has_secured_parties": true,
      "has_stolen_records": true,
      "has_written_off_records": true,
      "url": "string"
    }
  }
}

White Label

We offer white-label of certificates and can configure them to your brand guidelines. Contact us to learn more about the commercial arrangements. Technically you would just need to include a brand parameter in your request body.

{
  "valuation_id": "098a0653-ae84-4a97-a2d8-505896ce3229",
  "type": "car-analysis-standalone",
  "brand": "caranalysis"
}

PreviousPre-Accident Valuation API SuiteNextURL Linking Structure

Last updated