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:

FieldDescriptionFormat Example
primaryApplicantThe applicant’s information{ "name": "John Doe", "ssn": "123-45-6789" }
applicationTypeThe type of application (e.g., PURCHASE, REFINANCE, LEASE_BUYOUT)“PURCHASE”
vehicleThe vehicle information being financed{ "make": "Toyota", "model": "Camry", "year": 2020 }
hasCoApplicantWhether the application includes a co-applicanttrue
environmentThe environment to use”Production”
financeAmountThe amount to finance35000
sendToThe system to send the application to”RouteOne”
preApprovalThe pre-approval ID”PA123456”

Optional Fields

Optional fields can be included based on specific requirements:

FieldDescriptionFormat Example
coApplicantThe co-applicant’s information{ "name": "Jane Doe", "ssn": "987-65-4321" }
tradesTrade-in vehicle information{ "make": "Ford", "model": "Focus", "year": 2018 }

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.

export async function createCreditApp(data) {
  try {
    const res = await fetch('https://commerce.driv.ly/api/creditApplications', {
      method: 'POST',
      headers: {
        Authorization: '<api-key>',
        'Content-Type': 'application/json',
      },
      body: JSON.stringify(data),
    })

    const data = await res.json()
    console.log('Credit Application Response:', data)
  } catch (error) {
    console.error('Error during the API request:', error)
  }
}

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)

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.