openapi: 3.0.1 info: title: Vertical Insure contact: url: https://www.verticalinsure.com email: support@verticalinsure.com version: "1.0" servers: - url: https://api.verticalinsure.com security: - basic auth: [] tags: - name: Customer description: Endpoints for various customer operations. - name: Partner description: Endpoints for various partner operations. - name: Policies description: Retrieve information about policies - name: Purchase & Bind Policies description: Purchase and bind policies for insurance products. - name: Quotes description: Request quotes for insurance products. - name: Reports description: Retrieve reporting data for your platform. - name: Events description: Retrieve information about events - name: Products description: Get details and criteria for quoting and issuing policies for insurance products. - name: Webhooks description: Subscribe to events published by the Vertical Insure API - name: Purchase Prerequisites description: Get and confirm prerequisites for purchasing quotes. - name: Construction description: Retrieve and create information about construction - name: DocSign description: Create and retrieve document signing submissions for quotes paths: /v1/auth/customer/secret: post: tags: - Customer summary: Create Customer Client Secret description: Create customer client secret for web component payment method operations. operationId: create-customer-client-secret requestBody: content: application/json: schema: $ref: "#/components/schemas/CustomerTokenRequest" required: true responses: "201": description: create-customer-client-secret 201 response content: application/json: schema: $ref: "#/components/schemas/CustomerTokenResponse" /v1/auth/partner/secret: post: tags: - Partner summary: Create Partner Client Secret description: 'Create partner client secret for embedded component operations ' operationId: create-partner-client-secret responses: "201": description: create-partner-client-secret 201 response content: application/json: schema: $ref: "#/components/schemas/PartnerClientTokenResponse" /v1/construction/fraud-sign: post: tags: - Construction summary: Get or Create Fraud Sign description: "Creates a new fraud signature submission, or gets one if it already\ \ exists for this quote" operationId: create-fraud-sign requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateLegacyDocSignRequest" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CreateLegacyDocSignResponse" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "403": description: Forbidden - insufficient permissions content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "404": description: Quote not found content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" /v1/docsign: post: tags: - DocSign summary: Get or Create Doc Sign description: "Creates a new document signature submission, or gets one if it\ \ already exists for this quote" operationId: create-docsign requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateDocSignRequest" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/CreateLegacyDocSignResponse" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "403": description: Forbidden - insufficient permissions content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "404": description: Quote not found content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" /v1/events: post: tags: - Events summary: Create Event description: Creates a new event operationId: event-create requestBody: content: application/json: schema: $ref: "#/components/schemas/CreateEventRequest" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Event" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "403": description: Forbidden - insufficient permissions to access the event content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "404": description: Event not found content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" /v1/events/{event_id}: get: tags: - Events summary: Get Event description: Get an event operationId: event-get-by-id parameters: - name: event_id in: path required: true schema: type: string format: uuid responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Event" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "403": description: Forbidden - insufficient permissions to access the event content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "404": description: Event not found content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" /v1/events/{event_id}/vendors: get: tags: - Events summary: Retrieve Event Vendors description: Retrieves event vendors for an event operationId: event-get-vendors parameters: - name: page in: query description: Zero based page number schema: minimum: 0 type: integer - name: size in: query description: Number of items per page schema: minimum: 1 type: integer default: 20 - name: event_id in: path required: true schema: type: string format: uuid responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PageResponse_EventVendor_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "403": description: Forbidden - insufficient permissions to access the event content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "404": description: Event not found content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" /v1/events/{event_id}/vendors/batch: get: tags: - Events summary: Retrieve Event Vendors description: Retrieves event vendors for an event operationId: event-get-vendors-by-ids parameters: - name: event_id in: path required: true schema: type: string format: uuid - name: ids in: query description: comma separated list of vendor ids required: true explode: false schema: type: string responses: "200": description: Successful response content: application/json: schema: type: array items: $ref: "#/components/schemas/EventVendor" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "403": description: Forbidden - insufficient permissions to access the event content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "404": description: Event not found content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" /v1/events/{event_id}/vendors/{vendor_id}/status: put: tags: - Events summary: Update Vendor Status description: Updates the status of a vendor for an event operationId: event-update-vendor-status parameters: - name: event_id in: path required: true schema: type: string format: uuid - name: vendor_id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/UpdateVendorStatusRequest" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/EventVendor" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "403": description: Forbidden - insufficient permissions to access the event content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "404": description: Event not found content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" /v1/partners/certificate: post: tags: - Partner summary: Create Partner Certificate description: Create a partner certificate for which you can later create entitlements for operationId: create-partner-certificate requestBody: content: application/json: schema: $ref: "#/components/schemas/CreatePartnerCertificateRequest" required: true responses: "201": description: Created content: application/json: schema: $ref: "#/components/schemas/CreatePartnerCertificateResponse" /v1/partners/onboard: post: tags: - Partner summary: Onboards New Limited Partner description: Onboards a new limited partner operationId: onboard-limited-partner requestBody: content: application/json: schema: $ref: "#/components/schemas/OnboardPartnerRequest" required: true responses: "201": description: onboard-limited-partner 201 response content: application/json: schema: $ref: "#/components/schemas/LimitedPartnerDTO" /v1/policies/{policy_number}: get: tags: - Policies summary: Retrieve Policy Details description: Retrieve details about a policy operationId: get-policy-details parameters: - name: policy_number in: path required: true schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_PolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" security: - basic auth: [] /v1/policies/{policy_number}/cancel: post: tags: - Policies summary: Submit Policy Cancellation Request description: Submit a cancellation request for a policy operationId: submit-policy-cancellation parameters: - name: policy_number in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: cancellation_reason: type: string nullable: true responses: "409": description: Policy was already cancelled. content: application/json: schema: $ref: "#/components/schemas/JsonError" "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/Policy_PolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" security: - basic auth: [] /v1/policies/{policy_number}/document: get: tags: - Policies summary: Retrieve Policy Document description: Retrieves a link to a policy document operationId: policy-get-document parameters: - name: policy_number in: path required: true schema: type: string responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/DocumentResponse" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" security: - basic auth: [] /v1/policies/{policy_number}/endorsement: post: tags: - Policies summary: Create Policy Endorsement description: Create an endorsement for an existing policy operationId: create-policy-endorsement parameters: - name: policy_number in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/EndorsementRequest_PolicyAttributes.PolicyRequestCustomer_" required: true responses: "200": description: Successful response content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_PolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" - $ref: "#/components/schemas/JsonError" "201": description: create-policy-endorsement 201 response content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_PolicyAttributes_" security: - basic auth: [] /v1/prerequisites/{quote_id}: get: tags: - Purchase Prerequisites summary: Get prerequisites for purchasing a quote. operationId: get-prerequisites parameters: - name: quote_id in: path required: true schema: type: string responses: "409": description: Quote was already purchased. content: application/json: schema: oneOf: - $ref: "#/components/schemas/ErrorResponse" "404": description: Quote not found. content: application/json: schema: oneOf: - $ref: "#/components/schemas/JsonError" "200": description: get-prerequisites 200 response content: application/json: schema: type: object security: - basic auth: [] - partner-client-secret: [] post: tags: - Purchase Prerequisites summary: Confirm prerequisites are met for purchasing a quote. This endpoint is idempotent. operationId: confirm-prerequisites parameters: - name: quote_id in: path required: true schema: type: string responses: "200": description: Prerequisites confirmed. content: application/json: schema: $ref: "#/components/schemas/PrerequisiteConfirmationResponse.SuccessResponse" "422": description: Prerequisites missing. content: application/json: schema: $ref: "#/components/schemas/PrerequisiteConfirmationResponse.FailureResponse" "404": description: Quote not found. content: application/json: schema: oneOf: - $ref: "#/components/schemas/JsonError" security: - basic auth: [] - partner-client-secret: [] /v1/products/event-exhibitor-liability/events: get: tags: - Products summary: Get Exhibitor Liability Event operationId: get-product-event-exhibitor-liability-event parameters: - name: x-api-client-id in: header description: Either `x-api-client-id` or `Authorization` header must be provided. schema: type: object - name: event_token in: query required: true explode: false schema: type: string responses: "200": description: Ok content: application/json: schema: $ref: "#/components/schemas/ExhibitorLiabilityEvent" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. /v1/products/event-exhibitor-liability/events/underwrite: post: tags: - Products summary: Create Exhibitor Liability Event operationId: underwrite-product-event-exhibitor-liability-event parameters: - name: x-api-client-id in: header description: Either `x-api-client-id` or `Authorization` header must be provided. schema: type: object requestBody: content: application/json: schema: $ref: "#/components/schemas/ExhibitorLiabilityEvent" required: true responses: "200": description: Ok content: application/json: schema: $ref: "#/components/schemas/UnderwriteExhibitorLiabilityEventResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. /v1/products/event-host-cancellation/add-ons: post: tags: - Products summary: Get Add-ons for location description: List available add-ons available for a given location operationId: product-event-host-cancellation-add-ons parameters: - name: x-api-client-id in: header description: Either `x-api-client-id` or `Authorization` header must be provided. schema: type: object requestBody: content: application/json: schema: $ref: "#/components/schemas/EventHostCancellationLocation" required: true responses: "200": description: Ok content: application/json: schema: $ref: "#/components/schemas/BeazleyAddOnsResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. /v1/products/event-host-cancellation/event-types: get: tags: - Products summary: Get Event Host Cancellation Events description: List available event types applicable for event host cancellation operationId: product-event-host-cancellation-event-types parameters: - name: x-api-client-id in: header description: Either `x-api-client-id` or `Authorization` header must be provided. schema: type: object responses: "200": description: Ok content: application/json: schema: type: array items: type: string "401": description: Either `x-api-client-id` or `Authorization` header must be provided. /v1/products/gap-medical/age-bands: get: tags: - Products summary: Gap Medical Age Bands description: List available age bands for gap medical insurance operationId: product-gap-medical-age-bands parameters: - name: x-api-client-id in: header description: Either `x-api-client-id` or `Authorization` header must be provided. schema: type: object responses: "200": description: Ok content: application/json: schema: type: array items: $ref: "#/components/schemas/GapMedicalAgeBand" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. /v1/products/gap-medical/covered-sport: post: tags: - Products summary: Covered Sports description: "Get the covered sport(s) which corresponds to the given sport\ \ names, if any. This API exists to allow users of the web component to determine\ \ if any activities are insurable before presenting the web component offer." operationId: product-gap-medical-covered-sport parameters: - name: x-api-client-id in: header description: Either `x-api-client-id` or `Authorization` header must be provided. schema: type: object requestBody: content: application/json: schema: $ref: "#/components/schemas/GetCoveredSportRequest" required: true responses: "200": description: Ok content: application/json: schema: type: array items: $ref: "#/components/schemas/GetCoveredSportResponseItem" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. /v1/products/pet-insurance/age: get: tags: - Products summary: Pet Age Ranges description: List available age ranges for pet insurance operationId: product-pet-insurance-ages parameters: - name: x-api-client-id in: header description: Either `x-api-client-id` or `Authorization` header must be provided. schema: type: object responses: "200": description: Ok content: application/json: schema: type: array items: $ref: "#/components/schemas/Age" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. /v1/products/pet-insurance/breeds: get: tags: - Products summary: Pet Breeds description: List available breeds for pet insurance operationId: product-pet-insurance-breeds parameters: - name: x-api-client-id in: header description: Either `x-api-client-id` or `Authorization` header must be provided. schema: type: object responses: "200": description: Ok content: application/json: schema: $ref: "#/components/schemas/BreedResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. /v1/products/stay-to-play/events: post: tags: - Products - Room Block Protection summary: Stay-to-Play Confirm Event description: Confirm event details for a stay-to-play event operationId: product-stay-to-play-events-confirm requestBody: content: application/json: schema: $ref: "#/components/schemas/RoomBlockConfirmationRequest" required: true responses: "200": description: product-stay-to-play-events-confirm 200 response content: application/json: schema: $ref: "#/components/schemas/RoomBlockConfirmationResponse" /v1/products/stay-to-play/events/underwrite: post: tags: - Products - Room Block Protection summary: Stay-to-Play Underwrite Event description: Underwrite a stay-to-play event and retrieve a rate for the event coverage operationId: product-stay-to-play-events-underwrite requestBody: content: application/json: schema: $ref: "#/components/schemas/RoomBlockUnderwritingRequest" required: true responses: "200": description: product-stay-to-play-events-underwrite 200 response content: application/json: schema: $ref: "#/components/schemas/RoomBlockUnderwritingResponse" /v1/products/stay-to-play/events/{eventId}: put: tags: - Products - Room Block Protection summary: Stay-to-Play Event Status description: Update the status for the stay-to-play event operationId: product-stay-to-play-events-status-update parameters: - name: eventId in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/RoomBlockStatusUpdate" required: true responses: "200": description: product-stay-to-play-events-status-update 200 response content: application/json: schema: $ref: "#/components/schemas/RoomBlockStatusUpdate" /v1/products/travel/destination-countries: get: tags: - Products summary: Travel Destination Countries description: List available destination countries applicable for travel insurance operationId: product-travel-destination-countries parameters: - name: x-api-client-id in: header description: Either `x-api-client-id` or `Authorization` header must be provided. schema: type: object responses: "200": description: Ok content: application/json: schema: $ref: "#/components/schemas/NoPagingContentResponse_DestinationCountry_" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. /v1/purchase/builders-risk: post: tags: - Purchase & Bind Policies summary: Purchase Builder's Risk Insurance operationId: purchase-builders-risk requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1_BuildersRiskPolicyAttributes_" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_BuildersRiskPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/event-exhibitor-liability: post: tags: - Purchase & Bind Policies summary: Purchase Event Exhibitor Liability Insurance operationId: purchase-event-exhibitor-liability requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1NoAttrs" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventExhibitorLiabilityPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/event-host-cancellation: post: tags: - Purchase & Bind Policies summary: Purchase Event Host Cancellation Insurance operationId: issue-event-host-cancellation requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1_EventHostCancellationPolicyAttributes_" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventHostCancellationPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/event-host-cancellation-pp: post: tags: - Purchase & Bind Policies summary: Purchase Event Host Cancellation Insurance PP operationId: issue-event-host-cancellation-pp requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1_EventHostCancellationPPPolicyAttributes_" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventHostCancellationPPPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/event-host-liability: post: tags: - Purchase & Bind Policies summary: Purchase Event Host Liability Insurance operationId: issue-event-host-liability requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1_EventHostLiabilityPolicyAttributes_" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventHostLiabilityPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/event-host-liability-rental-coverage: post: tags: - Purchase & Bind Policies summary: Purchase Event Host Liability Insurance w/ Rental Coverage operationId: issue-event-host-liability_1 requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1_EventHostLiabilityRentalCoveragePolicyAttributes_" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventHostLiabilityRentalCoveragePolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/gap-medical: post: tags: - Purchase & Bind Policies summary: Purchase Accident and Injury Insurance operationId: purchase-gap-medical requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1NoAttrs" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_GapMedicalPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/hunting-lease-liability: post: tags: - Purchase & Bind Policies summary: Purchase Hunting Lease Liability Insurance operationId: purchase-hunting-lease-liability requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1NoAttrs" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_HuntingLeaseLiabilityPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/membership-insurance: post: tags: - Purchase & Bind Policies summary: Purchase Membership Insurance operationId: purchase-membership-insurance requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1_MembershipInsurancePolicyAttributes_" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_MembershipInsurancePolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/pet-insurance: post: tags: - Purchase & Bind Policies summary: Purchase Pet Insurance operationId: purchase-pet-insurance requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1_PetInsurancePolicyAttributesV1_" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_PetInsurancePolicyAttributesV1_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/registration-cancellation: post: tags: - Purchase & Bind Policies summary: Purchase Registration Cancellation Insurance operationId: purchase-registration-cancellation requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1_RegistrationCancellationPolicyAttributes_" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_RegistrationCancellationPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/shipping: post: tags: - Purchase & Bind Policies summary: Purchase Shipping Insurance operationId: purchase-shipping requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1_ShippingInsurancePolicyAttributes_" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_ShippingInsurancePolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/team-registration: post: tags: - Purchase & Bind Policies summary: Purchase Team Registration Insurance operationId: purchase-team-registration requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1_TeamRegistrationPolicyAttributes_" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_TeamRegistrationPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/ticket-refund: post: tags: - Purchase & Bind Policies summary: Purchase Ticket Refund Insurance operationId: purchase-ticket-refund requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1_TicketRefundPolicyAttributes_" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_TicketRefundPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/travel: post: tags: - Purchase & Bind Policies summary: Purchase Travel Insurance operationId: purchase-travel requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1_TravelInsurancePolicyAttributes_" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_TravelInsurancePolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/tuition: post: tags: - Purchase & Bind Policies summary: Purchase Tuition Insurance operationId: purchase-tuition requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequestV1_TuitionInsurancePolicyAttributes_" required: true responses: "201": description: New policy issued content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_TuitionInsurancePolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/purchase/{productCode}/batch: post: tags: - Purchase & Bind Policies summary: Batch Purchase description: Purchases multiple quotes. All quotes must be in `QUOTED` state and of the same product. operationId: purchase-batch parameters: - name: productCode in: path required: true schema: $ref: "#/components/schemas/PolicyType" requestBody: content: application/json: schema: $ref: "#/components/schemas/BatchPurchaseRequest_PolicyAttributes_" required: true responses: "200": description: Batch Policies Created content: application/json: schema: type: array items: $ref: "#/components/schemas/PolicyDTO_PolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v1/quote/bonds/probate: post: tags: - Quotes summary: Quote Probate Bonds operationId: quote-bonds-probate requestBody: content: application/json: schema: $ref: "#/components/schemas/BondQuoteRequest" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_ProbateBondPolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_ProbateBondPolicyAttributes_" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/builders-risk: post: tags: - Quotes summary: Quote Builder's Risk Insurance description: This API is not yet implemented. operationId: quote-builders-risk requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_BuildersRiskPolicyAttributes_" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_BuildersRiskPolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_BuildersRiskPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/event-deposit-cancellation: post: tags: - Quotes summary: Quote Event Deposit Cancellation Coverage operationId: quote-event-deposit-cancellation requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_EventDepositCancellationPolicyAttributes_" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventDepositCancellationPolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventDepositCancellationPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/event-exhibitor-liability: post: tags: - Quotes summary: Quote Event Exhibitor Liability Insurance operationId: quote-event-exhibitor-liability requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_EventExhibitorLiabilityPolicyAttributes_" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventExhibitorLiabilityPolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventExhibitorLiabilityPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/event-host-cancellation: post: tags: - Quotes summary: Quote Event Host Cancellation Insurance operationId: quote-event-host-cancellation requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_EventHostCancellationPolicyAttributes_" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventHostCancellationPolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventHostCancellationPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/event-host-cancellation-pp: post: tags: - Quotes summary: Quote Event Host Cancellation Insurance PP operationId: quote-event-host-cancellation-pp requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_EventHostCancellationPPPolicyAttributes_" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventHostCancellationPPPolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventHostCancellationPPPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/event-host-liability: post: tags: - Quotes summary: Quote Event Host Liability Insurance operationId: quote-event-host-liability requestBody: content: application/json: schema: $ref: "#/components/schemas/EventHostLiabilityQuoteRequest" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventHostLiabilityPolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventHostLiabilityPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/event-host-liability-rental-coverage: post: tags: - Quotes summary: Quote Event Host Liability Insurance w/ Rental Coverage operationId: quote-event-host-liability-rental-coverage requestBody: content: application/json: schema: $ref: "#/components/schemas/EventHostLiabilityRentalCoverageQuoteRequest" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventHostLiabilityRentalCoveragePolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_EventHostLiabilityRentalCoveragePolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/gap-medical: post: tags: - Quotes summary: Quote Accident and Injury Insurance operationId: quote-gap-medical requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_GapMedicalPolicyAttributes_" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_GapMedicalPolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_GapMedicalPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/hunting-lease-liability: post: tags: - Quotes summary: Quote Hunting Lease Liability Insurance operationId: quote-hunting-lease-liability requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_HuntingLeaseLiabilityPolicyAttributes_" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_HuntingLeaseLiabilityPolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_HuntingLeaseLiabilityPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/membership-insurance: post: tags: - Quotes summary: Quote Membership Insurance operationId: quote-membership-insurance requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_MembershipInsurancePolicyAttributes_" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_MembershipInsurancePolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_MembershipInsurancePolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/registration-cancellation: post: tags: - Quotes summary: Quote Registration Cancellation Insurance operationId: quote-registration-cancellation parameters: - name: save_quote in: query required: true explode: false schema: type: boolean default: true requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_RegistrationCancellationPolicyAttributes_" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_RegistrationCancellationPolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_RegistrationCancellationPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/shipping: post: tags: - Quotes summary: Quote Shipping Insurance operationId: quote-shipping requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_ShippingInsurancePolicyAttributes_" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_ShippingInsurancePolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_ShippingInsurancePolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/team-registration: post: tags: - Quotes summary: Quote Team Registration Insurance operationId: quote-team-registration requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_TeamRegistrationPolicyAttributes_" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_TeamRegistrationPolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_TeamRegistrationPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/ticket-refund: post: tags: - Quotes summary: Quote Ticket Refund Insurance operationId: quote-ticket-refund requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_TicketRefundPolicyAttributes_" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_TicketRefundPolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_TicketRefundPolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/travel: post: tags: - Quotes summary: Quote Travel Insurance operationId: quote-travel requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_TravelInsurancePolicyAttributes_" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_TravelInsurancePolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_TravelInsurancePolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/tuition: post: tags: - Quotes summary: Quote Tuition Insurance operationId: quote-tuition requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_TuitionInsurancePolicyAttributes_" required: true responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_TuitionInsurancePolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_TuitionInsurancePolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/{productCode}/batch: post: tags: - Quotes summary: Batch Quote description: Creates multiple quotes in a single request. All quotes must be of the same product type. operationId: quote-batch parameters: - name: productCode in: path required: true schema: $ref: "#/components/schemas/PolicyType" - name: save_quotes in: query required: true explode: false schema: type: boolean default: true requestBody: content: application/json: schema: type: array items: type: object required: true responses: "200": description: Batch Quotes Created content: application/json: schema: type: array allOf: - type: object anyOf: - $ref: "#/components/schemas/PolicyDTO_PolicyAttributes_" - $ref: "#/components/schemas/BatchError" oneOf: - $ref: "#/components/schemas/PolicyDTO_PolicyAttributes_" - $ref: "#/components/schemas/BatchError" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/{productCode}/short-link: post: tags: - Quotes summary: Create Short Link for Quote description: Creates a short Link for a quote. operationId: create-quote-short-link parameters: - name: productCode in: path required: true schema: type: string requestBody: content: application/json: schema: type: object additionalProperties: type: object required: true responses: "201": description: Short Link created successfully content: application/json: schema: $ref: "#/components/schemas/QuoteShortLinkResponse" "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/QuoteShortLinkResponse" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/quote/{productCode}/{quoteId}: get: tags: - Quotes summary: Retrieve Existing Quote operationId: get-quote parameters: - name: productCode in: path required: true schema: $ref: "#/components/schemas/PolicyType" - name: quoteId in: path required: true schema: type: string responses: "200": description: Quote updated content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_PolicyAttributes_" "201": description: Quote created content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_PolicyAttributes_" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "422": description: The quote or offer no longer exists but is either a pending or active policy. content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "401": description: Either `x-api-client-id` or `Authorization` header must be provided. security: - basic auth: [] - x-api-client-id: [] /v1/webhooks: get: tags: - Webhooks summary: List registered webhooks operationId: webhook-list responses: "200": description: Ok content: application/json: schema: $ref: "#/components/schemas/Webhook.MinimalWebhookResponse" post: tags: - Webhooks summary: Create webhook operationId: webhook-create requestBody: content: application/json: schema: $ref: "#/components/schemas/WebhookCreateRequest" required: true responses: "201": description: webhook-create 201 response content: application/json: schema: $ref: "#/components/schemas/Webhook" /v1/webhooks/{webhook_id}: get: tags: - Webhooks summary: Fetch webhook details operationId: webhook-get parameters: - name: webhook_id in: path required: true schema: type: string format: uuid responses: "200": description: webhook-get 200 response content: application/json: schema: $ref: "#/components/schemas/Webhook" put: tags: - Webhooks summary: Update webhook operationId: webhook-update parameters: - name: webhook_id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/WebhookUpdateRequest" required: true responses: "200": description: webhook-update 200 response content: application/json: schema: $ref: "#/components/schemas/Webhook" delete: tags: - Webhooks summary: Delete webhook operationId: webhook-delete parameters: - name: webhook_id in: path required: true schema: type: string format: uuid responses: "204": description: webhook-delete 204 response /v2/partners/{partner_id}/domains: get: tags: - Partner summary: List Partner Domains description: Lists domains configured for a partner operationId: list-partner-domains parameters: - name: partner_id in: path required: true schema: type: string format: uuid responses: "200": description: list-partner-domains 200 response content: application/json: schema: type: array items: $ref: "#/components/schemas/PartnerDomain" post: tags: - Partner summary: Add Partner Domain description: Adds a domain for a partner operationId: add-partner-domain parameters: - name: partner_id in: path required: true schema: type: string format: uuid requestBody: content: application/json: schema: $ref: "#/components/schemas/AddPartnerDomainRequest" required: true responses: "201": description: add-partner-domain 201 response content: application/json: schema: $ref: "#/components/schemas/PartnerDomain" /v2/partners/{partner_id}/domains/{domain_id}: delete: tags: - Partner summary: Delete Partner Domain description: Deletes a domain for a partner operationId: delete-partner-domain parameters: - name: partner_id in: path required: true schema: type: string format: uuid - name: domain_id in: path required: true schema: type: string format: uuid responses: "204": description: delete-partner-domain 204 response /v2/purchase: post: tags: - Purchase & Bind Policies summary: Purchase V2 description: Purchases one or more quotes.All quotes must be in `QUOTED` state. operationId: purchase-v2 requestBody: content: application/json: schema: $ref: "#/components/schemas/PurchaseRequest" required: true responses: "200": description: Policies Created content: application/json: schema: type: array items: allOf: - type: object anyOf: - $ref: "#/components/schemas/ApiResponse" - $ref: "#/components/schemas/ApiErrorResponseWithContext" oneOf: - $ref: "#/components/schemas/ApiResponse" - $ref: "#/components/schemas/ApiErrorResponseWithContext" "400": description: "Bad request was sent, most likely from a missing parameter." content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" "402": description: Failed payment content: application/json: schema: $ref: "#/components/schemas/ErrorResponse" security: - basic auth: [] /v2/quote/booking-protection: post: tags: - Quotes summary: Quote Booking Protection description: | Obtains one or more quotes for booking protection. The `booking_partner_id` must belong to a partner that you have already [onboarded](/api/partner/onboard-limited-partner). If you have [created a partner certificate](/api/partner/create-partner-certificate) for the booking partner, attempting to quote with this API will result in a season interruption assurance quote being offered. This quote can be purchased with an invoice. If you do not have a partner certificate, then we will check to see if the booking partner is an onboarded travel retailer. If it is, then we will present several quotes for travel insurance. If the booking partner has no partner certificate, and is not an onboarded travel retailer, no quotes can be offered. operationId: quote-booking-protection requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequestV2_BookingProtectionQuoteAttributes_" required: true responses: "401": description: Either `x-api-client-id` or `Authorization` header must be provided. "200": description: quote-booking-protection 200 response content: application/json: schema: $ref: "#/components/schemas/QuoteResponseV2" security: - basic auth: [] - x-api-client-id: [] /v2/quote/collectibles: post: tags: - Quotes summary: Quote Collectibles Insurance V2 operationId: quote-collectibles-v2 requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_CollectiblesInsurancePolicyAttributesV2_" required: true responses: "401": description: Either `x-api-client-id` or `Authorization` header must be provided. "200": description: quote-collectibles-v2 200 response content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_CollectiblesInsurancePolicyAttributesV2_" security: - basic auth: [] - x-api-client-id: [] /v2/quote/event-cancellation/stay-to-play: post: tags: - Quotes summary: Quote Stay to Play Insurance operationId: quote-stay-to-play requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequest_StayToPlayPolicyAttributes_" required: true responses: "401": description: Either `x-api-client-id` or `Authorization` header must be provided. "200": description: quote-stay-to-play 200 response content: application/json: schema: $ref: "#/components/schemas/PolicyDTO_StayToPlayPolicyAttributes_" security: - basic auth: [] - x-api-client-id: [] /v2/quote/pet: post: tags: - Quotes summary: Quote Pet Protection V2 description: | Obtains one or more quotes for pet protection. operationId: quote-pet-protection requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequestV2_PetInsuranceQuoteAttributes_" required: true responses: "401": description: Either `x-api-client-id` or `Authorization` header must be provided. "200": description: quote-pet-protection 200 response content: application/json: schema: $ref: "#/components/schemas/QuoteResponseV2" security: - basic auth: [] - x-api-client-id: [] /v2/quote/renters: post: tags: - Quotes summary: Quote Renters Insurance operationId: quote-renters requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequestV2_RentersQuoteRequestAttributes_" required: true responses: "401": description: Either `x-api-client-id` or `Authorization` header must be provided. "200": description: quote-renters 200 response content: application/json: schema: $ref: "#/components/schemas/QuoteResponseV2" security: - basic auth: [] - x-api-client-id: [] /v2/quote/travel: post: tags: - Quotes summary: Quote Travel Insurance V2 description: | Obtains one or more quotes for travel insurance. operationId: quote-travel-insurance requestBody: content: application/json: schema: $ref: "#/components/schemas/QuoteRequestV2_TravelInsuranceQuoteAttributes_" required: true responses: "401": description: Either `x-api-client-id` or `Authorization` header must be provided. "200": description: quote-travel-insurance 200 response content: application/json: schema: $ref: "#/components/schemas/QuoteResponseV2" security: - basic auth: [] - x-api-client-id: [] /v2/report/policy: post: tags: - Reports summary: Create Policy Report description: Begin creating a CSV policy report. operationId: create-policy-report parameters: - name: start in: query description: ISO datetime string required: true explode: false schema: type: string format: date-time example: 2023-01-01T00:00:00Z - name: end in: query description: ISO datetime string required: true explode: false schema: type: string format: date-time example: 2023-01-01T00:00:00Z - name: policy_status in: query explode: false schema: type: array nullable: true items: $ref: "#/components/schemas/PolicyStatus" responses: "200": description: create-policy-report 200 response content: application/json: schema: type: object /v2/report/policy/{report_id}: get: tags: - Reports summary: Get Policy Report description: "Check the status of a policy report, get presigned URL" operationId: get-policy-report parameters: - name: report_id in: path required: true schema: type: string responses: "200": description: get-policy-report 200 response content: application/json: schema: type: object /v3/report/marketing-payouts: get: tags: - Reports summary: List Marketing Payout Reports operationId: list-marketing-payout-reports parameters: - name: page in: query description: Zero based page number of the reports to retrieve schema: minimum: 0 type: integer - name: size in: query description: The number of reports to retrieve schema: minimum: 1 type: integer default: 20 responses: "200": description: list-marketing-payout-reports 200 response content: application/json: schema: $ref: "#/components/schemas/PageResponse_MarketingPayoutReportDTO_" /v3/report/marketing-payouts/{report_id}: get: tags: - Reports summary: Get Marketing Payout Report operationId: get-marketing-payout-report parameters: - name: report_id in: path required: true schema: type: string format: uuid responses: "200": description: get-marketing-payout-report 200 response content: application/json: schema: $ref: "#/components/schemas/MarketingPayoutReportDetailsDTO" components: schemas: ACHAccountType: type: string enum: - CHECKING - SAVINGS AbstractQuoteRequest_BuildersRiskPolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/BuildersRiskPolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_CollectiblesInsurancePolicyAttributesV2.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/CollectiblesInsurancePolicyAttributesV2" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_EventDepositCancellationPolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/EventDepositCancellationPolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_EventExhibitorLiabilityPolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/EventExhibitorLiabilityPolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_EventHostCancellationPPPolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/EventHostCancellationPPPolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_EventHostCancellationPolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/EventHostCancellationPolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_EventHostLiabilityPolicyAttributes.EventHostLiabilityCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_EventHostLiabilityCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/EventHostLiabilityPolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_EventHostLiabilityRentalCoveragePolicyAttributes.EventHostLiabilityCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_EventHostLiabilityCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/EventHostLiabilityRentalCoveragePolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_GapMedicalPolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/GapMedicalPolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_HuntingLeaseLiabilityPolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/HuntingLeaseLiabilityPolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_MembershipInsurancePolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/MembershipInsurancePolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_ProbateBondPolicyAttributes.BondCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_BondCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/ProbateBondPolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_RegistrationCancellationPolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/RegistrationCancellationPolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_ShippingInsurancePolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/ShippingInsurancePolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_StayToPlayPolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/StayToPlayPolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_TeamRegistrationPolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/TeamRegistrationPolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_TicketRefundPolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/TicketRefundPolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_TravelInsurancePolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/TravelInsurancePolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractQuoteRequest_TuitionInsurancePolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. nullable: true policy_attributes: $ref: "#/components/schemas/TuitionInsurancePolicyAttributes" quote_id: type: string description: Reference an existing quote. Only required if attempting to update an existing quote. email_quote: type: boolean description: Send an email to the customer with the quote and option to purchase. Not required. default: false language: type: string currency: $ref: "#/components/schemas/Currency" AbstractResource_JsonError_: required: - embedded - links type: object properties: links: $ref: "#/components/schemas/OptionalMultiValues_Link_" embedded: $ref: "#/components/schemas/OptionalMultiValues_Resource_" AddPartnerDomainRequest: required: - domain type: object properties: domain: minLength: 1 type: string description: "Domain name to add for the partner. Supports leftmost-label\ \ wildcards (e.g., *.example.com). Wildcard domains at the TLD level (e.g.,\ \ *.com) are not allowed." example: example.com AdditionalInsured: type: object properties: business_name: type: string street: type: string city: type: string state: type: string postal_code: type: string country: type: string Age: type: object properties: id: type: string name: type: string min: type: integer format: int32 max: type: integer format: int32 ApiErrorResponse: required: - error type: object properties: status: type: string enum: - failure error: $ref: "#/components/schemas/ApiErrorResponse.Body" ApiErrorResponse.Body: type: object properties: message: type: string code: type: string ApiErrorResponseWithContext: required: - error type: object properties: status: type: string enum: - failure error: $ref: "#/components/schemas/ApiErrorResponseWithContext.Body" error_context: $ref: "#/components/schemas/ApiErrorResponseWithContext.ErrorContext" ApiErrorResponseWithContext.Body: type: object properties: message: type: string code: type: string ApiErrorResponseWithContext.ErrorContext: type: object properties: quote_id: type: string description: The ID of the quote that failed ApiResponse: required: - data type: object properties: status: type: string enum: - success data: $ref: "#/components/schemas/PolicyDTO_PolicyAttributes_" BankCertificateHolder: required: - city - email - entity_name - loan_number - postal_code - state - street - suite type: object properties: entity_type: type: string enum: - bank entity_name: type: string street: type: string suite: type: string city: type: string state: type: string postal_code: type: string email: type: string loan_number: type: string BaseRentersPolicyAttributes: required: - additional_questions - coverage_end_date - coverage_start_date - property_address - rental_type type: object properties: rental_type: $ref: "#/components/schemas/RentalType" coverage_start_date: type: string format: date coverage_end_date: type: string description: Must be within 355 to 375 days of the start date format: date property_address: type: object description: The address of the rental property being insured. allOf: - $ref: "#/components/schemas/BaseRentersPolicyAttributes.PropertyAddress" - type: object interested_parties: type: array items: $ref: "#/components/schemas/BaseRentersPolicyAttributes.InterestedParty" additional_questions: type: object description: Underwriting questions used to determine quote eligibility. allOf: - $ref: "#/components/schemas/BaseRentersPolicyAttributes.AdditionalQuestions" - type: object BaseRentersPolicyAttributes.AdditionalQuestions: required: - felony_conviction type: object properties: felony_conviction: type: boolean description: Have you been convicted of a felony? detached_dwelling: type: boolean description: "Is the home a single-family detached dwelling and not a mobile\ \ home, modular home, travel trailer, RV, floating home, or houseboat?" excluded_conditions: type: boolean description: "Confirms the residence has no pool, jacuzzi, lake, pond, other\ \ body of water, or outdoor playground equipment; has working smoke detectors,\ \ CO detectors when gas is used, and a fire extinguisher; and all sleeping\ \ areas have two emergency exits." BaseRentersPolicyAttributes.InterestedParty: required: - name type: object properties: name: type: string email_address: type: string format: email BaseRentersPolicyAttributes.PropertyAddress: required: - city - country - postal_code - state - street - suite_or_unit type: object properties: street: type: string suite_or_unit: type: string city: type: string state: type: string postal_code: type: string country: type: string BasisOfIndemnity: type: string enum: - COSTS_AND_EXPENSES - GROSS_REVENUE BatchError: required: - error type: object properties: error: type: string BatchPurchaseRequest_PolicyAttributes_: required: - payment_method - quotes type: object properties: quotes: minItems: 1 type: array items: $ref: "#/components/schemas/PurchaseRequestPolicy" payment_method: $ref: "#/components/schemas/PaymentMethod" BeazleyAddOnsResponse: required: - add_ons type: object properties: add_ons: type: array items: type: string BondCustomer: required: - taxIdentifier type: object allOf: - $ref: "#/components/schemas/PolicyRequestCustomer" - type: object properties: taxIdentifier: minLength: 1 pattern: "^\\d{9}$" type: string description: "9 digits, no separators." x-pattern-message: must be 9 digits BondQuoteRequest: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_ProbateBondPolicyAttributes.BondCustomer_" - $ref: "#/components/schemas/PolicyRequest_BondCustomer_" BookingProtectionItem: required: - category - insurable_amount type: object properties: insurable_amount: type: integer description: "The insurable amount for this item, in cents" format: int64 insurable_amount_currency: $ref: "#/components/schemas/Currency" category: type: string description: "The 'category' that the itinerary item belongs to. LODGING\ \ will be offered a travel insurance quote if possible. Gap medical sport\ \ types will be offered a gap medical quote if possible. All gap medical\ \ sports other than RUNNING, SKIING and MOUNTAIN_BIKING require participant\ \ birthdays in order to be offered." oneOf: - $ref: "#/components/schemas/GapMedicalSport" - $ref: "#/components/schemas/TravelCategory" event_start_date: type: string format: date event_end_date: type: string format: date country: type: string description: "The abbreviation of the country that the itinerary item takes\ \ place in (ex: US, CA). Required when the category is LODGING." participants: type: array description: The list of participants that will be participating in this activity. Required in order to attempt to offer gap medical accident protection quotes. items: $ref: "#/components/schemas/BookingProtectionQuoteAttributes.BookingProtectionParticipant" BookingProtectionQuoteAttributes: type: object properties: items: type: array items: $ref: "#/components/schemas/BookingProtectionItem" event_country: type: string description: Please use 'country' in the items list instead deprecated: true participants: type: array description: "Unused, please use 'participants' in the items list instead" deprecated: true items: $ref: "#/components/schemas/BookingProtectionQuoteAttributes.BookingProtectionParticipant" organization: nullable: true allOf: - $ref: "#/components/schemas/OrganizationWithPaymentPlan" BookingProtectionQuoteAttributes.BookingProtectionParticipant: required: - country - first_name - last_name - state - street type: object properties: first_name: type: string last_name: type: string birth_date: type: string description: "Required to offer gap medical quotes for this participant,\ \ except in the case of RUNNING, SKIING and MOUNTAIN_BIKING itinerary\ \ items." format: date street: type: string state: type: string country: type: string Breed: required: - id - name type: object properties: id: type: string name: type: string BreedResponse: type: object properties: cat: type: array items: $ref: "#/components/schemas/Breed" dog: type: array items: $ref: "#/components/schemas/Breed" BuildersRiskCertificateHolder: type: object discriminator: propertyName: entity_type mapping: home-owner: "#/components/schemas/HomeOwnerCertificateHolder" bank: "#/components/schemas/BankCertificateHolder" oneOf: - $ref: "#/components/schemas/BankCertificateHolder" - $ref: "#/components/schemas/HomeOwnerCertificateHolder" BuildersRiskPolicyAttributes: required: - builder - loss_history - project_details - property - years_building type: object properties: property: $ref: "#/components/schemas/BuildersRiskPolicyAttributes.PropertyDetails" project_details: $ref: "#/components/schemas/BuildersRiskPolicyAttributes.ProjectDetails" builder: $ref: "#/components/schemas/BuildersRiskPolicyAttributes.BuilderInformation" additional_certificate_holders: maxItems: 10 type: array items: $ref: "#/components/schemas/BuildersRiskCertificateHolder" years_building: type: integer description: The number of years this builder has been building format: int32 loss_history: type: boolean description: Has this builder suffered a loss in the last three years? insured_type: type: object description: Is the applicant a builder or a contractor? allOf: - $ref: "#/components/schemas/InsuredType" - type: object BuildersRiskPolicyAttributes.BuilderInformation: required: - city - email_address - fein - name - phone_number - postal_code - state - street type: object properties: name: type: string street: type: string description: Street address example: 123 Example St suite_or_unit: type: string nullable: true city: type: string state: type: string example: MN postal_code: type: string phone_number: type: string email_address: type: string fein: pattern: "^\\d{2}-\\d{7}$" type: string description: Federal Employer Identification Number x-pattern-message: must match format 00-0000000 BuildersRiskPolicyAttributes.ProjectDetails: required: - end_date - intended_occupancy - start_date - type type: object properties: construction_cost: minimum: 1 type: integer description: "Cost of construction, in cents" format: int64 example: 100000000 type: $ref: "#/components/schemas/ConstructionType" category: $ref: "#/components/schemas/ProjectCategory" intended_occupancy: type: object description: Intended occupancy of the building being constructed or renovated. Defaults to RESIDENTIAL_SINGLE_FAMILY when omitted. allOf: - $ref: "#/components/schemas/IntendedOccupancy" - type: object project_scope: type: object description: Scope of renovation work. Required when project category is RENOVATION. nullable: true allOf: - $ref: "#/components/schemas/ProjectScope" - type: object start_date: type: string format: date end_date: type: string format: date BuildersRiskPolicyAttributes.PropertyDetails: type: object properties: street: type: string nullable: true suite_or_unit: type: string nullable: true city: type: string nullable: true state: type: string nullable: true postal_code: type: string nullable: true county: type: string nullable: true country: $ref: "#/components/schemas/Country" longitude: type: number format: double nullable: true latitude: type: number format: double nullable: true CollectiblesInsurancePolicyAttributes: type: object CollectiblesInsurancePolicyAttributesV2: required: - insurable_amount type: object allOf: - $ref: "#/components/schemas/CollectiblesInsurancePolicyAttributes" - type: object properties: insurable_amount: type: integer format: int64 storage_location: type: object description: "Storage location of the collectible item(s), required if\ \ the item(s) are not stored in the insured's home" allOf: - $ref: "#/components/schemas/CollectiblesInsurancePolicyAttributesV2.StorageLocation" - type: object CollectiblesInsurancePolicyAttributesV2.StorageLocation: required: - city - postal_code - state - street type: object properties: street: minLength: 1 type: string city: minLength: 1 type: string state: minLength: 1 type: string description: "State as a 2-letter code or full name, example \"MI\", for\ \ Michigan" example: MI postal_code: minLength: 1 type: string country: maxLength: 2 minLength: 2 type: string description: 2-character country code default: US enum: - US CommonOrganization: required: - org_contact_email - org_name type: object properties: org_name: type: string org_contact_first_name: type: string nullable: true org_contact_last_name: type: string nullable: true org_contact_email: type: string ConstructionType: type: string enum: - FRAME - MASONRY - NON_COMBUSTIBLE - MASONRY_NON_COMBUSTIBLE - FIRE_RESISTIVE Country: type: string enum: - US - CA - AU CoverOption: type: string enum: - STANDARD - OROEC CoverageType: type: string enum: - INJURY_ONLY - INJURY_AND_ILLNESS CreateDocSignRequest: required: - email - insured_name - quote_id type: object properties: email: minLength: 1 type: string format: email insured_name: minLength: 1 type: string quote_id: minLength: 1 type: string description: Request to create a new doc sign slug CreateEventRequest: required: - event_city - event_country - event_end_date - event_name - event_postal_code - event_start_date - event_state - event_street type: object properties: event_name: type: string description: Name of the event event_start_date: type: string description: Start date of the event format: date event_end_date: type: string description: End date of the event format: date event_street: type: string description: Street address of the event event_city: type: string description: City of the event event_state: type: string description: State of the event event_postal_code: type: string description: Postal code of the event event_country: type: string description: Country of the event metadata: type: object additionalProperties: type: object description: Additional metadata for the event attributes: $ref: "#/components/schemas/EventAttributes" description: Request to create a new event CreateLegacyDocSignRequest: required: - email - insured_name - policy_number type: object properties: email: type: string insured_name: type: string policy_number: type: string description: Request to create a new slug CreateLegacyDocSignResponse: required: - slug - status - submission_id type: object properties: slug: type: string submission_id: type: string status: type: string CreatePartnerCertificateRequest: type: object properties: partner_id: type: string description: Partner ID (UUID or mapped external identifier) certificate_type: type: string enum: - refund-protection - accident-coverage - shipping - shipping-unicorn - stay-to-play - collectibles CreatePartnerCertificateResponse: type: object properties: id: type: string format: uuid policy_number: type: string Currency: type: string enum: - USD - CAD - AUD - NZD - GBP - EUR - CHF - JPY Customer: required: - email_address type: object properties: email_address: type: string format: email created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time CustomerTokenRequest: required: - email_address type: object properties: email_address: type: string format: email CustomerTokenResponse: type: object allOf: - $ref: "#/components/schemas/TokenResponse" - type: object properties: customerId: type: string format: uuid customerEmail: type: string Decision: type: object properties: options: type: array items: allOf: - type: object anyOf: - $ref: "#/components/schemas/ApiResponse" - $ref: "#/components/schemas/ApiErrorResponse" oneOf: - $ref: "#/components/schemas/ApiResponse" - $ref: "#/components/schemas/ApiErrorResponse" DestinationCountry: type: object properties: code: type: string name: type: string disabled: type: boolean DocumentResponse: required: - url type: object properties: url: type: string DocumentType: type: string enum: - POLICY - CERTIFICATE_OF_INSURANCE - OTHER - QUOTE_PACK EndorsementRequest_PolicyAttributes.PolicyRequestCustomer_: required: - policy_attributes type: object properties: partner_id: type: string description: This field overrides the partner associated with the policy. This is not required as we typically retrieve the partner information off of the provided credentials. policy_attributes: allOf: - $ref: "#/components/schemas/PolicyAttributes" oneOf: - $ref: "#/components/schemas/RegistrationCancellationPolicyAttributes" - $ref: "#/components/schemas/GapMedicalPolicyAttributes" - $ref: "#/components/schemas/EventHostLiabilityPolicyAttributes" - $ref: "#/components/schemas/EventHostLiabilityRentalCoveragePolicyAttributes" - $ref: "#/components/schemas/TravelInsurancePolicyAttributes" allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" ErrorResponse: required: - message - status type: object properties: error: type: string error_code: type: string message: type: string reason: type: string status: type: integer format: int32 Event: required: - event_city - event_country - event_end_date - event_name - event_postal_code - event_start_date - event_state - event_street - insurance_required type: object properties: id: type: string format: uuid event_name: type: string event_start_date: type: string format: date event_end_date: type: string format: date event_street: type: string event_city: type: string event_state: type: string event_postal_code: type: string event_country: type: string metadata: type: object additionalProperties: type: object insurance_required: type: boolean readOnly: true insurance_requirements_type: type: object nullable: true readOnly: true allOf: - $ref: "#/components/schemas/InsuranceRequirementsType" - type: object purpose: type: object nullable: true readOnly: true allOf: - $ref: "#/components/schemas/EventPurpose_1" - type: object additional_insured: type: array nullable: true readOnly: true items: $ref: "#/components/schemas/AdditionalInsured" attributes: $ref: "#/components/schemas/EventAttributes" EventAttributes: type: object properties: room_block_protection: $ref: "#/components/schemas/RoomBlockProtectionAttributes" EventDepositCancellationPolicyAttributes: required: - additional_questions - event_start_date - event_type - venue type: object properties: event_start_date: type: string description: The date the event starts format: date event_type: type: object description: The type of event allOf: - $ref: "#/components/schemas/EventDepositEventType" - type: object venue: type: object description: The venue where the event takes place allOf: - $ref: "#/components/schemas/EventDepositCancellationPolicyAttributes.Venue" - type: object additional_questions: $ref: "#/components/schemas/EventDepositCancellationPolicyAttributes.AdditionalQuestions" EventDepositCancellationPolicyAttributes.AdditionalQuestions: required: - event_arrangements - known_loss_circumstances type: object properties: known_loss_circumstances: type: boolean description: Are there any known circumstances that could result in a loss? event_arrangements: type: boolean description: Have all event arrangements been made and confirmed at least 14 days prior to the event? EventDepositCancellationPolicyAttributes.Venue: required: - city - name - state - street - zip type: object properties: name: minLength: 1 type: string street: minLength: 1 type: string city: minLength: 1 type: string state: minLength: 1 type: string zip: minLength: 1 type: string EventDepositEventType: type: string enum: - APPAREL_TRADESHOW - BRIDAL_TRADESHOW - BUSINESS_CONFERENCE - BUSINESS_MEETING - ANNUAL_MEETING - CONSUMER_SHOW - INDOOR_CONVENTION - INDOOR_CRAFT_SHOW - FLOWER_SHOW - TRAVEL_TRADESHOW - WEDDING_RECEPTION - WEDDING_CEREMONY - WEDDING_DINNER - WEDDING_BRUNCH - TRADESHOW - FUNERAL_SERVICE EventExhibitorLiabilityAdditionalInsured: required: - address - city - name - postal_code - state type: object properties: name: minLength: 1 type: string address: minLength: 1 type: string city: minLength: 1 type: string state: minLength: 1 type: string description: "state (e.g. \"MI\", for Michigan)" example: MN postal_code: minLength: 1 type: string EventExhibitorLiabilityEventInfo: required: - address - city - name - postal_code - state type: object properties: name: minLength: 1 type: string address: minLength: 1 type: string city: minLength: 1 type: string state: minLength: 1 type: string description: "state (e.g. \"MI\", for Michigan)" example: MN postal_code: minLength: 1 type: string event_url: type: string event_contact_email: type: string EventExhibitorLiabilityHostQuestions: required: - no_excluded_event_features type: object properties: no_excluded_event_features: type: boolean description: |- **The event does not include any of the following products or operations?** * Events related to or involving firearms, ammunition, knives or weapons of any kind (novelty items not intended for combat are permitted), Cannabis/CBD/Hemp, open/uncontrolled flames or fire pits (grills for food vendors are permitted). * Primarily focused on a large concert or musical act (i.e. >5,000 people in direct audience attendance daily). * Automobiles, motorcycles, or similar motor vehicles being operated within the event space during the event (golf cart shuttles operated by event staff are permitted). * Adult-Themed or Adult Content Events/Shows. * Events or shows primarily focused on Alcohol. * Events or shows primarily focused on Tobacco, Vape, Drugs, or Similar Products. * Christmas Tree Lot or Pumpkin Patches. * Guests on premises after 12 AM. Additional underwriting required. * Birthday Parties. * Political Rallies, Demonstrations, Events, Marches, or involvement of high-profile political attendees. * Narcotic-Related Events or Sales/Distribution of Narcotics. * Medically Focused Events Featuring Medical Procedures, Medical Equipment, Pharmaceuticals, or Medically-Invasive Products. * Held at a private residence (e.g. someone's house, backyard, etc.). purpose: type: object description: Which description best describes your event? allOf: - $ref: "#/components/schemas/EventPurpose" - type: object EventExhibitorLiabilityPolicyAttributes: required: - business - food_questions type: object properties: event_start_date: type: string format: date event_end_date: type: string format: date business: type: object description: Business information allOf: - $ref: "#/components/schemas/EventExhibitorLiabilityPolicyAttributes.Business" - type: object event: type: object description: Event information allOf: - $ref: "#/components/schemas/EventExhibitorLiabilityEventInfo" - type: object additional_insureds: type: array description: Additional Insureds items: $ref: "#/components/schemas/EventExhibitorLiabilityAdditionalInsured" additional_questions: type: object description: Additional Questions allOf: - $ref: "#/components/schemas/EventExhibitorLiabilityPolicyAttributes.AdditionalQuestions" - type: object food_questions: type: object description: Food Questions allOf: - $ref: "#/components/schemas/EventExhibitorLiabilityPolicyAttributes.FoodQuestions" - type: object event_host_questions: type: object description: Event Organizer Questions allOf: - $ref: "#/components/schemas/EventExhibitorLiabilityHostQuestions" - type: object primary_non_contributory_coverage: type: boolean description: Primary/Non-Contributory Coverage EventExhibitorLiabilityPolicyAttributes.AdditionalQuestions: type: object properties: recent_claims: type: boolean description: I have experienced a loss or claim within the last 5 years or am aware of any incident(s) that may result in a claim. performing_artist: type: boolean description: I am a DJ or musician who performs live for an audience. excluded_features: type: boolean description: "My operations at the event will include inflatables, bounce\ \ houses, fireworks, pyrotechnics, weapons, live animals, parade floats,\ \ participation in a parade or open flames." performing_construction: type: boolean description: "I am performing any construction or installation services\ \ on behalf of the event host or other vendors (e.g. art installation,\ \ audio/visual equipment, hanging signage, etc)." after_twelve_am: type: boolean description: I will be offering products or services after midnight. EventExhibitorLiabilityPolicyAttributes.Business: required: - address - city - name - postal_code - state type: object properties: name: minLength: 1 type: string address: minLength: 1 type: string city: minLength: 1 type: string state: minLength: 1 type: string description: "State as a 2-letter code or full name, example \"MI\", for\ \ Michigan" example: MI postal_code: minLength: 1 type: string country: maxLength: 2 minLength: 2 type: string description: 2-character country code default: US enum: - US EventExhibitorLiabilityPolicyAttributes.FoodQuestions: required: - does_need_liquor_liability - is_food_vendor type: object properties: is_food_vendor: type: boolean description: I am preparing food onsite for the purpose of selling at the event. does_need_liquor_liability: type: boolean description: I am selling alcohol at the event and need liquor liability coverage. EventHostCancellationLocation: required: - country type: object properties: state: type: string description: "State as a 2-letter code or full name, example \"MI\", for\ \ Michigan" nullable: true example: MI country: type: string description: 2-character country code example: US default: US EventHostCancellationOtherTypes: type: string enum: - APPAREL_TRADESHOW - BRIDAL_TRADESHOW - BUSINESS_CONFERENCE - BUSINESS_MEETING - CONSUMER_SHOW - CONVENTION_INDOORS - CRAFT_SHOWS_INDOORS - FLOWER_GARDEN_SHOW - TRAVEL_TRADESHOW - COMPUTER_TRADESHOW - SPORTS_MEMORABILIA_TRADESHOW - TRADESHOW EventHostCancellationPPPolicyAttributes: required: - additional_questions - events type: object allOf: - $ref: "#/components/schemas/EventHostPolicyAttributes" - type: object properties: number_of_events: minimum: 1 type: integer format: int32 events: type: array description: "Provide all events happening within the overall event. For\ \ example, if the overall event is a wedding, you may have a ceremony,\ \ and a reception." items: $ref: "#/components/schemas/EventHostCancellationPPPolicyAttributes.CancellationEventInfo" total_event_expense_budget: type: integer description: "The total expense budget for the event, in dollars." format: int64 additional_questions: type: object description: Additional Questions allOf: - $ref: "#/components/schemas/EventHostCancellationPPPolicyAttributes.AdditionalQuestions" - type: object EventHostCancellationPPPolicyAttributes.AdditionalQuestions: required: - event_arrangements - event_certification - event_exclusion - event_exposure - event_indoors - limit_confirmation type: object properties: event_indoors: type: boolean description: Is your event located indoors? event_arrangements: type: boolean description: Will all necessary arrangements be made at least 14 days prior to the event start date? event_exposure: type: boolean description: Are there any known circumstances that could lead to a loss? limit_confirmation: type: boolean description: "Does the selected limit accurately encompass all of your costs,\ \ as closely as possible?" event_exclusion: type: boolean description: I understand the COVID exclusion. event_certification: type: boolean description: I confirm all information provided is true and accurate. EventHostCancellationPPPolicyAttributes.CancellationEventInfo: required: - event_type - max_daily_attendees type: object allOf: - $ref: "#/components/schemas/EventInfo" - type: object properties: event_type: type: string allOf: - type: string anyOf: - $ref: "#/components/schemas/EventHostCancellationOtherTypes" - $ref: "#/components/schemas/EventHostCancellationWeddingTypes" oneOf: - $ref: "#/components/schemas/EventHostCancellationOtherTypes" - $ref: "#/components/schemas/EventHostCancellationWeddingTypes" max_daily_attendees: minimum: 1 type: integer format: int32 EventHostCancellationPolicyAttributes: required: - additional_questions - events type: object properties: events: maxItems: 1 minItems: 1 type: array description: A list containing the event to cover items: $ref: "#/components/schemas/EventHostCancellationPolicyAttributes.Event" additional_questions: $ref: "#/components/schemas/EventHostCancellationPolicyAttributes.AdditionalQuestions" EventHostCancellationPolicyAttributes.AddOns: required: - earthquake - full_terrorism - tria - windstorm - winter_weather type: object properties: winter_weather: type: boolean description: Is winter weather cover required? windstorm: type: boolean description: Is windstorm cover required? earthquake: type: boolean description: Is earthquake cover required? tria: type: boolean description: Is TRIA cover required? full_terrorism: type: boolean description: Is full terrorism cover required? EventHostCancellationPolicyAttributes.AdditionalQuestions: required: - cancellation_contract_confirmed_in_writing - cancellation_declaration - cancellation_loss_in_last_5_years - cancellation_material_facts type: object properties: cancellation_contract_confirmed_in_writing: type: boolean description: Will all contractual arrangements necessary for the successful fulfilment of each Event be made and confirmed in writing in a prudent timely manner prior to the start of the Event? cancellation_contract_confirmed_in_writing_details: type: string description: "Detailed regarding cancellation_contract_confirmed_in_writing,\ \ if false" cancellation_loss_in_last_5_years: type: boolean description: Has any Event to be insured had any incidents that could have resulted or did result in a loss which would have been covered under this Insurance during the past 5 years? cancellation_loss_in_last_5_years_details: type: string description: "Detailed regarding cancellation_loss_in_last_5_years, if false" cancellation_material_facts: type: boolean description: "Is the Insured aware of any matter, fact, circumstance or\ \ incident existing or threatened that could possibly affect any Event\ \ and might result in a claim under the proposed Insurance" cancellation_material_facts_details: type: string description: "Detailed regarding cancellation_material_facts_details, if\ \ false" event_delayed_postponed: type: boolean description: "I confirm, that if possible, we will make all efforts to delay\ \ the event the same day or postpone the event to another day. This field\ \ is required if adverse_weather_cover_required is true" event_delayed_postponed_details: type: string description: "Detailed regarding event_delayed_postponed, if false" cancellation_declaration: type: boolean description: "I/we declare that the information disclosed on this application,\ \ is to the best of my/our knowledge and belief both accurate and complete.\ \ I/we have taken care not to make any misrepresentation in the disclosure\ \ of this information and understand that all information provided is\ \ relevant to the acceptance and assessment of this insurance, the terms\ \ on which it is accepted and the premium charged." EventHostCancellationPolicyAttributes.Event: required: - add_ons - basis_of_indemnity - costs_and_expenses - cover_option - event_city - event_country - event_end_date - event_name - event_situation - event_start_date - event_state - event_type - event_venue - gross_revenue - held_before type: object properties: basis_of_indemnity: type: object description: Whether the `gross_revenue` or `costs_and_expenses` are to be insured allOf: - $ref: "#/components/schemas/BasisOfIndemnity" - type: object gross_revenue: minimum: 0 type: integer description: "Please enter the total income figure for the insured event.\ \ If the event has not been held before, only enter the element of income\ \ which is pre contracted (i.e. secured in advance of the event) such\ \ as pre sold tickets, advertising, grants etc." format: int64 costs_and_expenses: minimum: 1 type: integer description: Please enter the total costs & expenses figure for the insured event. The figure must be equal to or greater than 1 as every event costs something to organize. format: int64 event_start_date: type: string description: The date the event starts format: date event_end_date: type: string description: The date the event ends format: date event_country: type: object description: The country that the event takes place in allOf: - $ref: "#/components/schemas/Country" - type: object event_state: type: string description: The state or province that the event takes place in event_city: type: string description: The city that the event takes place in event_type: type: string event_name: type: string description: The name of the event event_venue: type: string description: The name of the venue hosting the event event_situation: type: object description: Whether the event predominantly takes place indoors or outdoors allOf: - $ref: "#/components/schemas/EventSituation" - type: object cover_option: $ref: "#/components/schemas/CoverOption" add_ons: $ref: "#/components/schemas/EventHostCancellationPolicyAttributes.AddOns" held_before: type: boolean description: Has the event ever been held before? adverse_weather_cover_required: type: boolean description: "This field is required if event_situation = \"OUTDOOR\" /\ \ \"TEMPORARY_STRUCTURE\" / Help Text: We automatically include adverse\ \ weather cover for indoor events. If the event is outdoors or under temporary\ \ structures and cover is required in respect of adverse weather, please\ \ tick \"Yes\". If not, please tick \"No\"." moderate_rainfall_wind_speed_proceed: type: boolean description: "This field is required if adverse_weather_cover_required =\ \ true / Help Text: If answered “yes” you are confirming that the event\ \ can withstand rain falling at a light to moderate pace, being generally\ \ accepted as less than a 0.30 inch hourly rate and resulting in small\ \ puddles forming as well as wind speeds of up to 30 miles per hour which\ \ would mean the event can proceed with moderate to large branches in\ \ motion but there is not yet extra effort needed in walking nor are whole\ \ trees in motion. Should your event be more sensitive to weather than\ \ this, please answer “no” and provide additional information." moderate_rainfall_wind_speed_proceed_details: type: string description: "Please advise approximately what level of wind and rain would\ \ likely cause the event to be cancelled or abandoned due to it being\ \ physically impossible or unsafe to conduct the necessary setup, or that\ \ would make it unsafe to proceed with the event due to concerns for the\ \ safety of those attending and/or working at the event." history_waterlog_flooding: type: boolean description: Does the event site have any history of waterlogging or flooding? history_waterlog_flooding_details: type: string description: "If applicable, provide details about history of waterlogging\ \ or flooding" adverse_weather_losses: type: boolean description: Has this event ever had any losses as a result of adverse weather? This field is required if adverse_weather_cover_required = true AND held_before = TRUE adverse_weather_losses_details: type: string description: "If applicable, provide details about losses as a result of\ \ adverse weather" marquee_temporary_structure: type: boolean description: Does the event take place within a marquee or temporary structure which is covered on 3 sides and top? This field is required if event_situation = "TEMPORARY_STRUCTURE" AND adverse_weather_cover_required = true non_appearance: type: object description: Object representing NonAppearance coverage. Exclude if this type ofcoverage is not wanted or needed. allOf: - $ref: "#/components/schemas/EventHostCancellationPolicyAttributes.NonAppearance" - type: object EventHostCancellationPolicyAttributes.Individual: required: - birth_date - id - name type: object properties: id: minLength: 1 type: string description: An ID that uniquely identifies this individual name: minLength: 1 type: string description: The name of the individual birth_date: type: string description: The date of birth of this individual format: date EventHostCancellationPolicyAttributes.NonAppearance: required: - is_contracted_to_appear - non_appearance_type type: object properties: non_appearance_type: type: object description: "Please select the type of non appearance cover required. Key\ \ Speaker: Cover for non appearance of key persons following death, accident,\ \ illness or travel delay, whose performance at the event involves speaking\ \ or presenting only. Individual or Group of Individuals: Cover for key\ \ persons following death, accident, illness or travel delay, whose purpose\ \ is to perform at the event. For example a singer, musician, band or\ \ dance group. Simultaneous Non Appearance: Cover for the non-appearance\ \ of a group of performers as the result of a common cause. For example\ \ a sports team or orchestra." allOf: - $ref: "#/components/schemas/NonAppearanceCoverage" - type: object is_contracted_to_appear: type: boolean description: Is the Insured Person(s) contracted to appear at the event? confirm_minimum_number_of_participants: type: boolean description: Please confirm there are 20 or more Participants in total. Required if non_appearance_type is SIMULTANEOUS_NON_APPEARANCE less_than20_participants_details: type: string description: How many participants are there and how many of them are critical to enable the event to proceed? Required if confirm_minimum_number_of_participants is false royal_head_of_state: type: boolean description: Is any above named person a member of the royal family or a serving / former head of state or President of the USA? Required if non_appearance_type is KEY_SPEAKER individual_information: type: array description: List of individuals to be covered in non-appearance coverage. Required if non_appearance_type is NON_APPEARANCE_OF_ANY_INDIVIDUAL_OR_GROUP or KEY_SPEAKER items: $ref: "#/components/schemas/EventHostCancellationPolicyAttributes.Individual" EventHostCancellationWeddingTypes: type: string enum: - WEDDING_RECEPTION - WEDDING - WEDDING_BRUNCH EventHostLiabilityCustomer: required: - city - phone_number - street type: object allOf: - $ref: "#/components/schemas/PolicyRequestCustomer" - type: object properties: phone_number: type: string street: type: string city: type: string EventHostLiabilityPolicyAttributes: title: EventHostLiabilityPolicyAttributes required: - events - excluded_event_features - general_liability_loss_exceeded_max_loss - late_night_event - overnight_stay - total_event_expense_budget - venue_is_residential_home_rental type: object properties: number_of_events: minimum: 1 type: integer format: int32 event_type: type: object description: Overall event type allOf: - $ref: "#/components/schemas/EventLiabilityEventTypes" - type: object total_event_expense_budget: type: integer format: int32 general_liability_loss_exceeded_max_loss: type: boolean description: "Has the event host had a general liability loss greater than\ \ $5,000?" excluded_event_features: type: boolean description: |- Will your event feature any of the following activities? - Activities that take place in or on water (i.e. swimming) - Animals (excluding service animals) - Cannabis including but not limited to Edibles, CBD, etc. - Celebrity Appearances and/or High Profile Attendees - Firearms/Ammunition/Projectiles and/or weapons of any kind - Open Flames - the use of: (i) an open or exposed flame; (ii) any combustion that produces heat, light or smoke; or (iii) a fireplace, hearth, or other structure or appliance designed to contain a fire. live_music_type: type: object description: "If the event will feature live music, what is the type of\ \ music? Note that DISC_JOCKEY and COVER_BAND are only applicable to wedding\ \ event types." allOf: - $ref: "#/components/schemas/EventMusicType" - type: object venue_is_residential_home_rental: type: boolean description: Will the event be hosted at a residence or house rental property? overnight_stay: type: boolean description: Does the event include the host or attendees staying over night? renting_entire_venue_location: type: boolean description: "If there is an overnight stay, is the entire venue location\ \ being rented out?" late_night_event: type: boolean description: Will the event go past 2 AM? events: type: array description: "Provide all events happening within the overall event. For\ \ example, if the overall event is a wedding, you may have a ceremony,\ \ and a reception." items: $ref: "#/components/schemas/EventHostLiabilityPolicyAttributes.LiabilityEventInfo" allOf: - $ref: "#/components/schemas/EventHostPolicyAttributes" EventHostLiabilityPolicyAttributes.LiabilityEventInfo: required: - event_type - max_daily_attendees type: object allOf: - $ref: "#/components/schemas/EventInfo" - type: object properties: event_type: $ref: "#/components/schemas/EventLiabilityEventTypes" max_daily_attendees: minimum: 1 type: integer format: int32 EventHostLiabilityQuoteRequest: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_EventHostLiabilityPolicyAttributes.EventHostLiabilityCustomer_" - $ref: "#/components/schemas/PolicyRequest_EventHostLiabilityCustomer_" EventHostLiabilityRentalCoveragePolicyAttributes: required: - additional_questions - events type: object allOf: - $ref: "#/components/schemas/EventHostPolicyAttributes" - type: object properties: events: type: array description: Provide all events happening that should be included in coverage. items: $ref: "#/components/schemas/EventHostLiabilityRentalCoveragePolicyAttributes.LiabilityWithRentalCoverageEventInfo" additional_questions: type: object description: Additional Questions allOf: - $ref: "#/components/schemas/EventHostLiabilityRentalCoveragePolicyAttributes.AdditionalQuestions" - type: object EventHostLiabilityRentalCoveragePolicyAttributes.AdditionalQuestions: required: - excluded_event_features - general_liability_loss - late_night_event - live_music - overnight_stay - venue_is_residential_home_rental type: object properties: general_liability_loss: type: boolean description: Have you ever suffered a loss at any of your previous events? excluded_event_features: type: boolean description: |- Will your event feature any of the following activities? - Activities that take place in or on water (i.e. swimming) - Animals (excluding service animals) - Cannabis including but not limited to Edibles, CBD, etc. - Celebrity Appearances and/or High Profile Attendees - Firearms/Ammunition/Projectiles and/or weapons of any kind - Open Flames - the use of: (i) an open or exposed flame; (ii) any combustion that produces heat, light or smoke; or (iii) a fireplace, hearth, or other structure or appliance designed to contain a fire. live_music: type: boolean description: |- Will your event include musical performances in any of the following genres? - Heavy Metal - Punk Rock - Hardcore - Rap/Hip-Hop/Trap - Electronic Dance Music (EDM) - Dubstep - Rock - Ska - Alternative/Indie Rock - Reggae - Grunge - Industrial - High Profile Performer venue_is_residential_home_rental: type: boolean description: "Are you hosting this event at a residence or house rental\ \ property (i.e. AirBnb, VRBO or similar)?" overnight_stay: type: boolean description: Are your attendees staying overnight at the host venue? renting_entire_venue_location: type: boolean description: Are you renting out or in full possession of the entire venue? late_night_event: type: boolean description: Will your event involve camping or go past 2 AM? EventHostLiabilityRentalCoveragePolicyAttributes.LiabilityWithRentalCoverageEventInfo: required: - event_type - max_daily_attendees type: object allOf: - $ref: "#/components/schemas/EventInfo" - type: object properties: im_coverage_start: type: string description: Inland marine coverage start date format: date nullable: true im_coverage_end: type: string description: Inland marine coverage end date format: date nullable: true event_type: $ref: "#/components/schemas/EventLiabilityInlandMarineEventTypes" rental_coverage: type: array description: Optional additional coverage for rental equipment items: $ref: "#/components/schemas/EventLiabilityRentalCoverage" rental_items: type: array description: "Optional list of rental items (item, category label, rental\ \ cost in dollars). Can be used in place of rental_coverage, in which\ \ case VerticalInsure will perform the category classification and replacement\ \ cost calculation." items: $ref: "#/components/schemas/EventLiabilityRentalItem" additional_certificate_holders: type: array description: Optional additional entities to include on the certificate of insurance items: $ref: "#/components/schemas/EventLiabilityCertificateHolder" max_daily_attendees: maximum: 500 minimum: 1 type: integer format: int32 x-maximum-message: Events with more than 500 attendees are currently not eligible for insurance. EventHostLiabilityRentalCoverageQuoteRequest: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_EventHostLiabilityRentalCoveragePolicyAttributes.EventHostLiabilityCustomer_" - $ref: "#/components/schemas/PolicyRequest_EventHostLiabilityCustomer_" EventHostPolicyAttributes: type: object properties: named_insured: type: object description: Optional named insured information for the policy. Only required if the named insured is different than the applicant (customer). allOf: - $ref: "#/components/schemas/NamedInsured" - type: object contact: type: object description: Contact information regarding policy if policy is being purchased on behalf of the policy holder. allOf: - $ref: "#/components/schemas/EventHostPolicyAttributes.EventHostPolicyContact" - type: object EventHostPolicyAttributes.EventHostPolicyContact: required: - name type: object properties: name: type: string email_address: type: string phone_number: type: string EventInfo: required: - event_end_date - event_location - event_start_date type: object properties: event_name: type: string event_start_date: type: string format: date event_end_date: type: string format: date event_location: $ref: "#/components/schemas/EventVenue" EventLiabilityCertificateHolder: required: - city - country - name - state - street_address - type - zip_code type: object properties: type: $ref: "#/components/schemas/EventLiabilityCertificateHolderType" name: type: string street_address: type: string city: type: string state: type: string description: "State as a 2-letter code or full name, example \"MI\", for\ \ Michigan" example: MI zip_code: type: string country: type: string EventLiabilityCertificateHolderType: type: string enum: - RENTAL_COMPANY - CITY_MUNICIPALITY - SCHOOL_DISTRICT - VENUE EventLiabilityEventTypes: type: string enum: - ANTIQUE_SHOW - APPAREL_TRADESHOW - ART_FESTIVAL - ART_SHOW - AUCTION - AWARD_PRESENTATION - BABY_SHOWER - BALLET - BANQUET - BAPTISM - BAR_MITZVAH - BAZAAR - BEAUTY_PAGEANT - BIRTHDAY_PARTY - BRIDAL_SHOWER - BRIDAL_TRADESHOW - BUSINESS_CONFERENCE - BUSINESS_MEETING - CHARITY_AUCTION - CHESS_TOURNAMENT - COCKTAIL_PARTY - COMEDY_SHOW - CONCERT_CLASSICAL - CONCERT_CHOIR - CONCERT_DOOWOP - CONCERT_JAZZ - CONCERT_OPERA - CONCERT_SYMPHONY - CONSUMER_SHOW - CONVENTION_INDOORS - CRAFT_SHOWS_INDOORS - DANCE_CLASS - DANCE_RECITAL - DEBUTANTE_BALL - ENGAGEMENT_PARTY - FLOWER_GARDEN_SHOW - FUNERAL_SERVICE - GALA - HIGH_SCHOOL_OR_COLLEGE_GRADUATION_CEREMONY - JOB_FAIR - LECTURE - LUNCHEON - ORCHESTRA - PIANO_RECITAL - QUINCEANERA - RETIREMENT_PARTY - SEMINAR - TRAVEL_TRADESHOW - WEBINAR - WEDDING_RECEPTION - WEDDING - WEDDING_BRUNCH - WEDDING_ANNIVERSARY - BADMINTON - GOLF - TENNIS - VENDOR - EXHIBITOR_BOOTH - BASEBALL - BASKETBALL - BINGO_GAME - CARD_GAME - COMPUTER_TRADESHOW - CONSIGNMENT_SALE - FARMERS_MARKET - FLEA_MARKET - MATH_TOURNAMENT - SOFTBALL - SPORTS_MEMORABILIA_TRADESHOW - THEATER_PRODUCTIONS - TRADESHOW - VIDEO_GAME_CONTEST - VOLLEYBALL - FLAG_FOOTBALL - FIELD_HOCKEY - LACROSSE - SOCCER - REHEARSAL_DINNER - WATCH_PARTY EventLiabilityInlandMarineEventTypes: type: string enum: - ANTIQUE_SHOW - APPAREL_TRADESHOW - ART_SHOW - ARTS_AND_CRAFTS_FESTIVAL - AUCTION - AWARD_PRESENTATION - BABY_SHOWER - BALLET_RECITAL - BANQUET - BAPTISM - BAR_MITZVAH - BEAUTY_PAGEANT - BINGO_GAME - BIRTHDAY_PARTY - BRIDAL_SHOWER - BRIDAL_TRADESHOW - BUSINESS_CONFERENCE - BUSINESS_MEETING - CHESS_TOURNAMENT - CHILDRENS_BIRTHDAY_PARTY - COCKTAIL_PARTY - COMEDY_SHOW - COMPUTER_TRADESHOW - CONSIGNMENT_SALE - CONSUMER_SHOW - CONVENTION_INDOORS - CRAFT_SHOWS_INDOORS - DANCE_CLASS - DANCE_RECITAL - DEBUTANTE_BALL - EMPLOYEE_HOLIDAY_PARTY - ENGAGEMENT_PARTY - FAREWELL_BRUNCH - FARMERS_MARKET - FIRST_COMMUNION - FLEA_MARKET - FLOWER_GARDEN_SHOW - FUNERAL_SERVICE - GALA - GRADUATION_CEREMONY - JOB_FAIR - LECTURE - LUNCHEON - PIANO_RECITAL - QUINCEANERA - REHEARSAL_DINNER - RETIREMENT_PARTY - SEMINAR - SPORTS_MEMORABILIA_TRADESHOW - TRAVEL_TRADESHOW - THEATER_PRODUCTION - VIDEO_GAME_SHOW - WEDDING_ANNIVERSARY_PARTY - WEDDING_CEREMONY - WEDDING_RECEPTION - WATCH_PARTY EventLiabilityRentalCoverage: required: - replacement_cost - type type: object properties: type: $ref: "#/components/schemas/EventLiabilityRentalCoverageType" replacement_cost: type: integer description: "Replacement cost of the rented items, in dollars." format: int64 EventLiabilityRentalCoverageType: type: string enum: - FOOD_BEVERAGE - FURNITURE - LINEN - LIGHTING_DECOR - PIPE_DRAPE - DECOR - CUSTOM_SIGNAGE - PACKAGING_DELIVERY - STORAGE_ORGANIZATION - NETWORKING_DEVICES - OFFICE_EQUIPMENT - FLORALS - FLORAL_SUPPLIES EventLiabilityRentalItem: required: - category - rental_cost type: object properties: item: type: string description: "Item(s) name or description, optional" category: minLength: 1 type: string description: Category label for the item(s) rental_cost: minimum: 0 exclusiveMinimum: true type: integer description: Rental cost in dollars format: int64 EventMusicType: type: string enum: - CHOIR - CLASSICAL - DOO_WOP - JAZZ - ORCHESTRA - OPERA - SYMPHONY - FOLK_GUITAR - COUNTRY - CLASSIC_ROCK - DISC_JOCKEY - COVER_BAND - HEAVY_METAL - PUNK_ROCK - HARDCORE - RAP_HIP_HOP - EDM - DUBSTEP - ROCK - SKA - ALTERNATIVE_INDIE - REGGAE - GRUNGE - INDUSTRIAL - HIGH_PROFILE_PERFORMER EventPolicyAttributes: required: - event_end_date - event_start_date - insurable_amount type: object properties: insurable_amount: minimum: 300 type: integer description: Value of event in cents. format: int64 insurable_amount_currency: type: object description: Currency of the insurable amount allOf: - $ref: "#/components/schemas/Currency" - type: object default: USD event_start_date: type: string format: date event_end_date: type: string format: date EventPurpose: type: string enum: - CLIENT_PARTNER - COMMUNITY_PUBLIC - CORPORATE_SALES_PROMOTIONAL - PROFESSIONAL_CONFERENCE - SOCIAL_PERSONAL - OTHER x-type: String EventPurpose_1: type: string enum: - PROFESSIONAL_CONFERENCE - CORPORATE_SALES_PROMOTIONAL - CLIENT_PARTNER - COMMUNITY_PUBLIC - SOCIAL_PERSONAL - OTHER EventSituation: type: string enum: - INDOOR - OUTDOOR - TEMPORARY_STRUCTURE EventVendor: required: - business_city - business_country - business_name - business_postal_code - business_state - business_street - is_test - offer_id type: object properties: id: type: string format: uuid business_name: type: string business_street: type: string business_city: type: string business_state: type: string business_postal_code: type: string business_country: type: string quote_id: type: string nullable: true offer_id: type: string format: uuid status: nullable: true allOf: - $ref: "#/components/schemas/VendorStatus" created_at: type: string format: date-time updated_at: type: string format: date-time is_test: type: boolean accepted: type: boolean nullable: true metadata: type: object additionalProperties: type: object nullable: true manual_review_request: type: string nullable: true event_coi: nullable: true allOf: - $ref: "#/components/schemas/EventVendor.EventCoi" policy: nullable: true allOf: - $ref: "#/components/schemas/PolicyDTO_PolicyAttributes_" EventVendor.EventCoi: required: - read_only_signed_url - validation_failures type: object properties: validation_failures: type: array nullable: true items: $ref: "#/components/schemas/EventVendor.ValidationFailure" read_only_signed_url: type: string nullable: true EventVendor.ValidationFailure: required: - code - text type: object properties: code: type: string text: type: string EventVenue: required: - venue_city - venue_country - venue_name - venue_state - venue_street_address - venue_zip_code type: object properties: venue_name: type: string venue_street_address: type: string venue_city: type: string venue_state: type: string venue_zip_code: type: string venue_country: type: string ExhibitorLiabilityEvent: required: - event - event_end_date - event_start_date - host_questions type: object properties: event: type: object description: Event information allOf: - $ref: "#/components/schemas/EventExhibitorLiabilityEventInfo" - type: object additional_insured: type: object description: Additional insured information allOf: - $ref: "#/components/schemas/EventExhibitorLiabilityAdditionalInsured" - type: object host_questions: type: object description: Additional questions allOf: - $ref: "#/components/schemas/EventExhibitorLiabilityHostQuestions" - type: object event_start_date: type: string format: date event_end_date: type: string format: date GapMedicalAgeBand: required: - key - max_age - min_age type: object properties: key: type: string min_age: type: integer format: int32 max_age: type: integer format: int32 GapMedicalPolicyAttributes: title: GapMedicalPolicyAttributes required: - coverage_end_date - coverage_start_date - coverage_type - covered_person type: object properties: covered_person: $ref: "#/components/schemas/GapMedicalPolicyAttributes.CoveredPerson" coverage_start_date: type: string format: date coverage_end_date: type: string format: date covered_event_dates: type: array description: "If the event takes place over a span of days, but the participant\ \ will not be participating on every day in the span, then you can provide\ \ a list of dates where the participant will be participating and therefore\ \ need coverage. In some situations, we can use this information to offer\ \ a lower price than if they needed to be covered on every day for the\ \ entire duration." nullable: true items: type: string format: date coverage_type: $ref: "#/components/schemas/GapMedicalSport" GapMedicalPolicyAttributes.Contact: type: object properties: first_name: type: string last_name: type: string street: type: string city: type: string state: type: string postal_code: type: string country: type: string GapMedicalPolicyAttributes.CoveredPerson: required: - birth_date - state type: object properties: state: type: string description: "Covered person's state residence (e.g. \"MI\", for Michigan)" example: MN first_name: type: string last_name: type: string street: type: string country: maxLength: 2 minLength: 2 type: string birth_date: type: string format: date contacts: type: array items: $ref: "#/components/schemas/GapMedicalPolicyAttributes.Contact" GapMedicalSport: type: string enum: - ACADEMIC_CLUB - AEROBICS - ARCHERY - ART - BADMINTON - BAND - BARRE - BASEBALL - BASKETBALL - BOCCE - BOOTCAMP_CLASS - BOWLING - BOXING - BUBBLE_BALL_SOCCER - CHESS - CHORUS - COMPETITIVE_CHEERLEADING - CREW - CRICKET - CROSSFIT - CROSS_COUNTRY - CROSS_COUNTRY_SKIING - CURLING - DANCE - DEBATE - DIVING - DOCK_DOGS - DRILL - DOWNHILL_SKIING - DRAMA - EXERCISE_BIKE - E_SPORTS - FENCING - FIELD_HOCKEY - FIGURE_SKATING - FISHING - FITNESS - FITNESS_CENTERS - FLAG_FOOTBALL - FOOTBALL - GOLF - GYM - GYMNASTICS - HANDBALL - HIIT - HIKING - ICE_HOCKEY - ICE_SKATING - INLINE_SKATING - JAI_ALAI - JUDO - KARATE - KICKBALL - KICK_BOXING - LACROSSE - MARCHING_BAND - MARTIAL_ARTS - MEDITATION - MODEL_UN - MOUNTAIN_BIKING - MUD_RUN - MUSIC - ORIENTEERING - PADDLEBALL - PAINTBALL - PERSONAL_TRAINING - POLO - RACQUETBALL - REFEREEING - RIFLERY - ROAD_CYCLING - ROBOTICS - ROCK_CLIMBING - ROWING - RUGBY - RUNNING - SAILING - SIDELINE_CHEERLEADING - SKIING - SKI_CLUB - SNOW_SHOE - SOCCER - SOFTBALL - SPARTAN_RACE - SQUASH - STREET_HOCKEY - STUDENT_GOVERNMENT - SWIMMING - SURFING - TAI_CHI - TEE_BALL - TENNIS - THEATER - TRACK - TRACK_AND_FIELD - TRIATHLON - ULTIMATE_FRISBEE - VOLLEYBALL - WALKING - WATER_POLO - WEIGHT_LIFTING - WRESTLING - YOGA Gender: type: string enum: - MALE - FEMALE GetCoveredSportRequest: required: - sport_names - state_abbreviation type: object properties: state_abbreviation: type: string sport_names: minItems: 1 type: array items: type: string GetCoveredSportResponseItem: required: - covered_in_state - covered_sport - requested_sport_name type: object properties: requested_sport_name: type: string sport_covered: type: boolean covered_sport: type: string covered_in_state: type: boolean HomeOwnerCertificateHolder: required: - city - email - first_name - last_name - postal_code - state - street - suite type: object properties: entity_type: type: string enum: - home-owner first_name: type: string last_name: type: string street: type: string suite: type: string city: type: string state: type: string postal_code: type: string email: type: string HuntingLeaseLiabilityPolicyAttributes: required: - acres - additional_questions - coverage_end_date - coverage_start_date - land_location - land_owner - number_of_members type: object properties: acres: minimum: 1 type: integer format: int32 number_of_members: minimum: 1 type: integer format: int32 coverage_start_date: type: string format: date coverage_end_date: type: string format: date additional_questions: type: object description: Additional Questions allOf: - $ref: "#/components/schemas/HuntingLeaseLiabilityPolicyAttributes.AdditionalQuestions" - type: object land_owner: type: object description: Lease land owner allOf: - $ref: "#/components/schemas/HuntingLeaseLiabilityPolicyAttributes.LandOwner" - type: object land_location: type: object description: Lease land location allOf: - $ref: "#/components/schemas/HuntingLeaseLiabilityPolicyAttributes.LandLocation" - type: object HuntingLeaseLiabilityPolicyAttributes.AdditionalQuestions: required: - alcohol_usage - hosted_public_events - non_hunting_atv_usage - overnight_accommodations - recent_liability_claim - rent_or_loan_atv_snowmobiles - rent_or_loan_saddle_animals - rent_sell_maintenance_firearm_modification - trapping_population_control_payment - written_lease_agreement type: object properties: written_lease_agreement: type: boolean description: Will the club/group have a written lease agreement with the property owner? rent_or_loan_saddle_animals: type: boolean description: Does the club/group rent or loan saddle animals? (horses or mules) rent_or_loan_atv_snowmobiles: type: boolean description: Does the club/group rent or loan ATVs/snowmobiles? non_hunting_atv_usage: type: boolean description: "Are ATVs used for any purpose other than hunting? (joy riding,\ \ racing etc.)" rent_sell_maintenance_firearm_modification: type: boolean description: "Does the club/group rent, sell, offer maintenance or modification\ \ of firearms and/or ammunition?" alcohol_usage: type: boolean description: Is alcohol provided by the club/group? overnight_accommodations: type: boolean description: "Does club/group provide overnight accommodations, including\ \ but not limited to cabins, campers, tents etc." hosted_public_events: type: boolean description: "Does the club/group conduct/offer guided hunts, host or allow\ \ tournaments, charity events or public hunting?" trapping_population_control_payment: type: boolean description: "Does the club receive payment for trapping, or population\ \ control services?" recent_liability_claim: type: boolean description: Has the club/group had any liability claims filed against any policy in the last 5 years? HuntingLeaseLiabilityPolicyAttributes.LandLocation: required: - address - city - postal_code - state type: object properties: address: type: string city: type: string state: type: string description: "State as a 2-letter code or full name, example \"MI\", for\ \ Michigan" example: MI postal_code: type: string country: maxLength: 2 minLength: 2 type: string description: 2-character country code default: US enum: - US HuntingLeaseLiabilityPolicyAttributes.LandOwner: required: - address - city - first_name - last_name - postal_code - state type: object properties: first_name: type: string last_name: type: string address: type: string city: type: string state: type: string description: "State as a 2-letter code or full name, example \"MI\", for\ \ Michigan" example: MI postal_code: type: string InsuranceRequirementsType: type: string enum: - STANDARD - CUSTOM InsuredType: type: string enum: - HOME_BUILDER - CONTRACTOR IntendedOccupancy: type: string enum: - RESIDENTIAL_SINGLE_FAMILY - OFFICE_BUILDING - WAREHOUSE - APARTMENT_BUILDING - CONDOMINIUM - MUNICIPAL_BUILDING - STRIP_MALL_SHOPPING_CENTER - GENERAL_RETAIL - GENERAL_COMMERCIAL JsonError: required: - _embedded - _links - logref - message - path type: object allOf: - $ref: "#/components/schemas/AbstractResource_JsonError_" - type: object properties: _links: $ref: "#/components/schemas/OptionalMultiValues_Link_" _embedded: $ref: "#/components/schemas/OptionalMultiValues_Resource_" message: type: string logref: $ref: "#/components/schemas/JsonError" path: $ref: "#/components/schemas/JsonError" LimitedPartnerDTO: required: - administrative_email_address - country - entity_name - travel_retailer_onboarding_complete - website type: object properties: id: type: string description: Partner id format: uuid status: type: object description: Partner status allOf: - $ref: "#/components/schemas/PartnerStatus" - type: object type: type: object description: Partner type allOf: - $ref: "#/components/schemas/PartnerType" - type: object entity_name: type: string description: Partner entity name administrative_email_address: type: string description: Administrative contact email address format: email billing_email_address: type: string description: Billing contact email address format: email address: type: string description: Street address city: type: string description: City state: type: string description: State code postal_code: type: string description: Postal code country: type: string description: 2-character country code example: US default: US website: type: string description: Website travel_retailer_onboarding_url: type: string description: URL returned to complete onboarding as a travel retailer. Only returned if travel_retailer = true travel_retailer_onboarding_complete: type: boolean MarketingPayoutReportDTO: type: object properties: id: type: string format: uuid period: type: string payout_amount: type: integer format: int64 is_test: type: boolean paid: type: boolean created_at: type: string format: date-time MarketingPayoutReportDetailsDTO: type: object allOf: - $ref: "#/components/schemas/MarketingPayoutReportDTO" - type: object properties: url: type: string MembershipInsurancePolicyAttributes: required: - insurable_amount - membership_end_date - membership_start_date - organization - participant type: object properties: insurable_amount: type: integer format: int64 participant: $ref: "#/components/schemas/MembershipInsurancePolicyAttributes.Participant" membership_start_date: type: string format: date membership_end_date: type: string format: date organization: $ref: "#/components/schemas/CommonOrganization" MembershipInsurancePolicyAttributes.Participant: type: object properties: first_name: type: string last_name: type: string MinimalPartnerDTO: type: object properties: id: type: string format: uuid legal_business_name: type: string NamedInsured: required: - city - country - name - postal_code - state - street type: object properties: name: type: string street: type: string city: type: string state: type: string description: "State as a 2-letter code or full name, example \"MI\", for\ \ Michigan" example: MI postal_code: type: string country: type: string description: 2-character country code default: US enum: - US NoPagingContentResponse_DestinationCountry_: type: object properties: content: type: array items: $ref: "#/components/schemas/DestinationCountry" NonAppearanceCoverage: type: string enum: - KEY_SPEAKER - SIMULTANEOUS_NON_APPEARANCE - NON_APPEARANCE_OF_ANY_INDIVIDUAL_OR_GROUP NotEligibleReason: type: object properties: message: type: string OnboardPartnerRequest: required: - administrative_email_address - country - entity_name - website type: object properties: entity_name: type: string description: Partner entity name administrative_email_address: type: string description: Administrative contact email address format: email external_id: type: string description: Id of the client within your system billing_email_address: type: string description: Billing contact email address format: email address: type: string description: Street address city: type: string description: City state: type: string description: State code postal_code: type: string description: Postal code travel_retailer: type: boolean description: "If true, the partner will be emailed with steps to become\ \ a certified travel retailer." country: type: string description: 2-character country code example: US website: type: string description: Website bank_account: type: object description: banking info allOf: - $ref: "#/components/schemas/PartnerBankingInfo" - type: object OptionalMultiValues_Link_: $ref: "#/components/schemas/OptionalValues_List_Link__" OptionalMultiValues_Resource_: $ref: "#/components/schemas/OptionalValues_List_Resource__" OptionalValues_List_Link__: required: - empty type: object properties: empty: type: boolean OptionalValues_List_Resource__: required: - empty type: object properties: empty: type: boolean Order: type: object properties: id: type: string format: uuid customer: $ref: "#/components/schemas/Customer" order_item_transactions: type: array items: $ref: "#/components/schemas/OrderItemTransaction" subscription: $ref: "#/components/schemas/Subscription" is_initial_subscription: type: boolean total: type: integer format: int64 sub_total: type: integer format: int64 taxes_and_fees_total: type: integer format: int64 currency: $ref: "#/components/schemas/Currency" status: $ref: "#/components/schemas/OrderStatus" placed_at: type: string format: date-time completed_at: type: string format: date-time failed_payment_notification_count: type: integer format: int32 failed_payment_notification_last_sent: type: string format: date-time created_at: type: string format: date-time updated_at: type: string format: date-time is_test: type: boolean OrderItemTaxFee: type: object properties: amount: type: integer format: int64 description: type: string type: $ref: "#/components/schemas/OrderItemTaxFee.Type" included_in_premium: type: boolean include_in_marketing_share: type: boolean description: Determines if this tax/fee item should be included in the partner marketing payout calculations. refundable: type: boolean description: "Determines if this tax/fee item can be refunded. It's up to\ \ the support team to decide if a tax/fee can be refunded on a case-by-case\ \ basis, but this flag determines the standard for the item." taxable: type: boolean per_subscription_charge: type: boolean created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true OrderItemTaxFee.Type: type: string enum: - fee - tax x-enum-varnames: - fee - tax OrderItemTransaction: type: object properties: id: type: string format: uuid policy: $ref: "#/components/schemas/Policy_PolicyAttributes_" taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" item_total: type: integer format: int64 taxes_and_fees_amount: type: integer format: int64 item_sub_total: type: integer format: int64 estimated_allocated_transaction_fee: type: integer format: int64 chargeback_fee: type: integer format: int64 ar_accounting_period: type: string co_accounting_period: type: string transaction_status: $ref: "#/components/schemas/TransactionStatus" transaction_type: $ref: "#/components/schemas/TransactionType" transaction_amount: type: integer format: int64 payment_type: $ref: "#/components/schemas/PaymentType" processor: $ref: "#/components/schemas/PaymentProcessorType" estimated_processor_transaction_fee: type: integer format: int64 processor_payment_method_id: type: string processor_payment_id: type: string processor_payout_id: type: string processor_payout_date: type: string format: date-time processor_account_id: type: string source_total: type: integer format: int64 source_currency: $ref: "#/components/schemas/Currency" created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true OrderStatus: type: string enum: - REQUIRES_PAYMENT - COMPLETED - REFUNDED - PENDING - FAILED - CHARGED_BACK OrganizationCancellationPolicyAttributes: type: object allOf: - $ref: "#/components/schemas/ParticipantCancellationPolicyAttributes" - $ref: "#/components/schemas/EventPolicyAttributes" - type: object properties: organization: nullable: true allOf: - $ref: "#/components/schemas/OrganizationWithPaymentPlan" OrganizationWithPaymentPlan: required: - org_name type: object properties: org_name: type: string org_contact_email: type: string org_contact_first_name: type: string org_contact_last_name: type: string org_contact_phone: type: string org_website: type: string org_city: type: string org_state: type: string org_postal_code: type: string org_country: type: string payment_plan: type: boolean registration_session_name: type: string PageResponse_EventVendor_: type: object properties: content: type: array items: $ref: "#/components/schemas/EventVendor" page_number: type: integer format: int32 size: type: integer format: int32 empty: type: boolean number_of_elements: type: integer format: int32 total_size: type: integer format: int64 total_pages: type: integer format: int32 PageResponse_MarketingPayoutReportDTO_: type: object properties: content: type: array items: $ref: "#/components/schemas/MarketingPayoutReportDTO" page_number: type: integer format: int32 size: type: integer format: int32 empty: type: boolean number_of_elements: type: integer format: int32 total_size: type: integer format: int64 total_pages: type: integer format: int32 Participant: required: - business_name - first_name - last_name type: object properties: first_name: type: string last_name: type: string business_name: type: string ParticipantCancellationPolicyAttributes: required: - participant type: object allOf: - $ref: "#/components/schemas/EventPolicyAttributes" - type: object properties: participant: type: object description: "The participant being covered, either first name and last\ \ name, or business name" allOf: - $ref: "#/components/schemas/Participant" - type: object PartnerBankingInfo: $ref: "#/components/schemas/PartnerPayoutBankingUpdateRequest" PartnerClientTokenResponse: type: object allOf: - $ref: "#/components/schemas/TokenResponse" - type: object properties: partnerId: type: string format: uuid PartnerDomain: required: - domain - partner_id type: object properties: id: type: string format: uuid partner_id: type: string format: uuid domain: type: string created_at: type: string format: date-time PartnerPayoutBankingUpdateRequest: type: object properties: ach_account_number: type: string ach_routing_number: type: string ach_account_type: $ref: "#/components/schemas/ACHAccountType" ach_account_name: type: string PartnerStatus: type: string enum: - ACTIVE - PENDING_CONFIGURATION - PENDING_ONBOARDING - INACTIVE PartnerType: type: string enum: - STANDARD - LIMITED PaymentMethod: required: - bank_account - card - token type: object properties: card: $ref: "#/components/schemas/PaymentMethod.Card" bank_account: $ref: "#/components/schemas/PaymentMethod.BankAccount" token: type: string save_for_future_use: type: boolean description: Store the payment information for use in the future. description: "Only one of a `card`, `bank_account` or `token` payment is required." PaymentMethod.BankAccount: required: - account_number - account_owner_name - account_owner_type - account_type - country - currency - routing_number type: object properties: currency: type: string account_owner_name: type: string routing_number: type: string account_number: type: string account_type: type: string account_owner_type: type: string country: type: string PaymentMethod.Card: required: - address_postal_code - month - name - number - verification - year type: object properties: name: type: string description: Name on card. number: type: string description: Number on card. verification: type: string description: Verification code (CVV). month: type: string description: Month as a number string (e.g. August would be either "08" or "8"). year: type: string description: "Year as a string (e.g. \"2023\", i.e. YYYY)." address_postal_code: type: string description: Just the postal code (e.g. 04951). PaymentProcessorType: type: string enum: - justifi - card_connect - propay - stripe - stripe_express - sportsengine - teamsnap - insurance_carrier - stackpay - invoice - braintree - paysafe - vgs - paypal - odie - fluidpay - payrix - finix x-enum-varnames: - justifi - card_connect - propay - stripe - stripe_express - sportsengine - teamsnap - insurance_carrier - stackpay - invoice - braintree - paysafe - vgs - paypal - odie - fluidpay - payrix - finix PaymentType: type: string enum: - CC - ACH - INV PetInsurancePolicyAttributesBase: required: - gender - pet_name - species - zip_code type: object properties: species: $ref: "#/components/schemas/Species" pet_name: type: string zip_code: maxLength: 5 minLength: 5 type: string gender: $ref: "#/components/schemas/Gender" coverage_type: type: object description: "INJURY_ONLY or INJURY_AND_ILLNESS. If empty, INJURY_ONLY will\ \ be used." allOf: - $ref: "#/components/schemas/CoverageType" - type: object PetInsurancePolicyAttributesV1: required: - age - breedId type: object allOf: - $ref: "#/components/schemas/PetInsurancePolicyAttributesBase" - type: object properties: breedId: type: string description: The breed ID of the pet to insure. Refer to the `/v1/products/pet-insurance/breeds` API for a list of valid values for each pet species. age: minimum: 0 type: integer description: "The age of the pet, in years." format: int32 annualLimit: minimum: 0 type: integer description: "Annual Limit. Possible values: 5000, 10000, 25000, 40000.\ \ Required for INJURY_AND_ILLNESS quotes. Represents USD." format: int32 deductibleAmount: maximum: 1000 minimum: 0 type: integer description: "Possible values: \"100\", \"150\", \"200\" in increments\ \ of 50 up to 1,000. Required for INJURY_AND_ILLNESS quotes. Represents\ \ USD." format: int32 PetInsuranceQuoteAttributes: required: - birth_date - breed - gender - pet_name - species - zip_code type: object properties: species: $ref: "#/components/schemas/Species" breed: type: string birth_date: type: string format: date-time pet_name: type: string zip_code: maxLength: 5 minLength: 5 type: string gender: $ref: "#/components/schemas/Gender" include_only_carriers: type: array description: "Array of carrier names to include in quote. Valid values:\ \ ODIE, ASPCA, HARTVILLE, MINT_WELLNESS. If not provided, all carriers\ \ will be included." items: type: string exclude_carriers: type: array description: "Array of carrier names to exclude from quote. Valid values:\ \ ODIE, ASPCA, HARTVILLE, MINT_WELLNESS. If not provided, all carriers\ \ will be included." items: type: string PolicyAttributes: type: object PolicyDTO_BuildersRiskPolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/BuildersRiskPolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_CollectiblesInsurancePolicyAttributesV2_: type: object properties: policy_attributes: $ref: "#/components/schemas/CollectiblesInsurancePolicyAttributesV2" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_EventDepositCancellationPolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/EventDepositCancellationPolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_EventExhibitorLiabilityPolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/EventExhibitorLiabilityPolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_EventHostCancellationPPPolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/EventHostCancellationPPPolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_EventHostCancellationPolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/EventHostCancellationPolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_EventHostLiabilityPolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/EventHostLiabilityPolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_EventHostLiabilityRentalCoveragePolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/EventHostLiabilityRentalCoveragePolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_GapMedicalPolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/GapMedicalPolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_HuntingLeaseLiabilityPolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/HuntingLeaseLiabilityPolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_MembershipInsurancePolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/MembershipInsurancePolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_PetInsurancePolicyAttributesV1_: type: object properties: policy_attributes: $ref: "#/components/schemas/PetInsurancePolicyAttributesV1" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_PolicyAttributes_: type: object properties: policy_attributes: type: object premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_ProbateBondPolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/ProbateBondPolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_RegistrationCancellationPolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/RegistrationCancellationPolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_ShippingInsurancePolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/ShippingInsurancePolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_StayToPlayPolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/StayToPlayPolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_TeamRegistrationPolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/TeamRegistrationPolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_TicketRefundPolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/TicketRefundPolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_TravelInsurancePolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/TravelInsurancePolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDTO_TuitionInsurancePolicyAttributes_: type: object properties: policy_attributes: $ref: "#/components/schemas/TuitionInsurancePolicyAttributes" premium_amount: minimum: 1 type: integer description: The premium amount of the policy. This is typically considered a sub-total. Use `total` for charging payment methods and displaying amounts to the user. format: int64 policy_number: type: string partner: $ref: "#/components/schemas/MinimalPartnerDTO" policy_documents: type: array items: $ref: "#/components/schemas/PolicyDocument" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: yyyy-mm-dd nullable: true effective_date: type: string format: yyyy-mm-dd nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" endorsement_price_changes: type: integer description: "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." format: int64 subscription_premium: type: object description: "If this policy supports being billed as a monthly subscription\ \ instead of a one-time fee, this field will be present" allOf: - $ref: "#/components/schemas/SubscriptionPremium" - type: object currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer description: 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. format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string offer_id: type: string format: uuid distribution_channel: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url recommendation: $ref: "#/components/schemas/Recommendation" policy_holder: $ref: "#/components/schemas/PolicyHolderEmbedded" PolicyDocument: type: object properties: document_type: $ref: "#/components/schemas/DocumentType" url: type: string PolicyHolderEmbedded: type: object properties: first_name: type: string middle_name: type: string last_name: type: string email_address: type: string email_address_hash: type: string phone_number: type: string street: type: string city: type: string state: type: string postal_code: type: string country: type: string PolicyRecordType: type: string enum: - POLICY - CERTIFICATE - PARTNER_CERTIFICATE - CLIP - ENTITLEMENT PolicyRequestCustomer: required: - email_address - first_name - last_name - state type: object properties: email_address: type: string format: email email_address_hash: pattern: "^[A-Fa-f0-9]{64}$" type: string description: "SHA-256 hash of normalized email (trimmed + lowercase), represented\ \ as a 64-character hex string." x-pattern-message: email_address_hash must be a 64-character hex SHA-256 digest state: minLength: 1 type: string description: 2-character state code. Either state or postal_code is required when requesting a quote. example: MN country: maxLength: 6 minLength: 2 type: string description: ISO 3166-1 code example: US default: US enum: - US - CA - AU - NZ - GB-SCT postal_code: minLength: 1 type: string description: Either state or postal_code is required when requesting a quote. first_name: minLength: 1 type: string middle_name: type: string last_name: minLength: 1 type: string phone_number: minLength: 1 type: string street: minLength: 1 type: string city: minLength: 1 type: string birth_date: type: string description: Required for probate bond products. format: date PolicyRequest_BondCustomer_: required: - customer type: object properties: customer: $ref: "#/components/schemas/BondCustomer" metadata: type: object additionalProperties: type: string PolicyRequest_EventHostLiabilityCustomer_: required: - customer type: object properties: customer: $ref: "#/components/schemas/EventHostLiabilityCustomer" metadata: type: object additionalProperties: type: string PolicyRequest_PolicyRequestCustomer_: required: - customer type: object properties: customer: $ref: "#/components/schemas/PolicyRequestCustomer" metadata: type: object additionalProperties: type: string PolicyStatus: type: string enum: - ACTIVE - QUOTED - EXPIRED - PENDING_CANCELLATION - CANCELED - PENDING - REQUIRES_PAYMENT - BIND_FAILED - ENDORSED - NOT_ELIGIBLE PolicyType: type: string enum: - event-participation-cancellation-insurance - event-host-liability - event-host-liability-rental-coverage - event-host-cancellation - event-host-cancellation-pp - pet-insurance - shipping - collectibles - medsaver - gap-medical - regsaver - travel - tuition - registration-cancellation - ticket-refund - renters - season-interruption - team-registration - membership-insurance - hunting-lease-liability - event-exhibitor-liability - stay-to-play - builders-risk - event-cancellation-athletereg - event-deposit-cancellation - surety-bond-probate x-enum-varnames: - EVENT_PARTICIPATION_CANCELLATION_INSURANCE - EVENT_HOST_LIABILITY - EVENT_HOST_LIABILITY_RENTAL_COVERAGE - EVENT_HOST_CANCELLATION - EVENT_HOST_CANCELLATION_PP - PET_INSURANCE - SHIPPING - COLLECTIBLES_INSURANCE - MEDSAVER - GAP_MEDICAL - REGSAVER - TRAVEL - TUITION - REGISTRATION_CANCELLATION - TICKET_REFUND - RENTERS - SEASON_INTERRUPTION - TEAM_REGISTRATION - MEMBERSHIP_INSURANCE - HUNTING_LEASE_LIABILITY - EVENT_EXHIBITOR_LIABILITY - STAY_TO_PLAY - BUILDERS_RISK - EVENT_CANCELLATION_ATHLETEREG - EVENT_DEPOSIT_CANCELLATION - SURETY_BOND_PROBATE x-type: String Policy_PolicyAttributes_: type: object properties: type: $ref: "#/components/schemas/PolicyRecordType" premium_amount: minimum: 1 type: integer format: int64 premium_amount_to_show: type: integer format: int64 policy_number: type: string first_name: type: string middle_name: type: string last_name: type: string email_address: type: string email_address_hash: type: string phone_number: type: string street: type: string city: type: string postal_code: type: string country: maxLength: 2 minLength: 2 type: string state: $ref: "#/components/schemas/State" customer: $ref: "#/components/schemas/Customer" policy_status: $ref: "#/components/schemas/PolicyStatus" issued_date: type: string format: date-time nullable: true expiration_date: type: string format: date-time nullable: true effective_date: type: string format: date-time nullable: true quote_date: type: string format: date-time product: $ref: "#/components/schemas/Product" policy_attributes: type: object gross_insurance_price: minimum: 1 type: integer format: int64 endorsement_price_changes: type: integer format: int64 endorsement_tax_fee_changes: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" subscription_premium: $ref: "#/components/schemas/SubscriptionPremium" not_eligible_reason: type: array nullable: true items: $ref: "#/components/schemas/NotEligibleReason" currency: $ref: "#/components/schemas/Currency" language: type: string total: type: integer format: int64 taxes_and_fees: type: array items: $ref: "#/components/schemas/OrderItemTaxFee" version: type: integer format: int32 quote_id: type: string is_test: type: boolean metadata: type: object additionalProperties: type: string checkout_url: type: string format: url created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true cancellation_date: type: string format: date-time nullable: true cancellation_reason: type: string nullable: true external: type: boolean requires_subscription: type: boolean birth_date: type: string format: date tax_identifier: type: string description: SHA256 hash of the tax identifier (e.g. SSN). PrerequisiteConfirmationResponse.FailureResponse: type: object properties: success: type: boolean example: false message: type: string PrerequisiteConfirmationResponse.SuccessResponse: type: object properties: success: type: boolean ProbateBondPolicyAttributes: required: - additional_questions - attorney - bond_amount - bond_start_date - bond_type - case_number - jurisdiction type: object properties: decedent_left_valid_will_specified: type: boolean bond_amount: minimum: 0 exclusiveMinimum: true type: integer description: Required bond amount in cents format: int64 case_number: minLength: 1 type: string description: Court case number / identifier bond_start_date: type: string format: date jurisdiction: type: object description: Jurisdiction of the case allOf: - $ref: "#/components/schemas/ProbateBondPolicyAttributes.Jurisdiction" - type: object bond_type: $ref: "#/components/schemas/ProbateType" attorney: $ref: "#/components/schemas/ProbateBondPolicyAttributes.AttorneyInformation" additional_questions: $ref: "#/components/schemas/ProbateBondPolicyAttributes.AdditionalQuestions" ProbateBondPolicyAttributes.AdditionalQuestions: required: - fcra_consent_acknowledged - has_disputes_among_heirs - identity_attestation_acknowledged - indebted_to_estate - privacy_disclosure_acknowledged - replacing_bond_from_surety - will_operate_ongoing_business type: object properties: decedent_left_valid_will: type: boolean description: Did the decedent leave a valid will? has_adverse_legal_or_financial_history: type: boolean description: "Are you subject to any bankruptcies, lawsuits, felony convictions,\ \ judgements, or liens — either personally or related to this case?" replacing_bond_from_surety: type: boolean description: Is this bond replacing a bond from another surety company? indebted_to_estate: type: boolean description: "Are you indebted to the estate, trust, ward, or protected\ \ person named in this case?" will_operate_ongoing_business: type: boolean description: "Will you continue to operate an ongoing business on behalf\ \ of the estate, trust, ward, or protected person?" has_disputes_among_heirs: type: boolean description: "Are there any disputes or objections among heirs, beneficiaries,\ \ or other interested parties regarding your appointment?" ward_age: type: integer description: Age of the ward. Required if `bond_type = GUARDIANSHIP` format: int32 funds_used_for_ward: type: boolean description: Will the funds be used to care for the ward? Required if `bond_type = GUARDIANSHIP` fcra_consent_acknowledged: type: boolean description: FCRA credit consent - I authorize Vi Coverage and the underwriting bond carrier to obtain a soft credit inquiry in my name to provide me with bond quotes. I understand this will not affect my credit score. identity_attestation_acknowledged: type: boolean description: Identity Attestation - I confirm the personal information I provided is accurate and I am the person identified above. privacy_disclosure_acknowledged: type: boolean description: Privacy/FCRA disclosure - I have read and agree to the Privacy Notice and FCRA disclosure. ProbateBondPolicyAttributes.AttorneyInformation: required: - email_address - name type: object properties: name: minLength: 1 type: string description: Name of the attorney email_address: minLength: 1 type: string description: Email address of the attorney format: email phone_number: type: string description: Phone number of the attorney ProbateBondPolicyAttributes.Jurisdiction: required: - county - state type: object properties: state: minLength: 1 type: string county: minLength: 1 type: string judicial_district: type: string ProbateType: type: string enum: - ESTATE - GUARDIANSHIP Product: type: object properties: id: type: string format: uuid name: $ref: "#/components/schemas/PolicyType" friendly_name: type: string abbreviation: type: string enabled: type: boolean description: type: string peril_heading: type: string perils: type: array items: type: string descriptors: type: array items: type: string promotional_header: type: string promotional_description: type: string accept_action_text: type: string decline_action_text: type: string legal_disclaimer: type: string privacy_policy_url: type: string terms_conditions_url: type: string additional_policy_purchase_email_message: type: string layout: type: string carrier_logo_url: type: string carrier_name: type: string carrier_email: type: string carrier_phone: type: string claims_url: type: string ProjectCategory: type: string enum: - NEW - RENOVATION ProjectScope: type: string enum: - REMODEL - REMODEL_MINOR_STRUCTURAL - RESTRUCTURING PurchaseRequest: required: - payment_method - quotes type: object properties: quotes: minItems: 1 type: array items: type: array items: type: object payment_method: $ref: "#/components/schemas/PaymentMethod" PurchaseRequestPolicy: required: - quote_id type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: quote_id: type: string description: The quote id to purchase PurchaseRequestV1NoAttrs: required: - payment_method - quote_id type: object allOf: - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: payment_method: $ref: "#/components/schemas/PaymentMethod" subscription: type: boolean quote_id: type: string description: The quote id to purchase PurchaseRequestV1_BuildersRiskPolicyAttributes_: required: - payment_method type: object allOf: - $ref: "#/components/schemas/PurchaseRequestPolicy" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: payment_method: $ref: "#/components/schemas/PaymentMethod" subscription: type: boolean PurchaseRequestV1_EventHostCancellationPPPolicyAttributes_: required: - payment_method type: object allOf: - $ref: "#/components/schemas/PurchaseRequestPolicy" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: payment_method: $ref: "#/components/schemas/PaymentMethod" subscription: type: boolean PurchaseRequestV1_EventHostCancellationPolicyAttributes_: required: - payment_method type: object allOf: - $ref: "#/components/schemas/PurchaseRequestPolicy" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: payment_method: $ref: "#/components/schemas/PaymentMethod" subscription: type: boolean PurchaseRequestV1_EventHostLiabilityPolicyAttributes_: required: - payment_method type: object allOf: - $ref: "#/components/schemas/PurchaseRequestPolicy" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: payment_method: $ref: "#/components/schemas/PaymentMethod" subscription: type: boolean PurchaseRequestV1_EventHostLiabilityRentalCoveragePolicyAttributes_: required: - payment_method type: object allOf: - $ref: "#/components/schemas/PurchaseRequestPolicy" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: payment_method: $ref: "#/components/schemas/PaymentMethod" subscription: type: boolean PurchaseRequestV1_MembershipInsurancePolicyAttributes_: required: - payment_method type: object allOf: - $ref: "#/components/schemas/PurchaseRequestPolicy" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: payment_method: $ref: "#/components/schemas/PaymentMethod" subscription: type: boolean PurchaseRequestV1_PetInsurancePolicyAttributesV1_: required: - payment_method type: object allOf: - $ref: "#/components/schemas/PurchaseRequestPolicy" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: payment_method: $ref: "#/components/schemas/PaymentMethod" subscription: type: boolean PurchaseRequestV1_RegistrationCancellationPolicyAttributes_: required: - payment_method type: object allOf: - $ref: "#/components/schemas/PurchaseRequestPolicy" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: payment_method: $ref: "#/components/schemas/PaymentMethod" subscription: type: boolean PurchaseRequestV1_ShippingInsurancePolicyAttributes_: required: - payment_method type: object allOf: - $ref: "#/components/schemas/PurchaseRequestPolicy" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: payment_method: $ref: "#/components/schemas/PaymentMethod" subscription: type: boolean PurchaseRequestV1_TeamRegistrationPolicyAttributes_: required: - payment_method type: object allOf: - $ref: "#/components/schemas/PurchaseRequestPolicy" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: payment_method: $ref: "#/components/schemas/PaymentMethod" subscription: type: boolean PurchaseRequestV1_TicketRefundPolicyAttributes_: required: - payment_method type: object allOf: - $ref: "#/components/schemas/PurchaseRequestPolicy" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: payment_method: $ref: "#/components/schemas/PaymentMethod" subscription: type: boolean PurchaseRequestV1_TravelInsurancePolicyAttributes_: required: - payment_method type: object allOf: - $ref: "#/components/schemas/PurchaseRequestPolicy" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: payment_method: $ref: "#/components/schemas/PaymentMethod" subscription: type: boolean PurchaseRequestV1_TuitionInsurancePolicyAttributes_: required: - payment_method type: object allOf: - $ref: "#/components/schemas/PurchaseRequestPolicy" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" - type: object properties: payment_method: $ref: "#/components/schemas/PaymentMethod" subscription: type: boolean QuoteRequestV2_BookingProtectionQuoteAttributes_: required: - attributes type: object properties: partner_id: type: string nullable: true customer: $ref: "#/components/schemas/PolicyRequestCustomer" metadata: type: object additionalProperties: type: string offer_id: type: string format: uuid nullable: true attributes: $ref: "#/components/schemas/BookingProtectionQuoteAttributes" currency: nullable: true allOf: - $ref: "#/components/schemas/Currency" QuoteRequestV2_PetInsuranceQuoteAttributes_: required: - attributes type: object properties: partner_id: type: string nullable: true customer: $ref: "#/components/schemas/PolicyRequestCustomer" metadata: type: object additionalProperties: type: string offer_id: type: string format: uuid nullable: true attributes: $ref: "#/components/schemas/PetInsuranceQuoteAttributes" currency: nullable: true allOf: - $ref: "#/components/schemas/Currency" QuoteRequestV2_RentersQuoteRequestAttributes_: required: - attributes type: object properties: partner_id: type: string nullable: true customer: $ref: "#/components/schemas/PolicyRequestCustomer" metadata: type: object additionalProperties: type: string offer_id: type: string format: uuid nullable: true attributes: $ref: "#/components/schemas/RentersQuoteRequestAttributes" currency: nullable: true allOf: - $ref: "#/components/schemas/Currency" QuoteRequestV2_TravelInsuranceQuoteAttributes_: required: - attributes type: object properties: partner_id: type: string nullable: true customer: $ref: "#/components/schemas/PolicyRequestCustomer" metadata: type: object additionalProperties: type: string offer_id: type: string format: uuid nullable: true attributes: $ref: "#/components/schemas/TravelInsuranceQuoteAttributes" currency: nullable: true allOf: - $ref: "#/components/schemas/Currency" QuoteRequest_BuildersRiskPolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_BuildersRiskPolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_CollectiblesInsurancePolicyAttributesV2_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_CollectiblesInsurancePolicyAttributesV2.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_EventDepositCancellationPolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_EventDepositCancellationPolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_EventExhibitorLiabilityPolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_EventExhibitorLiabilityPolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_EventHostCancellationPPPolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_EventHostCancellationPPPolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_EventHostCancellationPolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_EventHostCancellationPolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_GapMedicalPolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_GapMedicalPolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_HuntingLeaseLiabilityPolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_HuntingLeaseLiabilityPolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_MembershipInsurancePolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_MembershipInsurancePolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_RegistrationCancellationPolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_RegistrationCancellationPolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_ShippingInsurancePolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_ShippingInsurancePolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_StayToPlayPolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_StayToPlayPolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_TeamRegistrationPolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_TeamRegistrationPolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_TicketRefundPolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_TicketRefundPolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_TravelInsurancePolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_TravelInsurancePolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteRequest_TuitionInsurancePolicyAttributes_: type: object allOf: - $ref: "#/components/schemas/AbstractQuoteRequest_TuitionInsurancePolicyAttributes.PolicyRequestCustomer_" - $ref: "#/components/schemas/PolicyRequest_PolicyRequestCustomer_" QuoteResponseV2: type: object properties: offer_id: type: string format: uuid decisions: type: array items: $ref: "#/components/schemas/Decision" QuoteShortLinkResponse: type: object properties: id: type: string product_code: type: string search_params: type: string url: type: string partner_url_identifier: type: string Recommendation: required: - enabled type: object properties: message: type: string nullable: true enabled: type: boolean RegistrationCancellationPolicyAttributes: title: RegistrationCancellationPolicyAttributes type: object allOf: - $ref: "#/components/schemas/OrganizationCancellationPolicyAttributes" - $ref: "#/components/schemas/ParticipantCancellationPolicyAttributes" - $ref: "#/components/schemas/EventPolicyAttributes" RentalType: type: string enum: - SINGLE_FAMILY_HOME RentersQuoteRequestAttributes: $ref: "#/components/schemas/BaseRentersPolicyAttributes" RoomBlockConfirmationRequest: type: object allOf: - $ref: "#/components/schemas/RoomBlockUnderwritingRequest" - type: object properties: enabled: type: boolean RoomBlockConfirmationResponse: type: object properties: event_id: type: string format: uuid enabled: type: boolean rate: type: number format: double RoomBlockEvent: required: - address - city - country - end_date - name - postal_code - start_date - state - type type: object properties: name: minLength: 1 type: string type: $ref: "#/components/schemas/StayToPlayEventType" address: minLength: 1 type: string city: minLength: 1 type: string state: minLength: 1 type: string description: 2-digit state code example: MN postal_code: minLength: 1 type: string country: $ref: "#/components/schemas/Country" start_date: type: string format: date end_date: type: string format: date RoomBlockProtectionAttributes: type: object properties: rate: type: number format: double enabled: type: boolean event_type: $ref: "#/components/schemas/StayToPlayEventType" RoomBlockStatusUpdate: type: object properties: partner_id: type: string enabled: type: boolean RoomBlockUnderwritingRequest: required: - event type: object properties: event: $ref: "#/components/schemas/RoomBlockEvent" partner_id: type: string RoomBlockUnderwritingResponse: type: object properties: rate: type: number format: double description: type: string peril_heading: type: string perils: type: array items: type: string descriptors: type: array items: type: string promotional_header: type: string promotional_description: type: string accept_action_text: type: string decline_action_text: type: string legal_disclaimer: type: string privacy_policy_url: type: string terms_conditions_url: type: string additional_policy_purchase_email_message: type: string layout: type: string ShippingInsurancePolicyAttributes: required: - courier_id - declared_value - shipment_date type: object properties: declared_value: maximum: 7500000 type: integer description: "Value of package in cents. Maximum varies by VID: SH-000003/SH-000004\ \ (7500000 for USPS/FedEx, 200000 for UPS), SH-000005 (2000000 for all\ \ couriers)" format: int64 courier_id: type: integer description: "What courier is handling the package? (USPS = 1, FedEx = 2,\ \ UPS = 3)" format: int32 enum: - 1 - 2 - 3 - 1 - 2 - 3 tracking_number: type: string shipment_date: pattern: yyyy-dd-mm type: string format: date contains: type: array description: "A list of the shipment contents which may require special\ \ coverage. Supported values: alcohol" nullable: true items: type: string Species: type: string enum: - CAT - DOG State: type: object properties: id: type: string format: uuid name: type: string abbreviation: type: string country: type: string default_timezone_offset: type: string type: type: string StayToPlayEventType: type: string enum: - INDOOR - OUTDOOR StayToPlayPolicyAttributes: required: - accommodation - coverage_type - end_date - event_id - insurable_amount - start_date type: object properties: insurable_amount: type: integer format: int64 accommodation: $ref: "#/components/schemas/StayToPlayPolicyAttributes.Accommodation" event_id: type: string format: uuid start_date: type: string format: date end_date: type: string format: date coverage_type: $ref: "#/components/schemas/StayToPlayPolicyAttributes.CoverageType" organization_name: type: string org_contact_name: type: string org_contact_email: type: string StayToPlayPolicyAttributes.Accommodation: required: - address - name - reservation_number type: object properties: name: type: string address: $ref: "#/components/schemas/StayToPlayPolicyAttributes.Address" reservation_number: type: string StayToPlayPolicyAttributes.Address: required: - city - state - street - zip type: object properties: street: type: string city: type: string state: type: string zip: type: string StayToPlayPolicyAttributes.CoverageType: type: string enum: - COMMISSION - REBATE - ALL Subscription: type: object properties: id: type: string format: uuid status: type: string payment_method: type: string payment_provider: type: string customer_id: type: string format: uuid start_date: type: string format: date payments_required: type: integer format: int64 payment_amount: type: integer format: int64 orders: type: array items: $ref: "#/components/schemas/Order" created_at: type: string format: date-time nullable: true updated_at: type: string format: date-time nullable: true SubscriptionPremium: type: object properties: payments_required: type: integer description: The number of monthly payments required for this subscription format: int64 payment_amount: type: integer description: The monthly premium to be paid for this subscription format: int64 can_cancel: type: boolean description: Can cancel the subscription at any time TeamRegistrationPolicyAttributes: required: - event - organization_name - teams type: object properties: insurable_amount_currency: type: object description: Currency of the insurable amount allOf: - $ref: "#/components/schemas/Currency" - type: object default: USD organization_name: type: string org_contact_name: type: string nullable: true org_contact_email: type: string nullable: true teams: type: array items: $ref: "#/components/schemas/TeamRegistrationPolicyAttributes.Team" event: $ref: "#/components/schemas/TeamRegistrationPolicyAttributes.Event" TeamRegistrationPolicyAttributes.Address: required: - city - state - street - zip type: object properties: street: type: string city: type: string state: type: string zip: type: string TeamRegistrationPolicyAttributes.Event: required: - address - event_end_date - event_start_date - location - name - type type: object properties: name: type: string type: type: string location: type: string address: $ref: "#/components/schemas/TeamRegistrationPolicyAttributes.Address" event_start_date: type: string format: date event_end_date: type: string format: date TeamRegistrationPolicyAttributes.Team: required: - insurable_amount - team_name type: object properties: insurable_amount: minimum: 1 type: integer format: int64 team_name: type: string TicketRefundPolicyAttributes: $ref: "#/components/schemas/EventPolicyAttributes" TokenResponse: type: object properties: secret: type: string TransactionStatus: type: string enum: - PENDING - FAILED - COMPLETED - REFUND_PENDING TransactionType: type: string enum: - REFUND - CHARGE - CHARGEBACK - REALLOCATION TravelCategory: type: string enum: - LODGING TravelInsurancePolicyAttributes: required: - coverage_type - destination_countries - trip_cost - trip_end_date - trip_start_date type: object properties: trip_cost: type: integer format: int64 trip_cost_currency: type: object description: Currency of the trip cost allOf: - $ref: "#/components/schemas/Currency" - type: object default: USD birth_date: type: string description: The birth date of the primary traveler. format: date trip_start_date: type: string format: date trip_end_date: type: string format: date initial_deposit_date: type: string description: Date on which payment or initial deposit was made for the trip. format: date origin: $ref: "#/components/schemas/TravelInsurancePolicyAttributes.TravelLocation" destination_countries: type: array items: type: string additional_travelers: type: array items: $ref: "#/components/schemas/TravelInsurancePolicyAttributes.Traveler" coverage_type: type: string enum: - BASIC - BASIC_CFAR - COMPREHENSIVE - COMPREHENSIVE_CFAR includes_cancel_for_any_reason: type: boolean readOnly: true TravelInsurancePolicyAttributes.OriginCountry: type: string enum: - US - CA TravelInsurancePolicyAttributes.TravelLocation: required: - country - state type: object properties: state: type: string country: $ref: "#/components/schemas/TravelInsurancePolicyAttributes.OriginCountry" TravelInsurancePolicyAttributes.Traveler: type: object properties: first_name: type: string middle_name: type: string last_name: type: string TravelInsuranceQuoteAttributes: required: - destination_countries - trip_cost - trip_end_date - trip_start_date type: object properties: trip_cost: type: integer format: int64 trip_cost_currency: type: object description: Currency of the trip cost allOf: - $ref: "#/components/schemas/Currency" - type: object default: USD birth_date: type: string description: The birth date of the primary traveler. format: date trip_start_date: type: string format: date trip_end_date: type: string format: date initial_deposit_date: type: string description: Date on which payment or initial deposit was made for the trip. format: date origin: $ref: "#/components/schemas/TravelInsurancePolicyAttributes.TravelLocation" destination_countries: type: array items: type: string additional_travelers: type: array items: $ref: "#/components/schemas/TravelInsurancePolicyAttributes.Traveler" coverage_types: type: array description: "When non-empty, only quotes for these coverage types are returned.\ \ Each value must be one of BASIC, COMPREHENSIVE, COMPREHENSIVE_CFAR.\ \ When null or empty, all applicable coverage types are quoted." nullable: true items: type: string TuitionInsurancePolicyAttributes: required: - school - student - term_end_date - term_start_date - tuition_amount type: object properties: tuition_amount: type: integer format: int64 payment_plan: type: boolean term_start_date: type: string format: date term_end_date: type: string format: date external_student_id: type: string student: $ref: "#/components/schemas/TuitionInsurancePolicyAttributes.Student" school: $ref: "#/components/schemas/TuitionInsurancePolicyAttributes.School" TuitionInsurancePolicyAttributes.School: required: - name - postal_code - state type: object properties: client_id: type: string description: "Vertical Insure Client Id for the school, if known, null otherwise" format: uuid name: minLength: 1 type: string street: type: string city: type: string state: minLength: 1 type: string description: state example: MN postal_code: minLength: 1 type: string description: postal code example: "55401" is_tuition_protection_required: type: boolean description: Whether tuition protection is required for this school default: false school_contact_email: type: string description: "School contact email, can be a comma separated list of email\ \ addresses" school_contact_first_name: type: string description: School contact first name school_contact_last_name: type: string description: School contact last name TuitionInsurancePolicyAttributes.Student: required: - birth_date - first_name - last_name type: object properties: first_name: minLength: 1 type: string last_name: minLength: 1 type: string birth_date: type: string format: date UnderwriteExhibitorLiabilityEventResponse: required: - event - event_token type: object properties: event: $ref: "#/components/schemas/ExhibitorLiabilityEvent" event_token: type: string UpdateVendorStatusRequest: required: - status type: object properties: status: type: object description: "New status for the vendor, can be COIManualReviewApproved\ \ or COIManualReviewRejected" example: COIManualReviewApproved allOf: - $ref: "#/components/schemas/VendorStatus" - type: object description: Request to update vendor status VendorStatus: type: string enum: - COIValid - COIManualReview - COIManualReviewRejected - COIManualReviewApproved - OfferAccept - OfferDecline - OfferPurchased - CompleteLater - OfferPurchaseCanceled WebHookEventName: type: string enum: - policy_bind_complete - policy_documents_generated - policy_canceled - policy_purchase_invalid - policy_endorsed - policy_bind_failed - policy_payment_failed - payout_report_published - payout_payment_sent x-enum-varnames: - policy_bind_complete - policy_documents_generated - policy_canceled - policy_purchase_invalid - policy_endorsed - policy_bind_failed - policy_payment_failed - payout_report_published - payout_payment_sent Webhook: type: object properties: events: type: array items: $ref: "#/components/schemas/WebHookEventName" id: type: string format: uuid webhook: type: string format: url example: https://www.example.com/my-webhook signature_key: type: string example: wh_AsDfASjklh123hGh3asHDgfdDfgh platform_level: type: boolean version: type: integer format: int32 created_at: type: string format: date-time Webhook.MinimalWebHook: type: object properties: id: type: string format: uuid webhook: type: string format: url example: https://www.example.com/my-webhook description: |- These exist for documentation purposes only. See [Add support for @JsonView](https://github.com/micronaut-projects/micronaut-openapi/issues/797) Webhook.MinimalWebhookResponse: type: object properties: content: type: array items: $ref: "#/components/schemas/Webhook.MinimalWebHook" WebhookCreateRequest: required: - events - webhook type: object properties: webhook: type: string format: url example: https://www.example.com/my-webhook events: minItems: 1 type: array items: $ref: "#/components/schemas/WebHookEventName" platform_level: type: boolean description: "When true, this webhook fires for events from this partner\ \ and all sub-partners in the tree" WebhookUpdateRequest: type: object properties: webhook: type: string format: url events: type: array items: $ref: "#/components/schemas/WebHookEventName" platform_level: type: boolean securitySchemes: basic auth: type: http description: | `Authorization` header with value of `Basic ` where the `auth string` value is a base64 encoded string of `:` scheme: basic customer-client-secret: type: apiKey name: id in: query partner-client-secret: type: http description: | `Authorization` header with value of `Bearer ` where `` is a JWT token obtained from `/v1/auth/partner/secret` scheme: bearer bearerFormat: JWT x-api-client-id: type: apiKey description: '`x-api-client-id` header with the value of your `client id`. This method can only be used in limited requests such as quoting.' name: x-api-client-id in: header