NIEM Examples - VIN Check (GVQ/GVR)

VIN Check NIEM Specifications

This section provides NIEM format and examples for VIN Check Transactions (GVQ/GVR).

All Nlets NIEM messages must be based on the Nlets NIEM Message Structure and include the standard Nlets XML Header as detailed in Message Structure. The NIEM header and hierarchy of the elements in this section have been omitted to avoid redundancy. The associated schemas and instances should be consulted to determine the correct XPaths of the elements.

Element Dictionary

Transaction types detailed below include: VIN Check Query (GVQ) and VIN Check Response (GVR).

Query Formats

VIN Check query (GVQ)

Inquiry Data (n:NLETSInquiryData)
This element will contain all elements specific to this transaction.

Vehicle(nc:Vehicle)
NIEM: A motor-driven conveyance designed to carry its operator, and optionally passengers and cargo, over land.
- Vehicle Identification (nc:VehicleIdentification)
  NIEM: A unique combination of alphanumeric characters that identifies a specific vehicle.
  - Identification ID (nc:IdentificationID)
    NIEM: A value that identifies something.

Response Formats

VIN Check response (GVR)

Name Code VIN Check Response n2-vc:VINCheckResponse Vehicle Information nc:Vehicle VIN nc:VehicleIdentification Vehicle Type nc:ItemCategoryText Make nc:ItemMakeName Model nc:ItemModelName Model Year nc:ItemModelYearDate Doors nc:VehicleDoorQuantity Seats nc:VehicleSeatingQuantity Transmission Type nc:VehicleTransmissionCategoryAbstract Axles nc:VehicleAxleQuantity Vehicle Augmentation n2-vc:VehicleAugmentation Active Safety System Note n2-vc:ActiveSafetySysNote Adaptive Cruise Control n2-vc:AdaptiveCruiseControlText Adaptive Driving Beam n2-vc:AdaptiveDrivingBeam Adaptive Headlights n2-vc:AdaptiveHeadlightsText Additional Information n2-vc:AdditionalInformationText Additional Restraint System n2-vc:AdditionalRestraintSystemText Air Bag Location Curtain n2-vc:AirBagLocationCurtainText Air Bag Location Front n2-vc:AirBagLocationFrontText Air Bag Location Knee n2-vc:AirBagLocationKneeText Air Bag Location Seat Cushion n2-vc:AirBagLocationSeatCushionText Air Bag Location Side n2-vc:AirBagLocationSideText Anti Lock Brakes n2-vc:AntiLockBrakeText Automatic Pedestrian Alerting Sound n2-vc:AutomaticPedestrianAlertingSound Auto Reverse System n2-vc:AutoReverseSystem Blind Spot Intervention n2-vc:BlindSpotIntervention Blind Spot Monitoring n2-vc:BlindSpotMonitoringText Bus Information n2-vc:BusInformationText CAN_AACN n2-vc:CAN_AACN Cash for Clunkers n2-vc:CashForClunkersText Charger Level n2-vc:ChargerLevelText Charger Power KW n2-vc:ChargerPowerKWText Collision imminent Braking n2-vc:CollisionImminentBraking Cooling Category n2-vc:CoolingCategoryText Daytime Running Light n2-vc:DaytimeRunningLight Dynamic Brake Support n2-vc:DynamicBrakeSupport Electrification Level n2-vc:ElectrificationLevelText Electronic Stability Control n2-vc:ElectronicStabilityControlText Entertainment System n2-vc:EntertainmentSystemText EVDriveUnit n2-vc:EVDriveUnitText Event Data Recorder n2-vc:EventDataRecorder Forward Collision Warning n2-vc:ForwardCollisionWarningText Fuel Category n2-vc:FuelCategorySecondaryText Fuel Injection n2-vc:FuelInjectionCategoryText GCWR n2-vc:GrossCombinedWeightRating GCWR Up To n2-vc:GrossCombinedWeightRatingUpTo GVWR n2-vc:GrossVehicleWeightRatingText GVWR Up To n2-vc:GrossVehicleWeightRatingUpTo Keyless Ignition n2-vc:KeylessIgnition Lane Departure Warning n2-vc:LaneDepartureWarningText Lane Keep n2-vc:LaneKeepText Lower Beam Headlamp Light Source n2-vc:LowerBeamHeadlampLightSource Make ID n2-vc:MakeID Manufacturer ID n2-vc:ManufacturerIdentification Model ID n2-vc:ModelID Motorcycle Chassis Category n2-vc:MotorcycleChassisCategoryText Motorcycle Custom Type n2-vc:MotorcycleCustomCategoryText Motorcycle Information n2-vc:MotorcycleInformationText Motorcycle Suspension Type n2-vc:MotorcycleSuspensionCategoryText Park Assist n2-vc:ParkAssistText Pedestrian Automatic Emergency Braking n2-vc:PedestrianAutomaticEmergencyBraking Plant City n2-vc:PlantCityText Plant Country n2-vc:PlantCountryText Plant Company n2-vc:PlantCompanyText Plant State n2-vc:PlantStateText Pretensioner n2-vc:Pretensioner Rear Cross Traffic Alert n2-vc:RearCrossTrafficAlert Rear Visibility System n2-vc:RearVisibilitySystem SAE Automation Level n2-vc:SAEAutomationLevel SAE Automation Level Up To n2-vc:SAEAutomationLevelUpTo Seat Belts n2-vc:SeatBeltsAllText Semiautomatic Headlamp Beam Switching n2-vc:SemiautomaticHeadlampBeamSwitching Series 2 n2-vc:SeriesAdditionalText Tire Pressure Monitoring System n2-vc:TirePressureMonitoringSystem Track Width Measure n2-vc:TrackWidthMeasure Trailer Body Type n2-vc:TrailerBodyCategoryText Trailer Connection Type n2-vc:TrailerConnectionCategoryText Traction Control n2-vc:TractionControlText Trailer Information n2-vc:TrailerInformationText Trailer Length n2-vc:TrailerLengthMeasure Trim n2-vc:TrimAdditionalText Axle Configuration n2-vc:VehicleAxelConfigurationText Base Price n2-vc:VehicleBasePriceText Battery Modules n2-vc:VehicleBatteryModulesText Battery Packs n2-vc:VehicleBatteryPacksText Bed Type n2-vc:VehicleBedCategoryText Bed Length n2-vc:VehicleBedLengthMeasure Body Cab Type n2-vc:VehicleBodyCabCategoryText Body Class n2-vc:VehicleBodyClassText Brake System Description n2-vc:VehicleBrakeSystemDescriptionText Brake System n2-vc:VehicleBrakeSystemText Bus Type n2-vc:VehicleBusCategoryText Bus Floor Configuration n2-vc:VehicleBusFloorConfigurationText Bus Length n2-vc:VehicleBusLength Curb Weight Measure n2-vc:VehicleCurbWeightMeasure Destination Market n2-vc:VehicleDestinationMarketText Drive Type n2-vc:VehicleDriveCategoryText Driver Assist n2-vc:VehicleDriverAssistText Engine Configuration n2-vc:VehicleEngineConfigurationText Seat Rows n2-vc:VehicleSeatRowsText Series n2-vc:VehicleSeriesText Steering Location n2-vc:VehicleSteeringLocationText Top Speed n2-vc:VehicleTopSpeedText Transmission Speeds n2-vc:VehicleTransmissionSpeedsText Trim n2-vc:VehicleTrimText Turbo n2-vc:VehicleTurboText Valve Train Design n2-vc:VehicleValveTrainDesignText Windows n2-vc:VehicleWindowsText Wheel Base Type n2-vc:WheelBaseCategoryText Wheel Base Short n2-vc:WheelBaseShortMeasure Wheel Base Long n2-vc:WheelBaseLongMeasure Wheels n2-vc:WheelNumberText Wheel Size Front n2-vc:WheelSizeFrontMeasure Wheel Size Rear n2-vc:WheelSizeRearMeasure Engine j:Engine Engine Cylinders j:EngineCylinderQuantity Fuel Type nc:ConveyanceFuelCategoryAbstract Engine Displacement: j:EngineDisplacementMeasure Engine Horsepower j:EngineHorsepowerQuantity Engine Augmentation n2-vc:EngineAugmentation Engine Cycles n2-vc:EngineCyclesText Horsepower Up To n2-vc:EngineHorsepowerUpToText Engine KW n2-vc:EngineKWText Engine Manufacturer n2-vc:EngineManufacturerText Engine Model n2-vc:EngineModelText Other Engine Info n2-vc:EngineOtherInformationText Battery n2-vc:Battery Battery Amps n2-vc:BatteryAmpsText Battery Amps Up To n2-vc:BatteryAmpsUpToText Battery Type n2-vc:BatteryCategoryText Battery Information n2-vc:BatteryInformationText Battery kWh n2-vc:BatterykWhText Battery kWh Up To n2-vc:BatterykWhUpToText Battery Volts n2-vc:BatteryVoltsText Battery Volts Up To n2-vc:BatteryVoltsUpToText NCSA n2-vc:NCSA NCSA Body Type n2-vc:NCSABodyTypeText NCSA Make n2-vc:NCSAMakeText NCSA Mapping Exception n2-vc:NCSAMappingException NCSA Map Exception Approved By n2-vc:NCSAMapExcApprovedBy NCSA Map Exception Approved On n2-vc:NCSAMapExcApprovedOn NCSA Model n2-vc:NCSAModelText NCSA Note n2-vc:NCSANote Additional Response Metadata n2-vc:ResponseMetadata Suggested VIN n2-vc:SuggestedVINText Error Codes n2-vc:ErrorCodesText Error Text n2-vc:ErrorText Possible Values n2-vc:PossibleValuesText Additional Error n2-vc:AdditionalErrorText

VIN Check NIEM Examples

Example 1: Query of a VIN Check transaction.

<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://niem.gov/niem/niem-core/2.0" xmlns:n2="http://www.nlets.org/niem/1.0">
    <n2:NLETSMessageHeader>
        <nh2:MessageKeyCodeText>GVQ</nh2:MessageKeyCodeText>
        <nh2:OriginatingORIID>AZNLETS45</nh2:OriginatingORIID>
        <nh2:DestinationORIID>NL</nh2:DestinationORIID>
    </n2:NLETSMessageHeader>
    <n2:NLETSInquiryData n2:key="GVQ">
        <n1:Vehicle xmlns:n1="http://release.niem.gov/niem/niem-core/4.0/">
            <n1:VehicleIdentification>
                <n1:IdentificationID>3GNEC12J48G183197</n1:IdentificationID>
            </n1:VehicleIdentification>
        </n1:Vehicle>
    </n2:NLETSInquiryData>
</n2:NLETS>

Example 2: Response to a VIN Check query.

<n2:NLETS xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" n2:version="4.00" xmlns:nc="http://release.niem.gov/niem/niem-core/4.0/"
xmlns:j="http://release.niem.gov/niem/domains/jxdm/6.0/" xmlns:n2-vc="http://www.nlets.org/niem/nlets-vin-check/1.0" xmlns:n2="http://www.nlets.org/niem/1.0">
    <n2:NLETSMessageHeader>
        <nh2:MessageKeyCodeText>GVR</nh2:MessageKeyCodeText>
        <nh2:OriginatingORIID>NL0000000</nh2:OriginatingORIID>
        <nh2:DestinationORIID>AZNLETS45</nh2:DestinationORIID>
        <nh2:DocumentControlFieldText>
            <![CDATA[WIKIEXAMPL]]></nh2:DocumentControlFieldText>
        <nh2:MessageReceiveDate>06/10/2021</nh2:MessageReceiveDate>
        <nh2:MessageReceiveTime>03:45</nh2:MessageReceiveTime>
        <nh2:MessageSendDate>06/10/2021</nh2:MessageSendDate>
        <nh2:MessageSendTime>03:45</nh2:MessageSendTime>
        <nh2:ReceiveMessageNumeric>00000</nh2:ReceiveMessageNumeric>
        <nh2:SendMessageNumeric>00002</nh2:SendMessageNumeric>
    </n2:NLETSMessageHeader>
    <n2:NLETSInquiryData n2:key="GVQ">
        <n2-vc:VINCheckInquiry>
            <nc:VehicleIdentification>
                <nc:IdentificationID>3GNEC12J48G183197</nc:IdentificationID>
            </nc:VehicleIdentification>
        </n2-vc:VINCheckInquiry>
    </n2:NLETSInquiryData>
    <n2:NLETSResponseData n2:key="GVR">
        <n2-vc:VINCheckResponse>
            <nc:Vehicle>
                <nc:ItemCategoryText>MULTIPURPOSE PASSENGER VEHICLE (MPV)</nc:ItemCategoryText>
                <nc:ItemMakeName>CHEVROLET</nc:ItemMakeName>
                <nc:ItemModelName>Avalanche</nc:ItemModelName>
                <nc:ItemModelYearDate>2008</nc:ItemModelYearDate>
                <nc:VehicleDoorQuantity>4</nc:VehicleDoorQuantity>
                <nc:VehicleIdentification>
                    <nc:IdentificationID>3GNEC12J48G183197</nc:IdentificationID>
                </nc:VehicleIdentification>
                <n2-vc:VehicleAugmentation>
                    <j:Engine>
                        <j:EngineDisplacementMeasure>
                            <nc:MeasureValueText>5300.0</nc:MeasureValueText>
                            <nc:VolumeUnit>CC</nc:VolumeUnit>
                            <nc:MeasureValueText>323.42584370208</nc:MeasureValueText>
                            <nc:VolumeUnit>CI</nc:VolumeUnit>
                            <nc:MeasureValueText>5.3</nc:MeasureValueText>
                            <nc:VolumeUnit>L</nc:VolumeUnit>
                        </j:EngineDisplacementMeasure>
                        <n2-vc:EngineAugmentation>
                            <n2-vc:EngineManufacturerText>GM</n2-vc:EngineManufacturerText>
                            <n2-vc:EngineModelText>LY5</n2-vc:EngineModelText>
                            <n2-vc:EngineOtherInformationText>Active Fuel Mgt.</n2-vc:EngineOtherInformationText>
                        </n2-vc:EngineAugmentation>
                    </j:Engine>
                    <n2-vc:FuelInjectionCategoryText>Sequential Fuel Injection (SFI)</n2-vc:FuelInjectionCategoryText>
                    <n2-vc:GrossVehicleWeightRatingText>Class 2E: 6,001 - 7,000 lb (2,722 - 3,175 kg)</n2-vc:GrossVehicleWeightRatingText>
                    <n2-vc:ManufacturerIdentification>
                                <nc:IdentificationID>984</nc:IdentificationID>
                    </n2-vc:ManufacturerIdentification>
                    <n2-vc:MotorcycleChassisCategoryText>Not Applicable</n2-vc:MotorcycleChassisCategoryText>
                    <n2-vc:MotorcycleCustomCategoryText>Not Applicable</n2-vc:MotorcycleCustomCategoryText>
                    <n2-vc:MotorcycleSuspensionCategoryText>Not Applicable</n2-vc:MotorcycleSuspensionCategoryText>
                    <n2-vc:PlantCityText>SILAO</n2-vc:PlantCityText>
                    <n2-vc:PlantCountryText>MEXICO</n2-vc:PlantCountryText>
                    <n2-vc:PlantCompanyText>GMNA</n2-vc:PlantCompanyText>
                    <n2-vc:TrailerBodyCategoryText>Not Applicable</n2-vc:TrailerBodyCategoryText>
                    <n2-vc:TrailerConnectionCategoryText>Not Applicable</n2-vc:TrailerConnectionCategoryText>
                    <n2-vc:VehicleBodyClassText>Sport Utility Truck (SUT)</n2-vc:VehicleBodyClassText>
                    <n2-vc:VehicleBrakeSystemText>Hydraulic</n2-vc:VehicleBrakeSystemText>
                    <n2-vc:VehicleBusCategoryText>Not Applicable</n2-vc:VehicleBusCategoryText>
                    <n2-vc:VehicleBusFloorConfigurationText>Not Applicable</n2-vc:VehicleBusFloorConfigurationText>
                    <n2-vc:VehicleDriveCategoryText>4x2</n2-vc:VehicleDriveCategoryText>
                    <n2-vc:VehicleEngineConfigurationText>V-Shaped</n2-vc:VehicleEngineConfigurationText>
                    <n2-vc:VehicleSeriesText>1/2 Ton</n2-vc:VehicleSeriesText>
                    <n2-vc:VehicleTrimText>LS</n2-vc:VehicleTrimText>
                    <n2-vc:MakeID>467</n2-vc:MakeID>
                    <n2-vc:ModelID>3876</n2-vc:ModelID>
                    <n2-vc:TirePressureMonitoringSystem>Direct</n2-vc:TirePressureMonitoringSystem>
                    <n2-vc:VehicleManufacturer>GENERAL MOTORS LLC</n2-vc:VehicleManufacturer>
                </n2-vc:VehicleAugmentation>
            </nc:Vehicle>
            <n2-vc:ResponseMetadata>
                <n2-vc:ErrorCodesText>0</n2-vc:ErrorCodesText>
                <n2-vc:ErrorText>0 - VIN decoded clean. Check Digit (9th position) is correct</n2-vc:ErrorText>
            </n2-vc:ResponseMetadata>
        </n2-vc:VINCheckResponse>
    </n2:NLETSResponseData>
</n2:NLETS>