LogoLogo
API StatusSupportPostmanContact Us
🇲🇾 MY AutoGrab API Doc
🇲🇾 MY AutoGrab API Doc
  • AutoGrab Basics
    • AutoGrab Developer Hub
    • Integration Overview
    • API Test Cases
    • FAQ
  • Authentication
    • API Key
    • OAuth Authentication
  • Vehicle Search
    • Vehicle Searching Basics
    • Plain-text Search
    • Registration Plate Search
    • Facet Search
    • Vehicle ID Search
    • Marketplace ID Lookup
  • Sourcing
    • Sourcing Basics
    • Market Overlay
    • Market Statistics
    • Stock Feeds
  • Vehicle Data
    • Vehicle Data Basics
    • Detailed Specifications Data
    • Vehicle History
    • Factory Build Data
  • Valuation
    • Valuation Basics
    • Valuation Predict
    • Residual Valuations
    • Max Offer Configuration
    • Gauge API
  • Embeddable Products
    • Embeddable Basics
    • Gauge Widget
    • Valuation Widget
    • Market Overlay Widget
  • REPORTS
    • Car Analysis
    • Certificates
  • Customer Recapture
    • Customer Recapture API
    • Webhooks
  • Insurance
    • Pre-Accident Valuation
Powered by GitBook
LogoLogo

Links

  • Terms of Use

2024 © AutoGrab Pty Ltd. ABN 79 638 468 569

On this page
  • CarAnalysis
  • White Label

Was this helpful?

Export as PDF
  1. REPORTS

Certificates

Generate certificates to meet you pricing or vehicle info needs.

PreviousCar AnalysisNextCustomer Recapture API

Last updated 3 months ago

Was this helpful?

The certificate's endpoint is officially deprecated in favour of theendpoint for the purpose of generating Car Analysis Reports

The documentation on this page is for historical reference only and should not be used for any integration development.

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 , 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.

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"
}

Car Analysis
Valuation ID
269KB
Standard CarAnalysis.pdf
pdf
269KB
Example CarAnalysis Excluding Valuation.pdf
pdf
92KB
CarAnalysis Standalone.pdf
pdf