Create and maintain the listings behind vehicle trade-ins, garage sales, property adverts and claims.
Sellers address their own listing by session key; partners address the same objects by numeric ID.
https://api.reportauto.euA listing — a request, in API terms — is created against /api/requests/self and addressed afterwards by its session key. The same endpoint backs vehicle trade-ins, garage sales, property listings and claims; request_type decides which of the optional objects apply.
Creates a listing and returns it with the session key used to address it later. Send the car and info objects for a vehicle, add details for a garage sale or property, add trade_in for a trade-in, and add qr to bind signs in the same call.
Authentication Access token, or none for public landing-page submissions
Request status
Users's email address
User's phone number
User's full name
Listing price of the vehicle
The type of Listing
QR code value
Send capture link to the user
Vehicle information object
Vehicle condition object
The type of Listing
The type of Listing
Binds QR codes to the listing as it is created, so no separate association call is needed.
Extra fields for garage-sale and property listings.
1curl -X POST "https://api.reportauto.eu/api/requests/self" \
2 -H "Authorization: $CAROOM_ACCESS_TOKEN" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "name": "Jamie Rivera",
6 "status": "PUBLISHED",
7 "phone": "+37256781061",
8 "request_type": "TRADE",
9 "car": {
10 "vincode": "1HGCV1F50JA123456",
11 "vehicle_category": "CAR",
12 "make": "Honda",
13 "model": "Accord",
14 "trim": "EX-L",
15 "style": "SEDAN",
16 "year": "2018",
17 "price": "200000",
18 "mileage": "32000",
19 "fuel": "GASOLINE",
20 "gearbox": "AUTOMATIC",
21 "color": "BLACK"
22 },
23 "car_condition": { "mileage": "20000" },
24 "info": {
25 "postcode": "32244",
26 "radius": 50,
27 "currency_code": "USD",
28 "car_condition_summary": "VERY_GOOD",
29 "user_sale_plan": "CASH_OFFER",
30 "geometry": {
31 "zoom": 2,
32 "location": { "lat": "29.2102306", "lng": "-79.7458845" }
33 }
34 },
35 "trade_in": {
36 "full_name": "Jamie Rivera",
37 "phone": "+37256781061",
38 "email": "jamie@example.com",
39 "country_code": "USA",
40 "country_state_code": "FL",
41 "plate": "728HBB"
42 }
43 }'{
"id": integer,
"unique_id": string,
"report_id": integer,
"qr_code_value": string,
"status": string,
"name": string,
"email": string,
"phone": string,
"inserted_at": string,
"info": {
"address_components": [{
"long_name": string,
"short_name": string,
"types": string[]
}],
"car_availability": enum,
"car_condition_summary": enum,
"currency_code": enum,
"geometry": {
"bounds": {
"northeast": {
"lat": integer,
"lng": integer,
},
"southwest": {
"lat": integer,
"lng": integer,
}
},
"location": {
"lat": integer,
"lng": integer,
},
"zoom": integer,
"location_type": string,
"viewport": {
"northeast": {
"lat": integer,
"lng": integer,
},
"southwest": {
"lat": integer,
"lng": integer,
}
}
},
"prediction": {
"currency": enum,
"suggested_price": integer,
"evaluation": integer,
"key": string,
"range": {
"lower_bound": integer,
"upper_bound": integer,
},
"estimation": {
"cash_offer": {
"excellent": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"fair": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"very_good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
},
"private_offer": {
"excellent": {
"dealer_margin": {
"from": integer,
"to": numintegerber,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"fair": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"very_good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
},
"tradein_offer": {
"excellent": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"fair": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"very_good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
}
}
},
"private": {
"excellent": integer,
"fair": integer,
"good": integer,
"very_good": integer,
},
"retail": {
"excellent": integer,
"fair": integer,
"good": integer,
"very_good": integer,
},
"tradein": {
"excellent": integer,
"fair": integer,
"good": integer,
"very_good": integer,
}
},
"sticker_flow": boolean
}
}Returns a single listing addressed by its session key. Appending .json to the key returns the same payload and is what the landing page uses.
Authentication Session key
Session key returned when the listing was created.
1curl "https://api.reportauto.eu/api/requests/self/7orpIa"{
"id": integer,
"unique_id": string,
"report_id": integer,
"qr_code_value": string,
"status": string,
"name": string,
"email": string,
"phone": string,
"inserted_at": string,
"info": {
"address_components": [{
"long_name": string,
"short_name": string,
"types": string[]
}],
"car_availability": enum,
"car_condition_summary": enum,
"currency_code": enum,
"geometry": {
"bounds": {
"northeast": {
"lat": integer,
"lng": integer,
},
"southwest": {
"lat": integer,
"lng": integer,
}
},
"location": {
"lat": integer,
"lng": integer,
},
"zoom": integer,
"location_type": string,
"viewport": {
"northeast": {
"lat": integer,
"lng": integer,
},
"southwest": {
"lat": integer,
"lng": integer,
}
}
},
"prediction": {
"currency": enum,
"suggested_price": integer,
"evaluation": integer,
"key": string,
"range": {
"lower_bound": integer,
"upper_bound": integer,
},
"estimation": {
"cash_offer": {
"excellent": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"fair": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"very_good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
},
"private_offer": {
"excellent": {
"dealer_margin": {
"from": integer,
"to": numintegerber,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"fair": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"very_good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
},
"tradein_offer": {
"excellent": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"fair": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"very_good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
}
}
},
"private": {
"excellent": integer,
"fair": integer,
"good": integer,
"very_good": integer,
},
"retail": {
"excellent": integer,
"fair": integer,
"good": integer,
"very_good": integer,
},
"tradein": {
"excellent": integer,
"fair": integer,
"good": integer,
"very_good": integer,
}
},
"sticker_flow": boolean
}
}Older addressing form that takes the numeric request ID alongside the session key. New integrations should use the /self form above.
Authentication Session key
Numeric ID of the request.
Session key for the request.
1curl "https://api.reportauto.eu/api/requests/3898/II1Na7"Updates any part of a listing — status, the info block, garage-sale details, or the claim and inspection contacts. Send only the keys that change.
Authentication Session key
Session key of the listing.
Unique identifier of the request
Request status
Users's email address
User's phone number
User's full name
QR code value
Vehicle information object
Vehicle condition object
The type of Listing
The type of Listing
Extra fields for garage-sale and property listings.
1curl -X PATCH "https://api.reportauto.eu/api/requests/self/q1Yvhb" \
2 -H "Content-Type: application/json" \
3 -d '{
4 "info": {
5 "currency_code": "USD",
6 "postcode": "32244",
7 "car_availability": "AVAILABLE",
8 "user_sale_plan": "CASH_OFFER",
9 "car_condition_summary": "EXCELLENT",
10 "preferred_contact": "EMAIL",
11 "radius": 50,
12 "send_to_dealers": false
13 },
14 "details": {
15 "start_date": "2024-09-01",
16 "end_date": "2024-09-30",
17 "open_hours": [
18 { "day": "MONDAY", "open": "09:00 UTC", "close": "17:00 UTC" }
19 ],
20 "items": [
21 {
22 "name": "Roof box",
23 "description": "Item description",
24 "price": 100,
25 "quantity": 1,
26 "condition": "NEW",
27 "category": "ELECTRONICS",
28 "images": [{ "url": "https://example.com/image.jpg" }],
29 "status": "AVAILABLE"
30 }
31 ]
32 }
33 }'{
"id": integer,
"unique_id": string,
"report_id": integer,
"qr_code_value": string,
"status": string,
"name": string,
"email": string,
"phone": string,
"inserted_at": string,
"info": {
"address_components": [{
"long_name": string,
"short_name": string,
"types": string[]
}],
"car_availability": enum,
"car_condition_summary": enum,
"currency_code": enum,
"geometry": {
"bounds": {
"northeast": {
"lat": integer,
"lng": integer,
},
"southwest": {
"lat": integer,
"lng": integer,
}
},
"location": {
"lat": integer,
"lng": integer,
},
"zoom": integer,
"location_type": string,
"viewport": {
"northeast": {
"lat": integer,
"lng": integer,
},
"southwest": {
"lat": integer,
"lng": integer,
}
}
},
"prediction": {
"currency": enum,
"suggested_price": integer,
"evaluation": integer,
"key": string,
"range": {
"lower_bound": integer,
"upper_bound": integer,
},
"estimation": {
"cash_offer": {
"excellent": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"fair": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"very_good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
},
"private_offer": {
"excellent": {
"dealer_margin": {
"from": integer,
"to": numintegerber,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"fair": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"very_good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
},
"tradein_offer": {
"excellent": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"fair": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"very_good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
}
}
},
"private": {
"excellent": integer,
"fair": integer,
"good": integer,
"very_good": integer,
},
"retail": {
"excellent": integer,
"fair": integer,
"good": integer,
"very_good": integer,
},
"tradein": {
"excellent": integer,
"fair": integer,
"good": integer,
"very_good": integer,
}
},
"sticker_flow": boolean
}
}Deletion is a status change rather than a DELETE: set status to DELETED on the update endpoint.
Authentication Session key
Session key of the listing.
DELETED.
1curl -X PATCH "https://api.reportauto.eu/api/requests/self/FDwXSK" \
2 -H "Content-Type: application/json" \
3 -d '{ "status": "DELETED" }'Sends the owner the capture link again, by whichever channel the listing was created with. Takes no body.
Authentication Session key
Session key of the listing.
1curl -X PATCH "https://api.reportauto.eu/api/requests/self/2e61ecb7-cde1-45f2-9463-9f60b3dbf213/resend"Records the seller’s rating of the listing flow, with an optional comment.
Authentication Session key
Session key of the listing.
Score from 1 to 5.
Free-text feedback.
1curl -X PATCH "https://api.reportauto.eu/api/requests/self/PR64FV/rating" \
2 -H "Content-Type: application/json" \
3 -d '{
4 "rating": 5,
5 "comment": "The process was very straightforward."
6 }'The partner-side view of the same objects. These calls are authenticated as a partner account and address requests by numeric ID rather than by session key.
Invites a customer to complete a request. The API contacts them on the email or phone given and returns the request with its session key. Add a claim object to raise an insurance claim instead of a trade-in.
Authentication API key or access token
Customer’s name.
Email to invite on. Use either email or phone.
Phone number to invite on, in E.164 format.
Partner the request is raised for.
TRADE, CLAIM, GARAGE or the other listing types — see Create a listing.
Subject line for the invitation message.
Your own identifier for the request, searchable later through the reference filter.
Claim details, when request_type is CLAIM.
1curl -X POST "https://api.reportauto.eu/api/requests" \
2 -H "Authorization: API_KEY $CAROOM_API_KEY" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "name": "Jamie Rivera",
6 "email": "jamie@example.com",
7 "subject": "Please create a report of your car",
8 "request_type": "TRADE",
9 "partner_id": 7
10 }'Returns the requests visible to the authenticated partner, newest first.
Authentication API key or access token
Maximum number of requests to return.
Filter by status, e.g. new.
Find the request carrying this external reference, set when it was created.
1curl "https://api.reportauto.eu/api/requests?limit=3&status=new" \
2 -H "Authorization: API_KEY $CAROOM_API_KEY"Returns the vehicles attached to a partner’s requests — the work queue behind the partner dashboard. Filter by status for trade-ins or by type for claims.
Authentication API key or access token
Filter by request status, e.g. new.
Filter by kind, e.g. preclaim.
Restrict to one partner.
1curl "https://api.reportauto.eu/api/requests/cars?status=new" \
2 -H "Authorization: API_KEY $CAROOM_API_KEY"Returns the full request, including its report and uploads.
Authentication API key or access token
ID of the request.
1curl "https://api.reportauto.eu/api/requests/9887" \
2 -H "Authorization: API_KEY $CAROOM_API_KEY"{
"id": integer,
"unique_id": string,
"report_id": integer,
"qr_code_value": string,
"status": string,
"name": string,
"email": string,
"phone": string,
"inserted_at": string,
"info": {
"address_components": [{
"long_name": string,
"short_name": string,
"types": string[]
}],
"car_availability": enum,
"car_condition_summary": enum,
"currency_code": enum,
"geometry": {
"bounds": {
"northeast": {
"lat": integer,
"lng": integer,
},
"southwest": {
"lat": integer,
"lng": integer,
}
},
"location": {
"lat": integer,
"lng": integer,
},
"zoom": integer,
"location_type": string,
"viewport": {
"northeast": {
"lat": integer,
"lng": integer,
},
"southwest": {
"lat": integer,
"lng": integer,
}
}
},
"prediction": {
"currency": enum,
"suggested_price": integer,
"evaluation": integer,
"key": string,
"range": {
"lower_bound": integer,
"upper_bound": integer,
},
"estimation": {
"cash_offer": {
"excellent": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"fair": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"very_good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
},
"private_offer": {
"excellent": {
"dealer_margin": {
"from": integer,
"to": numintegerber,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"fair": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"very_good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
},
"tradein_offer": {
"excellent": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"fair": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
},
"very_good": {
"dealer_margin": {
"from": integer,
"to": integer,
},
"fair_price": integer,
"lower_bound": integer,
"upper_bound": integer,
"recondition": integer
}
}
},
"private": {
"excellent": integer,
"fair": integer,
"good": integer,
"very_good": integer,
},
"retail": {
"excellent": integer,
"fair": integer,
"good": integer,
"very_good": integer,
},
"tradein": {
"excellent": integer,
"fair": integer,
"good": integer,
"very_good": integer,
}
},
"sticker_flow": boolean
}
}Changes the status of a request, or links it to a trade-in offer and session.
Authentication API key or access token
ID of the request.
New status, e.g. ARCHIVED.
Trade-in offer to attach to the request.
Session key associated with the trade-in.
1curl -X PATCH "https://api.reportauto.eu/api/requests/305" \
2 -H "Authorization: API_KEY $CAROOM_API_KEY" \
3 -H "Content-Type: application/json" \
4 -d '{ "status": "ARCHIVED" }'Notifies the vehicle owner again about an outstanding request. The collection uses the same call for both the initial resend and follow-up nudges.
Authentication API key or access token
ID of the request.
1curl -X PATCH "https://api.reportauto.eu/api/requests/76/resend" \
2 -H "Authorization: API_KEY $CAROOM_API_KEY"Moves a report request to a different account — used when an anonymous capture is claimed by a signed-in user.
Authentication Access token
ID of the request.
1curl -X PATCH "https://api.reportauto.eu/api/requests/3114/associate" \
2 -H "Authorization: $CAROOM_ACCESS_TOKEN"Permanently removes a request the partner owns.
Authentication API key or access token
ID of the request.
1curl -X DELETE "https://api.reportauto.eu/api/requests/4178" \
2 -H "Authorization: API_KEY $CAROOM_API_KEY"