Create bridge link

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

Create a bridge link associated with the provided quote. This link will be used to redirect the user to Root's web application to complete the quoting process.

Path Params

quote_id

string

required

Body Params

attributionParameters

object

The attribution parameters for this quote.

experience

string | null

Defaults to default

The experience the bridging user will be directed to.

cancelUrl

string | null

The redirect URL when the user cancels. Consult your Root representative to see if this property applies to your integration.

successUrl

string | null

The redirect URL when the user successfully binds. Consult your Root representative to see if this property applies to your integration.

ttlHours

integer | null

1 to 48

Defaults to 24

Time in hours that the bridge link/token will remain valid after creation. Minimum 1 hour (60 minutes), maximum 48 hours (2880 minutes) inclusively. If a value is not provided or is outside of the acceptable bounds, then a default value of 24 hours will be used.

Responses

Response body

object

quote

object

required

The full description of the quote. This includes profile data used for the quote, coverage selections, payment information, and relevant status fields.

string

required

The unique identifiers for this quote.

agent

object

required

The agent associated with this quote.

finalizable

boolean

Whether or not this quote is ready to be finalized.

profile

object

required

The profile data for this quote. This includes drivers, vehicles, addresses and additional information.

kind

string

required

The kind of quote currently being presented.

none estimated_quote bindable_quote finalized_quote

invoicePeriod

string | null

required

The selected invoice period for an unmodified, finalized quote

monthly full_term

expiresOnOrBefore

date-time | null

The latest this quote will expire. Quotes can expire sooner but this would be the maximum time it would be valid for.

status

string

required

The status of any background actions Root is currently performing in regards to this quote.

collecting_data quoted quoting errored underwriting_declined underwriting_pending

fullTermPayment

object | null

The payment required if the customer pays for the full 6 months today.

monthlyTermPayments

array of objects | null

The payments required if the customer pays for the 6-month policy monthly.

monthlyTermPayments

object

charges

array of objects

required

A breakdown of the component charges, including premium and applicable fees.

charges*

object

name

string

required

The name of the charge.

amountInCents

number

required

The amount this charge entails in USD cents.

description

string

A description of this charge.

isFee

boolean

required

This charge is a fee.

type

string

required

The kind of this charge.

installment_fee late_fee renewal_policy_fee new_vehicle_fee policy_fee premium rewrite_fee reinstatement_fee

totalAmountInCents

number

required

The total amount in USD cents for this payment.

totalAmountInDollars

string

required

The total amount in USD dollars for this payment.

coverages

object

required

The current coverage selections for this quote.

Language

Credentials

Bearer

URL


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://app.partner-testing.joinroot.com/bind_api/v3/quoting/quote/quote_id/bridge_link \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "experience": "default",
8
  "ttlHours": 24
9
}
10
'

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

application/json

201successful

401unauthorized

404invalid quote ID

422not ready to bridge

500internal server error