An Offer is an immutable offer for coverage extended to a customer. Offers are generated from draft quotes and provides a PDF quote document. Creating an offer requires no outstanding underwriting alerts on the quote. If alerts are present, the agent must bridge into the Steadily UI (via the `agent_ui_url` from the draft quote response) to resolve them before an offer can be generated.
openapi: 3.1.0
info:
title: Partner Account Quote Offer API
description: '
Get instant insurance quote estimates and manage referrals through our Partner API.
To request an API key contact partnerships-team@steadily.com
'
version: 1.0-cc63f79
x-logo:
url: https://app.staging.steadily.com/static/images/steadily-logo.svg
altText: Steadily
href: /redoc
tags:
- name: Quote Offer
description: '
An Offer is an immutable offer for coverage extended to a customer.
Offers are generated from draft quotes and provides a PDF quote document.
Creating an offer requires no outstanding underwriting alerts on the quote.
If alerts are present, the agent must bridge into the Steadily UI (via the `agent_ui_url` from the draft quote response)
to resolve them before an offer can be generated.
'
paths:
/v1/agency/quote_offer:
post:
tags:
- Quote Offer
summary: Offer Quote
description: Create an Immutable Offer from a Quote. (Lock Quote)
operationId: offer_quote
security:
- HTTPBearer: []
parameters:
- name: aud
in: query
required: false
schema:
type: string
default: steadily:api
title: Aud
- name: quote_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Quote Id
- name: offer_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Offer Id
- name: policy_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Policy Id
requestBody:
required: true
content:
application/json:
schema:
title: Req
allOf:
- $ref: '#/components/schemas/QuoteOfferCreateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/OfferResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v1/agency/quote_offer/{offer_id}:
get:
tags:
- Quote Offer
summary: Get Offer
description: Retrieve an existing Offer.
operationId: get_offer
security:
- HTTPBearer: []
parameters:
- name: offer_id
in: path
required: true
schema:
anyOf:
- type: string
- type: 'null'
title: Offer Id
- name: aud
in: query
required: false
schema:
type: string
default: steadily:api
title: Aud
- name: quote_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Quote Id
- name: policy_id
in: query
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Policy Id
requestBody:
content:
application/json:
schema:
title: Req
anyOf:
- $ref: '#/components/schemas/QuoteOfferCreateRequest'
- $ref: '#/components/schemas/PolicyCreateRequest'
- $ref: '#/components/schemas/QuoteCreateRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/OfferResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
RoofSurfacingLossValuationOptionValueRequest:
properties:
type:
type: string
enum:
- loss_valuation_option
title: Type
value:
$ref: '#/components/schemas/ralphie__models__coverage_models__RoofSurfacingLossValuationOptionValueRequest__ValueOptions'
label:
type: string
title: Label
nullable: true
editable:
type: string
title: Editable
nullable: true
additionalProperties: false
type: object
required:
- type
- value
title: RoofSurfacingLossValuationOptionValueRequest
ExclusionDescriptionValueRequest:
properties:
type:
type: string
enum:
- exclusion_description
title: Type
value:
anyOf:
- $ref: '#/components/schemas/ralphie__models__coverage_models__ExclusionDescriptionValueRequest__ValueOptions'
- type: string
- items:
type: string
type: array
title: Value
nullable: true
label:
type: string
title: Label
nullable: true
editable:
type: string
title: Editable
nullable: true
additionalProperties: false
type: object
required:
- type
title: ExclusionDescriptionValueRequest
LimitedRenovationCoverageRequest:
properties:
name:
type: string
enum:
- limited_renovation
title: Name
config:
items:
$ref: '#/components/schemas/SelectedValueRequest'
type: array
title: Config
additionalProperties: false
type: object
required:
- name
- config
title: LimitedRenovationCoverageRequest
description: 'Coverage request can specify just the list of coverages that need to change.
Anything unspecified is unmodified.
Coverages are de-selected rather than removed.
To de-select an optional coverage, set the "Selected" configuration to "no".'
example:
name: water_damage_limitation
config:
- type: limit
label: Water Damage Limitation
value: 10%
- type: sublimit
label: Water Damage Limitation - Fungi Rot Sublimit
value: '5000'
QuoteUnderwritingRequest:
properties:
answer:
allOf:
- $ref: '#/components/schemas/YesNo'
example: 'no'
nullable: true
type: object
title: QuoteUnderwritingRequest
RenovationStatus:
type: string
enum:
- under_construction
- under_renovation
- not_under_renovation
title: RenovationStatus
description: An enumeration.
BuildingCondition:
type: string
enum:
- excellent
- average
- fair
title: BuildingCondition
description: An enumeration.
FireLightningExplosionSmokeExclusionCoverageRequest:
properties:
name:
type: string
enum:
- fire_lightning_explosion_smoke_exclusion
title: Name
config:
items:
anyOf:
- $ref: '#/components/schemas/SelectedValueRequest'
- $ref: '#/components/schemas/FireLightningExplosionSmokeExclusionValueRequest'
type: array
title: Config
additionalProperties: false
type: object
required:
- name
- config
title: FireLightningExplosionSmokeExclusionCoverageRequest
description: 'Coverage request can specify just the list of coverages that need to change.
Anything unspecified is unmodified.
Coverages are de-selected rather than removed.
To de-select an optional coverage, set the "Selected" configuration to "no".'
example:
name: water_damage_limitation
config:
- type: limit
label: Water Damage Limitation
value: 10%
- type: sublimit
label: Water Damage Limitation - Fungi Rot Sublimit
value: '5000'
DwellingLossValuationOptionValueRequest:
properties:
type:
type: string
enum:
- loss_valuation_option
title: Type
value:
$ref: '#/components/schemas/ralphie__models__coverage_models__DwellingLossValuationOptionValueRequest__ValueOptions'
label:
type: string
title: Label
nullable: true
editable:
type: string
title: Editable
nullable: true
additionalProperties: false
type: object
required:
- type
- value
title: DwellingLossValuationOptionValueRequest
MineSubsidenceDwellingCoverageRequest:
properties:
name:
type: string
enum:
- mine_subsidence_dwelling
title: Name
config:
items:
anyOf:
- $ref: '#/components/schemas/SelectedValueRequest'
- $ref: '#/components/schemas/LimitValueRequest'
- $ref: '#/components/schemas/DeductibleValueRequest'
type: array
title: Config
additionalProperties: false
type: object
required:
- name
- config
title: MineSubsidenceDwellingCoverageRequest
description: 'Coverage request can specify just the list of coverages that need to change.
Anything unspecified is unmodified.
Coverages are de-selected rather than removed.
To de-select an optional coverage, set the "Selected" configuration to "no".'
example:
name: water_damage_limitation
config:
- type: limit
label: Water Damage Limitation
value: 10%
- type: sublimit
label: Water Damage Limitation - Fungi Rot Sublimit
value: '5000'
MineSubsidencePrivateStructuresCoverageRequest:
properties:
name:
type: string
enum:
- mine_subsidence_private_structures
title: Name
config:
items:
anyOf:
- $ref: '#/components/schemas/SelectedValueRequest'
- $ref: '#/components/schemas/LimitValueRequest'
type: array
title: Config
additionalProperties: false
type: object
required:
- name
- config
title: MineSubsidencePrivateStructuresCoverageRequest
description: 'Coverage request can specify just the list of coverages that need to change.
Anything unspecified is unmodified.
Coverages are de-selected rather than removed.
To de-select an optional coverage, set the "Selected" configuration to "no".'
example:
name: water_damage_limitation
config:
- type: limit
label: Water Damage Limitation
value: 10%
- type: sublimit
label: Water Damage Limitation - Fungi Rot Sublimit
value: '5000'
Occupancy:
type: string
enum:
- owner_and_tenant
- rental
- seasonal
- vacant
- fix_and_flip
- landlord_primary_home
title: Occupancy
description: An enumeration.
HeatingSource:
type: string
enum:
- furnace_electric
- furnace_natural_gas
- propane_gas
- oil
- wood_burning_stove_or_fireplace
- other
title: HeatingSource
description: An enumeration.
InsuranceScoreEstimate:
type: integer
enum:
- 999
- 725
- 865
title: InsuranceScoreEstimate
description: An enumeration.
ServiceLineCoverageRequest:
properties:
name:
type: string
enum:
- service_line
title: Name
config:
items:
$ref: '#/components/schemas/SelectedValueRequest'
type: array
title: Config
parent_coverage:
type: string
title: Parent Coverage
additionalProperties: false
type: object
required:
- name
- config
title: ServiceLineCoverageRequest
description: 'Coverage request can specify just the list of coverages that need to change.
Anything unspecified is unmodified.
Coverages are de-selected rather than removed.
To de-select an optional coverage, set the "Selected" configuration to "no".'
example:
name: water_damage_limitation
config:
- type: limit
label: Water Damage Limitation
value: 10%
- type: sublimit
label: Water Damage Limitation - Fungi Rot Sublimit
value: '5000'
PersonalPropertyLossValuationOptionValueRequest:
properties:
type:
type: string
enum:
- loss_valuation_option
title: Type
value:
$ref: '#/components/schemas/ralphie__models__coverage_models__PersonalPropertyLossValuationOptionValueRequest__ValueOptions'
label:
type: string
title: Label
nullable: true
editable:
type: string
title: Editable
nullable: true
additionalProperties: false
type: object
required:
- type
- value
title: PersonalPropertyLossValuationOptionValueRequest
CosmeticDamageCoverageRequest:
properties:
name:
type: string
enum:
- cosmetic_damage
title: Name
config:
items:
anyOf:
- $ref: '#/components/schemas/SelectedValueRequest'
- $ref: '#/components/schemas/CosmeticDamageValueRequest'
type: array
title: Config
additionalProperties: false
type: object
required:
- name
- config
title: CosmeticDamageCoverageRequest
description: 'Coverage request can specify just the list of coverages that need to change.
Anything unspecified is unmodified.
Coverages are de-selected rather than removed.
To de-select an optional coverage, set the "Selected" configuration to "no".'
example:
name: water_damage_limitation
config:
- type: limit
label: Water Damage Limitation
value: 10%
- type: sublimit
label: Water Damage Limitation - Fungi Rot Sublimit
value: '5000'
OfferResponse:
properties:
policy_type:
allOf:
- $ref: '#/components/schemas/PolicyTypeOptions'
example: DP3
insurance_structure:
$ref: '#/components/schemas/InsuranceStructure'
nullable: true
primary_insured:
$ref: '#/components/schemas/Policyholder'
additional_named_insured:
items:
$ref: '#/components/schemas/AdditionalNamedInsured'
type: array
title: Additional Named Insured
nullable: true
effective_date:
type: string
format: date
title: Effective Date
description: Effective date in YYYY-MM-DD format. Defaults to today.
example: '2022-01-15'
effective_date_timezone:
type: string
title: Effective Date Timezone
nullable: true
policy_details:
$ref: '#/components/schemas/PolicyDetails'
title: PolicyDetails
nullable: true
updated_at:
type: string
format: date-time
title: Updated At
nullable: true
previous_policy_id:
type: string
title: Previous Policy Id
nullable: true
renewal_policy_id:
type: string
title: Renewal Policy Id
nullable: true
renewal_quote_id:
type: string
title: Renewal Quote Id
nullable: true
renewal_status:
$ref: '#/components/schemas/RenewalStatus'
nullable: true
renewal_start_date:
type: string
format: date
title: Renewal Start Date
nullable: true
renewal_end_date:
type: string
format: date
title: Renewal End Date
nullable: true
properties:
items:
$ref: '#/components/schemas/PropertyResponse'
type: array
title: Properties
policy_coverages:
items:
$ref: '#/components/schemas/CoverageResponse'
type: array
title: Policy Coverages
payment:
$ref: '#/components/schemas/QuotePaymentResponse'
title: QuotePaymentResponse
nullable: true
underwriting:
$ref: '#/components/schemas/QuoteUnderwritingResponse'
title: QuoteUnderwritingResponse
nullable: true
signing_requirements:
$ref: '#/components/schemas/SigningRequirements'
agent_ui_url:
type: string
title: Agent Ui Url
description: Direct link to Agent UI, which can be used to complete quote.
example: https://app.steadily.com/spa/create-policy/?policy_loc={policy_id}
nullable: true
errors:
items:
$ref: '#/components/schemas/ApiValidationError'
type: array
title: Errors
nullable: true
carrier:
type: string
title: Carrier
public_policy_id:
type: string
title: Public Policy Id
example: OB3-AZ-100034386
nullable: true
pricing:
$ref: '#/components/schemas/QuotePriceResponse'
title: QuotePriceResponse
nullable: true
offer_id:
type: string
title: Offer Id
example: ofr_100034386
public_offer_id:
type: string
title: Public Offer Id
status:
$ref: '#/components/schemas/OfferStatus'
mandatory_agent_agreement_contract:
$ref: '#/components/schemas/ContractResponse'
title: ContractResponse
nullable: true
mandatory_policyholder_agreement_contract:
$ref: '#/components/schemas/ContractResponse'
title: ContractResponse
nullable: true
documents:
items:
$ref: '#/components/schemas/Document'
type: array
title: Documents
type: object
required:
- policy_type
- primary_insured
- properties
- policy_coverages
- carrier
- public_policy_id
- offer_id
- public_offer_id
- status
- documents
title: OfferResponse
description: Base response structure, shared by DraftQuote, QuoteOffer, etc.
CompanyTypes:
properties:
contracting:
allOf:
- $ref: '#/components/schemas/YesNo'
description: Does the entity engage in contracting operations?
example: 'yes'
nullable: true
operations_beyond_rental_property_ownership_and_maintenance:
allOf:
- $ref: '#/components/schemas/YesNo'
description: Does the entity engage in operations beyond rental property ownership and maintenance?
example: 'yes'
nullable: true
type: object
title: CompanyTypes
description: 'Note: these values are intentionally not mutually exclusive. They work like tags with tag values.'
CosmeticDamageValueRequest:
properties:
type:
type: string
enum:
- excluded
title: Type
value:
$ref: '#/components/schemas/YesNo'
label:
type: string
title: Label
nullable: true
editable:
type: string
title: Editable
nullable: true
additionalProperties: false
type: object
required:
- type
- value
title: CosmeticDamageValueRequest
PolicyDetails:
properties:
insurance_score_estimate:
allOf:
- $ref: '#/components/schemas/InsuranceScoreEstimate'
description: 'Estimated Insurance Score: Average(999) or Good(725)'
example: 725
nullable: true
is_paperless:
allOf:
- $ref: '#/components/schemas/YesNo'
example: 'yes'
nullable: true
occupancy:
allOf:
- $ref: '#/components/schemas/Occupancy'
description: Dwelling Occupancy
example: rental
similar_insurance_declined:
allOf:
- $ref: '#/components/schemas/YesNo'
description: Has the applicant had similar insurance declined, cancelled, or non-renewed in the last 5 years?
example: 'no'
nullable: true
self_reported_claims:
items:
$ref: '#/components/schemas/SelfReportedClaims'
type: array
title: Self Reported Claims
nullable: true
unique_tracking_id:
type: string
title: Unique Tracking Id
description: Unique ID to track origin of policy
example: id-12345
nullable: true
wind_coverage_excluded:
allOf:
- $ref: '#/components/schemas/YesNo'
description: If 'yes' this policy does NOT provide wind coverage. Otherwise, wind coverage is included.
example: 'no'
nullable: true
ca_dic:
allOf:
- $ref: '#/components/schemas/YesNo'
description: Whether or not this is a Difference in Condition (DIC) policy.
nullable: true
additionalProperties: false
type: object
required:
- occupancy
title: PolicyDetails
AllOtherPerilsDeductibleCoverageRequest:
properties:
name:
type: string
enum:
- all_other_perils_deductible
title: Name
config:
items:
anyOf:
- $ref: '#/components/schemas/SelectedValueRequest'
- $ref: '#/components/schemas/DeductibleValueRequest'
type: array
title: Config
additionalProperties: false
type: object
required:
- name
- config
title: AllOtherPerilsDeductibleCoverageRequest
description: 'Coverage request can specify just the list of coverages that need to change.
Anything unspecified is unmodified.
Coverages are de-selected rather than removed.
To de-select an optional coverage, set the "Selected" configuration to "no".'
example:
name: water_damage_limitation
config:
- type: limit
label: Water Damage Limitation
value: 10%
- type: sublimit
label: Water Damage Limitation - Fungi Rot Sublimit
value: '5000'
PropertyManager:
properties:
type:
$ref: '#/components/schemas/PropertyManagerType'
is_additional_insured:
allOf:
- $ref: '#/components/schemas/YesNo'
description: Is the property manager an additional insured?
example: 'no'
nullable: true
name:
type: string
title: Name
address:
$ref: '#/components/schemas/ralphie__models__address__Address'
is_active_manager:
allOf:
- $ref: '#/components/schemas/YesNo'
description: 'Does the property manager performs all of the following: Tenant screening checks, at least quarterly inspections, and utilizes risk reduction clauses. Proof of eligibility may be requested. Falsification could result in denial of a claim.'
example: 'no'
nullable: true
additionalProperties: false
type: object
required:
- type
- name
- address
title: PropertyManager
SquattersAndEvictionExpenseLimitDeductibleValueRequest:
properties:
type:
type: string
enum:
- limit_deductible
title: Type
value:
$ref: '#/components/schemas/ralphie__models__coverage_models__SquattersAndEvictionExpenseLimitDeductibleValueRequest__ValueOptions'
label:
type: string
title: Label
nullable: true
editable:
type: string
title: Editable
nullable: true
additionalProperties: false
type: object
required:
- type
- value
title: SquattersAndEvictionExpenseLimitDeductibleValueRequest
GeneralLiabilityCoverageRequest:
properties:
name:
type: string
enum:
- general_liability
title: Name
config:
items:
anyOf:
- $ref: '#/components/schemas/SelectedValueRequest'
- $ref: '#/components/schemas/LimitValueRequest'
type: array
title: Config
additionalProperties: false
type: object
required:
- name
- config
title: GeneralLiabilityCoverageRequest
description: 'Coverage request can specify just the list of coverages that need to change.
Anything unspecified is unmodified.
Coverages are de-selected rather than removed.
To de-select an optional coverage, set the "Selected" configuration to "no".'
example:
name: water_damage_limitation
config:
- type: limit
label: Water Damage Limitation
value: 10%
- type: sublimit
label: Water Damage Limitation - Fungi Rot Sublimit
value: '5000'
LiabilityExclusionAnimalCoverageRequest:
properties:
name:
type: string
enum:
- liability_exclusion_animal
title: Name
config:
items:
$ref: '#/components/schemas/SelectedValueRequest'
type: array
title: Config
additionalProperties: false
type: object
required:
- name
- config
title: LiabilityExclusionAnimalCoverageRequest
description: 'Coverage request can specify just the list of coverages that need to change.
Anything unspecified is unmodified.
Coverages are de-selected rather than removed.
To de-select an optional coverage, set the "Selected" configuration to "no".'
example:
name: water_damage_limitation
config:
- type: limit
label: Water Damage Limitation
value: 10%
- type: sublimit
label: Water Damage Limitation - Fungi Rot Sublimit
value: '5000'
InsuranceStructure:
type: string
enum:
- COI_MASTER_MGA
- STANDARD_MGA
- XMGA
- ARCHIVED
title: InsuranceStructure
description: An enumeration.
LimitValueRequest:
properties:
type:
type: string
enum:
- limit
title: Type
value:
type: string
title: Value
description: Integer value
label:
type: string
title: Label
nullable: true
editable:
type: string
title: Editable
nullable: true
additionalProperties: false
type: object
required:
- type
- value
title: LimitValueRequest
QuotePropertyDetails:
properties:
year_built:
type: integer
exclusiveMinimum: 0.0
title: Year Built
description: Year Originally Built
example: '2007'
nullable: true
stories:
type: number
exclusiveMinimum: 0.0
title: Stories
example: '2'
nullable: true
total_sq_feet:
type: number
exclusiveMinimum: 0.0
title: Total Sq Feet
description: Building Size (Total Square Feet)
example: '1605'
nullable: true
property_type:
allOf:
- $ref: '#/components/schemas/ralphie__models__mapped_models__PropertyType'
example: single_family
nullable: true
confirmed_property_style:
allOf:
- $ref: '#/components/schemas/ConfirmedPropertyStyle'
example: condominium_unit
nullable: true
construction_type:
allOf:
- $ref: '#/components/schemas/ConstructionType'
description: Construction type
example: frame
nullable: true
roof_type:
allOf:
- $ref: '#/components/schemas/RoofType'
description: Roof Type
example: asphalt_shingles
nullable: true
heating_sources:
items:
$ref: '#/components/schemas/HeatingSource'
type: array
description: Heating Sources
example:
- furnace_electric
nullable: true
has_barred_windows_over_50_percent:
type: string
title: Has Barred Windows Over 50 Percent
example: 'Yes'
nullable: true
days_uninsured:
type: integer
title: Days Uninsured
example: 1
nullable: true
central_station:
allOf:
- $ref: '#/components/schemas/YesNo'
description: Does the property have a central station theft or fire alarm monitoring service?
example: 'no'
nullable: true
wrought_iron_bars:
allOf:
- $ref: '#/components/schemas/YesNo'
description: Wrought Iron Bars
nullable: true
rental_duration:
allOf:
- $ref: '#/components/schemas/RentalDurationOptions'
description: How long do you typically rent for?
default: long_term
example: long_term
nullable: true
renovation_status:
allOf:
- $ref: '#/components/schemas/RenovationStatus'
description: Under Renovation or Construction?
example: not_under_renovation
nullable: true
pool_trampoline_hot_tub:
allOf:
- $ref: '#/components/schemas/YesNo'
description: Does this property have a swimming pool, trampoline, or hot tub?
example: 'no'
nullable: true
intermittent_rental:
allOf:
- $ref: '#/components/schemas/YesNo'
description: Intermittent Rental
nullable: true
building_quality:
allOf:
- $ref: '#/components/schemas/BuildingQuality'
example: standard
nullable: true
building_condition:
allOf:
- $ref: '#/components/schemas/BuildingCondition'
example: excellent
nullable: true
internal_data:
type: object
title: Internal Data
description: Extra data about the property used internally by Steadily
nullable: true
builder_name:
type: string
title: Builder Name
description: 'The name of the company that built this property. We currently recognize the following builders:
* adams homes
* american homes 4 rent
* ashton woods homes
* beazer homes
* betenbough homes
* bloomfield homes
* brookfield residential properties
* castlerock communities
* caviness and cates communities
* cbh homes
* century communities
* chesmar homes
* clayton properties group
* d.r. horton
* david weekley homes
* drb group
* dream finders homes
* drees homes
* dsld homes
* eastwood homes
* edge homes
* epcon communities
* first texas homes
* fischer homes
* gehan homes
* gl homes
* great southern homes
* green brick partners
* hayden homes
* highland homes
* historymaker homes
* holiday builders
* hovnanian enterprises
* ivory homes
* kb home
* kolter homes
* landsea homes
* legend homes
* lennar corp.
* lgi homes
* long lake
* m.d.c. holdings
* m/
# --- truncated at 32 KB (151 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/steadily/refs/heads/main/openapi/steadily-quote-offer-api-openapi.yml