> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bridgelinepf.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a partner quote

> Prices one or more policies financed together as one loan and returns every down payment × term option we can offer, at the agency's cost (price_basis "agency_cost"): the price before the agency that takes the quote adds its own compensation. The quote belongs to your partner account; no agency is attached and no link is returned. A deal we cannot finance still returns 201, with eligibility.status "ineligible", its reasons and no options; 422 is only for malformed input. A deal we can finance is never priced without your account's pricing settings: if they cannot be read, the request is refused with 503 and nothing is stored.

For partner API keys. The quote belongs to your partner account, and its prices are the **agency's cost** (`price_basis: "agency_cost"`): what the agency pays before it adds its own compensation. See [partner quotes](https://docs.bridgelinepf.com/guides/partner-quotes.md).

* A deal we can't finance is still a `201`: `eligibility.status` is `ineligible`, `eligibility.reasons` says why, and `options` is empty. A `422` means only that the request was malformed, and it lists every problem at once in `details`.
* The body carries the insured and the policies, the same deal fields an agency sends. There is no `broker_email`: a partner key has no broker to name, so sending it is a `422`.
* No link is returned. A partner quote has no page to send to anyone yet.
* A deal we can finance is never priced without your account's pricing settings. If they can't be read, the request is refused with [`503 SERVICE_UNAVAILABLE`](https://docs.bridgelinepf.com/errors/SERVICE_UNAVAILABLE) and no quote is stored; retry after `Retry-After`. A deal we can't finance is answered `ineligible` either way, since nothing is priced.
* Quotes expire 30 days after they're created. Each call counts toward your [daily quote limits](https://docs.bridgelinepf.com/guides/rate-limits.md#partner-keys).

```bash cURL theme={null}
curl https://portal.bridgelinepf.com/api/v1/partner/quotes \
  -H "Authorization: Bearer $BRIDGELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "client_reference_id": "SUB-2026-0412",
    "metadata": {
      "submission_id": "SUB-10442"
    },
    "insured": {
      "name": "Lone Star Fabrication LLC",
      "fein": "74-0000000",
      "address": {
        "line1": "1200 Industrial Blvd",
        "city": "Houston",
        "state": "TX",
        "postal_code": "77002"
      }
    },
    "policies": [
      {
        "premium": "46100.00",
        "taxes_and_fees": [
          {
            "description": "Surplus lines tax (4.85%)",
            "amount": "2235.85",
            "earned": false
          },
          {
            "description": "Stamping fee (0.075%)",
            "amount": "34.58",
            "earned": false
          },
          {
            "description": "Policy fee",
            "amount": "250.00"
          }
        ],
        "minimum_earned": {
          "rate": 0.25
        },
        "effective_date": "2026-10-15",
        "expiration_date": "2027-10-15",
        "carrier": {
          "name": "Scottsdale Insurance Company",
          "naic_code": "41297"
        },
        "coverages": [
          {
            "type": "general_liability"
          },
          {
            "type": "commercial_property",
            "description": "Commercial Property (Ex-Wind)"
          }
        ],
        "auditable": false,
        "document_type": "binder",
        "policy_number": "CPS7712045",
        "metadata": {
          "submission_policy_id": "POL-889213"
        }
      }
    ]
  }'
```

```javascript Node theme={null}
const res = await fetch('https://portal.bridgelinepf.com/api/v1/partner/quotes', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.BRIDGELINE_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    "client_reference_id": "SUB-2026-0412",
    "metadata": {
      "submission_id": "SUB-10442"
    },
    "insured": {
      "name": "Lone Star Fabrication LLC",
      "fein": "74-0000000",
      "address": {
        "line1": "1200 Industrial Blvd",
        "city": "Houston",
        "state": "TX",
        "postal_code": "77002"
      }
    },
    "policies": [
      {
        "premium": "46100.00",
        "taxes_and_fees": [
          {
            "description": "Surplus lines tax (4.85%)",
            "amount": "2235.85",
            "earned": false
          },
          {
            "description": "Stamping fee (0.075%)",
            "amount": "34.58",
            "earned": false
          },
          {
            "description": "Policy fee",
            "amount": "250.00"
          }
        ],
        "minimum_earned": {
          "rate": 0.25
        },
        "effective_date": "2026-10-15",
        "expiration_date": "2027-10-15",
        "carrier": {
          "name": "Scottsdale Insurance Company",
          "naic_code": "41297"
        },
        "coverages": [
          {
            "type": "general_liability"
          },
          {
            "type": "commercial_property",
            "description": "Commercial Property (Ex-Wind)"
          }
        ],
        "auditable": false,
        "document_type": "binder",
        "policy_number": "CPS7712045",
        "metadata": {
          "submission_policy_id": "POL-889213"
        }
      }
    ]
  }),
})
const quote = await res.json()
```

```python Python theme={null}
import os
import uuid
import requests

res = requests.post(
    "https://portal.bridgelinepf.com/api/v1/partner/quotes",
    headers={
        "Authorization": f"Bearer {os.environ['BRIDGELINE_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "client_reference_id": "SUB-2026-0412",
        "metadata": {
            "submission_id": "SUB-10442"
        },
        "insured": {
            "name": "Lone Star Fabrication LLC",
            "fein": "74-0000000",
            "address": {
                "line1": "1200 Industrial Blvd",
                "city": "Houston",
                "state": "TX",
                "postal_code": "77002"
            }
        },
        "policies": [
            {
                "premium": "46100.00",
                "taxes_and_fees": [
                    {
                        "description": "Surplus lines tax (4.85%)",
                        "amount": "2235.85",
                        "earned": False
                    },
                    {
                        "description": "Stamping fee (0.075%)",
                        "amount": "34.58",
                        "earned": False
                    },
                    {
                        "description": "Policy fee",
                        "amount": "250.00"
                    }
                ],
                "minimum_earned": {
                    "rate": 0.25
                },
                "effective_date": "2026-10-15",
                "expiration_date": "2027-10-15",
                "carrier": {
                    "name": "Scottsdale Insurance Company",
                    "naic_code": "41297"
                },
                "coverages": [
                    {
                        "type": "general_liability"
                    },
                    {
                        "type": "commercial_property",
                        "description": "Commercial Property (Ex-Wind)"
                    }
                ],
                "auditable": False,
                "document_type": "binder",
                "policy_number": "CPS7712045",
                "metadata": {
                    "submission_policy_id": "POL-889213"
                }
            }
        ]
    },
    timeout=60,
)
quote = res.json()
```

```jsonc 201 theme={null}
{
  "id": "qte_3kBdws4Iboz3EfcUQN2z68",
  "object": "partner_quote",
  "livemode": true,
  "status": "active",
  "client_reference_id": "SUB-2026-0412",
  "metadata": {
    "submission_id": "SUB-10442"
  },
  "created_at": "2026-10-12T15:04:05Z",
  "expires_at": "2026-11-11T15:04:05Z",
  "price_basis": "agency_cost",
  "totals": {
    "premium": "46100.00",
    "taxes_and_fees": "2520.43",
    "total": "48620.43",
    "weighted_minimum_earned_rate": 0.25,
    "financing_start_date": "2026-10-15"
  },
  "policies": [
    {
      "id": "pol_2bX9kQ7m",
      "total": "48620.43",
      "minimum_earned": {
        "rate": 0.25
      },
      "carrier": {
        "name": "Scottsdale Insurance Company",
        "am_best": {
          "rating": "A+",
          "source": "am_best"
        }
      },
      "metadata": {
        "submission_policy_id": "POL-889213"
      }
    }
  ],
  "eligibility": {
    "status": "eligible",
    "checks": [
      {
        "code": "INPUT_VALID",
        "passed": true
      },
      {
        "code": "INSURED_STATE",
        "passed": true,
        "limit": "TX",
        "actual": "TX"
      },
      {
        "code": "PREMIUM_MIN",
        "passed": true,
        "limit": "4500.00",
        "actual": "48620.43"
      },
      {
        "code": "PREMIUM_MAX",
        "passed": true,
        "limit": "175000.00",
        "actual": "48620.43"
      },
      {
        "code": "AM_BEST_MIN",
        "passed": true,
        "limit": "A-"
      },
      {
        "code": "ISSUER",
        "passed": true
      },
      {
        "code": "COVERAGE",
        "passed": true
      },
      {
        "code": "POLICY_BACKDATE",
        "passed": true,
        "limit": "30 days"
      },
      {
        "code": "DATE_UNIFORMITY",
        "passed": true
      },
      {
        "code": "POLICY_TERM",
        "passed": true,
        "limit": "3 months",
        "actual": "12 months"
      },
      {
        "code": "MINIMUM_EARNED_MAX",
        "passed": true,
        "limit": "90%",
        "actual": "25.4%"
      }
    ],
    "reasons": []
  },
  "assumptions": [
    {
      "code": "EARNED_ASSUMED",
      "param": "policies[0].taxes_and_fees[2].earned",
      "message": "Not marked; treated as earned (not refunded on cancellation)."
    }
  ],
  "warnings": [],
  "binding_readiness": {
    "ready": true,
    "issues": []
  },
  "recommended_option_id": "opt_25_10",
  "options": [
    {
      "id": "opt_25_10",
      "down_payment_rate": 0.25,
      "term_months": 10,
      "apr": 0.1184,
      "down_payment": "12155.11",
      "amount_financed": "36465.32",
      "monthly_payment": "3847.40",
      "finance_charge": "2008.64",
      "total_of_payments": "38473.96",
      "total_cost": "50629.07"
    }
    // ...29 more options
  ]
}
```

```jsonc 201 ineligible theme={null}
{
  "id": "qte_0ttEraHBIn4mMQxrxzvIa7",
  "object": "partner_quote",
  "livemode": true,
  "status": "active",
  "client_reference_id": "SUB-2026-0412",
  "metadata": {
    "submission_id": "SUB-10442"
  },
  "created_at": "2026-10-12T15:04:05Z",
  "expires_at": "2026-11-11T15:04:05Z",
  "price_basis": "agency_cost",
  "totals": {
    "premium": "46100.00",
    "taxes_and_fees": "2520.43",
    "total": "48620.43",
    "weighted_minimum_earned_rate": 0.25,
    "financing_start_date": "2026-10-15"
  },
  "policies": [
    {
      "id": "pol_7Rt4Lp2x",
      "total": "48620.43",
      "minimum_earned": {
        "rate": 0.25
      },
      "carrier": {
        "name": "Scottsdale Insurance Company",
        "am_best": {
          "rating": "A+",
          "source": "am_best"
        }
      },
      "metadata": {
        "submission_policy_id": "POL-889213"
      }
    }
  ],
  "eligibility": {
    "status": "ineligible",
    "checks": [
      {
        "code": "INPUT_VALID",
        "passed": true
      },
      {
        "code": "INSURED_STATE",
        "passed": false,
        "limit": "TX",
        "actual": "CA"
      },
      {
        "code": "PREMIUM_MIN",
        "passed": true,
        "limit": "4500.00",
        "actual": "48620.43"
      },
      {
        "code": "PREMIUM_MAX",
        "passed": true,
        "limit": "175000.00",
        "actual": "48620.43"
      },
      {
        "code": "AM_BEST_MIN",
        "passed": true,
        "limit": "A-"
      },
      {
        "code": "ISSUER",
        "passed": true
      },
      {
        "code": "COVERAGE",
        "passed": true
      },
      {
        "code": "POLICY_BACKDATE",
        "passed": true,
        "limit": "30 days"
      },
      {
        "code": "DATE_UNIFORMITY",
        "passed": true
      },
      {
        "code": "POLICY_TERM",
        "passed": true,
        "limit": "3 months",
        "actual": "12 months"
      },
      {
        "code": "MINIMUM_EARNED_MAX",
        "passed": true,
        "limit": "90%",
        "actual": "25.4%"
      }
    ],
    "reasons": [
      {
        "code": "INSURED_STATE_NOT_ELIGIBLE",
        "param": "insured.address.state",
        "message": "We finance insureds in TX only; this insured is in CA."
      }
    ]
  },
  "assumptions": [
    {
      "code": "EARNED_ASSUMED",
      "param": "policies[0].taxes_and_fees[2].earned",
      "message": "Not marked; treated as earned (not refunded on cancellation)."
    }
  ],
  "warnings": [],
  "binding_readiness": {
    "ready": true,
    "issues": []
  },
  "recommended_option_id": null,
  "options": []
}
```

```json 422 theme={null}
{
  "error": {
    "type": "invalid_request",
    "code": "VALIDATION_FAILED",
    "message": "Invalid request body: broker_email: \"broker_email\" is not a field here.",
    "param": "broker_email",
    "details": [
      {
        "code": "UNKNOWN_FIELD",
        "param": "broker_email",
        "message": "\"broker_email\" is not a field here."
      }
    ],
    "doc_url": "https://docs.bridgelinepf.com/errors#VALIDATION_FAILED",
    "request_id": "req_8fJ2kQ9xLm4TzW7nB3cY5pDv"
  }
}
```

```json 503 theme={null}
{
  "error": {
    "type": "api_error",
    "code": "SERVICE_UNAVAILABLE",
    "message": "Quoting is temporarily unavailable. Retry shortly.",
    "doc_url": "https://docs.bridgelinepf.com/errors#SERVICE_UNAVAILABLE",
    "request_id": "req_8fJ2kQ9xLm4TzW7nB3cY5pDv"
  }
}
```

The figures in these examples are illustrative.


## OpenAPI

````yaml POST /v1/partner/quotes
openapi: 3.1.0
info:
  title: Bridgeline Public API
  version: '2026-09-23'
  description: >-
    Premium finance quotes and applications for agencies. Authenticate with an
    API key from Agency Portal → API Keys. Scopes: `quotes:read` (Read quotes),
    `quotes:write` (Create quotes), `applications:read` (Read applications),
    `applications:write` (Create and edit applications and policies),
    `agreements:write` (Send and void agreements, attest down payments),
    `loans:read` (Read agreements, loans and payouts), `webhooks:manage` (Manage
    webhook endpoints).
servers:
  - url: https://portal.bridgelinepf.com/api
    description: Production (base URL not final, see D2)
security:
  - bearerAuth: []
paths:
  /v1/partner/quotes:
    post:
      tags:
        - Partners
      summary: Create a partner quote
      description: >-
        Prices one or more policies financed together as one loan and returns
        every down payment × term option we can offer, at the agency's cost
        (price_basis "agency_cost"): the price before the agency that takes the
        quote adds its own compensation. The quote belongs to your partner
        account; no agency is attached and no link is returned. A deal we cannot
        finance still returns 201, with eligibility.status "ineligible", its
        reasons and no options; 422 is only for malformed input. A deal we can
        finance is never priced without your account's pricing settings: if they
        cannot be read, the request is refused with 503 and nothing is stored.
      operationId: createPartnerQuote
      parameters:
        - name: Bridgeline-Version
          in: header
          required: false
          description: >-
            API version (a date). Defaults to 2026-09-23; echoed on every
            response.
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
        - name: Idempotency-Key
          in: header
          required: false
          description: >-
            Retrying with the same key and body within 24h replays the original
            response.
          schema:
            type: string
            minLength: 1
            maxLength: 255
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                insured:
                  type: object
                  properties:
                    name:
                      type: string
                      maxLength: 500
                    dba:
                      anyOf:
                        - type: string
                          maxLength: 500
                        - type: 'null'
                    fein:
                      anyOf:
                        - type: string
                          maxLength: 500
                        - type: 'null'
                    address:
                      type: object
                      properties:
                        line1:
                          anyOf:
                            - type: string
                              maxLength: 500
                            - type: 'null'
                        line2:
                          anyOf:
                            - type: string
                              maxLength: 500
                            - type: 'null'
                        city:
                          anyOf:
                            - type: string
                              maxLength: 500
                            - type: 'null'
                        state:
                          type: string
                          enum:
                            - AL
                            - AK
                            - AZ
                            - AR
                            - CA
                            - CO
                            - CT
                            - DE
                            - FL
                            - GA
                            - HI
                            - ID
                            - IL
                            - IN
                            - IA
                            - KS
                            - KY
                            - LA
                            - ME
                            - MD
                            - MA
                            - MI
                            - MN
                            - MS
                            - MO
                            - MT
                            - NE
                            - NV
                            - NH
                            - NJ
                            - NM
                            - NY
                            - NC
                            - ND
                            - OH
                            - OK
                            - OR
                            - PA
                            - RI
                            - SC
                            - SD
                            - TN
                            - TX
                            - UT
                            - VT
                            - VA
                            - WA
                            - WV
                            - WI
                            - WY
                            - DC
                            - PR
                            - GU
                            - VI
                            - AS
                            - MP
                          description: Two-letter USPS state code (e.g. `TX`)
                          examples:
                            - TX
                        postal_code:
                          anyOf:
                            - type: string
                              maxLength: 500
                            - type: 'null'
                      required:
                        - state
                      additionalProperties: false
                  required:
                    - name
                    - address
                  additionalProperties: false
                policies:
                  minItems: 1
                  type: array
                  items:
                    type: object
                    properties:
                      premium:
                        type: string
                        pattern: ^\d+(\.\d{1,2})?$
                      taxes_and_fees:
                        anyOf:
                          - maxItems: 50
                            type: array
                            items:
                              type: object
                              properties:
                                description:
                                  anyOf:
                                    - type: string
                                      maxLength: 500
                                    - type: 'null'
                                amount:
                                  type: string
                                  pattern: ^\d+(\.\d{1,2})?$
                                earned:
                                  type:
                                    - boolean
                                    - 'null'
                              required:
                                - amount
                              additionalProperties: false
                          - type: 'null'
                      minimum_earned:
                        type: object
                        properties:
                          rate:
                            type:
                              - number
                              - 'null'
                          amount:
                            anyOf:
                              - type: string
                                pattern: ^\d+(\.\d{1,2})?$
                              - type: 'null'
                        additionalProperties: false
                      effective_date:
                        type: string
                        maxLength: 500
                      expiration_date:
                        type: string
                        maxLength: 500
                      carrier:
                        type: object
                        properties:
                          name:
                            type: string
                            maxLength: 500
                          naic_code:
                            anyOf:
                              - type: string
                                maxLength: 500
                              - type: 'null'
                          am_best_id:
                            anyOf:
                              - type: string
                                maxLength: 500
                              - type: 'null'
                        required:
                          - name
                        additionalProperties: false
                      mga:
                        anyOf:
                          - type: object
                            properties:
                              name:
                                anyOf:
                                  - type: string
                                    maxLength: 500
                                  - type: 'null'
                            additionalProperties: false
                          - type: 'null'
                      coverages:
                        minItems: 1
                        maxItems: 20
                        type: array
                        items:
                          type: object
                          properties:
                            type:
                              type: string
                              maxLength: 500
                            description:
                              anyOf:
                                - type: string
                                  maxLength: 500
                                - type: 'null'
                          required:
                            - type
                          additionalProperties: false
                      auditable:
                        type:
                          - boolean
                          - 'null'
                      document_type:
                        anyOf:
                          - type: string
                            enum:
                              - quote
                              - binder
                              - policy
                          - type: 'null'
                      policy_number:
                        anyOf:
                          - type: string
                            maxLength: 500
                          - type: 'null'
                      metadata:
                        anyOf:
                          - type: object
                            propertyNames:
                              type: string
                            additionalProperties:
                              type: string
                              maxLength: 500
                          - type: 'null'
                    required:
                      - premium
                      - minimum_earned
                      - effective_date
                      - expiration_date
                      - carrier
                      - coverages
                    additionalProperties: false
                client_reference_id:
                  anyOf:
                    - type: string
                      minLength: 1
                      maxLength: 255
                    - type: 'null'
                metadata:
                  anyOf:
                    - type: object
                      propertyNames:
                        type: string
                      additionalProperties:
                        type: string
                        maxLength: 500
                    - type: 'null'
              required:
                - insured
                - policies
              additionalProperties: false
      responses:
        '201':
          description: The quote, eligible or not.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: qte_…
                  object:
                    type: string
                    const: partner_quote
                  livemode:
                    type: boolean
                  status:
                    type: string
                    enum:
                      - active
                      - expired
                  client_reference_id:
                    type:
                      - string
                      - 'null'
                  metadata:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties:
                      type: string
                  created_at:
                    type: string
                  expires_at:
                    type: string
                  price_basis:
                    type: string
                    const: agency_cost
                    description: >-
                      What the options' prices are. agency_cost: the price
                      before the agency that takes this quote adds its own
                      compensation.
                  totals:
                    type: object
                    properties:
                      premium:
                        type: string
                        pattern: ^\d+\.\d{2}$
                        description: US dollars, a decimal string with two decimal places.
                      taxes_and_fees:
                        type: string
                        pattern: ^\d+\.\d{2}$
                        description: US dollars, a decimal string with two decimal places.
                      total:
                        type: string
                        pattern: ^\d+\.\d{2}$
                        description: US dollars, a decimal string with two decimal places.
                      weighted_minimum_earned_rate:
                        type: number
                        description: 'A fraction: 0.25 means 25%.'
                      financing_start_date:
                        type:
                          - string
                          - 'null'
                    required:
                      - premium
                      - taxes_and_fees
                      - total
                      - weighted_minimum_earned_rate
                      - financing_start_date
                  policies:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        total:
                          type: string
                          pattern: ^\d+\.\d{2}$
                          description: Premium plus all taxes and fees.
                        minimum_earned:
                          type: object
                          properties:
                            rate:
                              anyOf:
                                - type: number
                                  description: 'A fraction: 0.25 means 25%.'
                                - type: 'null'
                              description: The minimum earned rate we used.
                          required:
                            - rate
                        carrier:
                          type: object
                          properties:
                            name:
                              type:
                                - string
                                - 'null'
                            am_best:
                              type: object
                              properties:
                                rating:
                                  type: string
                                source:
                                  type: string
                                  enum:
                                    - am_best
                                    - broker
                                    - document
                                    - assumed
                              required:
                                - rating
                                - source
                          required:
                            - name
                            - am_best
                        metadata:
                          type: object
                          propertyNames:
                            type: string
                          additionalProperties:
                            type: string
                      required:
                        - id
                        - total
                        - minimum_earned
                        - carrier
                        - metadata
                  eligibility:
                    type: object
                    properties:
                      status:
                        type: string
                        enum:
                          - eligible
                          - ineligible
                      checks:
                        type: array
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                            passed:
                              type: boolean
                            limit:
                              type: string
                            actual:
                              type: string
                            basis:
                              type: string
                              enum:
                                - partially_assumed
                            param:
                              type: string
                          required:
                            - code
                            - passed
                      reasons:
                        type: array
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                            param:
                              type: string
                              description: >-
                                The request path this refers to, e.g.
                                policies[1].auditable.
                            message:
                              type: string
                          required:
                            - code
                            - param
                            - message
                        description: Why the deal is ineligible; empty when eligible.
                    required:
                      - status
                      - checks
                      - reasons
                  assumptions:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        param:
                          type: string
                          description: >-
                            The request path this refers to, e.g.
                            policies[1].auditable.
                        message:
                          type: string
                      required:
                        - code
                        - param
                        - message
                  warnings:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                        param:
                          type: string
                          description: >-
                            The request path this refers to, e.g.
                            policies[1].auditable.
                        message:
                          type: string
                      required:
                        - code
                        - param
                        - message
                  binding_readiness:
                    type: object
                    properties:
                      ready:
                        type: boolean
                      issues:
                        type: array
                        items:
                          type: object
                          properties:
                            code:
                              type: string
                            param:
                              type: string
                              description: >-
                                The request path this refers to, e.g.
                                policies[1].auditable.
                            message:
                              type: string
                          required:
                            - code
                            - param
                            - message
                    required:
                      - ready
                      - issues
                  recommended_option_id:
                    type:
                      - string
                      - 'null'
                  options:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: >-
                            opt_<down payment percent>_<term months>, e.g.
                            opt_25_10.
                        down_payment_rate:
                          type: number
                          description: 'A fraction: 0.25 means 25%.'
                        term_months:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        apr:
                          type: number
                          description: >-
                            The annual percentage rate, as a fraction. This is
                            the agency's cost: the price before the agency adds
                            its own compensation.
                        down_payment:
                          type: string
                          pattern: ^\d+\.\d{2}$
                          description: >-
                            US dollars, a decimal string with two decimal
                            places.
                        amount_financed:
                          type: string
                          pattern: ^\d+\.\d{2}$
                          description: >-
                            US dollars, a decimal string with two decimal
                            places.
                        monthly_payment:
                          type: string
                          pattern: ^\d+\.\d{2}$
                          description: >-
                            US dollars, a decimal string with two decimal
                            places. This is the agency's cost: the price before
                            the agency adds its own compensation.
                        finance_charge:
                          type: string
                          pattern: ^\d+\.\d{2}$
                          description: >-
                            US dollars, a decimal string with two decimal
                            places. This is the agency's cost: the price before
                            the agency adds its own compensation.
                        total_of_payments:
                          type: string
                          pattern: ^\d+\.\d{2}$
                          description: >-
                            US dollars, a decimal string with two decimal
                            places.
                        total_cost:
                          type: string
                          pattern: ^\d+\.\d{2}$
                          description: >-
                            US dollars, a decimal string with two decimal
                            places.
                      required:
                        - id
                        - down_payment_rate
                        - term_months
                        - apr
                        - down_payment
                        - amount_financed
                        - monthly_payment
                        - finance_charge
                        - total_of_payments
                        - total_cost
                required:
                  - id
                  - object
                  - livemode
                  - status
                  - client_reference_id
                  - metadata
                  - created_at
                  - expires_at
                  - price_basis
                  - totals
                  - policies
                  - eligibility
                  - assumptions
                  - warnings
                  - binding_readiness
                  - recommended_option_id
                  - options
                description: >-
                  An indicative quote owned by a partner, priced at the agency's
                  cost: a stored snapshot, not a price lock.
        '400':
          description: Malformed request (bad JSON, version or header).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, invalid, revoked or expired API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            API access not enabled for this partner (API_ACCESS_NOT_ENABLED for
            a live key, TEST_MODE_NOT_ENABLED for a test key), an API key whose
            type cannot call this endpoint (KEY_TYPE_NOT_ALLOWED) or a missing
            scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Idempotency-Key reused with a different request, or still in flight.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited. See Retry-After.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal error. Safe to retry with the same Idempotency-Key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: >-
            Temporarily unable to serve the request (e.g. pricing inputs
            unavailable). Retry later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - doc_url
            - request_id
          properties:
            type:
              type: string
              enum:
                - invalid_request
                - authentication
                - permission
                - not_found
                - conflict
                - rate_limit
                - api_error
            code:
              type: string
              description: >-
                Stable, machine-readable error code. Branch on this, never on
                `message`.
              examples:
                - INVALID_REQUEST
                - INVALID_JSON
                - INVALID_API_VERSION
                - INVALID_PAGINATION
                - IDEMPOTENCY_KEY_REQUIRED
                - IDEMPOTENCY_KEY_INVALID
                - VALIDATION_FAILED
                - INVALID_API_KEY
                - KEY_REVOKED
                - KEY_EXPIRED
                - MISSING_SCOPE
                - BROKER_NOT_ACTIVE
                - DEFAULT_BROKER_INACTIVE
                - ACTING_BROKER_NOT_ALLOWED
                - API_ACCESS_NOT_ENABLED
                - TEST_MODE_NOT_ENABLED
                - TEST_MODE_ONLY
                - KEY_TYPE_NOT_ALLOWED
                - NOT_FOUND
                - METHOD_NOT_ALLOWED
                - IDEMPOTENCY_KEY_REUSED
                - IDEMPOTENCY_REQUEST_IN_PROGRESS
                - QUOTE_EXPIRED
                - QUOTE_ALREADY_INTERESTED
                - RATE_LIMITED
                - INTERNAL
                - IDEMPOTENCY_RECORD_LOST
                - SERVICE_UNAVAILABLE
            message:
              type: string
            param:
              type: string
            details:
              type: array
              items:
                type: object
                required:
                  - code
                  - message
                properties:
                  code:
                    type: string
                  message:
                    type: string
                  param:
                    type: string
            doc_url:
              type: string
              format: uri
            request_id:
              type: string
              pattern: ^req_
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: bl_live_… or bl_test_… API key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.