`POST` Quote Response
After a successful request, the API response will include a set of quotes to be polled.
200 Response Body
A successful POST
request to /quotes
may result in this response.
Aggregate Retention
The aggregate retention field may be different from the retention you requested.
If your requested retention can't be returned, it will return the lowest possible value instead.
Retentions can be higher depending on the class or question answers.
Example response
{
"company_id": "<COMPANY_ID>",
"quotes": [
{
"aggregate_limit": 1000000, // to be deprecated
"aggregate_retention": 2500, // to be deprecated
"per_claim_limit": 1000000, // to be deprecated
"quote_identifier": "<QUOTE_ID_STRING>",
"requested_aggregate_limit": 1000000,
"requested_aggregate_retention": 2500,
"requested_per_claim_limit": 2500
},
{
"aggregate_limit": 2000000,
"aggregate_retention": 5000,
"per_claim_limit": 2000000,
"quote_identifier": "<QUOTE_ID_STRING>",
"requested_aggregate_limit": 2000000,
"requested_aggregate_retention": 2500,
"requested_per_claim_limit": 2000000
},
{
"aggregate_limit": 3000000,
"aggregate_retention": 5000,
"per_claim_limit": 3000000,
"quote_identifier": "<QUOTE_ID_STRING>",
"requested_aggregate_limit": 3000000,
"requested_aggregate_retention": 2500,
"requested_per_claim_limit": 3000000
}
]
}
Utilizing the Company ID
Our 5 digit company_id
can be used by your broker to access their quotes via our Broker Platform.
After logging in with your broker's account, you can append thecompany_id
in our API response to our Broker Platform link:
- Production
https://keeprisk.at-bay.com/company/{company_id}
- Demo
https://keeprisk-demo.at-bay.com/company/{company_id}
Breaking Down Each Field in the Quotes Array
This array has a one to one relationship for each option in the quotes
list of your API request.
aggregate_retention
: The API will return the lowest aggregate retention equal to or above the retention requested. So, if the request was for 2500
, you may receive 5000
or 10000
depending on the parameters of the quote.
per_claim_limit
: If no value is submitted, it will usually match the aggregate limit by default.
Updated almost 2 years ago
Check out our guide to utilizing Quote Id's here: