Fetch Vehicle Details API

The following document outlines the details of the Fetch Vehicle Details API.

API Description

Objective

The Fetch Vehicle Details API retrieves detailed vehicle registration information based on the provided Chassis Number.

Input	Output
The vehicle's chassis number	The complete vehicle profile including registration details, ownership information, vehicle specifications, address details, insurance information, permit details, and financier information. The complete list of output fields is available in the Success Response Details section

did you know

A Chassis Number, also known as a Vehicle Identification Number (VIN), is a unique, 17-character alphanumeric code assigned to each motor vehicle. This number is used to track a vehicle's history, registration, ownership, and other critical information.

The Chassis Number or VIN is typically found stamped on the vehicle's chassis, often in the engine compartment or on the driver's side doorjamb.

API URL

https://ind-thomas.hyperverge.co/v1/getVehicleDetailsFromChassis

API Endpoint

getVehicleDetailsFromChassis

Overview

The Fetch Vehicle Details API is RESTful and uses standard HTTP verbs and status codes. The responses are in JSON format and you should send all data in JSON format through a POST request.

Authentication

You need a unique pair of application ID ( appId ) and application key (appKey) from HyperVerge to verify your identity for accessing the Fetch Vehicle Details API.

API Request Details

Method - `POST`

Headers

Parameter	Mandatory or Optional	Description	Valid Values
content-type	Mandatory	This parameter defines the media type for the request payload	application/json
appId	Mandatory	The application ID shared by HyperVerge	Not Applicable - this is a unique value
appKey	Mandatory	The application key shared by HyperVerge	Not Applicable - this is a unique value
transactionid	Mandatory	The unique transaction ID for the user journey	Not Applicable - this is a unique value

Input

The following table provides the details of the parameters required for the Fetch Vehicle Details API's request body:

Parameter	Mandatory or Optional	Description	Allowed Values	Default Value
`chassisNo`	Mandatory	The vehicle's chassis number	Valid chassis number format	Not Applicable

Request

The following code snippet demonstrates a standard curl request for the Fetch Vehicle Details API:

curl --location --request POST 'https://ind-thomas.hyperverge.co/v1/getVehicleDetailsFromChassis' \
--header 'Content-Type: application/json' \
--header 'appId: <Enter_the_HyperVerge_appId>' \
--header 'appKey: <Enter_the_HyperVerge_appKey>' \
--header 'transactionId: <Enter_the_HyperVerge_transactionID>' \
--data '{
    "chassisNo": "<Enter_the_chassis_number>"
}'

Success Response

The following code snippet demonstrates a success response from the Fetch Vehicle Details API:

{
    "status": "success",
    "statusCode": 200,
    "result": {
        "stateCode": "<State_Code>",
        "state": "<State_Name>",
        "officeCode": "<Office_Code>",
        "officeName": "<Office_Name>",
        "regNo": "<Registration_Number>",
        "regDate": "<Registration_Date>",
        "purchaseDate": "<Purchase_Date>",
        "ownerCount": "<Owner_Count>",
        "ownerName": "<Owner_Name>",
        "ownerFatherName": "<Owner_Father_Name>",
        "currentAddressLine1": "<Current_Address_Line1>",
        "currentAddressLine2": "<Current_Address_Line2>",
        "currentAddressLine3": "<Current_Address_Line3>",
        "currentDistrictName": "<Current_District_Name>",
        "currentState": "<Current_State_Code>",
        "currentStateName": "<Current_State_Name>",
        "currentPincode": "<Current_Pincode>",
        "currentFullAddress": "<Current_Full_Address>",
        "permanentAddressLine1": "<Permanent_Address_Line1>",
        "permanentAddressLine2": "<Permanent_Address_Line2>",
        "permanentAddressLine3": "<Permanent_Address_Line3>",
        "permanentDistrictName": "<Permanent_District_Name>",
        "permanentState": "<Permanent_State_Code>",
        "permanentStateName": "<Permanent_State_Name>",
        "permanentPincode": "<Permanent_Pincode>",
        "permanentFullAddress": "<Permanent_Full_Address>",
        "ownerCodeDescr": "<Owner_Code_Description>",
        "regTypeDescr": "<Registration_Type_Description>",
        "vehicleClassDesc": "<Vehicle_Class_Description>",
        "chassisNo": "<Chassis_Number>",
        "engineNo": "<Engine_Number>",
        "vehicleManufacturerName": "<Vehicle_Manufacturer_Name>",
        "modelCode": "<Model_Code>",
        "model": "<Model_Name>",
        "bodyType": "<Body_Type>",
        "cylindersNo": "<Cylinders_Number>",
        "vehicleHp": "<Vehicle_Horsepower>",
        "vehicleSeatCapacity": "<Vehicle_Seat_Capacity>",
        "vehicleStandingCapacity": "<Vehicle_Standing_Capacity>",
        "vehicleSleeperCapacity": "<Vehicle_Sleeper_Capacity>",
        "unladenWeight": "<Unladen_Weight>",
        "vehicleGrossWeight": "<Vehicle_Gross_Weight>",
        "vehicleGrossCombWeight": "<Vehicle_Gross_Comb_Weight>",
        "fuelDescr": "<Fuel_Description>",
        "color": "<Vehicle_Color>",
        "manufacturingMon": "<Manufacturing_Month>",
        "manufacturingYr": "<Manufacturing_Year>",
        "normsDescr": "<Norms_Description>",
        "wheelbase": "<Wheelbase>",
        "cubicCap": "<Cubic_Capacity>",
        "floorArea": "<Floor_Area>",
        "acFitted": "<AC_Fitted>",
        "audioFitted": "<Audio_Fitted>",
        "videoFitted": "<Video_Fitted>",
        "vehicleCatg": "<Vehicle_Category>",
        "saleAmount": "<Sale_Amount>",
        "length": "<Vehicle_Length>",
        "width": "<Vehicle_Width>",
        "height": "<Vehicle_Height>",
        "regUpto": "<Registration_Valid_Upto>",
        "fitUpto": "<Fitness_Valid_Upto>",
        "taxUpto": "<Tax_Valid_Upto>",
        "importedVehicle": "<Imported_Vehicle>",
        "status": "<Vehicle_Status>",
        "vehicleType": "<Vehicle_Type>",
        "taxMode": "<Tax_Mode>",
        "vehicleInsuranceDetails": {
            "insuranceFrom": "<Insurance_From_Date>",
            "insuranceUpto": "<Insurance_Upto_Date>",
            "insuranceCompanyCode": "<Insurance_Company_Code>",
            "insuranceCompanyName": "<Insurance_Company_Name>",
            "opdt": "<Operation_Date>",
            "policyNo": "<Policy_Number>",
            "vahanVerify": "<Vahan_Verify>",
            "regNo": "<Registration_Number>"
        },
        "vehiclePuccDetails": {
            "puccFrom": "<PUCC_From_Date>",
            "puccUpto": "<PUCC_Upto_Date>",
            "puccCentreno": "<PUCC_Centre_Number>",
            "puccNo": "<PUCC_Number>",
            "opDt": "<Operation_Date>"
        },
        "permitDetails": {
            "applNo": "<Application_Number>",
            "pmtNo": "<Permit_Number>",
            "regNo": "<Registration_Number>",
            "rcptNo": "<Receipt_Number>",
            "purpose": "<Purpose>",
            "permitType": "<Permit_Type>",
            "permitCatg": "<Permit_Category>",
            "permitIssuedOn": "<Permit_Issued_On>",
            "permitValidFrom": "<Permit_Valid_From>",
            "permitValidUpto": "<Permit_Valid_Upto>"
        },
        "latestTaxDetails": {
            "regNo": "<Registration_Number>",
            "taxMode": "<Tax_Mode>",
            "paymentMode": "<Payment_Mode>",
            "taxAmt": "<Tax_Amount>",
            "taxFine": "<Tax_Fine>",
            "rcptDt": "<Receipt_Date>",
            "taxFrom": "<Tax_From_Date>",
            "taxUpto": "<Tax_Upto_Date>",
            "collectedBy": "<Collected_By>",
            "rcptNo": "<Receipt_Number>"
        },
        "financerDetails": {
            "hpType": "<HP_Type>",
            "financerName": "<Financer_Name>",
            "financerAddressLine1": "<Financer_Address_Line1>",
            "financerAddressLine2": "<Financer_Address_Line2>",
            "financerAddressLine3": "<Financer_Address_Line3>",
            "financerDistrict": "<Financer_District>",
            "financerPincode": "<Financer_Pincode>",
            "financerState": "<Financer_State>",
            "financerFullAddress": "<Financer_Full_Address>",
            "hypothecationDt": "<Hypothecation_Date>",
            "opDt": "<Operation_Date>"
        }
    },
    "metadata": {
        "requestId": "<Request_ID>",
        "transactionId": "<Transaction_ID>"
    }
}

Success Response Details

The following table outlines the details of the success response from the Fetch Vehicle Details API:

Parameter	Type	Description
status	string	The status of the request
statusCode	number	The HTTP status code of the response
result.stateCode	string	The code of the state where the vehicle is registered
result.state	string	The name of the state where the vehicle is registered
result.officeCode	number	The code of the RTO/DTO office
result.officeName	string	The name of the RTO/DTO office
result.regNo	string	The vehicle registration number
result.regDate	string	The vehicle registration date
result.purchaseDate	string	The vehicle purchase date
result.ownerCount	number	The number of previous owners
result.ownerName	string	The name of the current registered owner
result.ownerFatherName	string	The father's name of the registered owner
result.currentFullAddress	string	The full current address of the owner
result.permanentFullAddress	string	The full permanent address of the owner
result.ownerCodeDescr	string	The owner type description
result.regTypeDescr	string	The type of registration description
result.vehicleClassDesc	string	The class or type of the vehicle
result.chassisNo	string	The chassis number of the vehicle
result.engineNo	string	The engine number of the vehicle
result.vehicleManufacturerName	string	The name of the vehicle manufacturer
result.modelCode	string	The vehicle model code
result.model	string	The vehicle model name
result.bodyType	string	The type of vehicle body
result.fuelDescr	string	The fuel type description
result.vehicleSeatCapacity	number	The seating capacity of the vehicle
result.unladenWeight	number	The vehicle's unladen weight in kilograms
result.vehicleGrossWeight	number	The gross weight of the vehicle in kilograms
result.manufacturingMon	number	The manufacturing month
result.manufacturingYr	number	The manufacturing year
result.normsDescr	string	The emission norms description
result.vehicleType	string	The vehicle type
result.saleAmount	number	The vehicle's sale amount
result.color	string	The vehicle color
result.regUpto	string	The vehicle registration validity date
result.fitUpto	string	The vehicle fitness certificate validity date
result.importedVehicle	string	The indicator whether the vehicle is imported
result.vehicleInsuranceDetails	object	The insurance details including company name, policy number, and validity
result.vehiclePuccDetails	object	The PUCC (Pollution Under Control Certificate) details
result.permitDetails	object	The permit details including type, purpose, and validity
result.latestTaxDetails	object	The latest tax information including amount, mode, and validity
result.financerDetails	object	The hypothecation and financer details if the vehicle is financed
metadata.requestId	string	The unique request identifier
metadata.transactionId	string	The transaction identifier

Error Responses

The following are some error responses from the Fetch Vehicle Details API:

Invalid Chassis Number
Record Not Found
Missing/Invalid Credentials

{
    "status": "failure",
    "statusCode": 400,
    "error": "Invalid Chassis Number",
    "metadata": {
        "requestId": "<Request_ID>",
        "transactionId": "<Transaction_ID>"
    }
}

{
    "status": "failure",
    "statusCode": 404,
    "error": "Record Not Found",
    "metadata": {
        "requestId": "<Request_ID>",
        "transactionId": "<Transaction_ID>"
    }
}

{
    "message": "Missing/Invalid credentials",
    "statusCode": 401,
    "status": "failure"
}

Internal Server Error
External Source Downtime

{
    "status": "failure",
    "statusCode": 500,
    "error": "Internal Server Error"
}

{
    "status": "failure",
    "statusCode": 503,
    "error": "External source downtime"
}

Error Response Details

A failure or error response from the module contains a failure status, with a relevant status code and error message.
The following table lists all error responses:

Status Code	Error Message	Error Description
400	Invalid Chassis Number	This error occurs when we pass invalid chassis number with special characters
401	Missing/Invalid credentials	The request is either missing the mandatory `appId` and `appKey` combination or has invalid values
404	Record Not Found	This error occurs when the entered chassisNo is not found in DB
500	Internal Server Error	Please contact HyperVerge for investigation
503	External source downtime	This error occurs when the external source is down

API Description​

Objective​

API URL​

API Endpoint​

Overview​

Authentication​

API Request Details

Method - POST

Headers

Input​

Request​

Success Response​

Success Response Details​

Error Responses​

Error Response Details​