/.../rear-right.jpg\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"","description":"This is delivered BY UVeye TO your configured webhook URL — it is not a request you send. It is documented here so you can see the payload contract. Set
\nWhen a VIN's merchandise images are ready, UVeye POSTs to your URL with:
\n\nAuthorization: Bearer <customer-bearer-token> — the token UVeye was given at onboarding; match it to authenticate UVeye.X-UVeye-Signature — an HS256 JWT binding the body (body_sha256); verify it for tamper detection + a delivery_id idempotency key (optional).
\nAcknowledge with 2xx. Non-2xx triggers retry (up to 5 retries / 6 attempts, same delivery_id).
\nMinimum body shown (default). A detailed format (opt-in at onboarding) adds publishStatus, coverImage, imageCount, per-image { url, category }, and modules. See the full Merchandise Integration Guide (Confluence) for JWT claims and verification code.
\n","urlObject":{"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"a0484eb1-be14-fd4e-d250-3e21687a44dc"}],"id":"44cae7f0-4a83-10db-6ecc-402848460c4d","_postman_id":"44cae7f0-4a83-10db-6ecc-402848460c4d","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"uveye-api-key"},{"key":"value","value":"{{uveye_api_key}}"}]},"isInherited":true,"source":{"_postman_id":"56a4eeda-8226-4651-a542-b93345bf7ce6","id":"56a4eeda-8226-4651-a542-b93345bf7ce6","name":"UVeye Public API v1","type":"collection"}}},{"name":"Public Link","id":"1d2c7199-fc25-4912-b902-458afd3337e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"uveye-api-key","value":"{{uveye_api_key}}"}],"body":{"mode":"raw","raw":"{\n \"inspectionId\": \"\", // or use \"\" / \"\"\n \"plainMode\": false\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}{{public_link_url_suffix}}","description":"General Description:
\nInspection Public Link
To get the public link an identifier must be specified. There are 3 possible identifiers that can be used: inspectionId, vin, and uniqueId. There are request and response examples for each of the possible identifiers.
\nThere are 2 types of inspection public link: regular or plain. You can find detailed information for both in the request body schema.
\nNote: Public inspection links expire 30 days after they are generated. The exact expiry timestamp is returned in the expirationDate field of the response.
\nRequest-Body schema:
In the request body an identifier must be chosen to get the inspection. inspectionId, vin, uniqueId. Review the examples provided for this request to see all possible methods to achieve the response wanted.
\n\n\n\n| parameter | \ntype | \ndescription | \nrequired\\optional | \n
\n\n\n\n| uniqueId | \nstring | \nthe barcode of the vehicle (if given), can be found on the scan page | \nrequired (1 of 3 options, can be replaced by \"inspectionId\"/\"vin\") | \n
\n\n| vin | \nstring | \na unique id of the vehicle provided by the manufacturer, can be found under vehicle info on the inspection page | \nrequired (1 of 3 options, can be replaced by \"inspectionId\"/\"uniqueId\") | \n
\n\n| inspectionId | \nstring | \na unique id of the inspection provided by the UVeye system, can be found in the scan page url | \nrequired (1 of 3 options, can be replaced by \"uniqueId\"/\"vin\") | \n
\n\n| plainMode | \nboolean | \nset to true to get a plain version of the public link | \noptional (false by default) | \n
\n\n
\n
Response-Body Schema:
\n\n\n\n| parameter | \ntype | \ndescription | \n
\n\n\n\n| url | \nstring | \nreturns public link to the inspection | \n
\n\n| isHeliosModuleInvalid | \nboolean | \nreturns true if the undercarriage inspection image was not uploaded successfully | \n
\n\n| isArtemisModuleInvalid | \nboolean | \nreturns true if any tire inspection images were not uploaded successfully | \n
\n\n| isAtlasModuleInvalid | \nboolean | \nreturns true if the exterior inspection images were not uploaded successfully | \n
\n\n| isScanInvalid | \nboolean | \nreturns true if any of the inspection modules is invalid | \n
\n\n| expirationDate | \nDate format | \nreturns the date that a generated public link will no longer be available (30 days after creation) | \n
\n\n| inspectionDate | \nDate format | \nreturns the date the inspection was scanned | \n
\n\n
\n
Possible response statuses:
\n\n\n\n| status number | \nexpected message | \ndescription | \n
\n\n\n\n| 200 (OK) | \n- | \n- | \n
\n\n| 400 (Bad Request) | \nRequest failed | \n- | \n
\n\n| 400 (Bad Request) | \nMissing search criteria | \n**vin**, **inspectionId**, or **uniqueId** must be provided in the request body to get a specific inspection | \n
\n\n| 401 | \nAPI key is disabled | \nRefresh the API key in the backoffice and use the updated key in the header of the request | \n
\n\n| 401 | \nInvalid API key | \nThe API key you entered is invalid. Refresh the API key in the backoffice and use the updated key in the header of the request | \n
\n\n| 404 (Not Found) | \nInspection not found | \nThe inspection expired OR there is a mistake in the **vin**, **inspectionId**, or **uniqueId** that was entered. | \n
\n\n| 405 (Method Not Allowed) | \nunknown method, please use POST | \nyou are using a different method then \"POST\" | \n
\n\n
\n
General Description:
\nVehicle Inspection Data
To get inspection data an inspection or vehicle identifier must be specified. There are three possible identifiers : `vin`, `inspectionId`, and `licensePlate`.
\nThe response of this request contains many nested objects. Each child object is listed with a description.
\nRequest-Body Schema:
\n\n\n\n| parameter name | \ntype | \ndescription | \nrequired\\optional | \n
\n\n\n\n| vin | \nstring | \na unique id of the vehicle found in the inspection page under vehicle info | \nrequired (1 of 4 options, can be replaced by inspectionId or licensePlate) | \n
\n\n| inspectionId | \nstring | \na unique id of the inspection found in each scan page URL. | \nrequired (1 of 4 options, can be replaced by vin or licensePlate) | \n
\n\n| licensePlate | \nstring | \na unique id of the vehicle found in the inspection page under vehicle info | \nrequired (1 of 4 options, can be replaced by inspectionId or vin) | \n
\n\n| uniqueId | \nstring | \na unique id of the vehicle referring to the barcode of the vehicle (if given) | \nrequired (1 of 4 options, can be replaced by vin, inspectionId, or licensePlate) | \n
\n\n| alertsOnly | \nboolean | \nwhen set to true the response body returns only alert detections and hides warning detections | \noptional (false by default) | \n
\n\n| showTreadPolygons | \nboolean | \nwhen set to true will show tread polygons coordinates | \noptional (false by default) | \n
\n\n
\n
Response-Body Schema:
\nGeneral response:
\n\n\n\n| parameter name | \ntype | \ndescription | \n
\n\n\n\n| inspectionId | \nstring | \na unique id of the inspection | \n
\n\n| artemis | \nObject | \nArtemis object contains information about the vehicle's tires condition, this object schema has detailed information below | \n
\n\n| helios | \nObject | \nHelios object contains information about the vehicle's undercarriage condition, this object schema has detailed information below | \n
\n\n| atlas | \nObject | \nAtlas object contains information about the vehicle's exterior condition, this object schema has detailed information below | \n
\n\n| apollo | \nObject | \nApollo object contains information about the vehicle's interior condition, this object schema has detailed information below | \n
\n\n| overviewImage | \nstring | \nURL to the overview image of the vehicle | \n
\n\n| coverImage | \nstring | \nURL to the cover image of the vehicle | \n
\n\n| organizationId | \nstring | \na unique id of the organization that scanned and generated the vehicle inspection | \n
\n\n| organizationDisplayName | \nstring | \nthe name of the organization that scanned and generated the vehicle inspection | \n
\n\n| siteId | \nstring | \na unique id of the site that scanned and generated the vehicle inspection | \n
\n\n| siteDisplayName | \nstring | \nthe name of the site that scanned and generated the vehicle inspection | \n
\n\n| inspectedAt | \nstring (Date format) | \ndate and time the inspection occurred | \n
\n\n| licensePlate | \nstring | \nlicense plate of the scanned vehicle | \n
\n\n| licensePlateUsStateAbbreviation | \nstring | \nthe two-letter state code of the vehicle as it appears on the license plate | \n
\n\n| vin | \nstring | \na unique id of the vehicle provided by the vehicle manufacturer | \n
\n\n| uniqueId | \nstring | \na unique id of the vehicle referring to the barcode of the vehicle (if given) | \n
\n\n| isArtemisModuleInvalid | \nboolean | \nreturns true if any tire inspection images were not uploaded successfully | \n
\n\n| isAtlasModuleInvalid | \nboolean | \nreturns true if the exterior inspection images were not uploaded successfully | \n
\n\n| isHeliosModuleInvalid | \nboolean | \nreturns true if the undercarriage inspection image was not uploaded successfully | \n
\n\n| isScanInvalid | \nboolean | \nreturns true if any of the inspection modules is invalid | \n
\n\n| year | \nstring | \nthe year of the vehicle provided by the manufacturer | \n
\n\n| numberOfCylinders | \nnumber | \nthe number of engine cylinders provided by the manufacturer (returns null if not available) | \n
\n\n| fuelType | \nstring | \nthe fuel type of the vehicle provided by the manufacturer | \n
\n\n| bodyType | \nstring | \nthe body type of the vehicle provided by the manufacturer | \n
\n\n| make | \nstring | \nthe vehicle make provided by the manfacturer | \n
\n\n| model | \nstring | \nthe vehicle model provided by the manfacturer | \n
\n\n| trim | \nstring | \nthe vehicle trim level (when available) | \n
\n\n| cabSubTrim | \nstring | \nthe cab sub-trim, for applicable body types (when available) | \n
\n\n| bedSubTrim | \nstring | \nthe bed sub-trim, for applicable body types (when available) | \n
\n\n| doorCount | \nnumber | \nthe number of doors of the vehicle provided by the manufacturer (returns null if not available) | \n
\n\n| exteriorColor | \nstring | \nthe exterior color of the vehicle provided by the manufacturer | \n
\n\n| engineDisplacement | \nstring | \nthe engine displacement of the vehicle provided by the manufacturer | \n
\n\n| isDriveable | \nboolean | \nreturns true if the vehicle was determined to be driveable | \n
\n\n| spareTireInfo | \nstring | \nspare tire information (when available) | \n
\n\n| keyType | \nstring | \nthe vehicle's key type (when available) | \n
\n\n| merchandiseVehicleData | \nobject | \nresolved vehicle data (inventory-first); present only once resolved | \n
\n\n
\n
Artemis (Tires), Helios (Undercarriage) & Atlas (Exterior) Objects Schemas:
\nArtemis: The Artemis (tires) Object has 4 properties for the 4 tires positions:
\n\n\n\n| property | \ntype | \n
\n\n\n\n| leftFront | \nobject | \n
\n\n| leftRear | \nobject | \n
\n\n| rightFront | \nobject | \n
\n\n| rightRear | \nobject | \n
\n\n
\n
Each property (tire position) is also an object - describes the tire's condition.
\nIn the following schemas there is detailed information about each Tire-Position Object:
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| treadImage | \nstring | \nURL to the tread image of a specific tire | \n
\n\n| wallImage | \nstring | \nURL to the tire-wall image of a specific tire | \n
\n\n| treadImageWithGrooves | \nstring | \nURL to the tread image with the detected grooves overlaid | \n
\n\n| croppedWallImage | \nstring | \nURL to a cropped tire-wall image (returned only when cropping is enabled for the API key) | \n
\n\n| croppedTreadImage | \nstring | \nURL to a cropped tread image (returned only when cropping is enabled for the API key) | \n
\n\n| treadDetections | \nObject | \ncontaints all damage detections that where found on the tires treads (schema and information for this object can be found below) | \n
\n\n| wallDetections | \nObject | \nwallDetections object holds all damage detections that where found on the tires walls (schema and information for this object can be found below) | \n
\n\n| brand | \nstring | \nreturns the brand of the tire | \n
\n\n| dot | \nstring | \nreturns the four digits describing the manufacture date of the tire (formated as WWYY where WW is the week number (1-52) and YY is the last two digits of the year) | \n
\n\n| tireAge | \nstring | \nreturns the tire age in years calculated from the dot. | \n
\n\n| pressure | \nstring | \nreturns “Normal” or “Low” depending on the state of the tire pressure detected | \n
\n\n| size | \nstring | \ntire’s size specifications as shown on the sidewall of the tire | \n
\n\n| speedAndLoad | \nstring | \ntire’s speed and load specifications as shown on the sidewall of the tire | \n
\n\n| unevenTreadsWearDetected | \nboolean | \nindicates whether the tire has uneven tread wear | \n
\n\n| wornTireDetected | \nstring | \nreturns “Normal Wear”, “Marginal”, or “Critical” depending on the state of the tread wear of the tire | \n
\n\n| isMountingCorrect | \nboolean | \nreturns true if the tire is mounted so that the “outside” marking is on the outer side of the tire sidewall | \n
\n\n| isAllSeasonPresent | \nboolean | \nreturns true if the “m+s” marking is on the tire sidewall
note: “m+s” stands for “mud and snow”, indicating that the tire is able to drive on snow and mud | \n
\n\n| isSpeedAndLoadNormal | \nboolean | \nindicated whether the tire has a speed & load mark. | \n
\n\n| isMismatchTire | \nboolean | \nreturns true if this tire does not match the others on the vehicle | \n
\n\n| grooves | \nObject[] | \ncontains information about the tire tread's grooves, each groove is an object which holds information about the groove condition (schema and information for this object can be found below) | \n
\n\n
\n
Tire-position sub-objects:
\n\n- treadDetections & wallDetection:
\n
\ntreadDetections & wallDetections are arrays of detection objects, each tread\\wall detection has the following schema:
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| id | \nstring | \nunique identifier of the detection | \n
\n\n| rectangle | \nObject | \nthe detection's rectangle highlighting the location of the detection on the vehicle as shown in the scan. rectangle Object has the following schema: {height: number (float), width: number (float), top: number (float), left: number (float)} all values are Relative to the image dimensions | \n
\n\n| type | \nstring | \ndescribes what is marked in the detection (what kind of damage or anomaly was found on the tread)
*see all possible detections types list below. | \n
\n\n| isHighSeverity | \nboolean | \nIndicates that the marked damage or anomaly has high severity | \n
\n\n| isMediumSeverity | \nboolean | \nIndicates that the marked damage or anomaly has medium severity | \n
\n\n| croppedImage | \nstring | \nURL to a cropped image of the detection (returned only when cropping is enabled for the API key) | \n
\n\n| widthInMm | \nnumber | \nwidth of the detection in millimeters (when available) | \n
\n\n| heightInMm | \nnumber | \nheight of the detection in millimeters (when available) | \n
\n\n| widthInInch | \nnumber | \nwidth of the detection in inches (when available) | \n
\n\n| heightInInch | \nnumber | \nheight of the detection in inches (when available) | \n
\n\n
\n
Artemis treadDetections & wallDetection- all possible detection types:
\n\n\n\n| detection-type | \ndescription | \n
\n\n\n\n| TireWear | \nindicates a worn tire | \n
\n\n| TireMissingLugNutCover | \nindicates a missing lug nut cover from a vehicle’s tire-rim | \n
\n\n| TireBrokenBelt | \nindicates a broken inner belt on a vehicle’s tire | \n
\n\n| TireBulge | \nindicates a bulge on a vehicle’s tire | \n
\n\n| TireDamage | \nindicates a general damage to the vehicle's tire | \n
\n\n| TireForeignObject | \nindicates a foreign object on a vehicle’s tire | \n
\n\n| TireMissingLugNut | \nindicates a missing lug nut from a vehicle’s tire-rim | \n
\n\n| TireRimDamage | \nindicates a general damage to a vehicle’s tire-rim | \n
\n\n
\n
2. grooves:
\ngrooves is an Array of Objects, each object represents a single groove of the tire's tread.
the following schema describes each groove object:
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| depthMm | \nnumber (float) | \ngroove depth in millimeters (Indication to how worn the grove is) | \n
\n\n| depth32ndOfInch | \nstring | \ngroove depth in 32nd of an Inch (Indication to how worn the grove is) | \n
\n\n| isCritical | \nboolean | \nreturns true if the groove depth is shallow enough to necessitate for immediate tire replacement | \n
\n\n| isMarginal | \nboolean | \nreturns true if the groove depth is shallow enough to recommend tire replacement however it is not immediately needed | \n
\n\n| isNormal | \nboolean | \nreturns true if the groove depth is deep enough to continue using the tire | \n
\n\n| polygon | \nnumber[][] | \nPolygon is a matrix that describes the groove outlines. each array (matrix row) in the parent array holds: [float, float] describing [xValue, yValue] of a point from the entire polygon | \n
\n\n
\n
Helios:
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| undercarriageImage | \nstring | \nURL to the image of the undercarriage of the vehicle | \n
\n\n| detections | \nObject[] | \nan array of objects, each object holds a detection object (described in the Helios sub-objects section) | \n
\n\n
\n
Helios sub-objects (Undercarriage):
\ndetections: is an array of object, each object describes one anomaly or damage that was detected on the vehicle's undercarriage.
the following schema describes each detection object:
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| id | \nstring | \nunique identifier of the detection | \n
\n\n| rectangle | \nObject | \nthe detection's rectangle highlighting the location of the detection on the vehicle as shown in the scan. rectangle Object has the following schema: {height: number (float), width: number (float), top: number (float), left: number (float)} all values are Relative values to the image dimensions | \n
\n\n| type | \nstring | \ndescribes what is marked in the detection (what kind of damage or anomaly was found)
*see all possible detections types list below. | \n
\n\n| isHighSeverity | \nboolean | \nIndicates that the marked damage or anomaly has high severity | \n
\n\n| isMediumSeverity | \nboolean | \nIndicates that the marked damage or anomaly has medium severity | \n
\n\n| croppedImage | \nstring | \nURL to a cropped image of the detection (returned only when cropping is enabled for the API key) | \n
\n\n| widthInMm | \nnumber | \nwidth of the detection in millimeters (when available) | \n
\n\n| heightInMm | \nnumber | \nheight of the detection in millimeters (when available) | \n
\n\n| widthInInch | \nnumber | \nwidth of the detection in inches (when available) | \n
\n\n| heightInInch | \nnumber | \nheight of the detection in inches (when available) | \n
\n\n
\n
all Helios detections possible types:
\n\n\n\n| detection-type | \ndescription | \n
\n\n\n\n| UndercarriageBrokenExhaust | \nindicates a broken exhaust on the vehicle’s undercarriage | \n
\n\n| UndercarriageBrokenShield | \nindicates a broken heat shield on the vehicle’s undercarriage | \n
\n\n| UndercarriageDamage | \nindicates a general damage to the vehicle’s undercarriage | \n
\n\n| UndercarriageForeignObject | \nindicates a foreign object on the vehicle’s undercarriage | \n
\n\n| UndercarriageLeak | \nindicates a leaking part of the vehicle’s undercarriage | \n
\n\n| UndercarriageMissingCatalyticConverter | \nindicates a missing catalytic convertor from the vehicle’s undercarriage | \n
\n\n| UndercarriageRust | \nindicates rust on the vehicle’s undercarriage | \n
\n\n
\n
Atlas:
Atlas object describes the vehicle's exterior condition. and has the following schema:
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| detections | \nObject[] | \narray of all detections found in the inspection. Each detection object holds information about the detection itself (described in detail in the Atlas sub-objects section) | \n
\n\n| coverImages | \nObject | \nobject that holds 4 URL links to 4 cover images captured by the Atlas system as different angles (described in detail in the Atlas sub-objects section) | \n
\n\n| animatedFrames | \nObject | \nobject containing images used for generating GIF animations of the sides and top of a vehicle driving through the system (described in detail in the Atlas sub-objects section) | \n
\n\n
\n
Atlas sub-objects (Exterior):
\n\n- detections:
\n
\ndetections property is an array of objects, each object describes the anomaly or damage that was detected on the vehicle's exterior body panels.
The following schema describes each detection object:
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| id | \nstring | \na unique id of the detection. | \n
\n\n| image | \nstring | \nURL link to the image on which the detection is marked on | \n
\n\n| bodyPart | \nstring | \nthe vehicle's body part where the detection is located | \n
\n\n| rectangle | \nObject | \nthe detection's rectangle highlighting the location of the detection on the vehicle as shown in the scan. rectangle Object has the following schema: {height: number (float), width: number (float), top: number (float), left: number (float)} all values are Relative values to the image dimensions | \n
\n\n| type | \nstring | \ndescribes what is marked in the detection (what kind of damage or anomaly was found) | \n
\n\n| isHighSeverity | \nboolean | \nIndicates that the marked damage or anomaly has high severity | \n
\n\n| isMediumSeverity | \nboolean | \nIndicates that the marked damage or anomaly has medium severity | \n
\n\n| bodyPartDisplayName | \nstring | \nhuman-readable name of the body part | \n
\n\n| bodyPartCustomerMappingId | \nstring | \nthe customer-specific mapping id for the body part (when configured) | \n
\n\n| damageTypeCustomerMappingId | \nstring | \nthe customer-specific mapping id for the damage type (when configured) | \n
\n\n| croppedImage | \nstring | \nURL to a cropped image of the detection (returned only when cropping is enabled for the API key) | \n
\n\n| widthInMm | \nnumber | \nwidth of the detection in millimeters (when available) | \n
\n\n| heightInMm | \nnumber | \nheight of the detection in millimeters (when available) | \n
\n\n| lengthInMm | \nnumber | \nlength of the detection in millimeters, for scratches (when available) | \n
\n\n| widthInInch | \nnumber | \nwidth of the detection in inches (when available) | \n
\n\n| heightInInch | \nnumber | \nheight of the detection in inches (when available) | \n
\n\n| lengthInInch | \nnumber | \nlength of the detection in inches, for scratches (when available) | \n
\n\n
\n
all Atlas detections possible types:
\n\n\n\n| detection-type | \ndescription | \n
\n\n\n\n| BodyHailDamage | \nindicates hail damage on the vehicle’s body | \n
\n\n| BodyChip | \nindicates a chipping body part | \n
\n\n| BodyDamage | \nindicates a general damage on the vehicle’s body | \n
\n\n| BodyDent | \nindicates a dent on the vehicle’s body | \n
\n\n| BodyPaintchip | \nindicates a paint chip on the vehicle’s body | \n
\n\n| BodyScratch | \nindicates a scratch on the vehicle’s body | \n
\n\n
\n
all Atlas body-part possible types:
\n\n\n\n| Body Part Type | \nBody Part Type | \n
\n\n\n\n| BumperFront | \nBumperRear | \n
\n\n| DoorFrontLeft | \nDoorFrontRight | \n
\n\n| DoorRearLeft | \nDoorRearRight | \n
\n\n| CameraRear | \nFuelCap | \n
\n\n| FenderFront | \nFenderRear | \n
\n\n| Grille | \nHood | \n
\n\n| HeadLightLeft | \nHeadLightRight | \n
\n\n| LicensePlateFront | \nLicensePlateRear | \n
\n\n| MirrorLeft | \nMirrorRight | \n
\n\n| MirrorCoverLeft | \nMirrorCoverRight | \n
\n\n| Roof | \nTrunk | \n
\n\n| TailLightLeft | \nTailLightRight | \n
\n\n| TurnSignalLeft | \nTurnSignalRight | \n
\n\n| WindowFrontLeft | \nWindowFrontRight | \n
\n\n| WindowRearLeft | \nWindowRearRight | \n
\n\n| Windshield | \nGeneralBody | \n
\n\n| FogLightLeft | \nFogLightRight | \n
\n\n| ReflectorLightLeft | \nReflectorLightRight | \n
\n\n| SymbolFront | \nSymbolRear | \n
\n\n| TailPipe | \nAntenna | \n
\n\n| Sunroof | \nChargingCap | \n
\n\n| DoorHandleBackLeft | \nDoorHandleBackRight | \n
\n\n| DoorHandleFrontLeft | \nDoorHandleFrontRight | \n
\n\n| FenderFrontLeft | \nFenderFrontRight | \n
\n\n| FenderRearLeft | \nFenderRearRight | \n
\n\n| FrontWheelLeft | \nFrontWheelRight | \n
\n\n| RearWheelLeft | \nRearWheelRight | \n
\n\n| HoodPlasticTip | \nRoofRack | \n
\n\n| RoofRackRight | \nRoofRackLeft | \n
\n\n| SideWindow | \nWindowFrameLeft | \n
\n\n| WindowFrameRight | \n | \n
\n\n
\n
2. coverImages:
\ncoverImages object has 4 properties, each property links to an image of the vehicle from a different angle.
\nThe following schema describes each angle-object:
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| leftFront | \nstring | \nURL link to the vehicle image from \"left-front\" angle | \n
\n\n| rightFront | \nstring | \nURL link to the vehicle image from \"right-front\" angle | \n
\n\n| leftRear | \nstring | \nURL link to the vehicle image from \"left-rear\" angle | \n
\n\n| rightRear | \nstring | \nURL link to the vehicle image from \"right-rear\" angle | \n
\n\n
\n
3. animatedFrames:
\nanimatedFrames object has 3 properties for 3 angles of the vehicle, each property holds an array of URL links to images from a specific camera angle.
\nanimatedFrames object is used to generate a GIF animation of the vehicle. the following schema describes the different angles:
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| left | \nstring[] | \nan array of image-URLs showing the left side of the vehicle | \n
\n\n| top | \nstring[] | \nan array of image-URLs showing the top side of the vehicle | \n
\n\n| right | \nstring[] | \nan array of image-URLs showing the right side of the vehicle | \n
\n\n
\n
Apollo:
Apollo object describes the vehicle's interior condition and has the following schema:
(*note that it's only available if you use the Apollo mobile application)
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| apolloStatus | \nstring | \ndescribes the status of the interior condition data.
*See the list of possible values and their meanings described below. | \n
\n\n| apolloImages | \nObject | \nObject contains interior images links.
(described in detail in the Apollo sub-objects section) | \n
\n\n| apolloInformation | \nObject | \nObject contains the obd data and vehicle's engine sound | \n
\n\n| apolloDamages | \nObject[] | \nan array of objects containing the information for apollo damages (described in detail in the Apollo sub-objects section) | \n
\n\n
\n
apolloStatus possible values:
\n\n\n\n| value | \ndescription | \n
\n\n\n\n| empty | \nIndicates that there is no any interior data available | \n
\n\n| acquisitionStarted | \nIndicates that the vehicle's interior data is being processed & uploaded (still not all data avaliable) | \n
\n\n| imagesReady | \nIndicates that the vehicle's interior data is ready and all images have been uploaded | \n
\n\n
\n
Apollo sub-objects (Interior):
\n\n- apolloImages:
\n
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| interiorImage | \nstring | \nA panoramic 360° interior image of the vehicle. | \n
\n\n| odometerImage | \nstring | \nImage of the vehicle's odometer. | \n
\n\n| engineImage | \nstring | \nImage of the engine (under the vehicle's hood). | \n
\n\n| dashboardImage | \nstring | \nImage of the vehicle interior dashboard. | \n
\n\n| keysPictureImage | \nstring | \nImage of the vehicle's keys. | \n
\n\n| spareTireImage | \nstring | \nImage of the vehicle's spare tire. | \n
\n\n| vinStickerImage | \nstring | \nImage of the vehicle's VIN (Vehicle Identification Number) sticker. | \n
\n\n| radioSystemImage | \nstring | \nImage of the vehicle's radio or entertainment system. | \n
\n\n| navigationSystemImage | \nstring | \nImage of the vehicle's navigation system. | \n
\n\n| tireDoorJamStickerImage | \nstring | \nImage of the tire specification sticker located in the door jamb. | \n
\n\n| emissionStickerImage | \nstring | \nImage of the vehicle's emission sticker. | \n
\n\n| openedGloveBoxImage | \nstring | \nImage of the vehicle's glove box in the opened state. | \n
\n\n| rearSeatsDriverSideViewImage | \nstring | \nImage showing the rear seats from the driver's side perspective. | \n
\n\n| rearSeatsPassengerSideViewImage | \nstring | \nImage showing the rear seats from the passenger's side perspective. | \n
\n\n| trunkImage | \nstring | \nImage of the vehicle's trunk. | \n
\n\n| vinQRCodeImage | \nstring | \nImage of the QR code associated with the vehicle's VIN. | \n
\n\n| exteriorFrontPerspectiveImage | \nstring | \nImage of the vehicle's front from a wide perspective. | \n
\n\n| exteriorFrontEmblemImage | \nstring | \nClose-up image of the vehicle's front emblem. | \n
\n\n| exteriorFrontRightPerspectiveImage | \nstring | \nImage of the vehicle's front right side perspective. | \n
\n\n| exteriorRightPerspectiveImage | \nstring | \nImage of the vehicle's right side perspective. | \n
\n\n| exteriorRearRightPerspectiveImage | \nstring | \nImage of the vehicle's rear right side perspective. | \n
\n\n| exteriorRearPerspectiveImage | \nstring | \nImage of the vehicle's rear perspective. | \n
\n\n| exteriorRearEmblemImage | \nstring | \nClose-up image of the vehicle's rear emblem. | \n
\n\n| exteriorRearLeftPerspectiveImage | \nstring | \nImage of the vehicle's rear left side perspective. | \n
\n\n| exteriorLeftPerspectiveImage | \nstring | \nImage of the vehicle's left side perspective. | \n
\n\n| exteriorFrontLeftPerspectiveImage | \nstring | \nImage of the vehicle's front left side perspective. | \n
\n\n| exteriorTrimEmblemImage | \nstring | \nClose-up image of the vehicle's trim or model emblem. | \n
\n\n| exteriorDriverSideTurnedWheelProfileImage | \nstring | \nImage of the driver's side profile with the front wheel turned. | \n
\n\n| exteriorHeadlightViewImage | \nstring | \nClose-up image of the vehicle's headlights. | \n
\n\n| backseatOptionsPanelImage | \nstring | \nImage of the panel showing options for the backseat. | \n
\n\n| driverFrontSeatImage | \nstring | \nImage of the driver's front seat. | \n
\n\n| passengerFrontSeatImage | \nstring | \nImage of the passenger's front seat. | \n
\n\n| driverDoorControlsImage | \nstring | \nImage of the controls located on the driver's door. | \n
\n\n| shifterImage | \nstring | \nImage of the vehicle's gear shifter. | \n
\n\n| lightingControlPanelImage | \nstring | \nImage of the vehicle's lighting control panel. | \n
\n\n| dashboardPanelRearSeatViewImage | \nstring | \nImage of the dashboard panel from the rear seat's perspective. | \n
\n\n| openedDriverDoorImage | \nstring | \nImage of the vehicle with the driver's door opened. | \n
\n\n| reverseCameraImage | \nstring | \nImage of the vehicle's reverse camera display. | \n
\n\n| dashboardPanelDriverSeatViewImage | \nstring | \nImage of the dashboard panel from the driver's seat perspective. | \n
\n\n| instrumentPanelImage | \nstring | \nImage of the vehicle's instrument panel. | \n
\n\n| climateControlPanelImage | \nstring | \nImage of the vehicle's climate control panel. | \n
\n\n| engineStartButtonImage | \nstring | \nClose-up image of the vehicle's engine start button. | \n
\n\n| steeringWheelControlImage | \nstring | \nImage of the vehicle's steering wheel with controls. | \n
\n\n| centerConsoleStorageImage | \nstring | \nImage of the storage compartment in the vehicle's center console. | \n
\n\n| sunroofImage | \nstring | \nImage of the vehicle's sunroof. | \n
\n\n| birdsEyeViewImage | \nstring | \nImage showing a bird's eye view of the vehicle. | \n
\n\n| dashboardPanelPassengerSeatViewImage | \nstring | \nImage of the dashboard panel from the passenger seat's perspective. | \n
\n\n| driverDoorSpeakerImage | \nstring | \nImage of the speaker located in the driver's door. | \n
\n\n
\n
2. apolloInformation:
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| obdData | \nObject | \nObject contains the OBD data retrieved from the vehicle (described in detail in the next table below) | \n
\n\n| mileage | \nObject | \nObject contains the mileage data retrieved from the vehicle | \n
\n\n| numberOfKeys | \nnumber | \nthe number of keys provided for the vehicle | \n
\n\n| interiorColor | \nstring | \nthe vehicle's interior color (when available) | \n
\n\n| interiorType | \nstring | \nthe vehicle's interior material/type (when available) | \n
\n\n| hasHeadrests | \nboolean | \nwhether headrests are present (when available) | \n
\n\n| hasThirdRowSeating | \nboolean | \nwhether the vehicle has third-row seating (when available) | \n
\n\n| isBioHazard | \nboolean | \nwhether a biohazard was detected in the vehicle interior (when available) | \n
\n\n
\n
2-obdData:
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| vin | \nstring | \nthe vin of the vehicle (a unique identifier) recived from the obd | \n
\n\n| protocol | \nstring | \nthe OBD protocol used by the vehicle
*See the list of all supported protocols below | \n
\n\n| troubleCodes | \nObject[] | \narray of objects, each object contains information about a certain issue that was found by the OBD.
(described in detail below) | \n
\n\n
\n
2-obdData: list of supported OBD protocols:
\n\n\n\n| OBD supported protocols | \nmost common use | \n
\n\n\n\n| ISO_9141_2 | \nUsed in EU, Chrysler & Asian cars in 2000-04 | \n
\n\n| ISO_14230_4_KWP | \nThe Keyword Protocol 2000 was a common protocol for 2003+ cars in e.g. Asia | \n
\n\n| ISO_14230_4_KWP_FAST | \nThe Keyword Protocol 2000 was a common protocol for 2003+ cars in e.g. Asia | \n
\n\n| ISO_15765_4_CAN | \nMandatory in US cars since 2008 and is today used in the vast majority of cars | \n
\n\n| ISO_15765_4_CAN_B | \nMandatory in US cars since 2008 and is today used in the vast majority of cars | \n
\n\n| ISO_15765_4_CAN_C | \nMandatory in US cars since 2008 and is today used in the vast majority of cars | \n
\n\n| ISO_15765_4_CAN_D | \nMandatory in US cars since 2008 and is today used in the vast majority of cars | \n
\n\n| SAE_J1850_PWM | \nUsed mostly in older Ford cars | \n
\n\n| SAE_J1850_VPW | \nUsed mostly in older GM cars | \n
\n\n
\n
2-obdData-troubleCodes:
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| code | \nstring | \na fixed string indicating about a certain issue that was found by the OBD | \n
\n\n| description | \nstring | \ndescribing the issue that the code indicates on. usually including what is the issue and where was it found. | \n
\n\n| isPending | \nboolean | \nindicates that the issue was found more then 1 time. | \n
\n\n| isPermanent | \nboolean | \nindicates that a techinician checked the vehicle and approved that it is an actual issue. | \n
\n\n
\n
3. apolloDamage
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| id | \nstring | \na unique id of the apollo detection | \n
\n\n| type | \nstring | \ndescribes what is marked in the detection (what kind of damage or anomaly was found) | \n
\n\n| category | \nstring | \nindicates the category on which the detection was found, either interior or exterior | \n
\n\n| bodyPart | \nstring | \nthe vehicle's body part where the detection is located | \n
\n\n| image | \nstring | \nURL link to the image on which the detection is marked on | \n
\n\n| rectangle | \nObject | \nthe detection's rectangle highlighting the location of the detection on the vehicle as shown in the scan. rectangle Object has the following schema: {height: number (float), width: number (float), top: number (float), left: number (float)} all values are Relative values to the image dimensions | \n
\n\n
\n
mileage:
\n\n\n\n| property name | \ntype | \ndescription | \n
\n\n\n\n| units | \nstring | \na fixed string indicating the mileage unit which could be
'MI' = miles,
'KM' = kilometers,
'HR' = hours, | \n
\n\n| value | \nnumber | \nthe mileage number of the vehicle | \n
\n\n
\n
Possible response statuses:
\n\n\n\n| status number | \nexpected message | \ndescription | \n
\n\n\n\n| 200 (OK) | \n- | \n- | \n
\n\n| 400 (Bad Request) | \nRequest failed | \n- | \n
\n\n| 400 (Bad Request) | \nMissing search criteria | \n`**vin**`, `**inspectionId**`, or `**uniqueId**` must be provided in the request body to get a specific inspection | \n
\n\n| 401 | \nAPI key is disabled | \nRefresh the API key in the backoffice and use the updated key in the header of the request | \n
\n\n| 401 | \nInvalid API key | \nThe API key you entered is invalid. Refresh the API key in the backoffice and use the updated key in the header of the request | \n
\n\n| 404 (Not Found) | \nInspection not found | \nThe inspection expired OR there is a mistake in the `**vin**`, `**inspectionId**`, or `**uniqueId**` that was entered. | \n
\n\n| 405 (Method Not Allowed) | \nunknown method, please use POST | \nyou are using a different method then \"POST\" | \n
\n\n
\n
General Description:
\nLatest Inspections
Returns a list of the most recent inspections for a site or site group, so you can discover the inspectionId values to use with the Inspection Details request.
\nRequest-Body schema:
Provide one location filter (siteId, siteGroupId, or vin) and one result-window filter (amountOfDaysForSearch, amountOfHoursForSearch, or amountOfInspections).
\n\n\n\n| parameter | \ntype | \ndescription | \nrequired\\optional | \n
\n\n\n\n| siteId | \nstring | \nthe id of the site to search inspections for | \nrequired (1 of 3 location filters, can be replaced by \"siteGroupId\"/\"vin\") | \n
\n\n| siteGroupId | \nstring | \nthe id of the site group to search inspections for (also known as BAC for GM dealers) | \nrequired (1 of 3 location filters, can be replaced by \"siteId\"/\"vin\") | \n
\n\n| vin | \nstring | \nsearch the latest inspections for a specific vehicle by VIN | \nrequired (1 of 3 location filters, can be replaced by \"siteId\"/\"siteGroupId\") | \n
\n\n| amountOfDaysForSearch | \nnumber (int) | \nreturn inspections from the last X days | \nrequired (1 of 3 window filters) | \n
\n\n| amountOfHoursForSearch | \nnumber (int) | \nreturn inspections from the last X hours | \nrequired (1 of 3 window filters) | \n
\n\n| amountOfInspections | \nnumber (int) | \nreturn the most recent X inspections | \nrequired (1 of 3 window filters) | \n
\n\n
\n
Response-Body Schema:
\nThe response contains a single property inspections, an array of objects with the following fields:
\n\n\n\n| parameter | \ntype | \ndescription | \n
\n\n\n\n| inspectionId | \nstring | \nunique id of the inspection — use it with the Inspection Details request | \n
\n\n| siteId | \nstring | \nid of the site where the inspection took place | \n
\n\n| organizationId | \nstring | \nid of the organization the site belongs to | \n
\n\n| inspectedAt | \nDate format | \ndate and time the inspection was scanned | \n
\n\n| vin | \nstring | \nvehicle VIN | \n
\n\n| year | \nstring | \nvehicle model year (may be empty when unavailable) | \n
\n\n| model | \nstring | \nvehicle model | \n
\n\n| make | \nstring | \nvehicle make | \n
\n\n| licensePlate | \nstring | \nvehicle license plate | \n
\n\n| licensePlateUsStateAbbreviation | \nstring | \nUS state abbreviation of the license plate | \n
\n\n| merchandiseVehicleData | \nobject | \nresolved vehicle data (inventory-first). Present only once resolved | \n
\n\n| hasHelios | \nboolean | \ntrue if the inspection includes an undercarriage (Helios) scan | \n
\n\n| hasArtemis | \nboolean | \ntrue if the inspection includes a tire (Artemis) scan | \n
\n\n| hasAtlas | \nboolean | \ntrue if the inspection includes an exterior (Atlas) scan | \n
\n\n| isHeliosModuleInvalid | \nboolean | \ntrue if the undercarriage module is invalid | \n
\n\n| isArtemisModuleInvalid | \nboolean | \ntrue if the tire module is invalid | \n
\n\n| isAtlasModuleInvalid | \nboolean | \ntrue if the exterior module is invalid | \n
\n\n| isScanInvalid | \nboolean | \ntrue if any of the inspection modules is invalid | \n
\n\n| overviewImage | \nstring | \nURL of the inspection overview image | \n
\n\n
\n
Possible response statuses:
\n\n\n\n| status number | \nexpected message | \ndescription | \n
\n\n\n\n| 200 (OK) | \n- | \n- | \n
\n\n| 400 (Bad Request) | \nRequest failed | \n- | \n
\n\n| 400 (Bad Request) | \nMissing search criteria | \na location filter (siteId, siteGroupId, or vin) must be provided | \n
\n\n| 401 | \nAPI key is disabled | \nRefresh the API key in the backoffice and use the updated key in the header of the request | \n
\n\n| 401 | \nInvalid API key | \nThe API key you entered is invalid. Refresh the API key in the backoffice and use the updated key in the header of the request | \n
\n\n| 404 (Not Found) | \nInspection not found | \nno inspections match the given filters | \n
\n\n| 405 (Method Not Allowed) | \nunknown method, please use POST | \nyou are using a different method then \"POST\" | \n
\n\n
\n
General Description:
\nImage
Returns an image acquired during a UVeye inspection. The image is identified by a key query parameter.
\nWhere do image keys come from?
You normally do not build this request yourself. Image URLs are returned inside the other endpoints' responses (for example overviewImage and coverImage, the tire treadImage/wallImage, detection image/croppedImage, and the Atlas coverImages/animatedFrames in Inspection Details). Those URLs already include the ?key=... parameter — use the returned URL as-is.
\nRequest:
The request has no body. The only input is the key query parameter.
\n\n\n\n| parameter | \nlocation | \ntype | \ndescription | \n
\n\n\n\n| key | \nquery | \nstring | \nthe image key, taken from an image URL returned by another endpoint | \n
\n\n
\n
Response:
The response body is the raw image (image/jpeg, or image/png for keys configured to return PNG) — not JSON.
\nNote: Image URLs are valid for 1 hour (unless stated otherwise) and expire afterwards. Request a fresh inspection response to obtain new image URLs.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"uveye-api-key"},{"key":"value","value":"{{uveye_api_key}}"}]},"isInherited":true,"source":{"_postman_id":"56a4eeda-8226-4651-a542-b93345bf7ce6","id":"56a4eeda-8226-4651-a542-b93345bf7ce6","name":"UVeye Public API v1","type":"collection"}},"urlObject":{"host":["{{base_url}}{{image_url_suffix}}"],"query":[{"key":"key","value":""}],"variable":[]}},"response":[],"_postman_id":"ffe14d44-ba9f-47c7-999c-7ef228cddaf2"},{"name":"Quote Data by Inspection ID","id":"ec15ef09-25d7-4b70-8fb5-3578ef4cda6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"uveye-api-key","value":"{{uveye_api_key}}"}],"body":{"mode":"raw","raw":"{\n \"inspectionId\": \"\", // or use \"\" / \"\" / \"\"\n \"includeImages\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{base_url}}{{appraisal_quote}}","description":"General Description:
\nQuote Data by Inspection ID
Returns the appraisal data of an inspection: basic vehicle information, the public quote link, the offer price and total reconditioning cost (when available), and a list of damages grouped by car part. Each damage group contains the estimator description and the cost to repair or replace the part, plus an image URL and the damage-location rectangle per detection.
\nMake sure the inspected vehicle has a related appraisal ready on uvcamp.
\nRequest-Body schema:
Provide one identifier (inspectionId, licensePlate, vin, or uniqueId).
\n\n\n\n| parameter | \ntype | \ndescription | \nrequired\\optional | \n
\n\n\n\n| inspectionId | \nstring | \nunique id of the inspection | \nrequired (1 of 4 identifiers) | \n
\n\n| licensePlate | \nstring | \nvehicle license plate | \nrequired (1 of 4 identifiers) | \n
\n\n| vin | \nstring | \nvehicle VIN | \nrequired (1 of 4 identifiers) | \n
\n\n| uniqueId | \nstring | \nvehicle barcode | \nrequired (1 of 4 identifiers) | \n
\n\n| includeImages | \nboolean | \nwhen false, image URLs are omitted from the response | \noptional (true by default) | \n
\n\n
\n
Response-Body Schema (top level):
\n\n\n\n| parameter | \ntype | \ndescription | \n
\n\n\n\n| inspectionId | \nstring | \nunique id of the inspection | \n
\n\n| uniqueId | \nstring | \nvehicle barcode (if available) | \n
\n\n| licensePlate | \nstring | \nvehicle license plate | \n
\n\n| vin | \nstring | \nvehicle VIN | \n
\n\n| make | \nstring | \nvehicle make | \n
\n\n| model | \nstring | \nvehicle model | \n
\n\n| year | \nnumber | \nvehicle model year | \n
\n\n| quoteUrl | \nstring | \npublic link to the quote | \n
\n\n| coverImage | \nstring | \nURL of the vehicle cover image | \n
\n\n| totalReconditioningCost | \nnumber | \ntotal estimated reconditioning cost (when available) | \n
\n\n| offerPrice | \nnumber | \noffer price (when available) | \n
\n\n| defects | \nobject[] | \nlist of damages grouped by car part (see below) | \n
\n\n
\n
defects[] — one entry per car part:
\n\n\n\n| parameter | \ntype | \ndescription | \n
\n\n\n\n| partName | \nstring | \nthe affected car part | \n
\n\n| module | \nstring | null | \nthe module that detected the damage (e.g. Atlas, Artemis) | \n
\n\n| damages | \nobject[] | \nlist of estimated repairs for this part (see below) | \n
\n\n
\n
defects[].damages[] — one entry per estimated repair (cost lives here):
\n\n\n\n| parameter | \ntype | \ndescription | \n
\n\n\n\n| damageType | \nstring | \nthe type of damage | \n
\n\n| isAutoEstimated | \nboolean | \ntrue if the cost was auto-estimated | \n
\n\n| cost | \nnumber | \ncost to repair or replace | \n
\n\n| description | \nstring | \nestimator description | \n
\n\n| damages | \nobject[] | \nsupporting images for this repair (see below) | \n
\n\n
\n
defects[].damages[].damages[] — one entry per image:
\n\n\n\n| parameter | \ntype | \ndescription | \n
\n\n\n\n| imageUrl | \nstring | \nURL of the damage image | \n
\n\n| detectionId | \nstring | null | \ndetection id (null for tire / Artemis damages) | \n
\n\n| rectangle | \nobject | \ndamage location: { pointType, top, left, width, height } (relative coordinates) | \n
\n\n
\n
\nNote on nesting: each defects[] entry is one car part; its damages[] array holds the estimated repairs for that part; and each repair carries its own damages[] array of supporting images.
\n
\nPossible response statuses:
\n\n\n\n| status number | \nexpected message | \ndescription | \n
\n\n\n\n| 200 (OK) | \n- | \n- | \n
\n\n| 400 (Bad Request) | \nRequest failed | \n- | \n
\n\n| 400 (Bad Request) | \nMissing search criteria | \none of inspectionId, licensePlate, vin, or uniqueId must be provided | \n
\n\n| 401 | \nAPI key is disabled | \nRefresh the API key in the backoffice and use the updated key in the header of the request | \n
\n\n| 401 | \nInvalid API key | \nThe API key you entered is invalid | \n
\n\n| 404 (Not Found) | \n- | \nno inspection or active quote found for the given identifier | \n
\n\n| 405 (Method Not Allowed) | \nunknown method, please use POST | \nyou are using a different method then \"POST\" | \n
\n\n
\n
General Description:
\nInspection Shared
Records that an inspection's public link was shared with a customer. Call this after sending a public link so the share is logged in the UVeye system.
\nRequest-Body schema:
\n\n\n\n| parameter | \ntype | \ndescription | \nrequired\\optional | \n
\n\n\n\n| inspectionId | \nstring | \nunique id of the inspection that was shared | \nrequired | \n
\n\n| publicLinkUrl | \nstring | \nthe public inspection link that was sent to the customer | \noptional | \n
\n\n
\n
Examples:
\n{ \"inspectionId\": \"1234567890\", \"publicLinkUrl\": \"https://us.uvpub.uveye.app/public/ABCDEF123456\" }\n
{ \"inspectionId\": \"1234567890\" }\n
Response:
On success the endpoint returns 200 OK with an empty body. The inspection is recorded as shared in the UVeye system.
\nPossible response statuses:
\n\n\n\n| status number | \nexpected message | \ndescription | \n
\n\n\n\n| 200 (OK) | \n- | \nthe share was recorded | \n
\n\n| 400 (Bad Request) | \n- | \ninspectionId is missing or the request is malformed | \n
\n\n| 401 | \nAPI key is disabled / Invalid API key | \nrefresh the API key in the backoffice and use the updated key | \n
\n\n| 405 (Method Not Allowed) | \nunknown method, please use POST | \nyou are using a different method then \"POST\" | \n
\n\n
\n