Changelog: [Breaking] Simplified Named Excluded Driver Validation

Overview

We are introducing a simplified validation structure for Named Excluded Driver (NED). Today, once a prefill is complete, we automatically add any missing drivers to the quote as "status": "Undecided", which can be a confusing experience for both integrators and users. With this new change, we will be leveraging our existing require_exclusive requirement to give our integrators the power to choose when and where NED drivers are added to the quote.

Affected Endpoints

• Get Quote​
• Update Quote
• Patch Quote
• Create Prefill
• Get Prefill

Does Your Integration Need to be Updated?

Yes, this is a change from both of the old behaviors which were either named_forced_excluded_drivers or forced_named_excluded_driver_consideration. The new version is required_exclusive.

We have updated the requirements on the driver to include the required_exclusive validation which will let you know that there were drivers added from the prefill report and that action needs to be taken.

How to Identify

Until now, there have been two methods of how prefill drivers have been handled. See below to identify which method you have been using.

Method 1:

Current Behavior:

That was a manual step where you had to account for them. Now, we will surface drivers during prefill and add them to the quote.

What you are used to seeing -

1. Create a quote
2. Create a prefill request
3. GET prefill
4. You would update the quote with the found prefill drivers

What you will see now -

1. Create a quote
2. Create a prefill request
3. GET prefill
4. The quote will be in the collecting_data status. The prefill driver ID requirements will inform you of the available prefill drivers (via prefill_driver_ID) that need to be accounted for.
5. The required_exclusive requirement will not be fulfilled and must be before the quote continues.

Method 2:

Current Behavior:

The drivers would have been added to your quote. There was no requirement for the prefill_driver_ID , whereas now there is.

What you are used to seeing -

1. Create a quote
2. Create a prefill request
3. GET prefill
4. The quote will be in the collecting_data status because you have drivers in the quote with a status of undecided which you need to update to specify if they are covered, not in household, or excluded
5. Make an update to fix those drivers and continue with the quote.

What you will see now -

1. Create a quote.
2. Create a prefill request.
3. GET prefill.
4. The quote will be in the collecting_data status.
5. The required_exclusive requirement will not be fulfilled and must be before the quote continues.

How to Upgrade Your Integration

To be compatible with this new change, after prefill, you will get a new requirement on the prefill driver ID in the quote. This will tell you that for every prefill driver that we know, you will have to account for those drivers in the quote. The breaking change is that prefill_driver_ID of the drivers have a new type of requirement.