Root Embedded API

Documentation
- Get v3 openapi specget
Agency
Policy
Address
- Validate addresspost
Bridge Link
- Create bridge linkpost
- Authenticate bridge linkpost
Legal Documents
Braintree Payments
- Create Braintree client tokenpost
- Get Braintree customerget
Prefill
- Create prefill reportpost
- Get prefill reportget
Quoting
YearMakeModel
- Get YearMakeModelget

Root Embedded API

Documentation
- Get v3 openapi specget
Agency
Policy
Address
- Validate addresspost
Bridge Link
- Create bridge linkpost
- Authenticate bridge linkpost
Legal Documents
Braintree Payments
- Create Braintree client tokenpost
- Get Braintree customerget
Prefill
- Create prefill reportpost
- Get prefill reportget
Quoting
YearMakeModel
- Get YearMakeModelget

Get prefill report

get https://app.partner-testing.joinroot.com/bind_api/v3/quoting/quote/{quote_id}/prefill

Attempt to retrieve a prefill report. The associated quote must exist and a prefill request must have been previously created on /v3/quoting/quote/{quote_id}/prefill in order to receive a success response. This operation is async and it is recommended to be polled until completion. This operation can take up to 35 seconds to complete.

URL Expired

The URL for this request expired after 30 days.

Path Params

quote_id

string

required

Responses

Response body

object

prefillReport

object

required

A report containing the found drivers and vehicles from the request.

drivers

array of objects

required

Drivers found in this report.

drivers*

object

dob

date

The driver's date of birth. This field is obfuscated to only show the birth year in ISO 8601 full-date format with month and day masked. See rfc 3339 section 5.6: https://www.rfc-editor.org/rfc/rfc3339#section-5.6..

firstName

string

The driver's first name.

string

required

The prefill driver's ID to be used in the Quote API.

isDenylistedDriver

boolean

Indicates whether this driver is on Root's denylist.Drivers on the denylist will not be underwritten by Root and cannot be included on the policy.

isRequestedDriver

boolean

required

Indicates whether this driver matches the parameters provided during the creation of the prefill request. There will be at most 1 prefill driver with this set to true, and the requested driver (if present) will be the first prefill driver in the list.

lastName

string

The driver's last name.

licenseNumber

string

The driver's license number. This field is obfuscated to only show the last 3 characters.

licenseState

string

The driver's license state issuer.

AK AL AR AZ CA CO CT DC DE FL GA HI IA ID IL IN KS KY LA MA MD ME MI MN MO MS MT NC ND NE NH NJ NM NV NY OH OK OR PA RI SC SD TN TX UT VA VT WA WI WV WY

prefillReportIdentifiers

array of objects

The unique identifiers for the associated prefilled report.

prefillReportIdentifiers

object

string

required

The vendor-provided ID from a prefill report.

source

string

required

The vendor that provided this prefill report.

vendorKey

string

required

The vendor-provided key by which to find the ID from a prefill report.

vehicles

array of objects

required

Vehicles found in this report.

vehicles*

object

make

string

The vehicle make.

model

string

The vehicle model.

vin

string

required

The vehicle identification number.

year

integer

The vehicle model year.

204

prefill report not ready

Response body

object

error

string

required

The error message.

Response body

object

message

string

required

The error message.

unauthorized

Response body

object

error

string

required

The error message.

Response body

object

error

string

required

The error message.

errorId

string

required

A unique error id for this error. Contact Root for more detailed information.

Updated about 1 month ago

Create prefill report

Quoting

Did this page help you?

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://app.partner-testing.joinroot.com/bind_api/v3/quoting/quote/quote_id/prefill \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 1 month ago

Create prefill report

Quoting

Did this page help you?

Root Embedded API
Documentation
Get v3 openapi specget
Agency
Get policies for your agencyget
Get quotes for your agencyget
Get agent quotesget
Get agent policiesget
Get agentget
Get agency agentsget
Policy
Get policy documentsget
Get policy summaryget
Get payment informationget
Address
Validate addresspost
Bridge Link
Authenticate bridge linkpost
Create bridge linkpost
Legal Documents
Affirm legal documentspost
Get all legal documentsget
Get legal documentget
Braintree Payments
Get Braintree customerget
Create Braintree client tokenpost
Prefill
Get prefill reportget
Create prefill reportpost
Quoting
Bind policypost
Finalize quotepost
Get suggested coveragesget
Get coverage rules by stateget
Get coverage rulesget
Get available coverages by stateget
Get available coveragesget
(Experimental) Patch quotepatch
Get quoteget
Update quoteput
Create quotepost
YearMakeModel
Get YearMakeModelget

Root Embedded API
Documentation
Get v3 openapi specget
Agency
Get policies for your agencyget
Get quotes for your agencyget
Get agent quotesget
Get agent policiesget
Get agentget
Get agency agentsget
Policy
Get policy documentsget
Get policy summaryget
Get payment informationget
Address
Validate addresspost
Bridge Link
Authenticate bridge linkpost
Create bridge linkpost
Legal Documents
Affirm legal documentspost
Get all legal documentsget
Get legal documentget
Braintree Payments
Get Braintree customerget
Create Braintree client tokenpost
Prefill
Get prefill reportget
Create prefill reportpost
Quoting
Bind policypost
Finalize quotepost
Get suggested coveragesget
Get coverage rules by stateget
Get coverage rulesget
Get available coverages by stateget
Get available coveragesget
(Experimental) Patch quotepatch
Get quoteget
Update quoteput
Create quotepost
YearMakeModel
Get YearMakeModelget

200successful

400invalid prefill report

401unauthorized

404invalid quote ID

500internal server error