Get Proposal-Level Line of Business (LOB) Field Metadata

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

Returns field metadata for building dynamic forms to collect insurance proposal (quote) information.

This endpoint is useful for the insurance quoting workflows that need to adapt to:

  • Line of Business (policy line code)
  • State regulations (jurisdiction-specific fields)
  • Carrier requirements (carrier-specific forms)
  • Insurance programs (product-specific configurations)

What is a Proposal?

A Proposal in Origami is an insurance quote or application. It represents:

  • A potential insurance policy being quoted for a client
  • Coverage, premium, and underwriting information before binding
  • LOB-specific (Line of Business) details like Workers Compensation, General Liability, Commercial Auto
  • State/jurisdiction-specific insurance requirements
  • Carrier-specific form fields and validations

Use Case for this Endpoint

When building a quote form, you need to know:

  • Which fields to display for this specific insurance line (Workers Comp fields differ from Auto fields)
  • Which fields are required by this state's regulations
  • Which fields are applicable based on carrier, coverage, and effective date
  • Validation rules, dropdowns, and formulas specific to insurance products

Query Params
string
required

This provides the context (carrier, insurance program, state, effective date) needed to determine which fields are applicable. The proposal must already exist in the database.

string
required

The Line of Business code (e.g., "WC" for Workers Comp, "GL" for General Liability, "CA" for Commercial Auto). This determines which LOB-specific form fields are returned. Different policy lines have different field sets.

string

Comma-separated list of field names to include in the response. If omitted, returns all fields.

boolean
Defaults to false

Exclude fields that are never applicable from the metadata result.

Response

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json