Generate PDF reports of vehicles for users
AutoGrab can service PDF reports over API that can then be handled in your application.
The report endpoint has the ability to determine the content of the report based on the information that is handed to it.
The CarAnalysis report contains a stock photo and vehicle-specific information. This is generated using the VIN or Registration and State. Provide all three wherever possible to obtain the most accurate information possible for report generation.
A valuation can be included in the report generation by adding the following data. What data is used for the valuation is determined on priority:
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.
A lead ID is obtained from the Sourcing endpoint and is the tier 2 valuation source.
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.
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.
A PPSR report provided by the government will be attached to the end of the PDF
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.
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.
It will populate a table with built-data information, which is the same data obtainable from the Factory Build Dataendpoint in PDF format.
Not currently implemented
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.
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.
Retrieve your CarAnalysis report
ID of the CarAnalysis report
The region to perform this request in
Success
The certificate url of the CarAnalysis record
Generate a CarAnalysis report
The region to perform this request in
request body
The ID of a previous valuation
The ID of a lead
The odometer reading of the vehicle, if known
The sources of the CarAnalysis report
Success
The certificate url of the CarAnalysis record