Retrieve a Credit App

curl --request GET \
  --url https://commerce.driv.ly/api/creditapps/{id}

{
  "data": {
    "id": "<string>",
    "preApproval": "<string>",
    "consumer": "<string>",
    "vehicle": "<string>",
    "provider": "TSG",
    "providerResponse": {},
    "coApplicantSSN": "<string>",
    "coApplicantPhoneNumber": "<string>",
    "coApplicantEmail": "<string>",
    "coApplicantBirthDate": "2023-12-25",
    "coApplicantLastName": "<string>",
    "coApplicantFirstName": "<string>",
    "ssn": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "birthDate": "2023-12-25",
    "lastName": "<string>",
    "firstName": "<string>",
    "coApplicantConsumer": "<string>",
    "toProvider": true
  },
  "success": true
}

GET

creditapps

{id}

Retrieve a Credit App

curl --request GET \
  --url https://commerce.driv.ly/api/creditapps/{id}

{
  "data": {
    "id": "<string>",
    "preApproval": "<string>",
    "consumer": "<string>",
    "vehicle": "<string>",
    "provider": "TSG",
    "providerResponse": {},
    "coApplicantSSN": "<string>",
    "coApplicantPhoneNumber": "<string>",
    "coApplicantEmail": "<string>",
    "coApplicantBirthDate": "2023-12-25",
    "coApplicantLastName": "<string>",
    "coApplicantFirstName": "<string>",
    "ssn": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "birthDate": "2023-12-25",
    "lastName": "<string>",
    "firstName": "<string>",
    "coApplicantConsumer": "<string>",
    "toProvider": true
  },
  "success": true
}

Path Parameters

string

required

Credit App is uniquely identified by id

Query Parameters

depth

integer

The number of levels of related objects to include in the response

Response

Credit App Found

data

Credit App · object

Show child attributes

data.id

string

required

Credit App is uniquely identified by id

data.preApproval

required

Credit App requires Pre-Approval

data.consumer

required

Consumer submits Credit App

data.vehicle

required

Credit App finances Vehicle

data.provider

enum<string>

Credit App has Credit App Provider

Available options:

TSG,

RouteOne

data.providerResponse

object

Credit App has Provider Response

data.coApplicantSSN

string

Credit App has CoApplicant SSN

data.coApplicantPhoneNumber

string

Credit App has CoApplicant Phone Number

data.coApplicantEmail

string<idn-email>

Credit App has CoApplicant Email

data.coApplicantBirthDate

string<date>

Credit App has CoApplicant Birth Date

data.coApplicantLastName

string

Credit App has CoApplicant Last Name

data.coApplicantFirstName

string

Credit App has CoApplicant First Name

data.ssn

string

Credit App has SSN

data.phoneNumber

string

Credit App has Phone Number

data.email

string<idn-email>

Credit App has Email

data.birthDate

string<date>

Credit App has Birth Date

data.lastName

string

Credit App has Last Name

data.firstName

string

Credit App has First Name

data.coApplicantConsumer

Credit App has CoApplicant Consumer

data.toProvider

boolean

Send Credit App to provider

success

boolean

Create a new Credit App Update an existing Credit App

⌘I

Services

Guides

API Reference

Retrieve a Credit App

Path Parameters

Query Parameters

Response