transactionTypestring
Identifier of the type of the transaction
Allowed values:EVRINTERSTATEDMVDESKNTX
Default:INTERSTATE
Commit Transaction
Commit the transaction
put
https://api-test.vitu.com/national-public-api/v2/transaction/{transactionId}/commit
Query Parameters
Path Parameters
transactionIdstringrequired
Either int transactionId or uuid refNumber
<= 36 characters
Headers
x-on-behalf-of-userinteger
Id of the user on behalf of whom the request is being made
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
signerNamestring
<= 500 characters
signerEmailstring(email)
<= 500 characters
signerPhonestring
<= 500 characters
Response
application/json
Response
application/json
OK
object
Callbacks
Callbacks
post
{$request.query.callbackUrl}
Callback Response
200
Callback Response
200
Target server returns this code if it accepts the callback
put/transaction/{transactionId}/commit
Authentication
Path Parameters
Query Parameters
Headers
Body
{
"shipping": {
"shippingType": "Standard"
}
}
application/json
callback sample
Callback Body
Callback Response
200
Download Transaction Coversheet
Download coversheet for ship documents assigned to transaction
get
https://api-test.vitu.com/national-public-api/v2/transaction/{transactionId}/coversheet/download
Query Parameters
transactionTypestring
Identifier of the type of the transaction
Allowed values:EVRINTERSTATEDMVDESKNTX
Default:INTERSTATE
Path Parameters
transactionIdstringrequired
Either int transactionId or uuid refNumber
<= 36 characters
Headers
x-on-behalf-of-userinteger
Id of the user on behalf of whom the request is being made
Response
application/pdf
Response
application/pdf
OK
string
<= 500 characters
get/transaction/{transactionId}/coversheet/download
Authentication
Path Parameters
Query Parameters
Headers
application/pdf
Get Transaction Status
Get status of the transaction
get
https://api-test.vitu.com/national-public-api/v2/transaction/{transactionId}/status
Query Parameters
transactionTypestring
Identifier of the type of the transaction
Allowed values:EVRINTERSTATEDMVDESKNTX
Default:INTERSTATE
Path Parameters
transactionIdstringrequired
Either int transactionId or uuid refNumber
<= 36 characters
Headers
x-on-behalf-of-userinteger
Id of the user on behalf of whom the request is being made
Response
application/json
Response
application/json
OK
StatusDTO
StatusDTO
One OftitleDestinationstring
<= 500 characters
statusstringrequired
Allowed values:StartedCompletedDraftPreAuditInProgressPreAuditErrorsFoundPreAuditCompletedSentToServiceReceivedErrorsFoundSentToStateReturnedFromStateStateProcessedStateCompletedInactiveCompletedManuallyCanceledFailed
eventsarray[object]
<= 500 items
Show Child Parameters
auditErrorsarray[string]
<= 500 characters<= 500 items
indiciaobject
Show Child Parameters
timeframestring
<= 500 characters
signRequestStatusstring
<= 500 characters
get/transaction/{transactionId}/status
Authentication
Path Parameters
Query Parameters
Headers
application/json
Utils
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
<= 36 characters
Response
application/json
Response
application/json
OK
integer
get/transactionId/{refNumber}
Authentication
Path Parameters
application/json