v3.0.0

Schema Reference

Complete reference for all API schemas. Click any schema in the sidebar to jump to its definition. Schema links show which endpoints use each model.

RegisterVehicleModel

Request /RegisterVehicle /RegisterVehicleAlt

Complete vehicle registration request model containing customer, vehicle, driver, and optional lien holder information.

Field Type Required Description
customerInfo CustomerInfo Yes Customer/dealer information
vehicleInfo VehicleInfo Yes Complete vehicle details
driverInfo DriverInfo Yes Driver category and driver list
mailingAddress MailingAddress No Where to send documents
lienHolderInfo LienHolderInfo No Lien holder details (if applicable)
titleContactInfo TitleContactInfo No Title contact person
transactionNotesInfo TransactionNotesInfo No Transaction notes
createdBy string No User who created the registration
References these schemas:
CustomerInfo VehicleInfo DriverInfo MailingAddress LienHolderInfo TitleContactInfo TransactionNotesInfo

RegisterVINModel

Request /RegisterVIN /RegisterVINAlt

Simplified registration model using VIN and customer ID with optional vehicle details.

Field Type Required Description
vin string Yes 17-character Vehicle Identification Number
customerId integer Yes Customer identifier
vehicleDetails VehicleInfo No Optional additional vehicle details

CustomerInfo

Nested RegisterVehicleModel TransactionRecordModel DealerSummary

Customer or dealer business information for vehicle registration.

Field Type Required Description
businessName string Yes Name of the business or dealership
customerID integer Yes Unique customer identifier
dealerId integer No Dealer identifier (nullable)

VehicleInfo

Nested RegisterVehicleModel RegisterVINModel TransactionRecordModel DealerSummary

Comprehensive vehicle details including identification, location, transaction info, pricing, and specifications.

Field Type Required Valid Values Description
vin string Yes 17 characters Vehicle Identification Number
state string Yes AlabamaAlaskaArizona...Wyoming US State for registration
county string Yes Text County for registration
city string Yes Text City for registration
zipcode integer Yes 5 digits ZIP code for registration
transactionType string Yes PurchaseLease Type of vehicle transaction
vehicleType string Yes Passenger VehiclePick-up TruckMotorcycleTravel TrailerMotor HomeCab & ChassisDelivery VehicleSUV Primary vehicle category
modelYear integer Yes 4 digits (e.g., 2024) Vehicle model year
model string Yes Text Vehicle model name
make string Yes Text Vehicle manufacturer
color string Conditional BLACKBROWNBLUEGREYSILVERREDGREENPURPLEPINKORANGEMAROONGOLDTANWHITEYELLOWBRONZE Vehicle color - Required in ~25 states
fuelType string Conditional GasElectricDieselHybridPlug In Fuel/power type - Required by vehicle type; 29 states for EV fees
titleState string No US State (nullable) State where title is held
titleStatus string Yes MCOTitle Title status of the vehicle
plateType string Yes RegularCommercial Type of license plate
plateTransfer boolean No true, false Whether transferring existing plate
plateNumber string Conditional Text (nullable) Existing plate number - Required if plateTransfer is true
plateExpiration string Conditional date (YYYY-MM-DD) Plate expiration date - Required if plateTransfer is true
lien boolean Yes true, false Whether vehicle has a lien
tradeIn boolean No true, false Whether there is a trade-in
tradeinValue number Conditional Decimal Trade-in vehicle value - Required if tradeIn is true
tradeInVehicleType string Conditional Text Trade-in vehicle type - Required if tradeIn is true
basePrice number Yes Decimal Base purchase price
msrp number Conditional Decimal Manufacturer's suggested retail price - Required in 11 states (AZ, CO, IA, KY, ME, MI, MT, NH, NV, NJ, WY)
purchaseDate string Yes date (YYYY-MM-DD) Vehicle purchase date
odometer integer Conditional Number Current odometer reading - Required by vehicle type (all except Trailers)
weight integer Yes Number (lbs) Vehicle weight
gvw integer Conditional Number (lbs) Gross vehicle weight - Required by vehicle type and state (35+ states)
gvwr integer Conditional Number (lbs) Gross vehicle weight rating - Required in 5 states (CT, KS, LA, NJ, TN)
isMilitary boolean Yes true, false Whether owner is military personnel
bodyStyle string No CAB & CHASSISCOUPECONVERTIBLEHATCHBACKMOTORCYCLEMOTORHOMESEDANSTATIONWAGONSPORT UTILITY VEHICLETRAILERTRUCKUTILITYVANWAGON Body style of the vehicle
vehicleSubType string No Semi-TrailersTravel TrailersUtilityHouseCampingBoatHeavy DutyFarm UseRecreationalOHV/ATVUTV Sub-type of vehicle
vehiclePossessionType string No DealershipResidence Where the vehicle is currently located
leaseTaxesType string No Paid In-LeasePaid Upfront How lease taxes are paid
cylinders integer Conditional Number Number of cylinders - Required in MA, NY, RI, VT
horsePower integer Conditional Number Engine horsepower - Required in MO
length number Conditional Number (feet) Vehicle length - Required in FL, MT, OR for Trailers/RVs; Bus vehicle type
mpg number Conditional Number Miles per gallon - Required in DC, OR, VA
cc integer Conditional Number Engine displacement (CC) - Required in AR, SD for Motorcycles
passengerCapacity integer Conditional Number Passenger capacity - Required for Bus vehicle type
registrationMonths integer Conditional Number (12, 24, etc.) Registration period in months - Required in DE, DC, MI, NJ, OH, TX

Additional Fields & Conditional Requirements

  • Pricing: dealerRebate, manufacturerRebate, discount, docFees, warranties, extendedWarranties, deliveryFees, capCostReduction
  • Lease (required when transactionType=Lease): monthlyPayment, numberofPayments
  • Trade-in (required when tradeIn=true): tradeinValue, tradeinState, tradeInVehicleType, tradeInSubVehicleType, tradeInModelYear
  • Specifications (state-conditional): cylinders (MA, NY, RI, VT), horsePower (MO), length (FL, MT, OR - Trailers/RVs), mpg (DC, OR, VA), cc (AR, SD - Motorcycles)
  • Registration: registrationMonths (required in DE, DC, MI, NJ, OH, TX)
  • Commercial: isFleetVehicle, isCommercialVehicle, registeredWeight, numberOfAxles, numberOfTires
  • Shipping: plateShipmentTo, plateShipmentDate, plateShipmentTrackingNumber, plateShipmentCarrier

See State Requirements for complete conditional field requirements by state and vehicle type.

DriverInfo

Nested RegisterVehicleModel TransactionRecordModel

Container for driver category and list of drivers associated with the registration.

Field Type Required Valid Values Description
driverCategory string Yes IndividualBusiness Type of driver/owner
drivers array[Driver] Yes Array of Driver objects List of drivers for the vehicle
companyName string No Text Company name (for Business category)
federalTaxID string No Text (nullable) Federal Tax ID (for Business category)

Driver

Nested DriverInfo.drivers[]

Individual driver details including name and address information.

Field Type Required Valid Values Description
firstName string Yes Text Driver's first name
middleName string No Text (nullable) Driver's middle name
lastName string Yes Text Driver's last name
address1 string Yes Text Primary address line
address2 string No Text (nullable) Secondary address line
city string Yes Text City
state string Yes US State name Driver's state
zipCode string Yes Text ZIP code
country string No Text Country
isPrimary boolean Yes true, false Primary driver designation

MailingAddress

Nested RegisterVehicleModel TransactionRecordModel

Destination address for registration documents and plates.

Field Type Required Valid Values Description
mailingInstruction string Yes DealerDriver Where to send mail
nameofBusiness string No Text Business name for mailing
attention string No Text (nullable) Attention line
address1 string No Text Primary address line
address2 string No Text (nullable) Secondary address line
city string No Text City
state string No US State name Mailing address state
zipCode string No Text ZIP code
dayTimePhoneNo string No Text (nullable) Daytime phone number

LienHolderInfo

Nested RegisterVehicleModel

Lien holder details for vehicles with financing.

Field Type Required Description
lienHolderName string No Name of the lien holder
lienHolderAddress1 string No Primary address line
lienHolderAddress2 string No Secondary address line
lienHolderCity string No City
lienHolderState string No US State name
lienHolderZipCode string No ZIP code
lienHolderFederalTaxID string No Lien holder's Federal Tax ID

TitleContactInfo

Nested RegisterVehicleModel

Contact person for title-related communications.

Field Type Required Description
userName string No Contact person's name
emailAddress string No Contact email address
userID integer No User identifier

TransactionNotesInfo

Nested RegisterVehicleModel

Container for transaction notes.

Field Type Required Description
transactionNotes array[object] No Array of note objects, each with a note string property

TransactionRecordModel

Response /GetTransactionRecord /GetTransactionRecords

Complete transaction record returned from GET endpoints.

Field Type Description
QuoteName string Unique quote identifier (format: YYYYMMDD-HHMMSSSSS-XXXXXX)
TransactionStatus string Current status of the transaction
CustomerInfo CustomerInfo Customer/dealer information
VehicleInfo VehicleInfo Complete vehicle details
DriverInfo DriverInfo Driver information
MailingAddress MailingAddress Mailing address details
Message string Optional message (nullable)
BarcodeByteArray byte[] Barcode data as byte array

DealerSummary

Response /GetDealerSummary

Dealer summary response with document and fee information.

Field Type Description
DocumentResponse string XML response with paperwork requirements
FeeResponse string XML response with fee calculations
QuoteName string Quote identifier for this transaction
TransactionStatus string Current status of the transaction
CustomerInfo CustomerInfo Customer information
VehicleInfo VehicleInfo Vehicle information

Customer

Response /GetCustomers

Customer lookup response model.

Field Type Description
customerId integer Unique customer identifier
customerName string Customer name
businessName string Business name
email string Email address

TaxableInfo

Response /GetTaxableInfo

Tax calculation information for a quote.

Field Type Description
quoteName string Quote identifier
taxableAmount number Amount subject to tax
taxRate number Applicable tax rate
totalTax number Total tax amount

DMVInfo

Response /GetQuoteDMVInfo

DMV status and fee information for a quote.

Field Type Description
quoteName string Quote identifier
dmvStatus string Current DMV processing status
dmvFees number Total DMV fees

FeeStructure

Response

Breakdown of different fee components.

Field Type Description
baseFee number Base fee amount
processingFee number Processing fee amount
expediteFee number Expedite fee amount

CustomerFees

Response /GetCustomerFees

Customer-specific fee breakdown.

Field Type Description
customerId integer Customer identifier
totalFees number Total fees for customer
breakdown array[object] Array of fee items with feeType (string) and amount (number)

FinalFees

Response /GetAtcFees /GetFinalFees

Final quote totals with all fees and taxes.

Field Type Description
quoteName string Quote identifier
subtotal number Subtotal before taxes and fees
taxes number Total tax amount
fees number Total fees amount
total number Grand total (subtotal + taxes + fees)

TurnaroundInfo

Response /GetDMVTurnaroundInfo

DMV processing time estimates by state.

Field Type Description
state string US State name
standardProcessing integer Days for standard processing
expeditedProcessing integer Days for expedited processing

ShipmentInfo

Response /GetShipmentInformation

Shipment tracking information for plates and documents.

Field Type Description
quoteName string Quote identifier
carrier string Shipping carrier name
trackingNumber string Shipment tracking number
trackingUrl string URL to track shipment
shipmentDate date Date shipment was sent
estimatedDelivery date Estimated delivery date

VINInfo

Response /GetVinInfo

VIN decoding results with vehicle details.

Field Type Description
vin string Vehicle Identification Number
year integer Model year
make string Vehicle manufacturer
model string Vehicle model name
trim string Vehicle trim level
engineType string Engine type/configuration
bodyStyle string Vehicle body style

Quote Name Pattern

Field 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 always required and must be provided
  • Fields marked Conditional are required based on state, vehicle type, or other field values
  • Click any schema name in the sidebar to jump directly to its definition
  • Schema type links (e.g., CustomerInfo) navigate to the referenced schema
  • Endpoint badges link to the Interactive API for testing
  • Use the exact spelling and capitalization shown for enum values
  • See State Requirements for the Required Fields Calculator