Skip to main content

Retrieve Policy Details

GET 
/v1/policies/:policy_number

Retrieve details about a policy

Request​

Path Parameters

    policy_number stringrequired

Responses​

Successful response

Schema
    policy_holder object
    first_name string
    middle_name string
    last_name string
    email_address string
    phone_number string
    street string
    city string
    state string
    postal_code string
    country string
    policy_attributes
    policy_number string
    partner object
    id uuid
    legal_business_name string
    dba_name string
    business_structure BusinessStructure

    Possible values: [sole_proprietorship, single_member_llc, multi_member_llc, private_partnership, private_corporation]

    email_address emailrequired
    notification_email_address email
    tax_identifier string
    tax_identifier_verified boolean
    address string
    city string
    state string
    zip_code string
    country Country

    Possible values: [US, CA]

    phone_number string
    website string
    industry string
    refund_policy_url string
    business_name string
    status PartnerStatus

    Possible values: [ACTIVE, PENDING_CONFIGURATION, PENDING_ONBOARDING, INACTIVE]

    partner_parent_id uuid
    theme_mode boolean
    portal_purchase_enabled boolean
    pre_transaction_fee_commission boolean
    url_identifier string
    vertical Vertical

    Possible values: [youth_sports, health_and_wellness, live_events, travel, pets, education, collectibles, events_and_rentals, camps_and_recreation, conferences, generic]

    policy_documents object[]
  • Array [
    • id uuid
    master_policy_id uuid
    policy_id uuid
    document_type DocumentType

    Possible values: [POLICY, CERTIFICATE_OF_INSURANCE, OTHER]

    storage_bucket string
    storage_key string
  • ]
    • policy_status PolicyStatus

    Possible values: [ACTIVE, QUOTED, EXPIRED, PENDING_CANCELLATION, CANCELED, PENDING, REQUIRES_PAYMENT, BIND_FAILED, ENDORSED]

    issued_date date-timenullable
    expiration_date yyyy-mm-ddnullable
    effective_date yyyy-mm-ddnullable
    quote_date date-time
    product object
    id uuid
    name PolicyType

    Possible values: [event-participation-cancellation-insurance, event-host-liability, event-host-cancellation, pet-insurance, shipping, collectibles, medsaver, gap-medical, regsaver, travel, tuition, registration-cancellation, ticket-refund, renters, season-interruption, team-registration, membership-insurance, hunting-lease-liability]

    friendly_name string
    abbreviation string
    description string
    peril_heading string
    perils string[]
    descriptors string[]
    promotional_header string
    promotional_description string
    accept_action_text string
    decline_action_text string
    legal_disclaimer string
    privacy_policy_url string
    terms_conditions_url string
    additional_policy_purchase_email_message string
    endorsement_price_changes int64

    For an endorsement, the change in price. A positive price change indicates that the price has increased and the customer will need to pay the difference. A negative price change indicates that the new policy is cheaper and that a refund is needed.

    subscription_premium object

    If this policy supports being billed as a monthly subscription instead of a one-time fee, this field will be present

    payments_required int64

    The number of monthly payments required for this subscription

    payment_amount int64

    The monthly premium to be paid for this subscription

    currency Currency

    Possible values: [USD, CAD]

    total int64

    Total cost of the policy in cents. This is the amount that should be displayed and charged during checkout if the user accepts the insurance purchase.

    taxes_and_fees object[]
  • Array [
    • order_item_transaction object
    id uuid
    policy object
    premium_amount_to_show int64
    policy_number string
    first_name string
    middle_name string
    last_name string
    email_address string
    phone_number string
    street string
    city string
    postal_code string
    country string

    Possible values: >= 2 characters and <= 2 characters

    state object
    id uuid
    name string
    abbreviation string
    country string
    default_timezone_offset string
    customer object
    email_address emailrequired
    policy_documents object[]
  • Array [
    • id uuid
    master_policy_id uuid
    policy_id uuid
    document_type DocumentType

    Possible values: [POLICY, CERTIFICATE_OF_INSURANCE, OTHER]

    storage_bucket string
    storage_key string
  • ]
    • policy_status PolicyStatus

    Possible values: [ACTIVE, QUOTED, EXPIRED, PENDING_CANCELLATION, CANCELED, PENDING, REQUIRES_PAYMENT, BIND_FAILED, ENDORSED]

    issued_date date-timenullable
    expiration_date date-timenullable
    effective_date date-timenullable
    quote_date date-time
    product object
    id uuid
    name PolicyType

    Possible values: [event-participation-cancellation-insurance, event-host-liability, event-host-cancellation, pet-insurance, shipping, collectibles, medsaver, gap-medical, regsaver, travel, tuition, registration-cancellation, ticket-refund, renters, season-interruption, team-registration, membership-insurance, hunting-lease-liability]

    friendly_name string
    abbreviation string
    description string
    peril_heading string
    perils string[]
    descriptors string[]
    promotional_header string
    promotional_description string
    accept_action_text string
    decline_action_text string
    legal_disclaimer string
    privacy_policy_url string
    terms_conditions_url string
    additional_policy_purchase_email_message string
    policy_attributes
    policy_attributes_old string
    premium_amount int64

    Possible values: >= 50

    endorsement_price_changes int64
    subscription_premium object
    payments_required int64

    The number of monthly payments required for this subscription

    payment_amount int64

    The monthly premium to be paid for this subscription

    currency Currency

    Possible values: [USD, CAD]

    total int64
    taxes_and_fees undefined[]
    version int32
    quote_id string
    is_test boolean
    metadata object
    property name* string
    checkout_url url
    order object
    id uuid
    customer object
    email_address emailrequired
    order_item_transactions undefined[]
    subscription object
    id uuid
    status string
    payment_method string
    payment_provider string
    customer_id uuid
    start_date date
    payments_required int64
    payment_amount int64
    orders undefined[]
    total int64
    sub_total int64
    taxes_and_fees_total int64
    currency Currency

    Possible values: [USD, CAD]

    status OrderStatus

    Possible values: [REQUIRES_PAYMENT, COMPLETED, REFUNDED, PENDING, FAILED, CHARGED_BACK]

    placed_at date-time
    created_at date-time
    updated_at date-time
    is_test boolean
    taxes_and_fees undefined[]
    item_total int64
    taxes_and_fees_amount int64
    item_sub_total int64
    estimated_allocated_transaction_fee int64
    chargeback_fee int64
    ar_accounting_period string
    co_accounting_period string
    transaction_status TransactionStatus

    Possible values: [PENDING, FAILED, COMPLETED]

    transaction_type TransactionType

    Possible values: [REFUND, CHARGE, CHARGEBACK]

    transaction_amount int64
    payment_type PaymentType

    Possible values: [CC, ACH]

    processor PaymentProcessorType

    Possible values: [justifi, card_connect, propay, stripe, sportsengine, teamsnap, insurance_carrier, stackpay, invoice, braintree]

    estimated_processor_transaction_fee int64
    processor_payment_method_id string
    processor_payment_id string
    processor_payout_id string
    processor_payout_date date-time
    created_at date-time
    updated_at date-time
    amount int64
    description string
    type OrderItemTaxFee.Type

    Possible values: [fee, tax]

    included_in_premium boolean
    per_subscription_charge boolean
  • ]
    • version int32
    quote_id string
    is_test boolean
    metadata object
    property name* string
    checkout_url url
Loading...