Skip to main content
PATCH
/
creditapps
/
{id}
Update an existing Credit App
curl --request PATCH \
  --url https://commerce.driv.ly/api/creditapps/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "crapp_4ks9j3k2d0d2",
  "ssn": "123-45-6789",
  "email": "john.doe@example.com",
  "vehicle": "Vehicle ID",
  "lastName": "Doe",
  "consumer": "Consumer ID",
  "birthDate": "1984-09-20",
  "firstName": "John",
  "phoneNumber": "555-0199",
  "preApproval": "Pre-Approval ID",
  "coApplicantSSN": "234-56-7890",
  "coApplicantEmail": "jane.doe@example.com",
  "coApplicantLastName": "Doe",
  "coApplicantConsumer": "Consumer ID",
  "coApplicantBirthDate": "1990-07-12",
  "coApplicantFirstName": "Jane",
  "coApplicantPhoneNumber": "555-6789"
}'
{
  "data": {
    "id": "crapp_4ks9j3k2d0d2",
    "ssn": "123-45-6789",
    "email": "john.doe@example.com",
    "vehicle": "Vehicle ID",
    "lastName": "Doe",
    "consumer": "Consumer ID",
    "birthDate": "1984-09-20",
    "firstName": "John",
    "phoneNumber": "555-0199",
    "preApproval": "Pre-Approval ID",
    "coApplicantSSN": "234-56-7890",
    "coApplicantEmail": "jane.doe@example.com",
    "coApplicantLastName": "Doe",
    "coApplicantConsumer": "Consumer ID",
    "coApplicantBirthDate": "1990-07-12",
    "coApplicantFirstName": "Jane",
    "coApplicantPhoneNumber": "555-6789"
  },
  "success": true
}

Path Parameters

id
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

Body

application/json
id
string

Credit App is uniquely identified by id

provider
enum<string>

Credit App has Credit App Provider

Available options:
TSG,
RouteOne
providerResponse
object

Credit App has Provider Response

coApplicantSSN
string

Credit App has CoApplicant SSN

coApplicantPhoneNumber
string

Credit App has CoApplicant Phone Number

coApplicantEmail
string<idn-email>

Credit App has CoApplicant Email

coApplicantBirthDate
string<date>

Credit App has CoApplicant Birth Date

coApplicantLastName
string

Credit App has CoApplicant Last Name

coApplicantFirstName
string

Credit App has CoApplicant First Name

ssn
string

Credit App has SSN

phoneNumber
string

Credit App has Phone Number

email
string<idn-email>

Credit App has Email

birthDate
string<date>

Credit App has Birth Date

lastName
string

Credit App has Last Name

firstName
string

Credit App has First Name

preApproval

Credit App requires Pre-Approval

consumer

Consumer submits Credit App

coApplicantConsumer

Credit App has CoApplicant Consumer

vehicle

Credit App finances Vehicle

toProvider
boolean

Send Credit App to provider

Response

Credit App Updated

data
object
Examples:
{
"id": "crapp_4ks9j3k2d0d2",
"ssn": "123-45-6789",
"email": "john.doe@example.com",
"vehicle": "Vehicle ID",
"lastName": "Doe",
"consumer": "Consumer ID",
"birthDate": "1984-09-20",
"firstName": "John",
"phoneNumber": "555-0199",
"preApproval": "Pre-Approval ID",
"coApplicantSSN": "234-56-7890",
"coApplicantEmail": "jane.doe@example.com",
"coApplicantLastName": "Doe",
"coApplicantConsumer": "Consumer ID",
"coApplicantBirthDate": "1990-07-12",
"coApplicantFirstName": "Jane",
"coApplicantPhoneNumber": "555-6789"
}
success
boolean
I