Search
K
Lien Add - Sandbox

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

AkLienAddAddressDTO

object
streetstring

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

<= 255 characters

citystring

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

<= 255 characters

countystring

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

<= 255 characters

statestring

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

<= 255 characters

zipCodestring

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

<= 255 characters

Example

AkLienAddOwnerDTO

object
lastNamestring

Set Owner’s last name.

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

<= 100 characters

firstNamestring

Set Owner’s first name.

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

<= 100 characters

middleNamestring

Set Owner’s middle name.

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

<= 100 characters

ssnstring

Set Owner’s Social Security Number.

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

<= 50 characters

driverLicenseNumberstring

Indicates Owner’s driver license number.

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

<= 50 characters

driverLicenseStatestring

Set the issuing state of Owner’s driver license.

Allowed values:AKALARAZCACOCTDCDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPARISCSDTNTXUTVAVTWAWIWVWYOther

dateOfBirthstring(date)

Set Owner’s date of birth.

<= 10 characters

residenceAddressobject
Show Child Parameters
ownerTypestring

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

<= 255 characters

businessNamestring

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

<= 255 characters

feinstring

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

<= 255 characters

Example

AkLienAddRegistrationDTO

object
registrationActionstring

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

<= 255 characters

plateCategorystring

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

<= 255 characters

numberOfRegYearsnumber
addressobject
Show Child Parameters
Example