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).
{
  "title": "Credit Application",
  "sendTo": "RouteOne",
  "state": "DRAFT",
  "environment": "Production",
  "preApproval": "123456789",
  "applicationType": "REFINANCE",
  "financeAmount": 65000,
  "downPayment": 5000,
  "primaryApplicant": {
    "firstName": "Danny",
    "lastName": "Turner",
    "birthDate": "06/24/1995",
    "emailAddress": "dannyt@gmail.com",
    "cellPhone": "561-775-1234",
    "ssn": "123-45-6789",
    "currentResidence": {
      "monthlyPaymentAmount": 3000,
      "monthsAtResidence": 36,
      "ownershipStatus": "OWN",
      "address": {
        "lineOne": "123 Main St",
        "lineTwo": "Apt 2",
        "city": "Miami",
        "state": "FL",
        "postalCode": "33101"
      }
    },
    "currentEmployment": {
      "yearlyIncomeAmount": 95000,
      "monthsAtEmployer": 36,
      "employmentType": "FULL_TIME",
      "employerName": "ABC Corp",
      "employmentPosition": "Manager",
      "employmentAddress": {
        "lineOne": "1525 Flamingo Ave",
        "lineTwo": "Suite 100",
        "city": "Miami",
        "state": "FL",
        "postalCode": "33101"
      }
    },
    "additionalIncomeAmount": 1000,
    "additionalIncomeFrequency": "WEEKLY",
    "additionalIncomeSource": "Part-time job",
    "terms": {
      "agreeToTerms": true,
      "agreeIP": "150.80.15.220",
      "agreeUserAgent": "Mozilla/5.0"
    }
  },
  "hasCoApplicant": false,
  "vehicle": {
    "vin": "W1NKM4HB4RF139674",
    "year": 2024,
    "make": "Mercedes-Benz",
    "model": "GLC",
    "trim": "GLC 300 4MATIC",
    "mileage": 20,
    "lien": {
      "lienHolder": "ABC Bank",
      "monthlyPaymentAmount": 800,
      "payoffAmount": 30000,
      "initialTerm": 72,
      "remainingTerm": 36,
      "originalAmount": 60000,
      "apr": 4.5
    }
  }
}

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.
{
  "id": "65f4c43aa86cc23f4013cfc8",
  "sendTo": "RouteOne",
  "state": "DRAFT",
  "environment": "Production",
  "requiredFields": [],
  "preApproval": {
    "id": "12034631b86bb45g202071a1",
    "title": "Danny Turner (dannyt@gmail.com)",
    "firstName": "Danny",
    "middleInitial": "",
    "lastName": "Turner",
    "suffix": null,
    "address": "123 Main St Apt 2",
    "city": "Miami",
    "state": "FL",
    "zip": "33101",
    "phone": "+15617751234",
    "email": "dannyt@gmail.com",
    "sessionId": "",
    "createdAt": "2024-03-26T22:04:01.175Z",
    "updatedAt": "2024-03-26T22:04:01.175Z",
    "status": "Processed",
    "AppId": 154422063,
    "customer": {
      "id": "12ab3d1241567b12d2ga12c1",
      "leads": ["65ea2c8130784a03c8fd39c9"],
      "address": "65ea2c8130784a03c8fd39c9",
      "email": "dannyt@gmail.com",
      "phone": "+15617551234",
      "consumerFirstName": "Danny",
      "consumerMiddleName": "",
      "consumerLastName": "Turner",
      "consumerSuffix": null,
      "consumerPreApprovals": ["12034631b86bb45g202071a1"],
      "consumerLeadSource": [],
      "companyType": [],
      "createdAt": "2024-03-26T22:03:29.685Z",
      "updatedAt": "2024-03-26T22:03:29.685Z"
    },
    "segmentationBand": "Good (700-749)",
    "income": "$12,000" // monthly income
  },
  "primaryApplicant": {
    "firstName": "Danny",
    "lastName": "Turner",
    "birthDate": "06/24/1995",
    "emailAddress": "dannyt@gmail.com",
    "cellPhone": "561-775-1234",
    "ssn": "123-45-6789",
    "currentResidence": {
      "monthlyPaymentAmount": 3000,
      "monthsAtResidence": 36,
      "ownershipStatus": "OWN",
      "address": {
        "lineOne": "123 Main St",
        "lineTwo": "Apt 2",
        "city": "Miami",
        "state": "FL",
        "postalCode": "33101"
      }
    },
    "currentEmployment": {
      "yearlyIncomeAmount": 95000,
      "monthsAtEmployer": 36,
      "employmentType": "FULL_TIME",
      "employerName": "ABC Corp",
      "employmentPosition": "Manager",
      "employmentAddress": {
        "lineOne": "1525 Flamingo Ave",
        "lineTwo": "Suite 100",
        "city": "Miami",
        "state": "FL",
        "postalCode": "33101"
      }
    },
    "previousResidence": { "address": {} },
    "previousEmployment": { "employmentAddress": {} },
    "additionalIncomeAmount": 1000,
    "additionalIncomeFrequency": "WEEKLY",
    "additionalIncomeSource": "Part-time job",
    "terms": {
      "agreeToTerms": true,
      "agreeIP": "150.80.15.220",
      "agreeUserAgent": "Mozilla/5.0"
    }
  },
  "coApplicant": {
    "currentResidence": { "address": {} },
    "currentEmployment": { "employmentAddress": {} },
    "previousResidence": { "address": {} },
    "previousEmployment": { "employmentAddress": {} },
    "terms": {}
  },
  "vehicle": {
    "vin": "W1NKM4HB4RF139674",
    "year": 2024,
    "make": "Mercedes-Benz",
    "model": "GLC",
    "trim": "GLC 300 4MATIC",
    "mileage": 20,
    "lien": {
      "lienHolder": "ABC Bank",
      "monthlyPaymentAmount": 800,
      "payoffAmount": 30000,
      "initialTerm": 72,
      "remainingTerm": 36,
      "originalAmount": 60000,
      "apr": 4.5
    }
  },
  "createdAt": "2024-03-15T21:58:48.032Z",
  "updatedAt": "2024-03-15T21:58:48.032Z",
  "logs": [],
  "missingFields": {},
  "passesChecklist": true,
  "rates": [],
  "title": "[DRAFT] Danny Turner - $65,000.00",
  "applicationType": "REFINANCE",
  "meta": {
    "refinanceType": "REMOVE SOMEONE",
    "term": "60 months",
    "sellTrade": "No"
  },
  "downPayment": 5000,
  "financeAmount": 65000,
  "trades": [],
  "hasCoApplicant": false
}

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.