transactionTypestring
Identifier of the type of the transaction
Allowed values:EVRINTERSTATEDMVDESKNTX
Default:NTX
<= 1048576 characters
Example:NTX
Get list of documents produced by the transaction
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]*$
<= 1048576 characters
Headers
x-on-behalf-of-userinteger(int64)
>= -9007199254740991<= 9007199254740991
Response
application/json
Response
application/json
OK
<= 100000 items
namestring
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:Sample Name
idinteger(int64)
>= -9007199254740991<= 9007199254740991
Example:1
descriptionstring
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:Sample description
keystring
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:example
serialNumberstring
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:SAMPLE-001
isRequiredboolean
Example:true
isSelectedboolean
Example:true
informationstring
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:example
signedboolean
Example:true
metaobject
* Additional properties are NOT allowed.
Show Child Parameters
get/transaction/{transactionId}/forms
Authentication
Path Parameters
Query Parameters
Headers
application/json
Download documents produced by the transaction
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:NTX
<= 1048576 characters
Example:NTX
targetstring
target parameter
Allowed values:DealerCustomerLenderOwnerCoOwnerScans
<= 1048576 characters
Example:Dealer
Path Parameters
transactionIdstringrequired
Either int transactionId or uuid refNumber
Match pattern:^[\s\S]*$
<= 1048576 characters
Headers
x-on-behalf-of-userinteger(int64)
>= -9007199254740991<= 9007199254740991
Response
application/pdf
Response
application/pdf
OK
string
<= 1048576 characters
get/transaction/{transactionId}/forms/download
Authentication
Path Parameters
Query Parameters
Headers
application/pdf
Download transaction's document by transaction and document Id
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:NTX
<= 1048576 characters
Example:NTX
blankboolean
if you need to generate blank form
Path Parameters
transactionIdstringrequired
Either int transactionId or uuid refNumber
Match pattern:^[\s\S]*$
<= 1048576 characters
documentIdstring(uuid)required
identifier of the document
Match pattern:^[\s\S]*$
<= 64 characters
Headers
x-on-behalf-of-userinteger(int64)
>= -9007199254740991<= 9007199254740991
Response
application/pdf
Response
application/pdf
OK
string
<= 1048576 characters
get/transaction/{transactionId}/forms/download/{documentId}
Authentication
Path Parameters
Query Parameters
Headers
application/pdf
Commit the transaction
Commit the transaction
put
https://api-test.vitu.com/national-public-api/v2/transaction/{transactionId}/commit
Query Parameters
transactionTypestring
Identifier of the type of the transaction
Allowed values:EVRINTERSTATEDMVDESKNTX
Default:NTX
<= 1048576 characters
Example:NTX
Path Parameters
transactionIdstringrequired
Either int transactionId or uuid refNumber
Match pattern:^[\s\S]*$
<= 1048576 characters
Headers
x-on-behalf-of-userinteger(int64)
>= -9007199254740991<= 9007199254740991
Body
application/json
Body
application/json
FinalizeDTO
* Additional properties are NOT allowed.
shippingobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
plateDestinationobject
* Additional properties are NOT allowed.
Show Child Parameters
submitAsIsboolean
Example:true
signerNamestring
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:Sample Name
signerPhonestring
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:555-0100
Response
application/json
Response
application/json
OK
object
Accepted — processing asynchronously
Callbacks
Callbacks
post
{$request.query.callbackUrl}
Callback Response
application/json
Callback Response
application/json
Target server returns this code if it accepts the callback
object
Accepted — processing asynchronously
put/transaction/{transactionId}/commit
Authentication
Path Parameters
Query Parameters
Headers
Body
{
"shipping": {
"shippingType": "Standard"
}
}
application/json
callback sample
Callback Body
Callback Response
application/json
Tickets
Tickets operations