Lien Add - Sandbox

ESign

ESign operations.

Cancel Sign

Cancel an e-sign request

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

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

CancelSignDTO

CancelSignDTOobject

Response

application/json

OK

EmptyResponse

EmptyResponseobject

Empty response body (operation accepted / no content).

* Additional properties are NOT allowed.
post/transaction/{transactionId}/sign/cancel

Body

{}
 
application/json

Initiate Sign

Initiate e-sign flow for an interstate transaction

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

Query Parameters

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

Body

application/json

InitiateFlowDTO

callbackUrlstring | null(uri)

Match pattern:^https?://

<= 2048 characters

senderobject
Show Child Parameters
ownerobject
Show Child Parameters
coOwnerobject
Show Child Parameters
expirationDatestring | null(date-time)

<= 40 characters

Response

application/json

OK

EmptyResponse

EmptyResponseobject

Empty response body (operation accepted / no content).

* Additional properties are NOT allowed.
post/transaction/{transactionId}/sign/initiate

Body

{ "callbackUrl": "https://vitu.com/example", "sender": { "companyName": "Vitu Motors", "firstName": "John", "lastName": "Doe", "email": "[email protected]", "phone": "5551234567" }, "owner": { "signFlowInline": true, "companyName": "Vitu Motors", "firstName": "Jane", "lastName": "Smith", "email": "[email protected]", "phone": "5552223333" }, "coOwner": { "signFlowInline": true, "companyName": "Vitu Motors", "firstName": "Alex", "lastName": "Johnson", "email": "[email protected]", "phone": "5554445555" }, "expirationDate": "2026-06-18T17:04:22Z" }
 
application/json

Get Sign Link

Get e-sign link by signer number

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

Query Parameters

signerNumberinteger(int32)required

>= -2147483648<= 2147483647

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

OK

SignLinkDTO

SignLinkDTOobject
get/transaction/{transactionId}/sign/link
 
application/json

Resend Sign Invitation

Resend e-sign invitation email to a signer

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

Query Parameters

signerNumberinteger(int32)required

>= -2147483648<= 2147483647

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

OK

EmptyResponse

EmptyResponseobject

Empty response body (operation accepted / no content).

* Additional properties are NOT allowed.
post/transaction/{transactionId}/sign/resend
 
application/json