Broker Policy Detail

GET

/api/v1/broker/policies/{policy_id}

curl --request GET \
  --url https://example.com/api/v1/broker/policies/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Parameters

Path Parameters

policy_id

required

Policy Id

string format: uuid

Responses

200

Successful Response

Media typeapplication/json

BrokerPolicyDetail

object

id

required

Id

string format: uuid

submission_id

Any of:

string

string format: uuid

null

null

insured_id

Any of:

string

string format: uuid

null

null

insured_name

Any of:

string

string

null

null

dba_name

Any of:

string

string

null

null

policy_number

Any of:

string

string

null

null

binder_number

Any of:

string

string

null

null

status

required

Status

string

status_label

required

Status Label

string

lines

Lines

Array<string>

coverages

Coverages

Array<string>

effective_date

Any of:

string

string format: date

null

null

expiration_date

Any of:

string

string format: date

null

null

bound_at

Any of:

string

string format: date-time

null

null

issued_at

Any of:

string

string format: date-time

null

null

carrier_name

Any of:

string

string

null

null

underwriting_carrier

Any of:

string

string

null

null

naic_code

Any of:

string

string

null

null

admitted

Any of:

boolean

boolean

null

null

insurers

Insurers

Array<object>

BrokerPolicyInsurer

One insurer’s participation on a policy’s quota-share panel.

object

name

Any of:

string

string

null

null

naic_code

Any of:

string

string

null

null

participation_pct

required

Participation Pct

string

is_lead

required

Is Lead

boolean

net_premium

Any of:

string

string

null

null

policy_fee

Any of:

string

string

null

null

broker_fee

Any of:

string

string

null

null

stamping_fee

Any of:

string

string

null

null

surplus_lines_tax

Any of:

string

string

null

null

total_billed

Any of:

string

string

null

null

minimum_earned_premium

Any of:

string

string

null

null

commission_rate

Any of:

string

string

null

null

commission_amount

Any of:

string

string

null

null

payment_plan

Any of:

string

string

null

null

down_payment

Any of:

string

string

null

null

installment_count

Any of:

integer

integer

null

null

installment_amount

Any of:

string

string

null

null

is_bond

Is Bond

boolean

bond_details

Any of:

object

object

key

additional properties

any

null

null

documents

Documents

Array<object>

BrokerPolicyDocument

object

kind

required

Kind

string

label

required

Label

string

download_path

required

Download Path

string

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

Example

{
  "is_bond": false
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}