GET
/
creditApplications
/
versions
curl --request GET \
  --url https://commerce.driv.ly/api/creditApplications/versions \
  --header 'Authorization: <api-key>'
{
  "docs": [
    {
      "version": {
        "title": "<string>",
        "sendToTSG": true,
        "state": "DRAFT",
        "environment": "Production",
        "meta": {},
        "sentToCustomer": true,
        "rates": [
          {
            "term": "<string>",
            "apr": "<string>",
            "monthlyPayment": 123,
            "requiredDownPayment": 123,
            "activationLink": "<string>",
            "id": "<string>"
          }
        ],
        "passesChecklist": true,
        "requiredFields": [
          "primaryApplicant"
        ],
        "missingFields": {},
        "requestId": "<string>",
        "logs": [
          {
            "timestamp": "<string>",
            "message": "<string>",
            "debug": {},
            "id": "<string>"
          }
        ],
        "autopayNumber": "<string>",
        "applicationLink": "<string>",
        "preApproval": 123,
        "applicationType": "REFINANCE",
        "financeAmount": 123,
        "downPayment": 123,
        "primaryApplicant": {
          "consumer": 123,
          "firstName": "<string>",
          "lastName": "<string>",
          "birthDate": "<string>",
          "emailAddress": "<string>",
          "cellPhone": "<string>",
          "ssn": "<string>",
          "relationshipType": "SPOUSE",
          "currentResidence": {
            "monthlyPaymentAmount": 123,
            "monthsAtResidence": 123,
            "ownershipStatus": "OWN",
            "address": {
              "lineOne": "<string>",
              "lineTwo": "<string>",
              "city": "<string>",
              "state": "AL",
              "postalCode": "<string>"
            }
          },
          "currentEmployment": {
            "yearlyIncomeAmount": 123,
            "monthsAtEmployer": 123,
            "employmentType": "FULL_TIME",
            "employerName": "<string>",
            "employmentPosition": "<string>",
            "employmentAddress": {
              "lineOne": "<string>",
              "lineTwo": "<string>",
              "city": "<string>",
              "state": "AL",
              "postalCode": "<string>"
            }
          },
          "previousResidence": {
            "monthlyPaymentAmount": 123,
            "monthsAtResidence": 123,
            "ownershipStatus": "OWN",
            "address": {
              "lineOne": "<string>",
              "lineTwo": "<string>",
              "city": "<string>",
              "state": "AL",
              "postalCode": "<string>"
            }
          },
          "previousEmployment": {
            "yearlyIncomeAmount": 123,
            "monthsAtEmployer": 123,
            "employmentType": "FULL_TIME",
            "employerName": "<string>",
            "employmentPosition": "<string>",
            "employmentAddress": {
              "lineOne": "<string>",
              "lineTwo": "<string>",
              "city": "<string>",
              "state": "AL",
              "postalCode": "<string>"
            }
          },
          "additionalIncomeAmount": 123,
          "additionalIncomeFrequency": "WEEKLY",
          "additionalIncomeSource": "<string>",
          "terms": {
            "agreeToTerms": true,
            "agreeIP": "<string>",
            "agreeUserAgent": "<string>"
          }
        },
        "hasCoApplicant": true,
        "coApplicant": {
          "consumer": 123,
          "firstName": "<string>",
          "lastName": "<string>",
          "birthDate": "<string>",
          "emailAddress": "<string>",
          "cellPhone": "<string>",
          "ssn": "<string>",
          "relationshipType": "SPOUSE",
          "currentResidence": {
            "monthlyPaymentAmount": 123,
            "monthsAtResidence": 123,
            "ownershipStatus": "OWN",
            "address": {
              "lineOne": "<string>",
              "lineTwo": "<string>",
              "city": "<string>",
              "state": "AL",
              "postalCode": "<string>"
            }
          },
          "currentEmployment": {
            "yearlyIncomeAmount": 123,
            "monthsAtEmployer": 123,
            "employmentType": "FULL_TIME",
            "employerName": "<string>",
            "employmentPosition": "<string>",
            "employmentAddress": {
              "lineOne": "<string>",
              "lineTwo": "<string>",
              "city": "<string>",
              "state": "AL",
              "postalCode": "<string>"
            }
          },
          "previousResidence": {
            "monthlyPaymentAmount": 123,
            "monthsAtResidence": 123,
            "ownershipStatus": "OWN",
            "address": {
              "lineOne": "<string>",
              "lineTwo": "<string>",
              "city": "<string>",
              "state": "AL",
              "postalCode": "<string>"
            }
          },
          "previousEmployment": {
            "yearlyIncomeAmount": 123,
            "monthsAtEmployer": 123,
            "employmentType": "FULL_TIME",
            "employerName": "<string>",
            "employmentPosition": "<string>",
            "employmentAddress": {
              "lineOne": "<string>",
              "lineTwo": "<string>",
              "city": "<string>",
              "state": "AL",
              "postalCode": "<string>"
            }
          },
          "additionalIncomeAmount": 123,
          "additionalIncomeFrequency": "WEEKLY",
          "additionalIncomeSource": "<string>",
          "terms": {
            "agreeToTerms": true,
            "agreeIP": "<string>",
            "agreeUserAgent": "<string>"
          }
        },
        "vehicle": {
          "vin": "<string>",
          "year": 123,
          "make": "<string>",
          "model": "<string>",
          "trim": "<string>",
          "mileage": 123,
          "lien": {
            "lienHolder": "<string>",
            "monthlyPaymentAmount": 123,
            "payoffAmount": 123,
            "initialTerm": 123,
            "remainingTerm": 123,
            "originalAmount": 123,
            "apr": 123
          }
        },
        "trades": [
          123
        ]
      },
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "totalDocs": 123,
  "limit": 123,
  "totalPages": 123,
  "page": 123,
  "pagingCounter": 123,
  "hasPrevPage": true,
  "hasNextPage": true,
  "prevPage": 123,
  "nextPage": 123
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
depth
number

number of levels to automatically populate relationships and uploads

​
locale
string

retrieves document(s) in a specific locale

​
fallback-locale
string

specifies a fallback locale if no locale value exists

​
sort
string

sort by field

​
where
object

pass a where query to constrain returned documents (complex type, see documentation)

Example:
{
  "or": [
    { "color": { "equals": "mint" } },
    {
      "and": [
        { "color": { "equals": "white" } },
        { "featured": { "equals": false } }
      ]
    }
  ]
}
​
limit
number

limit the returned documents to a certain number

​
page
number

get a specific page of documents

Response

200 - application/json

ok

The response is of type object.