Skip to main content

​
Overview

Drivly’s Credit Application API is designed for the submission of credit applications for vehicle purchases and loan payoffs. It interfaces with financial lenders for processing these applications, ensuring a streamlined approach for credit checks, approvals, and financing options.

​
Making a Request

Submit a credit application to https://commerce.driv.ly/api/creditApplications with a POST request. Below is a breakdown of the required and optional data fields, supplemented with example requests for your applications.

​
Required Fields

Required fields must be provided with every application:

​
Optional Fields

Optional fields can be included based on specific requirements:

​
Required Fields

  • primaryApplicant: The applicant’s information.
  • applicationType: The type of application (e.g., PURCHASE, REFINANCE, LEASE_BUYOUT).
  • vehicle: The vehicle information being financed.
  • hasCoApplicant: Whether the application includes a co-applicant (e.g., true, false).
  • environment: The environment to use (e.g., Production, Development).
  • financeAmount: The amount to finance (e.g., 35000).
  • sendTo: The system to send the application to (e.g., RouteOne, TSG).
  • preApproval: The pre-approval ID.

​
Optional Fields

  • coApplicant: The co-applicant’s information (if applicable).
  • trades: Trade-in vehicle information (if applicable).

Example Request

​
Fetch API Example

We will assume that the createCreditApplication function and the Promise is called with the required data fields.

​
Successful Response

A successful response will have a 200 status code and a JSON object with the following fields:
  • id: The application ID.
  • title: The application title.
  • status: The application status.
  • sendTo: The system the application is sent to.
  • state: The application state.
  • environment: The environment used.
  • preApproval: The pre-approval ID.
  • applicationType: The application type.
  • financeAmount: The financed amount.
  • downPayment: The down payment amount.
  • primaryApplicant: The primary applicant’s information.
  • hasCoApplicant: Whether the application has a co-applicant.
  • vehicle: The vehicle information.
  • createdAt: The application creation date.
  • updatedAt: The application update date.

Example Response

​
Form Integration (UI)

We have RouteOne Certified Form Integration available. This allows you to submit credit applications directly to RouteOne for processing. To use this feature:
  • Use https://credit.driv.ly?tenant={RouteOneDealerId} with the RouteOne Dealer ID.
  • Host the form on custom domain with the RouteOne API integration.
The form fields can be pre-filled using query parameters, making it easier to complete the application. https://credit.driv.ly/?[fieldName]={value}&[fieldName]={value}

​
Form Fields (UI)

​
string
required
The first name of the primary applicant (e.g., John)Min: 2 characters, Max: 30 characters
​
string
The middle initial of the primary applicant (e.g., D)Max: 3 characters
​
string
required
The last name of the primary applicant (e.g., Smith)Min: 2 characters, Max: 30 characters
​
string
required
The phone number of the primary applicant (e.g., 5615551212)
​
enum<string>
required
The type of phone number (e.g., MOBILE, HOME, WORK)options: MOBILE, HOME, WORK
​
string
required
The email address of the primary applicant (e.g., john@gmail.com)
​
string
required
The date of birth of the primary applicant (e.g., 01/01/1990)format: MM/DD/YYYY
​
string
required
The SSN of the primary applicant (e.g., 123456789)Min: 9 characters
​
enum<string>
required
The residence type of the primary applicant (e.g., OWN=1, Rent=3, Live With Others=4)options: 1, 3, 4
​
string
required
The address line 1 of the primary applicant (e.g., 123 Main St)Max: 200 characters
​
string
The address line 2 of the primary applicant (e.g., Apt 2)Max: 200 characters
​
string
required
The city of the primary applicant (e.g., Miami)Max: 30 characters
​
string
required
The state of the primary applicant (e.g., FL)Max: 2 characters
​
string
required
The ZIP code of the primary applicant (e.g., 33101)Max: 5 characters
​
enum<string>
required
The number of years at the current addressoptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
​
enum<string>
The number of months at the current addressoptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
​
string
required
The monthly rent/mortgage payment of the primary applicant (e.g., 1500)
​
string
The address line 1 of the primary applicant (e.g., 123 Main St)Required if addressYears is less than 2 yearsMax: 200 characters
​
string
The address line 2 of the primary applicant (e.g., Apt 2)Required if addressYears is less than 2 yearsMax: 200 characters
​
string
The city of the primary applicant (e.g., Miami)Required if addressYears is less than 2 yearsMax: 30 characters
​
string
The state of the primary applicant (e.g., FL)Required if addressYears is less than 2 yearsMax: 2 characters
​
string
The ZIP code of the primary applicant (e.g., 33101)Required if addressYears is less than 2 yearsMax: 5 characters
​
enum<string>
The number of years at the current addressoptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10Required if addressYears is less than 2 years
​
enum<string>
The number of months at the current addressoptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
​
string
The monthly rent/mortgage payment of the primary applicant (e.g., 1500)Required if addressYears is less than 2 years
​
string
required
The driver’s license number of the primary applicant (e.g., 123456789)
​
string
required
The driver’s license state of the primary applicant (e.g., FL)Max: 2 characters
​
enum<string>
required
The employment status of the primary applicant (e.g., Full Time, Military, Contract)options: Full Time, Military, Contract, Part Time, Temporary, Seasonal, Self-Employed, Retired, Not Applicable
​
string
required
The employer name of the primary applicant (e.g., ABC Corp)Max: 40 characters
​
string
required
The employer phone number of the primary applicant (e.g., 5615551212)
​
string
required
The job title of the primary applicant (e.g., Manager)Max: 20 characters
​
enum<string>
required
The number of years at the current joboptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
​
enum<string>
The number of months at the current joboptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
​
string
required
The monthly income of the primary applicant (e.g., 5000)
​
string
The employer name of the primary applicant (e.g., ABC Corp)Required if timeOnJobYears is less than 2 yearsMax: 40 characters
​
string
The employer phone number of the primary applicant (e.g., 5615551212)Required if timeOnJobYears is less than 2 years
​
string
The job title of the primary applicant (e.g., Manager)Required if timeOnJobYears is less than 2 yearsMax: 20 characters
​
enum<string>
The number of years at the current joboptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10Required if timeOnJobYears is less than 2 years
​
enum<string>
The number of months at the current joboptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
​
string
The monthly income of the primary applicant (e.g., 5000)Required if timeOnJobYears is less than 2 years
​
enum<string>
The other income source of the primary applicant (e.g., OTHCSTM)options: OTHCSTM, NO
​
string
The other income monthly amount of the primary applicant (e.g., 1000)
​
string
The other income source description of the primary applicant (e.g., Part-time job)Max: 30 characters
​
boolean
Joint application indicator
​
string
required
The first name of the primary applicant (e.g., John)Min: 2 characters, Max: 30 characters
​
string
The middle initial of the primary applicant (e.g., D)Max: 3 characters
​
string
required
The last name of the primary applicant (e.g., Smith)Min: 2 characters, Max: 30 characters
​
string
required
The phone number of the primary applicant (e.g., 5615551212)
​
enum<string>
required
The type of phone number (e.g., MOBILE, HOME, WORK)options: MOBILE, HOME, WORK
​
string
required
The email address of the primary applicant (e.g., john@gmail.com)
​
string
required
The date of birth of the primary applicant (e.g., 01/01/1990)format: MM/DD/YYYY
​
string
required
The SSN of the primary applicant (e.g., 123456789)Min: 9 characters
​
enum<string>
required
The residence type of the primary applicant (e.g., OWN=1, Rent=3, Live With Others=4)options: 1, 3, 4
​
string
required
The address line 1 of the primary applicant (e.g., 123 Main St)Max: 200 characters
​
string
The address line 2 of the primary applicant (e.g., Apt 2)Max: 200 characters
​
string
required
The city of the primary applicant (e.g., Miami)Max: 30 characters
​
string
required
The state of the primary applicant (e.g., FL)Max: 2 characters
​
string
required
The ZIP code of the primary applicant (e.g., 33101)Max: 5 characters
​
enum<string>
required
The number of years at the current addressoptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
​
enum<string>
The number of months at the current addressoptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
​
string
required
The monthly rent/mortgage payment of the primary applicant (e.g., 1500)
​
string
The address line 1 of the primary applicant (e.g., 123 Main St)Required if co_addressYears is less than 2 yearsMax: 200 characters
​
string
The address line 2 of the primary applicant (e.g., Apt 2)Required if co_addressYears is less than 2 yearsMax: 200 characters
​
string
The city of the primary applicant (e.g., Miami)Required if co_addressYears is less than 2 yearsMax: 30 characters
​
string
The state of the primary applicant (e.g., FL)Required if co_addressYears is less than 2 yearsMax: 2 characters
​
string
The ZIP code of the primary applicant (e.g., 33101)Required if co_addressYears is less than 2 yearsMax: 5 characters
​
enum<string>
The number of years at the current addressoptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10Required if co_addressYears is less than 2 years
​
enum<string>
The number of months at the current addressoptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
​
string
The monthly rent/mortgage payment of the primary applicant (e.g., 1500)Required if co_addressYears is less than 2 years
​
string
required
The driver’s license number of the primary applicant (e.g., 123456789)
​
string
required
The driver’s license state of the primary applicant (e.g., FL)Max: 2 characters
​
enum<string>
required
The employment status of the primary applicant (e.g., Full Time, Military, Contract)options: Full Time, Military, Contract, Part Time, Temporary, Seasonal, Self-Employed, Retired, Not Applicable
​
string
required
The employer name of the primary applicant (e.g., ABC Corp)Max: 40 characters
​
string
required
The employer phone number of the primary applicant (e.g., 5615551212)
​
string
required
The job title of the primary applicant (e.g., Manager)Max: 20 characters
​
enum<string>
required
The number of years at the current joboptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10
​
enum<string>
The number of months at the current joboptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
​
string
required
The monthly income of the primary applicant (e.g., 5000)
​
string
The employer name of the primary applicant (e.g., ABC Corp)Required if co_timeOnJobYears is less than 2 yearsMax: 40 characters
​
string
The employer phone number of the primary applicant (e.g., 5615551212)Required if co_timeOnJobYears is less than 2 years
​
string
The job title of the primary applicant (e.g., Manager)Required if co_timeOnJobYears is less than 2 yearsMax: 20 characters
​
enum<string>
The number of years at the current joboptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10Required if co_timeOnJobYears is less than 2 years
​
enum<string>
The number of months at the current joboptions: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
​
string
The monthly income of the primary applicant (e.g., 5000)Required if co_timeOnJobYears is less than 2 years
​
enum<string>
The other income source of the primary applicant (e.g., OTHCSTM)options: OTHCSTM, NO
​
string
The other income monthly amount of the primary applicant (e.g., 1000)
​
string
The other income source description of the primary applicant (e.g., Part-time job)Max: 30 characters
​
string
required
The vehicle’s VIN (e.g., 5LM5J6WC1RGL07567)Min: 17 characters
​
string
required
The vehicle’s year (e.g., 2024)Min: 4 characters
​
string
required
The vehicle’s make (e.g., Lincoln)Min: 1 characters
​
string
required
The vehicle’s model (e.g., Aviator)Min: 1 characters
​
string
required
The vehicle’s price (e.g., 55985)Min: 1 characters
​
string
required
The vehicle’s mileage (e.g., 7)Min: 1 characters
​
string
The cash down payment (e.g., 5000)
​
string
required
Trade-in vehicle indicator (e.g., Y)
​
string
Trade-in vehicle VIN (e.g., W1NKM4HB4RF139674)Min: 17 characters
​
string
Trade-in vehicle year (e.g., 2024)Min: 4 characters
​
string
Trade-in vehicle make (e.g., Mercedes-Benz)Min: 1 characters
​
string
Trade-in vehicle model (e.g., GLC 300)Min: 1 characters
​
string
Trade-in vehicle lien indicator (e.g., Y)
Requires a dealer account with RouteOne and company logo. Please contact sales for more information.

​
Next Steps

Now that you have a better understanding of how the Credit Application API works, you can start integrating it into your application.

Credit Application Guide

Getting Started with Credit Apps

Credit Application API Reference

Explore the Credit Application API