Services
API Reference
- GETGet Pre-Approvals
- POSTCreate a new Pre-Approval
- GETRetrieve a Pre-Approval
- PATCHUpdate an existing Pre-Approval
- GETGet Credit Apps
- POSTCreate a new Credit App
- GETRetrieve a Credit App
- PATCHUpdate an existing Credit App
- GETGet Credit Reports
- POSTCreate a new Credit Report
- GETRetrieve a Credit Report
- PATCHUpdate an existing Credit Report
- GETGet Credit Bands
- GETRetrieve a Credit Band
- GET
curl --request GET \
--url https://commerce.driv.ly/api/creditapps{
"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,
"page": 123,
"nextPage": 123,
"prevPage": 123,
"totalPages": 123,
"totalCount": 123,
"limit": 123,
"pagingCounter": 123,
"hasPrevPage": true,
"hasNextPage": true
}Get Credit Apps
curl --request GET \
--url https://commerce.driv.ly/api/creditapps{
"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,
"page": 123,
"nextPage": 123,
"prevPage": 123,
"totalPages": 123,
"totalCount": 123,
"limit": 123,
"pagingCounter": 123,
"hasPrevPage": true,
"hasNextPage": true
}Query Parameters
Pass the name of a top-level field to sort by that field in ascending order. Prefix the name of the field with a minus symbol ("-") to sort in descending order.
Limit number of results, default 10
Search for results fitting criteria, uses qs library for query string parsing
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
The value must be greater than.
The value must be greater than or equal.
The value must be less than.
The value must be less than or equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
The value must be greater than.
The value must be greater than or equal.
The value must be less than.
The value must be less than or equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
Show child attributes
Show child attributes
The value must be exactly equal.
The query will return all documents where the value is not equal.
Case-insensitive string must be present. If string of words, all words must be present, in any order.
Must contain the value entered, case-insensitive.
The value must be found within the provided comma-delimited list of values.
The value must NOT be within the provided comma-delimited list of values.
The value must contain all values provided in the comma-delimited list.
Only return documents where the value either exists (true) or does not exist (false).
The number of levels of related objects to include in the response
Response
Credit Apps Found
Show child attributes
Show child attributes
Credit App is uniquely identified by id
Credit App requires Pre-Approval
Consumer submits Credit App
Credit App finances Vehicle
Credit App has Credit App Provider
TSG, RouteOne Credit App has Provider Response
Credit App has CoApplicant SSN
Credit App has CoApplicant Phone Number
Credit App has CoApplicant Email
Credit App has CoApplicant Birth Date
Credit App has CoApplicant Last Name
Credit App has CoApplicant First Name
Credit App has SSN
Credit App has Phone Number
Credit App has Email
Credit App has Birth Date
Credit App has Last Name
Credit App has First Name
Credit App has CoApplicant Consumer
Send Credit App to provider
Current page number
number of next page, null if it doesn't exist
number of previous page, null if it doesn't exist
Total pages available, based upon the limit
Total available records within the database
Limit query parameter, defaults to 10
number of the first record on the current page
true/false if previous page exists
true/false if next page exists