Skip to main content
POST
/
creditApplications
Create a new Credit Application
curl --request POST \
  --url https://commerce.driv.ly/api/creditApplications \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "environment": "Production",
  "updatedAt": "<string>",
  "createdAt": "<string>",
  "title": "<string>",
  "sendToTSG": true,
  "state": "DRAFT",
  "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
  ]
}
'
{
  "doc": {
    "environment": "Production",
    "updatedAt": "<string>",
    "createdAt": "<string>",
    "title": "<string>",
    "sendToTSG": true,
    "state": "DRAFT",
    "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
    ]
  },
  "message": "<string>"
}
Make sure you install our SDK first. You can find out how, and more here.
import { SDK } from '@drivly/commerce'
import type { creditApplications } from '@drivly/commerce'

const sdk = new SDK(...)

const creditApplications = await sdk.creditApplications.create(data: creditApplications): Promise<creditApplications>

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

Body

application/json
​
environment
enum<string>
required
Available options:
Production,
Development
​
updatedAt
string
required
​
createdAt
string
required
​
title
string | null
​
sendToTSG
boolean | null
​
state
enum<string> | null
Available options:
DRAFT,
SUBMITTED,
APPROVED,
DENIED,
CANCELLED
​
meta
​
sentToCustomer
boolean | null
​
rates
object[] | null
​
passesChecklist
boolean | null
​
requiredFields
enum<string>[] | null
Available options:
primaryApplicant,
primaryApplicant.currentResidence,
primaryApplicant.currentEmployment,
primaryApplicant.additionalIncome,
primaryApplicant.previousResidence,
primaryApplicant.previousEmployment,
coApplicant,
coApplicant.currentResidence,
coApplicant.currentEmployment,
coApplicant.additionalIncome,
coApplicant.previousResidence,
coApplicant.previousEmployment,
vehicle,
vehicle.lien,
financeAmount,
applicationType,
primaryApplicant.agreeTerms,
coApplicant.agreeTerms
​
missingFields
​
requestId
string | null
​
logs
object[] | null
​
autopayNumber
string | null
​
applicationLink
string | null
​
preApproval
​
applicationType
enum<string> | null
Available options:
REFINANCE,
PURCHASE,
LEASE_BUYOUT
​
financeAmount
number | null
​
downPayment
number | null
​
primaryApplicant
object
​
hasCoApplicant
boolean | null
​
coApplicant
object
​
vehicle
object
​
trades
(number | Trade · object)[] | null

Response

200 - application/json

ok

​
doc
CreditApplication · object
required
​
message
string
required