{"openapi":"3.1.0","info":{"title":"MrVIN Partner API","description":"Vehicle history reports for business partners, billed per call.\n\nBuy a report with `POST /v1/reports`. Some sections are assembled asynchronously, so a response may come back with `status: enriching` and the remaining sections named in `pendingSections`; re-read the report with `GET /v1/reports/{reportId}` to collect them. Re-reads are free for the life of the report's access window, and so is the report you already bought — you are charged for the lookup, not for reading it back.\n\nCalls that return an error are never billed.","version":"v1"},"servers":[{"url":"https://api.mrvin.com","description":"Production"}],"security":[{"apiKey":[]}],"paths":{"/v1/reports":{"post":{"tags":["web-partner-report-api"],"operationId":"createReport","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReportRequest"}}}},"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PartnerReport"}}}}}}},"/v1/reports/{reportId}":{"get":{"tags":["web-partner-report-api"],"operationId":"getReport","parameters":[{"name":"reportId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PartnerReport"}}}}}}},"/v1/ping":{"get":{"tags":["web-partner-ping-api"],"operationId":"ping","responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PingResponse"}}}}}}},"/v1/account":{"get":{"tags":["web-partner-account-api"],"operationId":"account","responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AccountResponse"}}}}}}},"/v1/account/usage":{"get":{"tags":["web-partner-usage-api"],"operationId":"usage","parameters":[{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UsageResponse"}}}}}}},"/v1/account/statements":{"get":{"tags":["web-partner-usage-api"],"operationId":"statements","responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Statement"}}}}}}}}},"components":{"schemas":{"CreateReportRequest":{"type":"object","properties":{"vin":{"type":"string"}}},"AccidentEntry":{"type":"object","properties":{"date":{"type":"string"},"type":{"type":"string"},"description":{"type":"string"},"referenceId":{"type":"integer","format":"int64"},"country":{"type":"string"},"damageValue":{"type":"number","format":"double"},"damageCurrency":{"type":"string"},"damageValueEur":{"type":"number","format":"double"},"otherPartyDamageValue":{"type":"number","format":"double"},"otherPartyDamageCurrency":{"type":"string"},"otherPartyDamageValueEur":{"type":"number","format":"double"},"wasVictim":{"type":"boolean"},"source":{"type":"string"},"cause":{"type":"string"},"damageZones":{"type":"array","items":{"type":"string"}},"damagePositions":{"type":"array","items":{"type":"string"}},"partGroups":{"type":"array","items":{"type":"string"}},"referenceCode":{"type":"string"},"photos":{"type":"array","items":{"$ref":"#/components/schemas/Photo"}}}},"AuctionEntry":{"type":"object","properties":{"saleIndex":{"type":"string"},"saleDate":{"type":"string"},"saleStatus":{"type":"string"},"price":{"type":"string"},"priceAmount":{"type":"integer","format":"int32"},"priceCurrency":{"type":"string"},"odometerMi":{"type":"integer","format":"int32"},"odometerKm":{"type":"integer","format":"int32"},"titleType":{"type":"string"},"primaryDamage":{"type":"string"},"secondaryDamage":{"type":"string"},"estRepairCost":{"type":"string"},"bodyStyle":{"type":"string"},"color":{"type":"string"},"fuelType":{"type":"string"},"transmission":{"type":"string"},"sellerType":{"type":"string"},"location":{"type":"string"},"lotNumber":{"type":"string"},"northAmerican":{"type":"boolean"},"source":{"type":"string"},"photos":{"type":"array","items":{"$ref":"#/components/schemas/Photo"}}}},"Checks":{"type":"object","properties":{"hasAccidents":{"type":"boolean"},"isTaxi":{"type":"boolean"},"isLearningVehicle":{"type":"boolean"},"hasOpenRecall":{"type":"boolean"},"isExported":{"type":"boolean"},"odometerVerdict":{"type":"string"},"odometerVerdictCode":{"type":"string"},"odometerVerdictExplanation":{"type":"string"},"canBeTransferred":{"type":"boolean"}}},"Coverage":{"type":"object","properties":{"checks":{"type":"array","items":{"$ref":"#/components/schemas/CoverageCheck"}},"sourcesConsulted":{"type":"integer","format":"int32"},"countries":{"type":"array","items":{"type":"string"}}}},"CoverageCheck":{"type":"object","properties":{"key":{"type":"string"},"status":{"type":"string"},"sources":{"type":"integer","format":"int32"},"countries":{"type":"array","items":{"type":"string"}}}},"Defect":{"type":"object","properties":{"group":{"type":"string"},"subgroup":{"type":"string"},"description":{"type":"string"},"severity":{"type":"string"},"details":{"type":"string"}}},"EquipmentEntry":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"}}},"EquipmentLine":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}}},"FactoryData":{"type":"object","properties":{"trim":{"type":"string"},"style":{"type":"string"},"baseMsrp":{"type":"string"},"deliveryCharges":{"type":"string"},"invoicePrice":{"type":"string"},"totalPrice":{"type":"string"},"priceCurrency":{"type":"string"},"epaCityMpg":{"type":"string"},"epaHwyMpg":{"type":"string"},"epaCombinedMpg":{"type":"string"},"recalls":{"type":"array","items":{"$ref":"#/components/schemas/FactoryRecall"}},"warranties":{"type":"array","items":{"$ref":"#/components/schemas/FactoryWarranty"}},"nhtsaRatings":{"type":"array","items":{"$ref":"#/components/schemas/SafetyRating"}},"iihsRatings":{"type":"array","items":{"$ref":"#/components/schemas/SafetyRating"}},"standardEquipment":{"type":"array","items":{"$ref":"#/components/schemas/EquipmentLine"}},"featureGroups":{"type":"array","items":{"$ref":"#/components/schemas/FeatureGroup"}}}},"FactoryRecall":{"type":"object","properties":{"campaignId":{"type":"string"},"date":{"type":"string"},"component":{"type":"string"},"summary":{"type":"string"},"consequences":{"type":"string"},"remedy":{"type":"string"}}},"FactoryWarranty":{"type":"object","properties":{"type":{"type":"string"},"months":{"type":"string"},"miles":{"type":"string"}}},"FeatureGroup":{"type":"object","properties":{"title":{"type":"string"},"items":{"type":"array","items":{"type":"string"}}}},"HistoryEvent":{"type":"object","properties":{"date":{"type":"string"},"location":{"type":"string"},"source":{"type":"string"},"odometerKm":{"type":"integer","format":"int32"},"details":{"type":"array","items":{"type":"string"}}}},"Identity":{"type":"object","properties":{"make":{"type":"string"},"model":{"type":"string"},"variant":{"type":"string"},"commercialName":{"type":"string"},"year":{"type":"string"},"color":{"type":"string"},"colorKey":{"type":"string"},"colorHex":{"type":"string"},"interiorColor":{"type":"string"},"bodyType":{"type":"string"},"category":{"type":"string"},"seatCount":{"type":"integer","format":"int32"},"doors":{"type":"integer","format":"int32"},"isRightHandDrive":{"type":"boolean"},"isTaxi":{"type":"boolean"},"isLearningVehicle":{"type":"boolean"},"currentStatus":{"type":"string"},"manufacturedDate":{"type":"string"}}},"Images":{"type":"object","properties":{"brandLogo":{"type":"string"},"modelPhoto":{"type":"string"}}},"Inspection":{"type":"object","properties":{"date":{"type":"string"},"type":{"type":"string"},"decision":{"type":"string"},"odometer":{"type":"integer","format":"int32"},"nextInspectionDate":{"type":"string"},"company":{"type":"string"},"address":{"type":"string"},"source":{"type":"string"},"defects":{"type":"array","items":{"$ref":"#/components/schemas/Defect"}}}},"InsuranceEntry":{"type":"object","properties":{"insurer":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"issueDate":{"type":"string"}}},"ListingEntry":{"type":"object","properties":{"firstSeenAt":{"type":"string"},"lastSeenAt":{"type":"string"},"price":{"type":"integer","format":"int32"},"mileage":{"type":"integer","format":"int32"},"sourceDomain":{"type":"string"},"sellerType":{"type":"string"},"inventoryType":{"type":"string"}}},"ListingHistory":{"type":"object","properties":{"providerName":{"type":"string"},"totalListings":{"type":"integer","format":"int32"},"entries":{"type":"array","items":{"$ref":"#/components/schemas/ListingEntry"}}}},"MileageEntry":{"type":"object","properties":{"date":{"type":"string"},"odometer":{"type":"integer","format":"int32"},"source":{"type":"string"}}},"OwnerRecord":{"type":"object","properties":{"owner":{"type":"string"},"purchased":{"type":"string"},"state":{"type":"string"},"owned":{"type":"string"},"duration":{"type":"string"}}},"OwnershipEntry":{"type":"object","properties":{"ownerType":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"durationDays":{"type":"integer","format":"int32"}}},"PartOption":{"type":"object","properties":{"brand":{"type":"string"},"partNumber":{"type":"string"}}},"PartnerReport":{"type":"object","properties":{"reportId":{"type":"string"},"status":{"type":"string"},"pendingSections":{"type":"array","items":{"type":"string"}},"vin":{"type":"string"},"registrationNumber":{"type":"string"},"sectionStatus":{"type":"object","additionalProperties":{"type":"string"}},"report":{"$ref":"#/components/schemas/VehicleReport"}}},"Photo":{"type":"object","properties":{"claimId":{"type":"string"},"wan":{"type":"string"},"url":{"type":"string"}}},"Provenance":{"type":"object","properties":{"sources":{"type":"array","items":{"type":"string"}},"fromCache":{"type":"boolean"},"fieldSources":{"type":"object","additionalProperties":{"type":"string"}}}},"Recall":{"type":"object","properties":{"campaignId":{"type":"string"},"manufacturerCode":{"type":"string"},"date":{"type":"string"},"manufacturer":{"type":"string"},"component":{"type":"string"},"summary":{"type":"string"},"consequences":{"type":"string"},"risk":{"type":"string"},"remedy":{"type":"string"},"repaired":{"type":"boolean"},"status":{"type":"string"},"vehiclesAffected":{"type":"integer","format":"int32"},"vehiclesAffectedInCountry":{"type":"integer","format":"int32"},"country":{"type":"string"},"source":{"type":"string"}}},"Registration":{"type":"object","properties":{"firstRegisteredAt":{"type":"string"},"registeredInLatviaAt":{"type":"string"},"purchaseCountry":{"type":"string"},"previousRegistrationCountry":{"type":"string"},"isCurrentlyInsured":{"type":"boolean"},"currentOwnerType":{"type":"string"},"currentKeeperSince":{"type":"string"},"catalogPriceNew":{"type":"integer","format":"int32"},"catalogPriceCurrency":{"type":"string"},"registrationTax":{"type":"integer","format":"int32"}}},"SafetyRating":{"type":"object","properties":{"type":{"type":"string"},"rating":{"type":"string"}}},"ServiceEvent":{"type":"object","properties":{"date":{"type":"string"},"mileageKm":{"type":"integer","format":"int32"},"mileageOriginal":{"type":"integer","format":"int32"},"mileageUnit":{"type":"string"},"serviceProvider":{"type":"string"},"serviceType":{"type":"string"},"actions":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"location":{"type":"string"},"cost":{"type":"number","format":"double"},"costCurrency":{"type":"string"},"documentUrl":{"type":"string"},"referenceId":{"type":"string"},"source":{"type":"string"}}},"ServicePart":{"type":"object","properties":{"name":{"type":"string"},"spec":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/PartOption"}},"optionsMore":{"type":"integer","format":"int32"}}},"ServiceScheduleItem":{"type":"object","properties":{"operation":{"type":"string"},"operationKey":{"type":"string"},"intervalKm":{"type":"integer","format":"int32"},"intervalMonths":{"type":"integer","format":"int32"},"labourMinutes":{"type":"integer","format":"int32"},"serviceType":{"type":"string"},"status":{"type":"string"},"lastDoneKm":{"type":"integer","format":"int32"},"lastDoneDate":{"type":"string"},"dueKm":{"type":"integer","format":"int32"},"dueDate":{"type":"string"},"source":{"type":"string"},"parts":{"type":"array","items":{"$ref":"#/components/schemas/ServicePart"}}}},"ServiceScheduleSummary":{"type":"object","properties":{"nextDueKm":{"type":"integer","format":"int32"},"nextDueDate":{"type":"string"},"nextDueOperation":{"type":"string"},"overdue":{"type":"boolean"},"lastKnownKm":{"type":"integer","format":"int32"},"lastKnownDate":{"type":"string"}}},"StolenCheck":{"type":"object","properties":{"possibleStolen":{"type":"boolean"},"records":{"type":"array","items":{"$ref":"#/components/schemas/StolenRecord"}},"source":{"type":"string"}}},"StolenRecord":{"type":"object","properties":{"make":{"type":"string"},"model":{"type":"string"},"plate":{"type":"string"},"color":{"type":"string"},"location":{"type":"string"},"date":{"type":"string"}}},"Technical":{"type":"object","properties":{"engineCode":{"type":"string"},"engineDescription":{"type":"string"},"fuelType":{"type":"string"},"powerKw":{"type":"string"},"powerPs":{"type":"string"},"capacityCcm":{"type":"string"},"cylinders":{"type":"string"},"valves":{"type":"string"},"aspiration":{"type":"string"},"co2GPerKm":{"type":"string"},"curbMassKg":{"type":"integer","format":"int32"},"grossMassKg":{"type":"integer","format":"int32"},"transmission":{"type":"string"},"drive":{"type":"string"},"driveSide":{"type":"string"},"platform":{"type":"string"},"emissionStandard":{"type":"string"},"energyLabel":{"type":"string"}}},"Valuation":{"type":"object","properties":{"providerName":{"type":"string"},"currency":{"type":"string"},"description":{"type":"string"},"valuationDate":{"type":"string"},"mileageAtValuation":{"type":"integer","format":"int32"},"book":{"type":"string"},"onTheRoadGbp":{"type":"integer","format":"int32"},"dealerForecourtGbp":{"type":"integer","format":"int32"},"privateCleanGbp":{"type":"integer","format":"int32"},"partExchangeGbp":{"type":"integer","format":"int32"},"auctionGbp":{"type":"integer","format":"int32"},"retailPrice":{"type":"integer","format":"int32"},"tradeInPrice":{"type":"integer","format":"int32"},"privatePartyPrice":{"type":"integer","format":"int32"},"auctionPrice":{"type":"integer","format":"int32"},"priceLow":{"type":"integer","format":"int32"},"priceHigh":{"type":"integer","format":"int32"},"averagePrice":{"type":"integer","format":"int32"},"baseMarketCountry":{"type":"string"},"targetCountry":{"type":"string"},"basePrice":{"type":"integer","format":"int32"},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/ValuationAdjustment"}},"adjustedPrice":{"type":"integer","format":"int32"}}},"ValuationAdjustment":{"type":"object","properties":{"code":{"type":"string"},"pct":{"type":"number","format":"double"},"amountEur":{"type":"integer","format":"int32"}}},"VehicleHistory":{"type":"object","properties":{"titleBrands":{"type":"array","items":{"type":"string"}},"owners":{"type":"array","items":{"$ref":"#/components/schemas/OwnerRecord"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/HistoryEvent"}},"serviceCount":{"type":"integer","format":"int32"},"accidentRecordsFound":{"type":"boolean"},"source":{"type":"string"}}},"VehicleReport":{"type":"object","properties":{"reportId":{"type":"string"},"vin":{"type":"string"},"generatedAt":{"type":"string"},"identity":{"$ref":"#/components/schemas/Identity"},"technical":{"$ref":"#/components/schemas/Technical"},"registration":{"$ref":"#/components/schemas/Registration"},"checks":{"$ref":"#/components/schemas/Checks"},"mileageHistory":{"type":"array","items":{"$ref":"#/components/schemas/MileageEntry"}},"ownershipHistory":{"type":"array","items":{"$ref":"#/components/schemas/OwnershipEntry"}},"accidentHistory":{"type":"array","items":{"$ref":"#/components/schemas/AccidentEntry"}},"damagePhotosAvailable":{"type":"boolean"},"photos":{"type":"array","items":{"$ref":"#/components/schemas/Photo"}},"photosStatus":{"type":"string"},"inspections":{"type":"array","items":{"$ref":"#/components/schemas/Inspection"}},"recalls":{"type":"array","items":{"$ref":"#/components/schemas/Recall"}},"insurance":{"type":"array","items":{"$ref":"#/components/schemas/InsuranceEntry"}},"equipment":{"type":"array","items":{"$ref":"#/components/schemas/EquipmentEntry"}},"serviceHistory":{"type":"array","items":{"$ref":"#/components/schemas/ServiceEvent"}},"serviceHistoryStatus":{"type":"string"},"serviceSchedule":{"type":"array","items":{"$ref":"#/components/schemas/ServiceScheduleItem"}},"serviceScheduleStatus":{"type":"string"},"serviceScheduleSummary":{"$ref":"#/components/schemas/ServiceScheduleSummary"},"vehicleStatus":{"type":"string"},"images":{"$ref":"#/components/schemas/Images"},"valuation":{"$ref":"#/components/schemas/Valuation","deprecated":true},"valuations":{"type":"array","items":{"$ref":"#/components/schemas/Valuation"}},"listingHistories":{"type":"array","items":{"$ref":"#/components/schemas/ListingHistory"}},"auctionHistory":{"type":"array","items":{"$ref":"#/components/schemas/AuctionEntry"}},"auctionPhotosStatus":{"type":"string"},"factoryData":{"$ref":"#/components/schemas/FactoryData"},"stolenCheck":{"$ref":"#/components/schemas/StolenCheck"},"vehicleHistory":{"$ref":"#/components/schemas/VehicleHistory"},"vehicleHistoryStatus":{"type":"string"},"provenance":{"$ref":"#/components/schemas/Provenance"},"coverage":{"$ref":"#/components/schemas/Coverage"}}},"PingResponse":{"type":"object","properties":{"status":{"type":"string"},"version":{"type":"string"},"region":{"type":"string"}}},"AccountResponse":{"type":"object","properties":{"partner":{"type":"string"},"billingMode":{"type":"string"},"balanceEur":{"type":"number"},"creditLimitEur":{"type":"number"},"rateLimitPerMinute":{"type":"integer","format":"int32"},"reportAccessDays":{"type":"integer","format":"int32"},"prices":{"type":"object","additionalProperties":{"type":"number"}}}},"DailyUsage":{"type":"object","properties":{"day":{"type":"string","format":"date"},"calls":{"type":"integer","format":"int64"},"billableCalls":{"type":"integer","format":"int64"},"amountEur":{"type":"number"}}},"UsageResponse":{"type":"object","properties":{"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"totalCalls":{"type":"integer","format":"int64"},"billableCalls":{"type":"integer","format":"int64"},"totalEur":{"type":"number"},"days":{"type":"array","items":{"$ref":"#/components/schemas/DailyUsage"}}}},"Line":{"type":"object","properties":{"endpoint":{"type":"string"},"calls":{"type":"integer","format":"int64"},"billableCalls":{"type":"integer","format":"int64"},"amountEur":{"type":"number"}}},"Statement":{"type":"object","properties":{"periodStart":{"type":"string","format":"date"},"periodEnd":{"type":"string","format":"date"},"totalCalls":{"type":"integer","format":"int64"},"billableCalls":{"type":"integer","format":"int64"},"totalEur":{"type":"number"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/Line"}},"status":{"type":"string"},"deliveredAt":{"type":"string","format":"date-time"}}}},"securitySchemes":{"apiKey":{"type":"http","description":"Your API key, sent as `Authorization: Bearer <key>`. Keys begin with `mrvin_live_`. The `X-Api-Key` header is accepted as an alternative. Never send a key in the query string — that request is rejected, because a key in a URL ends up in logs and browser history.","scheme":"bearer"}}}}