Kentucky (KY) EVR API - Sandbox

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

KYEVRLessee1DTO

object
phonestring

Set Lessee’s primary phone number.

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

<= 1048576 characters

Example:555-0100

emailstring

Indicates Lessee’s email address.

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

<= 1048576 characters

Example:[email protected]

residenceAddressobject
Show Child Parameters
mailingAddressobject
Show Child Parameters
lesseeTypestring

Set Lessee type.

Allowed values:IndividualBusinessGovernmentNonProfitPoliticalSubdivisionStateAgencyCharityTrust

<= 1048576 characters

Example:Individual

driverLicenseNumberstring

Indicates Lessee’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 Lessee’s driver license.

Allowed values:AKALARAZCACOCTDCDEFLGAHIIAIDILINKSKYLAMAMDMEMIMNMOMSMTNCNDNENHNJNMNVNYOHOKORPARISCSDTNTXUTVAVTWAWIWVWYOther

<= 1048576 characters

Example:KY

firstNamestring

Set Lessee’s first name.

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

<= 1048576 characters

Example:John

middleNamestring

Set Lessee’s middle name.

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

<= 1048576 characters

Example:A

lastNamestring

Set Lessee’s last name.

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

<= 1048576 characters

Example:Doe

suffixstring

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

<= 1048576 characters

Example:Jr

businessNamestring

Set Lessee’s business name.

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

<= 1048576 characters

Example:Acme Auto Sales LLC

dateOfBirthstring

Set Lessee’s date of birth.

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

<= 1048576 characters

Example:1985-06-15

Example