Search
K
Motor Vehicle Record (MVR) Verification - Sandbox

Inquiry

Create vehicle inquiry

Create vehicle inquiry.

post
https://api-test.vitu.com/lookup-national-vr-public-api/v1/inquiry

Headers

x-location-idinteger

VITU Location ID

x-on-behalf-user-idinteger

Id of the user on behalf of whom the request is being made

Body

application/json

StateInquiryDTO

StateInquiryDTO
One Of
statestringrequired

Allowed values:ALARAZCACODCDEFLGAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENJNMNVNYOHOKORPARISCTNTXUTVAVTWAWIWV

refNumberstring(uuid)required

Unique reference number for the inquiry

<= 36 characters

inquiryIdinteger(int32)read-only

Unique identifier for the inquiry

inquiryStringstringrequired

<= 500 characters

inquiryTypestringrequired

Allowed values:VINPLATETITLETAGHINDECAL

plateTypeobject
Show Child Parameters
stockNumberstring

<= 500 characters

createdDatestring(date-time)read-only

<= 500 characters

processedDatestring(date-time)read-only

<= 500 characters

chargedbooleanread-only
errorstringread-only

<= 500 characters

Response

application/json

OK

InquiryIdResponseDTO

inquiryIdinteger

Callbacks

post
{$request.query.callbackUrl}

Callback Response

200

OK

post/inquiry

Body

{ "state": "AL", "refNumber": "0961d37a-55f7-40b4-ab76-b8b78329b866", "inquiryString": "LRBFZNR42MD107860", "inquiryType": "VIN" }
 
application/json
callback sample
Callback Body
Callback Response
200

Load inquiry

Load inquiry.

get
https://api-test.vitu.com/lookup-national-vr-public-api/v1/inquiry/id/{inquiryId}

Path Parameters

inquiryIdinteger(int32)required

>= 1

Response

application/json

OK

StateInquiryDTO

StateInquiryDTO
One Of
statestringrequired

Allowed values:ALARAZCACODCDEFLGAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENJNMNVNYOHOKORPARISCTNTXUTVAVTWAWIWV

refNumberstring(uuid)required

Unique reference number for the inquiry

<= 36 characters

inquiryIdinteger(int32)read-only

Unique identifier for the inquiry

inquiryStringstringrequired

<= 500 characters

inquiryTypestringrequired

Allowed values:VINPLATETITLETAGHINDECAL

plateTypeobject
Show Child Parameters
stockNumberstring

<= 500 characters

createdDatestring(date-time)read-only

<= 500 characters

processedDatestring(date-time)read-only

<= 500 characters

chargedbooleanread-only
errorstringread-only

<= 500 characters

get/inquiry/id/{inquiryId}
 
application/json

Load inquiry by request ID

Load inquiry by request ID.

get
https://api-test.vitu.com/lookup-national-vr-public-api/v1/inquiry/refNumber/{refNumber}

Path Parameters

refNumberstring(uuid)required

<= 36 characters

Response

application/json

OK

StateInquiryDTO

StateInquiryDTO
One Of
statestringrequired

Allowed values:ALARAZCACODCDEFLGAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENJNMNVNYOHOKORPARISCTNTXUTVAVTWAWIWV

refNumberstring(uuid)required

Unique reference number for the inquiry

<= 36 characters

inquiryIdinteger(int32)read-only

Unique identifier for the inquiry

inquiryStringstringrequired

<= 500 characters

inquiryTypestringrequired

Allowed values:VINPLATETITLETAGHINDECAL

plateTypeobject
Show Child Parameters
stockNumberstring

<= 500 characters

createdDatestring(date-time)read-only

<= 500 characters

processedDatestring(date-time)read-only

<= 500 characters

chargedbooleanread-only
errorstringread-only

<= 500 characters

get/inquiry/refNumber/{refNumber}
 
application/json

Load unified vehicle inquiry record

Load unified vehicle inquiry record.

get
https://api-test.vitu.com/lookup-national-vr-public-api/v1/inquiry/{inquiryId}/vitu-record

Path Parameters

inquiryIdinteger(int32)required

>= 1

Response

application/json

OK

MVRBaseRecordDTO

vehicleobject
Show Child Parameters
titleobject
Show Child Parameters
ownerobject
Show Child Parameters
coOwnerobject
Show Child Parameters
lienholderobject
Show Child Parameters
lessorobject
Show Child Parameters
registrationobject
Show Child Parameters
get/inquiry/{inquiryId}/vitu-record
 
application/json