STsteadily
Policy

Get Policy

Changed on

Retrieve a Policy.

get/v1/agency/policy/{policy_id}

Request

  • Base URL
    https://api.steadily.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.steadily.com/v1/agency/policy/{policy_id}
  • Auth
    HTTP bearer

Path parameters

policy_idstring required

Response

Successful Response

policy_type'DP1' | 'DP2' | 'DP3' required
effective_datestring date

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

agent_ui_urlstring nullable

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

carrierstring required
public_policy_idstring nullable required
quote_versioninteger nullable

Version of the quote this response describes. Every saved change creates a new version.

insurance_structure'COI_MASTER_MGA' | 'STANDARD_MGA' | 'XMGA' | 'ARCHIVED'
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'
renewal_start_datestring date nullable
renewal_end_datestring date nullable
status'issued' | 'cancelled' | 'voided' required

Status of a bound policy.

A policy stays issued until its cancellation takes effect, so a cancellation dated in the future leaves it issued until that date. cancelled is a policy whose cancellation has taken effect. voided is a policy treated as if it had never been in force.

policy_idstring required

Changes

  • 7ee9d080d9b0Revision changes
    • warning

      removed the optional property //// from the response with the status

    • info

      added subschema #2 to the //// response property anyOf list for the response status

    • info

      added subschema #2 to the //// response property anyOf list for the response status

  • f5a3b2c6d050Revision changes
    • warning

      removed the optional property //// from the response with the status