Idaho (ID) EVR API - Sandbox

Updates a transaction in VITU system

Updates a transaction in VITU system

put
https://api-test.vitu.com/national-public-api/v2/transaction/{transactionId}

Query Parameters

transactionTypestring

Identifier of the type of the transaction

Allowed values:EVRINTERSTATEDMVDESKNTX

Default:INTERSTATE

<= 1048576 characters

Example:EVR

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

IDEVRTransactionDTO

statestring

Allowed values:AKALARAZCACOCTDCDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPARISCSDTNTXUTVAVTWAWIWVWYOther

<= 1048576 characters

Example:ID

refNumberstring(uuid)

<= 1048576 characters

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

applicationTypestring

Type of transaction

Allowed values:TitleAndRegistrationTitleOnlyTaxOnly

<= 1048576 characters

Example:TitleAndRegistration

serviceTypestring

Allowed values:FormsAndFeesFullService

<= 1048576 characters

Example:FormsAndFees

loanNumberstring | null

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:LN-7788990

locationIdinteger | null(int64)

>= -9007199254740991<= 9007199254740991

Example:1

saveForLaterboolean

Default:false

Example:true

isPremiumServiceboolean

Example:true

stateTransactionIdstring

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:1234567

registrationobject
Show Child Parameters
sellerobject
Show Child Parameters
ownerobject
Show Child Parameters
coOwnerobject
Show Child Parameters
lessorobject
Show Child Parameters
lessee1object
Show Child Parameters
lessee2object
Show Child Parameters
lienholder1object
Show Child Parameters
previousTitleobject
Show Child Parameters
additionalAddressesobject
Show Child Parameters
leaseBuyoutobject
Show Child Parameters
vehicleobject
Show Child Parameters
tradeInVehiclesarray[object]

<= 100000 items

Show Child Parameters

Response

application/json

OK

object

Accepted — processing asynchronously

Callbacks

post
{$request.query.callbackUrl}

Callback Response

application/json

Target server returns this code if it accepts the callback

object

Accepted — processing asynchronously

put/transaction/{transactionId}

Body

{}
 
application/json
callback sample
Callback Body
Callback Response
application/json

TransactionTypeEnum

string

Allowed values:EVRINTERSTATEDMVDESKNTX

Default:INTERSTATE

<= 1048576 characters

Example

Errors

array

>= 1 items<= 100000 items

messagestringrequired

Description of error

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:Request processed successfully

Error

messagestringrequired

Description of error

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:Request processed successfully

Example

CallbackDTO

object
One Of
timestampstring(date-time)required

<= 1048576 characters

Example:2024-03-15T09:30:00Z

callbackTypestring

Allowed values:SUCCESSFAILUREDMVDESKEVRINVOICEDNTX

<= 1048576 characters

Example:SUCCESS

refNumberstring(uuid)

<= 1048576 characters

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

transactionIdinteger(int32)required

>= -9007199254740991<= 9007199254740991

Example:1

statusstring

Allowed values:StartedCompletedDraftPreAuditInProgressPreAuditErrorsFoundPreAuditCompletedSentToServiceReceivedErrorsFoundSentToStateReturnedFromStateStateProcessedStateCompletedInactiveCompletedManuallyCanceledFailed

<= 1048576 characters

Example:Started

auditErrorsarray[string]

Match pattern:^[\s\S]*$

<= 1048576 characters<= 100000 items

Example:example

auditMessagesarray[object]

<= 100000 items

Show Child Parameters
shipmentobject
Show Child Parameters
vinstring

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:1HGCM82633A004352

owner1FullNamestring

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:Sample Name

controlNumberstring

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:STK-2024-001

applicationTypestring

Allowed values:TitleAndRegistrationTitleOnlyLienAddTempTagTaxOnlyReplacementSalvageTitleSalvageTitle

<= 1048576 characters

Example:TitleAndRegistration

universalStatusstring

Allowed values:AvailableDeal PendingVoidRejectedCompletedSubmittedIn ErrorInvoicedCompleted ManuallyAudit in ProgressTemp Tag DraftTemp Tag IssuedTemp Tag ClosedTemp Tag FailedTemp Tag VoidedDeleted

<= 1048576 characters

Example:Available

signRequestStatusstring

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:example

signerStatusstring

Match pattern:^[\s\S]*$

<= 1048576 characters

Example:example

signerNumberinteger(int32)

>= -9007199254740991<= 9007199254740991

Example:1

Example