{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"56a4eeda-8226-4651-a542-b93345bf7ce6","name":"UVeye Public API v1","description":"# Introduction\n\nAllow 3rd-party access to UVeye's data.\n\n**Documentation version: v1.2 — updated 2026-07-06.** See the Changelog at the bottom of this description.\n\n# Overview\n\nAll data provided is confidential and may not be used in any way without explicit permission from UVeye.\n\nThis documentation will explore the different types of requests that can be made to retrieve information from UVeye.\n\n**Authentication**  \nMost endpoints use a header key `uveye-api-key`. Generate a global key in the Global Keys tab of the UVeye Back Office and set it as `uveye-api-key`. The **Merchandise** endpoints use a separate credential sent as `Authorization: Bearer <merchandise API key>`, issued at onboarding.\n\n**Environments**  \nNotice that this API is for US organizations. Ensure that in the topbar of this page, ENVIRONMENT is set to Production-US. This displays all relevant URLs for sending requests.  \n_base url for for dev environment is:_ [<i>https://api.uveye.dev/v1/</i>](https://api.uveye.dev/v1/)\n\nRequest & Response Structure:  \nEach endpoint has specific request parameters as detailed in the request-body schema below. Refer to the response-body schema table to see each returned parameter and its description.\n\nGeneral Notes:  \nDetailed information on how to find the data needed is given on each request and response.\n\n# Changelog\n\n**v1.2 — 2026-07-06**\n\n- Added the **Merchandise** folder — `Submit inventory`, `Mark vehicles sold`, and the outbound webhook payload contract. Postman is now the single source of truth for the UVeye API, unifying inspection + merchandise for customers. Merchandise endpoints authenticate with `Authorization: Bearer` (distinct from `uveye-api-key`).\n\n**v1.1 — 2026-06-30**\n\n- **Inspection Details:** added `uniqueId` as a 4th lookup option; documented additional response fields (`isDriveable`, `spareTireInfo`, `keyType`, `merchandiseVehicleData`; tire `treadImageWithGrooves` / `croppedWallImage` / `croppedTreadImage` / `isMismatchTire`; detection `croppedImage` and millimeter/inch dimensions; Atlas `bodyPartDisplayName` / `bodyPartCustomerMappingId` / `damageTypeCustomerMappingId`); corrected the Apollo `apolloInformation` block (added `interiorColor`, `interiorType`, `hasHeadrests`, `hasThirdRowSeating`, `isBioHazard`; removed obsolete `soundRecording` and `dashboardAlertLights`); fixed `isAllSeasonPresent` / `isSpeedAndLoadNormal` spelling.\n    \n- **Latest Inspections:** added `vin` as a search filter; documented `merchandiseVehicleData`.\n    \n- **Quote Data by Inspection ID:** corrected the request body (`includeImages`, removed parameters that do not apply) and added the full response schema.\n    \n- **Public Link:** noted that links expire 30 days after creation; fixed an invalid example value.\n    \n- **image:** completed the documentation (image keys are returned embedded in other endpoints' image URLs; URLs expire after 1 hour).\n    \n- **Inspection shared:** documented the request/response schema.\n    \n- Removed the **Inspection Feedback** request (the endpoint is not available).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"6788683","team":25958143,"collectionId":"56a4eeda-8226-4651-a542-b93345bf7ce6","publishedId":"UzBqnQ9W","public":true,"publicUrl":"https://api.v1.uveye.dev","privateUrl":"https://go.postman.co/documentation/6788683-56a4eeda-8226-4651-a542-b93345bf7ce6","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Pull UVeye vehicle-inspection results — exterior, tire, undercarriage, and interior data, images, appraisals, and shareable report links — via a simple REST API."},{"name":"title","value":"UVeye Public API v1 — Vehicle Inspection Data API"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.3","publishDate":"2026-07-01T17:32:33.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"UVeye Public API v1 — Vehicle Inspection Data API","description":"Pull UVeye vehicle-inspection results — exterior, tire, undercarriage, and interior data, images, appraisals, and shareable report links — via a simple REST API."},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"Staging","id":"23ced684-a99f-4f00-92aa-b259ee1c9f6b","owner":"6788683","values":[{"key":"base_url","value":"https://api-uveye-playground.web.app/v1/i","enabled":true,"type":"default"},{"key":"inspection_url_suffix","value":"inspection","enabled":true,"type":"default"},{"key":"uveye_api_key","value":"","enabled":true,"type":"secret"},{"key":"sample_inspection_id","value":"79c0c1d0-f600-413d-87f1-7e2f70d03ecb","enabled":true,"type":"default"},{"key":"image_url_suffix","value":"image","enabled":true,"type":"default"},{"key":"public_link_url_suffix","value":"public-link","enabled":true,"type":"default"},{"key":"latest_inspections_suffix","value":"latest-inspections","enabled":true,"type":"default"},{"key":"appraisal_quote","value":"quote","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/b9d89ec849e833b4b81871e2c76be4759311f38aa3ee9c4136c1d9573193e5ef","favicon":"https://uveye.dev/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Staging","value":"6788683-23ced684-a99f-4f00-92aa-b259ee1c9f6b"}],"canonicalUrl":"https://api.v1.uveye.dev/view/metadata/UzBqnQ9W"}