Getting Started
Check with us to obtain your credentials to use with the API.
Servers
Auth
Env | BASE URL |
---|---|
Prod | https://login.ensuredit.com |
Test | https://login-qa.ensuredit.com |
API
Authentication
POST
Env | URL |
---|---|
Test | <server-base-url>/auth/realms/ensuredit-sprint/protocol/openid-connect/token |
Prod | <server-base-url>/auth/realms/ensuredit/protocol/openid-connect/token |
Generate an Auth token which needs to be passed as a Bearer token header for API interactions.
Request Body
The request body should be x-www-form-urlencoded with the following parameters:
Key | Value |
---|---|
client_id | <client-id> |
client_secret | <client-secret> |
username | <user-name> |
password | <password> |
grant_type | password |
Successful Response:
- Status Code: 200 OK
{
“access_token”: “”,
“expires_in”: 3600,
“refresh_expires_in”: 864000,
“refresh_token”: “<refresh-token”,
“token_type”: “Bearer”,
“not-before-policy”: 0,
“session_state”: “e4a4fa5e-fd9a-432c-87ba-419f574400d4”,
“scope”: “email Groups profile phone”
}
curl –location ‘https://login-qa.ensuredit.com/auth/realms/ensuredit-sprint/protocol/openid-connect/token’ \
–header ‘Content-Type: application/x-www-form-urlencoded’ \
–data-urlencode ‘client_id=<client-id>’ \
–data-urlencode ‘client_secret=<client-secret>’ \
–data-urlencode ‘username=<user-name>’ \
–data-urlencode ‘password=<user-password>’ \
–data-urlencode ‘grant_type=password’
Endpoints
Retrieve vehicle info using the Registration Number
Request Body
Replace url parameter “:regnNumber” with vehicle Registration Number
Key | Value |
---|---|
regnNumber | Registration number of the vehicle |
Successful Response:
- Status Code: 200 OK
{
“regNo”: “XXXXXX3300”,
“vehicleClass”: “XXXXX Car(LMV)”,
“chassis”: “XXXXXXXXX548819”,
“engine”: “XXXXXX73470”,
“vehicleManufacturerName”: “XXXXXX SUZUKI XXXX LTD”,
“model”: “X XXXXNO XXXXX “,
“vehicleColour”: “XXXXXXGE”,
“type”: “XXXXXX”,
“normsType”: “XXXXXX STAGE IV”,
“bodyType”: “XXXXXX”,
“ownerCount”: “X”,
“owner”: “XXXXXX PASHA”,
“ownerFatherName”: “XXXX VAZEER”,
“mobileNumber”: null,
“status”: “XXXXXX”,
“statusAsOn”: “XX-Nov-XXXX”,
“regAuthority”: “XXXXXX CENTRAL RTO, XXXXXXX”,
“regDate”: “XX-Oct-XXXX”,
“vehicleManufacturingMonthYear”: “X/XXXX”,
“rcExpiryDate”: “XX-Oct-XXXX”,
“vehicleTaxUpto”: “XX-Oct-XXXX”,
“vehicleInsuranceCompanyName”: “XXXXX Lombard General Insurance Co. Ltd.”,
“vehicleInsuranceUpto”: “XX-Nov-XXXX”,
“vehicleInsurancePolicyNumber”: “XXXX/XXXXXXXXX/XX/XXX”,
“rcFinancer”: “On Cash”,
“presentAddress”: “# XX/X XXXXX XXXXAN NEAR MICO , BG ROAD XXXXXXX POST,BANGALORE, -XXXXXX”,
“permanentAddress”: “# XX/X XXXXX XXXXAN NEAR MICO , BG ROAD XXXXXXX POST,BANGALORE, -XXXXXX”,
“vehicleCubicCapacity”: “XXXX.0”,
“grossVehicleWeight”: “XXXX”,
“unladenWeight”: “XXX”,
“vehicleCategory”: “XXX”,
“rcStandardCap”: “NA”,
“vehicleCylindersNo”: “X”,
“vehicleSeatCapacity”: “X”,
“vehicleSleeperCapacity”: “NA”,
“vehicleStandingCapacity”: “NA”,
“wheelbase”: “X”,
“vehicleNumber”: “XXXXXX3300”,
“puccNumber”: “NA”,
“puccUpto”: “NA”,
“blacklistStatus”: “NA”,
“blacklistDetails”: [
“NA”
],
“permitIssueDate”: null,
“permitNumber”: null,
“permitType”: null,
“permitValidFrom”: null,
“permitValidUpto”: null,
“nonUseStatus”: “N”,
“nonUseFrom”: null,
“nonUseTo”: null,
“nationalPermitNumber”: null,
“nationalPermitUpto”: null,
“nationalPermitIssuedBy”: null,
“isCommercial”: false,
“nocDetails”: “NA”,
“dbResult”: false,
“partialData”: false,
“mmvResponse”: null,
“financed”: false
}
Successful Response:
- Status Code: 200 OK
{
“code”: 404,
“message”: “Vehicle not found”
}
curl –location ‘<api_base_url>/api/vehicle-lookup/info/KA01MSXXXX’ \
–header ‘Authorization: Bearer <auth-token> ‘
Challans
Retrieve Challans information of the vehicle using Registration Number and Chassis Number
Request Body
Replace url parameters “:regnNumber” and “:chassisNumber” as mentioned below.
Key | Value | Data Restrictions |
---|---|---|
regnNumber | Registration number of the vehicle | – Of the form [State-Code][RTO-Code][Series][Number] |
chassisNumber | Chassis Number of the vehicle | – Five Digit Number |
Successful Response:
- Status Code: 200 OK
[
{
“number”: 1,
“challanNumber”: “XXxxxxx23020101183”,
“offenseDetails”: “XX. Wrong parking”,
“challanPlace”: “XXX”,
“payment_url”: “https://echallan.parivahan.gov.in/index/accused-challan”,
“image_url”: “”,
“receipt_url”: “”,
“challanDate”: “2023-05-26 08:53:00”,
“state”: “XX”,
“rto”: “XXXXXX – XXX”,
“accusedName”: “XXXX XXXXX XXXX XXXX XXX LTD”,
“accused_father_name”: “XX”,
“amount”: 500,
“challanStatus”: “Pending”,
“court_status”: 1,
“custom_offence”: [],
“pdf_url”: “https://echallan.parivahan.gov.in/report/print-page?challan_no=XXXXXXXXXXXXXXXXXXXXXXXXX”,
“under_investigate”: false,
“lat_long”: “XX.XXXXXX,XX.XXXXXX”,
“officer_id”: XXXX,
“designation”: “”,
“address”: “”,
“owner_name”: “XXXX XXXXX XXXX XXXX XXX LTD”,
“chasis_no”: “XXXXXXXXXXXXX91026”,
“vehicle_class”: “XXXXX Cab(LPV)”,
“payment_date”: “”,
“doc_no”: “XX52GD2319”,
“payment_source”: “”,
“mobile_no”: “”,
“sent_to_court_on”: “28-10-2023 12:29:41”,
“court_name”: “sec-9a ps area”,
“court_address”: “XXX”,
“traffic_police”: 1,
“challan_source”: 4,
“for_online_payment_CH”: “”,
“transaction_id”: “XX”,
“vcourt_eligible”: 1,
“vcourt_contested”: 0,
“vcourt_transferred_to_court”: 0,
“vcourt_info_corrected”: 0,
“sent_to_vcourt”: 1,
“vcourt_proceeding”: 1,
“vcourt_contested_id”: 0,
“vcourt_transferred_to_court_id”: 0,
“vcourt_info_corrected_id”: 0,
“vcourt_proceeding_id”: XXXXXXXX,
“proceeding_data”: {
// Masked similar to above keys
},
“vehicle_impound”: 0,
“valid_contact_no”: 1,
“office_name”: “XXXXXX”,
“paymentEligible”: 2
},
{
“number”: 2,
// Masked similar to the first object
}
]
curl –location <api-base-url>/api/vehicle-lookup/challans/DL52GDXXXX/91026 \
–header ‘Authorization: Bearer <access-token>’
HTTP Status Codes
- 200 OK: The request was successful.
- 400 Bad Request: There was a problem with the request.
- 404 Not Found: The requested resource couldn’t be found.
- 500 Internal Server Error: There was a problem serving the request on the Server side.
Service Level Agreements (SLAs)
Our commitment to our users is of utmost importance. Below are our Service Level Agreements (SLAs):
- Uptime: We guarantee 99.9% uptime.
- Response Time: Our average response time for API requests is below ~1000 milliseconds.
- Support: Any support ticket raised is addressed within 24 hours.