Virginia (VA) EVR API - Sandbox

VehicleOwnershipDTO

object
stateCustomerIdstring

Indicates customer’s state id.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:CUST-0099

vinstring

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:1HGCM82633A004352

yearstring

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:2021

makestring

Indicates the make of the vehicle.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:Toyota

modelstring

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:Camry

bodyTypestring

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:example

plateNumberstring

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:ABC1234

registrationExpirationDatestring(date)

<= 1048576 characters

Example:2024-03-15

regFeePaidboolean

Example:true

Example

VAEVRTransactionDTO

object
statestring

Allowed values:AKALARAZCACOCTDCDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPARISCSDTNTXUTVAVTWAWIWVWYOther

<= 1048576 characters

Example:VA

refNumberstring(uuid)

<= 1048576 characters

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

applicationTypestring

Type of transaction

Allowed values:TitleAndRegistrationTitleOnlyTaxOnlyTempTag

<= 1048576 characters

Example:TitleAndRegistration

serviceTypestring

Allowed values:FormsAndFeesFullService

<= 1048576 characters

Example:FormsAndFees

loanNumberstring

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:LN-7788990

locationIdinteger(int64)

>= -9007199254740991<= 9007199254740991

Example:1

saveForLaterboolean

Default:false

Example:true

isPremiumServiceboolean

Example:true

stateTransactionIdstring

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:1234567

registrationobject
Show Child Parameters
ownerobject
Show Child Parameters
coOwnerobject
Show Child Parameters
lessorobject
Show Child Parameters
lessee1object
Show Child Parameters
lienholder1object
Show Child Parameters
lienholder2object
Show Child Parameters
lienholder3object
militaryobject
Show Child Parameters
insuranceobject
Show Child Parameters
previousTitleobject
Show Child Parameters
vehicleobject
Show Child Parameters
tradeInVehiclesarray[object]

<= 100000 items

Show Child Parameters
Example

VAEVRRegistrationDTO

object
actionstring

Set the registration action.

Allowed values:NewRegistrationPlateTransferTemporaryTag

<= 1048576 characters

Example:NewRegistration

expirationDatestring

In the event of a plate transfer, indicate the current registration expiration date.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:2024-03-15

plateTransferredFromVinstring

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:example

plateNumberstring

In the event of a plate transfer, indicate the transfer plate number.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:ABC1234

addressobject
Show Child Parameters
Example

VAEVROwnerDTO

object
businessNamestring

Set Owner’s business name.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:Acme Auto Sales LLC

firstNamestring

Set Owner’s first name.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:John

middleNamestring

Set Owner’s middle name.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:A

lastNamestring

Set Owner’s last name.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:Doe

ownerTypestring

Set Owner type.

Allowed values:IndividualBusinessGovernmentNonProfitPoliticalSubdivisionSeniorCitizenCenterStateAgencyVolunteerFireDepartmentCharityTrust

<= 1048576 characters

Example:Individual

dateOfBirthstring

Set Owner’s date of birth.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:1985-06-15

driverLicenseNumberstring

Indicates Owner’s driver license number.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:D1234567

feinstring

Indicates the assigned FEIN; typically required of a business or other organization.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:12-3456789

genderTypestring

Set Owner’s gender.

Allowed values:FemaleMaleOther

<= 1048576 characters

Example:Female

phonestring

Set Owner’s primary phone number.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:555-0100

emailstring

Indicates Owner’s email address.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:[email protected]

residenceAddressobject
Show Child Parameters
mailingAddressobject
Show Child Parameters
Example

VAEVRCoOwnerDTO

object
ownerTypestring

Set secondary Owner type.

Allowed values:IndividualBusinessGovernmentNonProfitPoliticalSubdivisionSeniorCitizenCenterStateAgencyVolunteerFireDepartmentCharityTrust

<= 1048576 characters

Example:Individual

jointOwnershipTypestring

Set type of joint ownership concerning release of interest in a vehicle.

Allowed values:AndOrAndOrSpousesTenantsByEntiretiesTenantsInCommonJointTenantsJointTenantsWithRightsOfSurvivorshipJointTenantsWithoutRightsOfSurvivorshipBusinessPartners

<= 1048576 characters

Example:And

dateOfBirthstring

Set secondary Owner’s date of birth.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:1985-06-15

driverLicenseNumberstring

Indicates secondary Owner’s driver license number.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:D1234567

feinstring

Indicates the assigned FEIN; typically required of a business.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:12-3456789

firstNamestring

Set secondary Owner’s first name.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:John

middleNamestring

Set secondary Owner’s middle name.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:A

lastNamestring

Set secondary Owner’s last name.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:Doe

businessNamestring

Set secondary owner’s business name.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:Acme Auto Sales LLC

genderTypestring

Set secondary Owner’s gender.

Allowed values:FemaleMaleOther

<= 1048576 characters

Example:Female

phonestring

Set secondary Owner’s primary phone number.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:555-0100

emailstring

Indicates Secondary Owner’s email address.

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:[email protected]

residenceAddressobject
Show Child Parameters
mailingAddressobject
Show Child Parameters
Example