Car
Create Car Quote

API Information

Name: Save Car Lead

Description: It will create a lead and returns the lead uuid.

Basic Info

Basic
Method: POST
Endpoint: <API_BASE_URL>/capi/api/v1-save-car-quote
 
---
 
REQUEST HEADERS:
x-api-token: <REQUIRED>
Content-Type: application/json

Request Body when transactionType is RENEWAL

JSON
{
  "carModelId": "3814", // Car Make
  "carMakeId": "128", // Car Model
  "carTrimId": "2609",// Car Trim
  "yearOfManufacture": "2022",
  "yearOfFirstRegistration": 2022,
  "emirateOfRegistrationId": "2", // Where will your car be registered i.e. which authority will you get your Mulkiya from? This is usually the same Emirate that your visa is from.
  "carTypeInsuranceId": "1",  // Would you like to insure your own car as well as people and property outside your vehicle? If so, select Comprehensive.
 
  "insuranceExpiryDate": "6/16/2024",
  "currentlyInsuredWithId": 14, //lookups api id
  "dob": "1996-04-18",
  "email": "john@example.com",
  "firstName": "john",
  "lastName": "doe",
  "mobileNo": "0256325634",
  "nationalityId": "136",//lookups api id
  "uaeLicenseHeldForId": "7",//lookups api id
  "backHomeLicenseHeldForId": "2",//lookups api id
  "isGccStandard": true,
  "isModified": false,
  "source": "DUBAI_NOW",
  "transactionType": "RENEWAL",
 
  "metaData": {
      "personalInfo": {
          "personGenderDescEn": "any",
          "jobTitle": "any",
          "occupationEN": "any"
      },
      "licenseInfo": {
          "licenseNumber": "any",
          "licenseSource": "any",
          "expiryDate": "any",
          "issueDate": "any",
          "licenseType": "any"
      },
      "customerInfo": {
          "trafficFileNumber": "any",
          "personNameAr": "any",
          "emiratesID": "any",
          "emiratesIDExpiryDate": "any"
      },
      "vehicleInfo": {
          "vehicleSourceTypeEn": "any",
          "carryWeight": "any",
          "unloadedWeight": "any",
          "cylinders": "any",
          "transactionType": "RENEWAL",
          "vehicleCountryEn": "any",
          "engCapacity": "any",
          "noOfDoors":"any",
          "noOfSeats": "any",
          "engineNo": "any",
          "chassisNo": "any",
          "insuranceTypeEn": "any",
          "insurranceCompanyEn": "any",
          "insurranceRefNo": "any",
          "mortgageCompanyNameEn": "any",
          "isMortgaged": "any",
          "vehicleHasPassTest": "any",
          "IS_VALID": "any",
          "colorDescEn": "any",
          "Plate": "any",
          "plateId": "any",
          "plateNumber": "any",
          "category": "any"
      }
  }
}

Request Body when transactionType is NEW

JSON
{
  "carModelId": "3814",
  "carMakeId": "128",
  "carTrimId": "2609",
  "yearOfManufacture": "2022",
  "yearOfFirstRegistration": 2022,
  "emirateOfRegistrationId": "2", //lookups api id
  "carTypeInsuranceId": "1", //lookups api id
  "insuranceExpiryDate": "6/16/2024",
  "currentlyInsuredWithId": 14, //lookups api id
  "dob": "1996-04-18",
  "email": "john@example.com",
  "firstName": "john",
  "lastName": "doe",
  "mobileNo": "0256325634",
  "nationalityId": "136",//lookups api id
  "uaeLicenseHeldForId": "7",//lookups api id
  "backHomeLicenseHeldForId": "2",//lookups api id
  "isGccStandard": "true",
  "isModified": false,
  "source": "DUBAI_NOW",
  "transactionType": "NEW",
 
  "metaData": {
      "personalInfo": {
          "personGenderDescEn": "any",
          "personNameAr": "any",
          "emiratesID": "any",
          "emiratesIDExpiryDate": "any",
          "jobTitle": "any",
          "occupationEN": "any",
          "trafficFileNumber": "any"
      },
      "licenseInfo": {
          "licenseNumber": "any",
          "licenseSource": "any",
          "expiryDate": "any",
          "issueDate": "any",
          "licenseType": "any"
      },
      "vehicleInfo": {
          "vehicleSourceTypeEn": "any",
          "unloadedWeight": "any",
          "cylinders": "any",
          "transactionType": "NEW",
          "vehicleCountryEn": "any",
          "engCapacity": "any",
          "noOfDoors":"any",
          "noOfSeats": "any",
          "engineNo": "any",
          "chassisNo": "any",
          "mortgageCompanyNameEn": "any",
          "isMortgaged": "any",
          "vehicleHasPassTest": "any",
          "IS_VALID": "any",
          "colorDescEn": "any",
      }
  }
}

Response Body

JSON
{
  "message": "Car Quote successfully created.",
  "quoteUID": "2CCRMY75", // unique code to identify this quote
  "quoteTypeId": 1,
  "hasRating": true, // true: ratings are found against your details, display plans || false: ratings are not found against your details, do not display plans
  "isRenewal": false,
  "isRenewalEnqiury": false
}