Partner API access is by invitation during the beta. Bridgeline turns it on for your organization; once it is on, you create your own keys.
Getting a key
You create and revoke keys yourself, in the partner console.- Sign in at portal.bridgelinepf.com/wholesaler/sign-in and open Settings, then API keys.
- Choose Create API key. Give the key a name, pick test or live, and pick its scopes:
quotes:writeto create quotes,quotes:readto read them back. - Copy the key. It is shown once, when you create it, and we store only a hash of it. If you lose it, revoke it and create a new one.
bl_test_) and live keys (bl_live_) are turned on separately, by Bridgeline. A test key prices deals the same way a live key does and keeps its quotes apart from live ones, so it is the place to build. See test and live mode.
If the API keys tab says access isn’t turned on, or a mode can’t be chosen when you create a key, that mode is off for your organization: ask your Bridgeline contact. Bridgeline can also turn access off. When that happens every key of that mode stops working at once, and requests made with one return 403 API_ACCESS_NOT_ENABLED for a live key or 403 TEST_MODE_NOT_ENABLED for a test key. The key is not deleted: it works again if access is turned back on, so revoke any key you no longer trust. Revoking works while access is off.
Check a new key with GET /v1/partner/whoami.
The endpoints
Every partner endpoint starts with/v1/partner/.
A partner key works only on these endpoints, and an agency key works only on the others. Either mismatch returns
403 KEY_TYPE_NOT_ALLOWED.
Create a quote
Send the insured and one or more policies financed together as one loan: the same deal fields an agency sends. There is nobroker_email, and sending it is a 422. The reference page lists every field.
partner_quote: totals, eligibility, assumptions, warnings, binding readiness and every down payment and term we can offer. Eligibility, assumptions and binding readiness mean what they mean on any Bridgeline quote: see eligibility, assumptions and binding readiness. recommended_option_id is the option we’d show first.
A deal we can’t finance is still a 201 with eligibility.status: "ineligible", its reasons and no options.
The price is the agency’s cost
Every partner quote carriesprice_basis: "agency_cost". The apr, monthly_payment, finance_charge and totals on each option are what the agency pays, before the agency adds its own compensation. They are not the price the insured will see.
Show these figures to the agency you’re quoting for, not to the insured as a final offer.
Your pricing settings
A partner quote is priced using the pricing settings on your partner account, which you manage in your Bridgeline console.- The API reads those settings. It never changes them and never returns them.
- A deal we can finance is never priced without them. If they can’t be read, the request is refused with
503 SERVICE_UNAVAILABLEand no quote is stored. Wait forRetry-After, then retry with the sameIdempotency-Key. If it keeps happening, your account’s settings may need attention: contact Bridgeline. - A deal we can’t finance is answered
201witheligibility.status: "ineligible"whether or not the settings can be read, because nothing is priced.
What a partner quote doesn’t have yet
- No link. The response has no link field, and a partner quote has no page to send to anyone. A way to hand a quote on to an agency is planned and is not available yet.
- No broker and no interest. There is no
broker,hosted_url,interestorselected_option_idon a partner quote. - No list. Read a quote back by its id. Store the
id, or setclient_reference_idto your own reference.
status is active until expires_at (30 days after the quote is created), then expired.
Reading a quote back
GET /v1/partner/quotes/{id} returns the quote exactly as it was priced. It is never re-priced.
You can read only the quotes your partner account created, with a key of the same mode. Anything else is a 404: another partner’s quote, an agency’s quote, or a live quote read with a test key.
Test and live
Partner keys come in both modes, and Bridgeline turns each on for your account separately. Abl_test_ key gets real pricing and real rules, and its quotes are kept apart from live ones. See test and live mode.
Limits and retries
- Partner keys have their own rate limits, counted separately from any agency’s.
- Send an
Idempotency-Keyon everyPOST /v1/partner/quotes, so a retry after a timeout can’t create a second quote. See idempotency.