transactionTypestring
Identifier of the type of the transaction
Allowed values:EVRINTERSTATEDMVDESKNTX
Default:INTERSTATE
Update Transaction
Updates a transaction in VITU system
put
https://api-test.vitu.com/national-public-api/v2/transaction/{transactionId}
Query Parameters
Path Parameters
transactionIdstringrequired
Either int transactionId or uuid refNumber
Match pattern:^[\s\S]*$
<= 255 characters
Headers
x-on-behalf-of-userinteger(int32)
>= -2147483648<= 2147483647
Body
application/json
Body
application/json
LienAddTransactionRequest
LienAddTransactionRequest
One Ofstatestringrequired
Allowed values:UT
Match pattern:^[\s\S]*$
<= 255 characters
applicationTypestringrequired
Allowed values:LienAdd
refNumberstring(uuid)
<= 36 characters
loanNumberstring | null
Match pattern:(?=^[\s\S]*$)(?=^[\s\S]*$)
<= 255 characters
lienholder1object
Show Child Parameters
vehicleobject
Show Child Parameters
ownerobject
Show Child Parameters
coOwnerobject
Show Child Parameters
registrationobject
Show Child Parameters
sellerobject
Show Child Parameters
Response
application/json
Response
application/json
OK
EmptyResponse
EmptyResponseobject
Empty response body (operation accepted / no content).
* Additional properties are NOT allowed.
Callbacks
Callbacks
post
{$request.query.callbackUrl}
Callback Response
Callback Response
Target server returns this code if it accepts the callback
put/transaction/{transactionId}
Authentication
Path Parameters
Query Parameters
Headers
Body
{
"refNumber": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"state": "AL",
"applicationType": "LienAdd",
"loanNumber": "string",
"lienholder1": {
"lienAmount": 0,
"name": "test2",
"maturityDate": "2025-01-01",
"address": {
"zipCode": "93279",
"state": "CA",
"city": "VISALIA",
"street": "PO BX 1311",
"county": "string"
}
},
"vehicle": {
"state": "AL",
"model": "SANTA FE",
"odometerReadDate": "2025-01-01",
"vehicleType": "Passenger",
"grossWeight": 5357
},
"previousTitle": {
"plateNumber": "string"
},
"owner": {
"ssn": "987987987",
"driverLicenseNumber": "F112345",
"driverLicenseState": "AR",
"dateOfBirth": "1969-03-07"
},
"registration": {
"action": "NewRegistration",
"address": {
"street": "1116 Clarendon Ave",
"city": "Brighton",
"county": "Jefferson",
"state": "AL",
"zipCode": "35020",
"zipCodeExt": "405"
}
},
"seller": {
"address": {
"street": "500 Lessor Ave",
"city": "Birmingham",
"county": "Jefferson",
"state": "AL",
"zipCode": "35205",
"zipCodeExt": "1234"
}
}
}
application/json
callback sample
Callback Body
Callback Response
Cancel Transaction
Cancels a transaction in VITU system
delete
https://api-test.vitu.com/national-public-api/v2/transaction/{transactionId}
Query Parameters
messagestring
message parameter.
Match pattern:^[\s\S]*$
<= 255 characters
transactionTypestring
Identifier of the type of the transaction
Allowed values:EVRINTERSTATEDMVDESKNTX
Default:INTERSTATE
Path Parameters
transactionIdstringrequired
Either int transactionId or uuid refNumber
Match pattern:^[\s\S]*$
<= 255 characters
Headers
x-on-behalf-of-userinteger(int32)
>= -2147483648<= 2147483647
Response
application/json
Response
application/json
OK
EmptyResponse
EmptyResponseobject
Empty response body (operation accepted / no content).
* Additional properties are NOT allowed.
Callbacks
Callbacks
post
{$request.query.callbackUrl}
Callback Response
Callback Response
Target server returns this code if it accepts the callback
delete/transaction/{transactionId}
Authentication
Path Parameters
Query Parameters
Headers
application/json
callback sample
Callback Body
Callback Response
Get Transaction Fees
Get fees calculated by the transaction
get
https://api-test.vitu.com/national-public-api/v2/transaction/{transactionId}/fees
Query Parameters
transactionTypestring
Identifier of the type of the transaction
Allowed values:EVRINTERSTATEDMVDESKNTX
Default:INTERSTATE
limitinteger(int32)
Default:20
>= 1<= 100
offsetinteger(int32)
Default:0
>= 0
Path Parameters
transactionIdstringrequired
Either int transactionId or uuid refNumber
Match pattern:^[\s\S]*$
<= 255 characters
Headers
x-on-behalf-of-userinteger(int32)
>= -2147483648<= 2147483647
Response
application/json
Response
application/json
OK
<= 1000 items
namestring
Match pattern:^[\s\S]*$
<= 255 characters
get/transaction/{transactionId}/fees
Authentication
Path Parameters
Query Parameters
Headers
application/json
Get Transaction Forms
Get list of documents produced by the transaction
get
https://api-test.vitu.com/national-public-api/v2/transaction/{transactionId}/forms
Query Parameters
transactionTypestring
Identifier of the type of the transaction
Allowed values:EVRINTERSTATEDMVDESKNTX
Default:INTERSTATE
limitinteger(int32)
Default:20
>= 1<= 100
offsetinteger(int32)
Default:0
>= 0
Path Parameters
transactionIdstringrequired
Either int transactionId or uuid refNumber
Match pattern:^[\s\S]*$
<= 255 characters
Headers
x-on-behalf-of-userinteger(int32)
>= -2147483648<= 2147483647
Response
application/json
Response
application/json
OK
<= 1000 items
namestring
Match pattern:^[\s\S]*$
<= 255 characters
get/transaction/{transactionId}/forms
Authentication
Path Parameters
Query Parameters
Headers
application/json
Download Transaction Forms
Download documents produced by the transaction
get
https://api-test.vitu.com/national-public-api/v2/transaction/{transactionId}/forms/download
Query Parameters
transactionTypestring
Identifier of the type of the transaction
Allowed values:EVRINTERSTATEDMVDESKNTX
Default:INTERSTATE
targetstring
target parameter.
Allowed values:DealerCustomerLenderOwnerCoOwnerScans
Path Parameters
transactionIdstringrequired
Either int transactionId or uuid refNumber
Match pattern:^[\s\S]*$
<= 255 characters
Headers
x-on-behalf-of-userinteger(int32)
>= -2147483648<= 2147483647
Response
application/pdf
Response
application/pdf
OK
string
<= 255 characters
get/transaction/{transactionId}/forms/download
Authentication
Path Parameters
Query Parameters
Headers
application/pdf