Virginia (VA) EVR API - Sandbox

Get ownership info from state for EVR requests

Requests state information for EVR requests

post
https://api-test.vitu.com/national-public-api/v2/ownership/lookup

Headers

x-on-behalf-of-userinteger(int64)

>= -9007199254740991<= 9007199254740991

Body

application/json

OwnershipLookupDTO

locationIdinteger(int64)required

Id that represents dealer location in vitu. Provided by vitu, required

>= -9007199254740991<= 9007199254740991

Example:1

statestringrequired

Allowed values:AKALARAZCACOCTDCDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPARISCSDTNTXUTVAVTWAWIWVWY

<= 1048576 characters

Example:VA

stateTransactionIdstring

State transaction identifier. Might be required for some states

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

<= 1048576 characters

Example:1234567

stateCustomerIdstring

State customer identifier. Might be required for some states

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

<= 1048576 characters

Example:CUST-0099

vinstring

Indicates VIN for the vehicle for which lookup is being performed

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

<= 1048576 characters

Example:1HGCM82633A004352

searchBystring

Allowed values:VIN

<= 1048576 characters

Example:VIN

Response

application/json

OK

OwnershipLookupResponseDTO

ownershipsarray[object]

<= 100000 items

Show Child Parameters
post/ownership/lookup

Body

{ "locationId": 1, "state": "VA" }
 
application/json

TransactionTypeEnum

string

Allowed values:EVRINTERSTATEDMVDESKNTX

Default:INTERSTATE

<= 1048576 characters

Example

Errors

array

>= 1 items<= 100000 items

messagestringrequired

Description of error

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

<= 1048576 characters

Example:Request processed successfully

Error

messagestringrequired

Description of error

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

<= 1048576 characters

Example:Request processed successfully

Example

CallbackDTO

object
One Of
timestampstring(date-time)required

<= 1048576 characters

Example:2024-03-15T09:30:00Z

callbackTypestring

Allowed values:SUCCESSFAILUREDMVDESKEVRINVOICEDNTX

<= 1048576 characters

Example:SUCCESS

refNumberstring(uuid)

<= 1048576 characters

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

transactionIdinteger(int32)required

>= -9007199254740991<= 9007199254740991

Example:1

statusstring

Allowed values:StartedCompletedDraftPreAuditInProgressPreAuditErrorsFoundPreAuditCompletedSentToServiceReceivedErrorsFoundSentToStateReturnedFromStateStateProcessedStateCompletedInactiveCompletedManuallyCanceledFailed

<= 1048576 characters

Example:Started

auditErrorsarray[string]

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

<= 1048576 characters<= 100000 items

Example:example

auditMessagesarray[object]

<= 100000 items

Show Child Parameters
shipmentobject
Show Child Parameters
vinstring

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

<= 1048576 characters

Example:1HGCM82633A004352

owner1FullNamestring

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

<= 1048576 characters

Example:Sample Name

controlNumberstring

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

<= 1048576 characters

Example:STK-2024-001

applicationTypestring

Allowed values:TitleAndRegistrationTitleOnlyLienAddTempTagTaxOnlyReplacementSalvageTitleSalvageTitle

<= 1048576 characters

Example:TitleAndRegistration

universalStatusstring

Allowed values:AvailableDeal PendingVoidRejectedCompletedSubmittedIn ErrorInvoicedCompleted ManuallyAudit in ProgressTemp Tag DraftTemp Tag IssuedTemp Tag ClosedTemp Tag FailedTemp Tag VoidedDeleted

<= 1048576 characters

Example:Available

signRequestStatusstring

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

<= 1048576 characters

Example:example

signerStatusstring

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

<= 1048576 characters

Example:example

signerNumberinteger(int32)

>= -9007199254740991<= 9007199254740991

Example:1

Example