VehicleSearchInfo

Vehicle information for plan search. You must provide ONE of the following combinations:

  1. VIN (17 characters) - Most accurate method
  2. Make + Model + Year - All three required together
  3. LicensePlate + State - State is always required with license plate
  • state
    Type: string
    min length:  
    2
    max length:  
    2
    required

    Two-letter US state code (e.g., "NY", "CA", "TX"). Required. Used for location-based pricing and license plate lookups.

  • licensePlate
    Type: string | null
    min length:  
    1
    max length:  
    8

    Vehicle license plate number (1-8 characters). Alternative to VIN or Make/Model/Year. State must also be provided for license plate lookup.

  • make
    Type: string | null

    Vehicle manufacturer (e.g., "Toyota", "Ford", "Honda"). Required if VIN and LicensePlate are not provided. Must be provided together with Model and Year.

  • mileage
    Type: integerFormat: int32

    Current vehicle odometer reading in miles. Required. Must be between 1 and 250,000 miles.

  • model
    Type: string | null

    Vehicle model name (e.g., "Camry", "F-150", "Civic"). Required if VIN and LicensePlate are not provided. Must be provided together with Make and Year.

  • vin
    Type: string | null
    min length:  
    17
    max length:  
    17

    17-character Vehicle Identification Number. Required if Make/Model/Year and LicensePlate are not provided. VIN is the most accurate vehicle identification method.

  • year
    Type: integer | nullFormat: int32
    min:  
    1990
    max:  
    2030

    Vehicle model year (e.g., 2020). Required if VIN and LicensePlate are not provided. Must be provided together with Make and Model. Must be between 1990 and 2030.