',
'Content-Type': 'application/json'
}
```
Learn how to keep your API key secure and prevent unauthorized access.
***
## Making a Pre-Approval Request
Submit a pre-approval to `https://commerce.driv.ly/api/preApprovals` with a `POST` request. Below is a breakdown of the required and optional data fields, supplemented with example requests for your applications.
### Required Fields
* `firstName`: Customer's first name (String)
* `middleInitial`: Customer's middle initial (String)
* `lastName`: Customer's last name (String)
* `address`: Customer's physical address (String)
* `city`: City of the address (String)
* `state`: State of the address (AA format) (String)
* `zip`: Zip code of the address (String)
* `phone`: Customer's phone number (String)
* `email`: Customer's email address (String)
### Optional Fields
* `income`: Customer's income (String)
* `ipAddress`: IP address of the customer making the request (String)
* `userAgent`: User agent of the customer's browser (String)
* `isp`: Internet Service Provider of the customer (String)
### Fetch API Example
```javascript Async/Await theme={null}
export async function createPreApproval() {
try {
const response = await fetch('https://commerce.driv.ly/api/preApprovals', {
method: 'POST',
headers: {
Authorization: '',
'Content-Type': 'application/json',
},
body: JSON.stringify({
firstName: 'Danny',
middleInitial: '',
lastName: 'Turner',
suffix: null,
address: '241 Main St',
city: 'Juno Beach',
state: 'FL',
zip: '33408',
phone: '(561) 555-1234',
email: 'dannyt@gmail.com',
income: '$15,000',
}),
})
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`)
}
const responseData = await response.json()
console.log('Pre-Approval Response:', responseData)
} catch (error) {
console.error('Error during the API request:', error)
}
}
```
```javascript Promises theme={null}
fetch('https://commerce.driv.ly/api/preApprovals', {
method: 'POST',
headers: {
Authorization: '',
'Content-Type': 'application/json',
},
body: JSON.stringify({
firstName: 'Danny',
middleInitial: '',
lastName: 'Turner',
suffix: null,
address: '241 Main St',
city: 'Juno Beach',
state: 'FL',
zip: '33408',
phone: '(561) 555-1234',
email: 'dannyt@gmail.com',
income: '$15,000',
}),
})
.then((response) => response.json())
.then((data) => console.log(data))
.catch((error) => console.error('Error:', error))
```
This function createPreApproval sends the pre-approval data to the API endpoint using fetch with a
POST method. It waits for the response asynchronously, converts the response to JSON, and logs it
to the console. If an error occurs during the request or while handling the response, it catches
the error and logs it, which is crucial for debugging and user feedback in real applications.
To execute the function, simply call createPreApproval() from your JavaScript code.
This example is meant to be a basic demonstration. In production, you might want to handle errors
more gracefully and provide user feedback based on the result of the API call.
***
## Successful Response
Upon successful submission, the API returns a response containing the following generated values:
* `id`: Unique identifier for the pre-approval (String)
* `customer`: Customer's unique identifier (String)
* `segmentationBand`: Credit score band, e.g., "Excellent (750-900)" (String)
* `lead`: Unique identifier for the lead generated (String)
* `status`: Current status of the pre-approval, e.g., "Processing" (Enum)
* `estimatedInterestRate`: Estimated interest rate for the loan (String)
* `estimatedLoanTerm`: Estimated term for the loan in months (String)
* `updatedAt`: Timestamp of the last update (String)
* `createdAt`: Timestamp when the pre-approval was created (String)
The response will contain the same values as the request, along with the generated values. The
response will also include the status of the pre-approval, which can be used to track the progress
of the request. The status will be one of the following values: `Processing`, `Error`,
`Processed`, `Needs Info`.
### Example Response
```javascript theme={null}
{
id: '12034631b86bb45g202071a1',
title: 'Danny Turner (dannyt@gmail.com)',
firstName: 'Danny',
middleInitial: '',
lastName: 'Turner',
suffix: null,
address: '241 Main St',
city: 'Juno Beach',
state: 'FL',
zip: '33408',
phone: '+15615551234',
email: 'dannyt@gmail.com',
sessionId: '',
createdAt: '2024-03-26T22:03:29.685Z',
updatedAt: '2024-03-26T22:04:01.175Z',
status: 'Processed',
income: '$15,000',
AppId: 154422063,
customer: '12ab3d1241567b12d2ga12c1',
segmentationBand: 'Good (700-749)'
}
```
***
## Properties Reference
Available options: `Processing`, `Error`, `Processed`, `Needs Info`
Available options: `JR`, `SR`, `II`, `III`, `IV`
Available options: `AA`, `AE`, `AK`, `AL`, `AR`, `AS`, `AZ`, `CA`, `CO`, `CT`, `DC`, `DE`,
`FL`, `FM`, `GA`, `GU`, `HI`, `IA`, `ID`, `IL`, `IN`, `KS`, `KY`, `LA`, `MA`, `MD`, `ME`,
`MH`, `MI`, `MN`, `MO`, `MP`, `MS`, `MT`, `NC`, `ND`, `NE`, `NH`, `NJ`, `NM`, `NV`, `NY`,
`OH`, `OK`, `OR`, `PA`, `PR`, `PW`, `RI`, `SC`, `SD`, `TN`, `TX`, `UT`, `VA`, `VI`, `VT`,
`WA`, `WI`, `WV`, `WY`, `AP`{' '}
