v4

latestOpenAPI 3.1.02026-08-0421336267.5 KB

Policy

Get Policy

Retrieve a Policy.

get/v1/agency/policy/{policy_id}

policy_idstring required

Successful Response

policy_type'DP1' | 'DP2' | 'DP3' required

An enumeration.

insurance_structure'COI_MASTER_MGA' | 'STANDARD_MGA' | 'XMGA' | 'ARCHIVED'

An enumeration.

effective_datestring date

Effective date in YYYY-MM-DD format. Defaults to today.

effective_date_timezonestring nullable

updated_atstring date-time nullable

previous_policy_idstring nullable

renewal_policy_idstring nullable

renewal_quote_idstring nullable

renewal_status'draft' | 'quoted' | 'bound' | 'invalidated'

An enumeration.

renewal_start_datestring date nullable

renewal_end_datestring date nullable

agent_ui_urlstring nullable

Direct link to Agent UI, which can be used to complete quote.

carrierstring required

public_policy_idstring nullable required

status'issued' required

An enumeration.

policy_idstring required