Kentucky (KY) EVR API - Sandbox

KYEVRTransactionDTO

object
statestring

Allowed values:AKALARAZCACOCTDCDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPARISCSDTNTXUTVAVTWAWIWVWYOther

<= 1048576 characters

Example:KY

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

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

<= 1048576 characters

Example:LN-7788990

locationIdinteger(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
ownerobject
Show Child Parameters
coOwnerobject
Show Child Parameters
lessorobject
Show Child Parameters
lessee1object
Show Child Parameters
lessee2object
Show Child Parameters
lienholder1object
Show Child Parameters
insuranceobject
Show Child Parameters
previousTitleobject
Show Child Parameters
priorOwnerobject
Show Child Parameters
vehicleobject
Show Child Parameters
tradeInVehiclesarray[object]

<= 100000 items

Show Child Parameters
Example

KYEVRRegistrationDTO

object
actionstring

Set the registration action.

Allowed values:NewRegistrationPlateTransferTemporaryTag

<= 1048576 characters

Example:NewRegistration

plateCategorystring

Indicates the type of license plate Owner is applying for registration.

Allowed values:StandardPersonalizedSpecialtyRideShareDisabled

<= 1048576 characters

Example:Standard

expirationDatestring

In the event of a plate transfer, indicate the current registration expiration date.

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

<= 1048576 characters

Example:2024-03-15

plateNumberstring

In the event of a plate transfer, indicate the transfer plate number.

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

<= 1048576 characters

Example:ABC1234

paperlessTitleboolean

Example:true

Example

KYEVROwnerDTO

object
ownerTypestring

Set Owner type.

Allowed values:IndividualBusinessGovernmentNonProfitPoliticalSubdivisionSeniorCitizenCenterStateAgencyVolunteerFireDepartmentCharityTrust

<= 1048576 characters

Example:Individual

dateOfBirthstring

Set Owner’s date of birth.

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

<= 1048576 characters

Example:1985-06-15

driverLicenseNumberstring

Indicates Owner’s driver license number.

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

<= 1048576 characters

Example:D1234567

driverLicenseTypestring

Allowed values:USDriversLicensePassportUSCitizenshipDOJNATOUSMilitaryUSDeptOfStateUSDeptOfHomelandSecurityOtherMilitaryStatusOfForces

<= 1048576 characters

Example:USDriversLicense

driverLicenseStatestring

Set the issuing state of Owner’s driver license.

Allowed values:AKALARAZCACOCTDCDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPARISCSDTNTXUTVAVTWAWIWVWYOther

<= 1048576 characters

Example:KY

firstNamestring

Set Owner’s first name.

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

<= 1048576 characters

Example:John

middleNamestring

Set Owner’s middle name.

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

<= 1048576 characters

Example:A

lastNamestring

Set Owner’s last name.

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

<= 1048576 characters

Example:Doe

suffixstring

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

<= 1048576 characters

Example:Jr

businessNamestring

Set Owner’s business name.

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

<= 1048576 characters

Example:Acme Auto Sales LLC

phonestring

Set Owner’s primary phone number.

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

<= 1048576 characters

Example:555-0100

emailstring

Indicates Owner’s email address.

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

<= 1048576 characters

Example:[email protected]

residenceAddressobject
Show Child Parameters
mailingAddressobject
Show Child Parameters
Example

KYEVRCoOwnerDTO

object
phonestring

Set secondary Owner’s primary phone number.

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

<= 1048576 characters

Example:555-0100

emailstring

Indicates Secondary Owner’s email address.

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

<= 1048576 characters

Example:[email protected]

residenceAddressobject
Show Child Parameters
mailingAddressobject
Show Child Parameters
ownerTypestring

Set secondary Owner type.

Allowed values:IndividualBusinessGovernmentNonProfitPoliticalSubdivisionSeniorCitizenCenterStateAgencyVolunteerFireDepartmentCharityTrust

<= 1048576 characters

Example:Individual

jointOwnershipTypestring

Set type of joint ownership concerning release of interest in a vehicle.

Allowed values:AndOrAndOrSpousesTenantsByEntiretiesTenantsInCommonJointTenantsJointTenantsWithRightsOfSurvivorshipJointTenantsWithoutRightsOfSurvivorshipBusinessPartners

<= 1048576 characters

Example:And

dateOfBirthstring

Set secondary Owner’s date of birth.

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

<= 1048576 characters

Example:1985-06-15

driverLicenseNumberstring

Indicates secondary Owner’s driver license number.

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

<= 1048576 characters

Example:D1234567

driverLicenseTypestring

Allowed values:USDriversLicensePassportUSCitizenshipDOJNATOUSMilitaryUSDeptOfStateUSDeptOfHomelandSecurityOtherMilitaryStatusOfForces

<= 1048576 characters

Example:USDriversLicense

driverLicenseStatestring

Set the issuing state of secondary Owner’s driver license.

Allowed values:AKALARAZCACOCTDCDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPARISCSDTNTXUTVAVTWAWIWVWYOther

<= 1048576 characters

Example:KY

firstNamestring

Set secondary Owner’s first name.

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

<= 1048576 characters

Example:John

middleNamestring

Set secondary Owner’s middle name.

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

<= 1048576 characters

Example:A

lastNamestring

Set secondary Owner’s last name.

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

<= 1048576 characters

Example:Doe

suffixstring

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

<= 1048576 characters

Example:Jr

businessNamestring

Set secondary owner’s business name.

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

<= 1048576 characters

Example:Acme Auto Sales LLC

Example

KYEVRLessorDTO

object
namestring

Set Lessor’s name.

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

<= 1048576 characters

Example:Sample Name

phonestring

Indicates Lessor primary phone number.

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

<= 1048576 characters

Example:555-0100

emailstring

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

<= 1048576 characters

Example:[email protected]

leaseOrRentalLicenseNumberstring

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

<= 1048576 characters

Example:SAMPLE-001

physicalAddressobject
Show Child Parameters
mailingAddressobject
Show Child Parameters
Example