Skip to main content

​
Versioning

The API has one version today, 2026-09-23. Versions are dates, and a new one is made only for a change that could break an integration. You can pin a version by sending the Bridgeline-Version header. Every response echoes the version that served it:
Leave the header out and you get the current version. A value that isn’t a real date is refused with 400 INVALID_API_VERSION.

​
What we change without a new version

Additive changes ship to everyone, at any time:
  • new endpoints;
  • new optional request fields;
  • new response fields;
  • new values in an enum, such as a quote status, a coverage type, or an assumption, warning or reason code;
  • new error codes;
  • changes to human-readable message text.
Write your integration to tolerate all of these: ignore unknown fields and fall back safely on unknown values. See conventions.

​
What we never do

  • Rename or repurpose a field, an enum value or an error code. Codes and fields are added, never renamed; enums only grow.
  • Remove a field, or make an optional request field required, within a version.
  • Change the meaning of a value, such as rates from fractions to percentages.
If we ever need a breaking change, it ships in a new dated version, announced here in advance, and your pinned version keeps behaving as before.
The API is in private beta. We may still adjust details based on feedback from the agencies building with us. We’ll announce any such change here first, and we won’t make it silently.

​
Changelog

​
Test mode
​
State codes
insured.address.state must now be a two-letter USPS state code (the 50 states, DC, PR, GU, VI, AS and MP). Any other value is a 422 VALIDATION_FAILED with detail code INVALID_FORMAT; a full state name gets a message naming its code. A valid code outside Texas is still a 201 ineligible quote. See insured state.
​
Documentation
The documentation moves to docs.bridgelinepf.com, with an API reference generated from our OpenAPI spec and a page for every error code.
​
Retries
New error code IDEMPOTENCY_RECORD_LOST. When a request’s response was lost, a retry with the same Idempotency-Key now gets this terminal 500 straight away, instead of 409 IDEMPOTENCY_REQUEST_IN_PROGRESS until the key expired. See idempotency.
​
Quotes and the interactive quote
  • POST /v1/quotes: price one or more policies as one loan, with every option, eligibility, assumptions and binding readiness.
  • GET /v1/quotes/{id} and GET /v1/coverage-types.
  • The interactive quote. Every quote’s hosted_url opens a page where your client compares options and taps I’m interested. GET /v1/quotes/{id} reports the response in interest, and POST /v1/quotes/{id}/hosted-link replaces a link.
  • Rate limits: 60 requests a minute per key, 500 quotes a day per key and 2,000 quotes a day per agency.
​
Foundation
API keys, authentication, scopes, the error format, idempotency and GET /v1/whoami.