Schema Reference
Complete reference tables showing all API fields, their types, requirements, and valid values.
Vehicle Information Fields
| Field Name |
Type |
Required |
Valid Values |
Description |
| vin |
string |
Yes |
17-character VIN |
Vehicle Identification Number |
| state |
string |
Yes |
AlabamaAlaskaArizonaArkansasCaliforniaColoradoConnecticutDelawareFloridaGeorgiaHawaiiIdahoIllinoisIndianaIowaKansasKentuckyLouisianaMaineMarylandMassachusettsMichiganMinnesotaMississippiMissouriMontanaNebraskaNevadaNew HampshireNew JerseyNew MexicoNew YorkNorth CarolinaNorth DakotaOhioOklahomaOregonPennsylvaniaRhode IslandSouth CarolinaSouth DakotaTennesseeTexasUtahVermontVirginiaWashingtonWest VirginiaWisconsinWyoming
|
US State for registration |
| transactionType |
string |
Yes |
PurchaseLease
|
Type of vehicle transaction |
| vehicleType |
string |
Yes |
Passenger VehiclePick-up TruckMotorcycleTravel TrailerMotor HomeCab & ChassisDelivery VehicleSUV
|
Primary vehicle category |
| color |
string |
No |
BLACKBROWNBLUEGREYSILVERREDGREENPURPLEPINKORANGEMAROONGOLDTANWHITEYELLOWBRONZE
|
Vehicle color |
| fuelType |
string |
No |
GasElectricDieselHybrid
|
Fuel/power type |
Driver Information Fields
| Field Name |
Type |
Required |
Valid Values |
Description |
| driverCategory |
string |
Yes |
IndividualBusiness
|
Type of driver/owner |
| firstName |
string |
Yes |
Text |
Driver's first name |
| lastName |
string |
Yes |
Text |
Driver's last name |
| isPrimary |
boolean |
Yes |
true, false |
Primary driver designation |
Quote Name Pattern
| Field Name |
Pattern |
Example |
Description |
| quoteName |
^\d{8}-\d{9}-\d{6}$ |
20250911-192528253-403461 |
Format: YYYYMMDD-HHMMSSSSS-XXXXXX (Date-Time with milliseconds-6 digit ID) |
💡 Quick Tips
- Fields marked Yes are required and must be provided
- Enum fields have dropdown menus in the Interactive API tab
- State fields all use the same 50 US state values
- Use the exact spelling and capitalization shown for enum values
- Quote names follow a strict date-time-ID pattern for tracking