details
- base
- localhost
- dev
- prod
/v2/private/purchase/aa/details
http://localhost:1350/v2/private/purchase/aa/details
https://dev.everdays.com/v2/private/purchase/aa/details
https://everdays.com/v2/private/purchase/aa/details
Available Methods​
- POST
POST /v2/private/purchase/aa/details​
This endpoint will be called on the first purchase screen that includes the form with all the user's information.
The data will then be sent to AA to start an application and retrieve pricing information.
Under the hood the API will also make a call to AA to submit the application into queue, creating a transaction ID.
Params​
| Param | Type | Description |
|---|---|---|
| firstName | String | The user's first name |
| lastName | String | The user's last name |
| dateOfBirth | Date (ISO) | The user's date of birth |
| gender | String Enum - ['Male', 'Female'] | The user's gender |
| profile | String | See rq-api |
| street | String | The user's street address (ex. 123 Fake Street) |
| city | String | The user's city address (ex. Birmingham) |
| state | String | The user's city address (ex. MI) |
| zip | String | The user's zip code (ex. 12345) |
| phone | Number | The user's phone number |
String | The user's email address | |
| occupation | String | The user's occupation |
| annualSalary | String | The user's annual salary |
| birthState | String | The user's birth state |
| driversLicenseNumber | String | The user's driver's license number |
| hasDriversLicense | Boolean | If the user has a driver's license |
| stateIssued | String | Which state the user's driver's license was issued |
Example request body
body: {
"firstName": "cool",
"lastName": "person",
"dateOfBirth": "1982-01-30T23:52:45.372+00:00",
"gender": "Male",
"profile": "",
"street": "street address",
"city": "asdf",
"state": "zz",
"zip": "12345",
"phone": 8185550102,
"email": "mwong+engine@everdays.com"
}
Returns​
The entire user object. user.purchase data will be updated with appNumber, a pricing array, and a transactionId. Pricing data will be used for the Term Policy Builder.
The transaction ID is returned from the call to submit the application to the queue.
Example return object with user.purchase
user: {
...,
"purchase": {
"aa": {
"appNumber": 1000542,
"pricing": [
{
"product": "EZT",
"coverage": 50000,
"terms": [
{
"years": 10,
"price": 21.48,
"riders": [
{
"type": "CI",
"price": 4.94,
"included": false,
"coverage": 12500
}
]
}
]
},
{
"product": "EZT",
"coverage": 50000,
"terms": [
{
"years": 20,
"price": 25.53,
"riders": [
{
"type": "CI",
"price": 4.93,
"included": false,
"coverage": 12500
}
]
}
]
},
...
],
"transactionId": 11272
}
}
}
info
For more detailed information about each value in purchase, please refer to the user model docs.