Reports

Vehicle inspection records, their damage data, and the comment threads on them.

Base URL

https://api.reportauto.eu

Reports

A report is the vehicle inspection record behind a listing or claim — the photos, damage locations and condition data captured against a plate.

Create a report

POST/v2/reports

Opens a report for a registration plate. Uploads and damage data are attached to the returned report ID.

Authentication API key

Parameters

regstringRequired

Registration plate the report is for.

cURL

1curl -X POST "https://api.reportauto.eu/v2/reports" \
2  -H "Authorization: API_KEY $CAROOM_API_KEY" \
3  -H "Content-Type: application/json" \
4  -d '{ "reg": "039vmk" }'

Retrieve a report

GET/v2/reports/:report_id

Returns the report with its uploads, damage locations and condition data.

Authentication API key

Path parameters

report_idintegerRequired

ID of the report.

cURL

1curl "https://api.reportauto.eu/v2/reports/4290" \
2  -H "Authorization: API_KEY $CAROOM_API_KEY"

Update a report

PATCH/v2/reports/:report_id

Updates the report, most often to record where on the vehicle damage was found.

Authentication Access token or API key

Path parameters

report_idintegerRequired

ID of the report.

Parameters

damage_locationsarray

Damage positions on the vehicle. Send an empty array to clear them.

cURL

1curl -X PATCH "https://api.reportauto.eu/v2/reports/7732" \
2  -H "Authorization: $CAROOM_ACCESS_TOKEN" \
3  -H "Content-Type: application/json" \
4  -d '{ "damage_locations": [] }'

Report comments

Threaded notes on a report, used by inspectors and partners to discuss specific damage or uploads.

Create a comment

POST/v2/reports/:report_id/comments

Adds a comment to a report. Pass comment_id to reply inside an existing thread instead of starting a new one.

Authentication API key

Path parameters

report_idintegerRequired

ID of the report.

Parameters

messagestringRequired

Comment text.

subjectstring

What the comment is about, e.g. "Damage".

comment_idinteger

Parent comment, when replying in a thread.

cURL

1curl -X POST "https://api.reportauto.eu/v2/reports/5620/comments" \
2  -H "Authorization: API_KEY $CAROOM_API_KEY" \
3  -H "Content-Type: application/json" \
4  -d '{
5    "message": "Create a comment thread here",
6    "subject": "Damage",
7    "comment_id": 57
8  }'

List comments on a report

GET/v2/reports/:report_id/comments

Returns every comment thread on the report.

Authentication API key

Path parameters

report_idintegerRequired

ID of the report.

cURL

1curl "https://api.reportauto.eu/v2/reports/5757/comments" \
2  -H "Authorization: API_KEY $CAROOM_API_KEY"

Delete a comment

DELETE/v2/reports/:report_id/comments/:comment_id

Removes a single comment from a report.

Authentication API key

Path parameters

report_idintegerRequired

ID of the report.

comment_idintegerRequired

ID of the comment.

cURL

1curl -X DELETE "https://api.reportauto.eu/v2/reports/5620/comments/62" \
2  -H "Authorization: API_KEY $CAROOM_API_KEY"