API Reference

Vehicle Registration

This document describes the API for fetching details associated with the submitted Vehicle registration number

Base URL

https://identity.cladfy.app/api/v1

API Endpoint:

POST /plate

Request Headers:

  • Payload: The data sent to the server in the request body. Here, it's a JSON object with a single key-value pair:
    "plate": 0 – A placeholder value that should be replaced with an actual Vehicle Registration number.

  • Content-Type: "application/json" Indicates that the data in the request body is in JSON format.

  • Accept: "application/json"Tells the server that the client expects the response to be in JSON format.

  • Authorization: "Basic 123"
    Used for HTTP Basic Authentication, where "123" is a placeholder for the base64-encoded username:password credentials. See guide here

Request Body:

The request body contains the Vehicle Registration number. It should be JSON with the properties below.

  • plate: The Vehicle Registered Number - string.

Example Request Body:

{
  "plate": "string"
}

Response - 200:

The response will be a JSON object following the request data type specification: A typed dictionary containing the detailed results. Properties include:


  • success

    • Type: boolean
    • Required: Yes

  • response_code

    • Type: integer
    • Required: Yes
    • Example: 200

  • message

    • Type: string
    • Required: Yes
    • Example: Vehicle Plate Checked Successfully

  • data

    • Type: object

    • Required: Yes

    • Details

      • Type: string
      • Required: Yes
      • Example: XXXXXXX

    • Status

      • Type: string
      • Required: Yes
      • Example: XX

    • caveat

      • Type: array[array]
      • Required: Yes

    • chassisNumber

      • Type: string
      • Required: Yes
      • Example: XXXXXXXXXXXXXXXXXX

    • inspection

      • Type: array[array]
      • Required: Yes

    • owner

      • Type: array[array]
      • Required: Yes

    • regNo

      • Type: string
      • Required: Yes
      • Example: XXXXXXX

    • vehicle

      • Type: object
      • Required: Yes

  • request_id

    • Type: string
    • Required: Yes
    • Example: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Example Response:

{
  "success": true,
  "response_code": 200,
  "message": "Vehicle Plate Checked Successfully",
  "data": {
    "Details": "XXXXXXX",
    "Status": "XX",
    "caveat": [
      [
        "string"
      ]
    ],
    "chassisNumber": "XXXXXXXXXXXXXXXXXX",
    "inspection": [
      [
        "string"
      ]
    ],
    "owner": [
      [
        "string"
      ]
    ],
    "regNo": "XXXXXXX",
    "vehicle": {
      "ChassisNo": "XXXXXXXXXXXXXXXXXX",
      "bodyColor": "XXXXX",
      "bodyType": "XXXXXX",
      "carMake": "XXXX",
      "carModel": "XX",
      "dutyAmount": {},
      "dutyDate": "",
      "dutyStatus": "XXXX",
      "engineCapacity": {},
      "engineNumber": "XXX - XXXXXX",
      "entry": {
        "CPC": "XX",
        "importer_pin": "XXXXXXXXXX",
        "number": "XXXXXXXXXXXXXXXXX"
      },
      "fuel_type": "XX",
      "grossweight": {},
      "logbookNumber": {
        "LOGBOOK_NUMBER": "XXXXXXXXXXXXXXX",
        "SERIAL_NO": "XXXXXXXXX"
      },
      "passengerCapacity": {},
      "purpose": "XXXXXXX",
      "regNo": "XXXXXXX",
      "regStatus": "XXXXXXXXXX",
      "registrationDate": "XXXX-XX-XX",
      "tareweight": {},
      "vehiceType": "XXXXXXXXXXXXX",
      "yearOfManufacture": "XXXX"
    }
  },
  "request_id": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

Error Handling:

401 Unauthorized: If the API key is invalid.
400 Bad Request: If the request body is not valid JSON or missing required fields.
500 Internal Server Error: If an internal server error occurs during API request processing. The response will include an error message.

Python Test Example:

This test example demonstrates sending a POST request to the API endpoint with the Vehicle Registration Number. The response will include the associated details.

import requests

url = "https://identity.cladfy.app/api/v1/plate"

payload = { "plate": "string" }
headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Basic 123"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())