transactionTypestring
Identifier of the type of the transaction
Allowed values:EVRINTERSTATEDMVDESKNTX
Default:INTERSTATE
limitinteger(int32)
Default:20
>= 1<= 100
offsetinteger(int32)
Default:0
>= 0
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
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
Download Transaction Document
Download transaction’s document by transaction and document Id
get
https://api-test.vitu.com/national-public-api/v2/transaction/{transactionId}/forms/download/{documentId}
Query Parameters
transactionTypestring
Identifier of the type of the transaction
Allowed values:EVRINTERSTATEDMVDESKNTX
Default:INTERSTATE
blankboolean
if you need to generate blank form
Path Parameters
transactionIdstringrequired
Either int transactionId or uuid refNumber
Match pattern:^[\s\S]*$
<= 255 characters
documentIdstringrequired
identifier of the document
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/{documentId}
Authentication
Path Parameters
Query Parameters
Headers
application/pdf
Utils
Utils operations.
Get Transaction Id By Ref Number
Get transaction ID by Reference Number provided on Create
get
https://api-test.vitu.com/national-public-api/v2/transactionId/{refNumber}
Path Parameters
refNumberstring(uuid)required
refNumber parameter.
<= 36 characters
Response
application/json
Response
application/json
OK
integer(int32)
>= -2147483648<= 2147483647
get/transactionId/{refNumber}
Authentication
Path Parameters
application/json