API Reference
- Addresses
- Attachments
- Calls
- Contacts
- Credit Applications
- Customers
- Deals
- Definitions
- DMV Fees
- Documents
- Fees
- Holidays
- Insurance Policies
- Insurance Quotes
- Leads
- Lead Events
- Listings
- Locations
- Logs
- Meetings
- Messages
- Pre-Approvals
- Sales Reps
- Searches
- Service Quotes
- Service Orders
- Taxes And Fees
- Templates
- CRM Trades
- Trades
- VDP Emails
- CRM Vehicles
- Vehicles
- Web Events
- Webhooks
Pre-Approvals
Create a new Pre Approval
Create a new Pre Approval
POST
/
preApprovals
Copy
curl --request POST \
--url https://commerce.driv.ly/api/preApprovals \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"customer": 123,
"title": "<string>",
"status": "Processing",
"firstName": "<string>",
"middleInitial": "<string>",
"lastName": "<string>",
"suffix": "JR",
"address": "<string>",
"city": "<string>",
"state": "AA",
"zip": "<string>",
"phone": "<string>",
"email": "<string>",
"income": "<string>",
"ipAddress": "<string>",
"userAgent": "<string>",
"isp": "<string>",
"sessionId": "<string>",
"resend": "<string>",
"AppId": 123,
"segmentationBand": "Excellent (750-900)",
"Name": "<string>",
"Score": "<string>",
"Status": "<string>",
"CreateDate": "<string>",
"DealerName": "<string>",
"Email": "<string>",
"AppMobileNo": "<string>",
"IsFullFileReportAvilable": true,
"estimatedInterestRate": "<string>",
"estimatedLoanTerm": "<string>",
"lead": 123,
"UserName": "<string>",
"ProductId": 123,
"QuickProductId": 123,
"StatusId": 123,
"IsQqPass": 123,
"IsQuickQualifyXpress": true,
"IsLeadFormReport": true,
"IsQr": true,
"RemoveOperator": true,
"IsQScan": true,
"QuickScanStatus": "<string>",
"updatedAt": "<string>",
"createdAt": "<string>"
}'
Copy
{
"doc": {
"customer": 123,
"title": "<string>",
"status": "Processing",
"firstName": "<string>",
"middleInitial": "<string>",
"lastName": "<string>",
"suffix": "JR",
"address": "<string>",
"city": "<string>",
"state": "AA",
"zip": "<string>",
"phone": "<string>",
"email": "<string>",
"income": "<string>",
"ipAddress": "<string>",
"userAgent": "<string>",
"isp": "<string>",
"sessionId": "<string>",
"resend": "<string>",
"AppId": 123,
"segmentationBand": "Excellent (750-900)",
"Name": "<string>",
"Score": "<string>",
"Status": "<string>",
"CreateDate": "<string>",
"DealerName": "<string>",
"Email": "<string>",
"AppMobileNo": "<string>",
"IsFullFileReportAvilable": true,
"estimatedInterestRate": "<string>",
"estimatedLoanTerm": "<string>",
"lead": 123,
"UserName": "<string>",
"ProductId": 123,
"QuickProductId": 123,
"StatusId": 123,
"IsQqPass": 123,
"IsQuickQualifyXpress": true,
"IsLeadFormReport": true,
"IsQr": true,
"RemoveOperator": true,
"IsQScan": true,
"QuickScanStatus": "<string>",
"updatedAt": "<string>",
"createdAt": "<string>"
},
"message": "<string>"
}
Usage with the Drivly SDK
Usage with the Drivly SDK
Make sure you install our SDK first. You can find out how, and more here.
Copy
import { SDK } from '@drivly/commerce'
import type { preApprovals } from '@drivly/commerce'
const sdk = new SDK(...)
const preApprovals = await sdk.preApprovals.create(data: preApprovals): Promise<preApprovals>
Authorizations
Query Parameters
number of levels to automatically populate relationships and uploads
retrieves document(s) in a specific locale
specifies a fallback locale if no locale value exists
Body
application/json
Response
200 - application/json
ok
The response is of type object
.
Copy
curl --request POST \
--url https://commerce.driv.ly/api/preApprovals \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"customer": 123,
"title": "<string>",
"status": "Processing",
"firstName": "<string>",
"middleInitial": "<string>",
"lastName": "<string>",
"suffix": "JR",
"address": "<string>",
"city": "<string>",
"state": "AA",
"zip": "<string>",
"phone": "<string>",
"email": "<string>",
"income": "<string>",
"ipAddress": "<string>",
"userAgent": "<string>",
"isp": "<string>",
"sessionId": "<string>",
"resend": "<string>",
"AppId": 123,
"segmentationBand": "Excellent (750-900)",
"Name": "<string>",
"Score": "<string>",
"Status": "<string>",
"CreateDate": "<string>",
"DealerName": "<string>",
"Email": "<string>",
"AppMobileNo": "<string>",
"IsFullFileReportAvilable": true,
"estimatedInterestRate": "<string>",
"estimatedLoanTerm": "<string>",
"lead": 123,
"UserName": "<string>",
"ProductId": 123,
"QuickProductId": 123,
"StatusId": 123,
"IsQqPass": 123,
"IsQuickQualifyXpress": true,
"IsLeadFormReport": true,
"IsQr": true,
"RemoveOperator": true,
"IsQScan": true,
"QuickScanStatus": "<string>",
"updatedAt": "<string>",
"createdAt": "<string>"
}'
Copy
{
"doc": {
"customer": 123,
"title": "<string>",
"status": "Processing",
"firstName": "<string>",
"middleInitial": "<string>",
"lastName": "<string>",
"suffix": "JR",
"address": "<string>",
"city": "<string>",
"state": "AA",
"zip": "<string>",
"phone": "<string>",
"email": "<string>",
"income": "<string>",
"ipAddress": "<string>",
"userAgent": "<string>",
"isp": "<string>",
"sessionId": "<string>",
"resend": "<string>",
"AppId": 123,
"segmentationBand": "Excellent (750-900)",
"Name": "<string>",
"Score": "<string>",
"Status": "<string>",
"CreateDate": "<string>",
"DealerName": "<string>",
"Email": "<string>",
"AppMobileNo": "<string>",
"IsFullFileReportAvilable": true,
"estimatedInterestRate": "<string>",
"estimatedLoanTerm": "<string>",
"lead": 123,
"UserName": "<string>",
"ProductId": 123,
"QuickProductId": 123,
"StatusId": 123,
"IsQqPass": 123,
"IsQuickQualifyXpress": true,
"IsLeadFormReport": true,
"IsQr": true,
"RemoveOperator": true,
"IsQScan": true,
"QuickScanStatus": "<string>",
"updatedAt": "<string>",
"createdAt": "<string>"
},
"message": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.