Receiving Quote Responses
Use this URL to fetch the quote response by passing the quote_id
provided by the previous response. Once the quote process is finished, you will receive a set of Quote Options. Each option is a package of benefits with a price related to it.
After this process you shall choose between the options available and pass its related quote_option_id
in the next call (see Purchasing insurance)
GET https://insurance-api.paycertify.com/api/quotes/{quote_id}
Field | Type | Description | Example |
---|---|---|---|
quote_id |
uuid |
Session ID, to be set in the URL | ac35fbb1-5fcc-4927-89cd-4b5c96d31c16 |
Field | Type | Description | Example |
---|---|---|---|
id |
uuid |
Quote ID | ac35fbb1-5fcc-4927-89cd-4b5c96d31c16 |
status |
string |
Quote status | processing , finished |
session_id |
uuid |
Session ID | ac35fbb1-5fcc-4927-89cd-4b5c96d31c16 |
purchase_id |
uuid |
Purchase ID (for records in which a purchase was consolidaded) | ac35fbb1-5fcc-4927-89cd-4b5c96d31c16 |
quote_options |
object | An object representing an option that can be purchased by the user | – |
quote_options.*.id |
uuid |
Quote option’s ID | – |
quote_options.*.amount |
float |
The quote option’s price | – |
quote_options.*.created_at |
timestamp |
Created at | 2018-04-12T21:07:59.353Z |
quote_options.*.updated_at |
timestamp |
Updated at | 2018-04-12T21:07:59.353Z |
quote_options.*.status |
string |
Quote option state: processing , quoted , invalid , error |
quoted |
quote_options.*.product |
object | An object representing the product that is associated to the quote option | |
quote_options.*.product.id |
uuid |
Product ID | ac35fbb1-5fcc-4927-89cd-4b5c96d31c16 |
quote_options.*.product.name |
string |
Product name | Plan 6 |
quote_options.*.product.active |
boolean |
true if product is active, false otherwise |
true |
quote_options.*.coverages.*.id |
string |
Coverage element ID | 4533171c-db5e-45ec-b88e-1e20a46e5c98 |
quote_options.*.coverages.*.description |
string |
The coverage description | Cancel for any reason |
quote_options.*.coverages.*.value |
string |
A description of the value associated to the coverage (per person limit) | 75% of non-refundable trip cost |
curl --request GET \
--url https://insurance-api.paycertify.com/api/quotes/20f1864d-f4d3-4b9c-990a-ffb5e53a1c34 \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
Responds with:
{
"quote": {
"id": "12e3e0d0-0447-40c2-9d3b-953cc5f94202",
"created_at": "2018-05-04T21:06:26.849Z",
"updated_at": "2018-05-04T21:06:29.453Z",
"status": "finished",
"session_id": "49b46755-6c7e-4b0a-ba3f-73326f8e2643",
"purchase_id": null,
"quote_options": [
{
"id": "fd6d933a-3e58-4c12-802c-10d8e4d1a906",
"created_at": "2018-05-04T21:06:29.433Z",
"updated_at": "2018-05-04T21:06:29.433Z",
"amount": "36.0",
"status": "quoted",
"coverages": [
{
"id": "4533171c-db5e-45ec-b88e-1e20a46e5c98",
"description": "Cancel for any reason",
"value": "75% of non-refundable trip cost "
},
{
"id": "a86b6309-70fa-414b-aacd-b7b544a71c08",
"description": "Rental Car Damage Coverage",
"value": "$30.000"
}
],
"product": {
"id": "eaa59318-9359-4c60-891c-5a96480be14e",
"created_at": "2018-04-19T16:26:06.495Z",
"updated_at": "2018-05-04T20:44:04.342Z",
"name": "RoundTrip Economy",
"active": true
}
}
]
}
}