Purchase & Bind Policies
Batch Purchase
Purchases multiple quotes. All quotes must be in QUOTED state and of the same product.
AuthorizationBasic <token>
Authorization header with value of Basic <auth string> where the auth string value
is a base64 encoded string of <client id>:<client secret>
In: header
Path Parameters
productCodestring
Value in
"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"quotes
Items
1 <= itemspayment_method
Only one of a card, bank_account or token payment is required.
Response Body
application/json
application/json
application/json
curl -X POST "https://api.verticalinsure.com/v1/purchase/event-participation-cancellation-insurance/batch" \ -H "Content-Type: application/json" \ -d '{ "quotes": [ { "customer": { "email_address": "user@example.com", "first_name": "string", "last_name": "string" }, "quote_id": "string" } ], "payment_method": {} }'[
{
"policy_holder": {
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string",
"street": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string"
},
"policy_attributes": {},
"policy_number": "string",
"partner": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "STANDARD",
"legal_business_name": "string",
"dba_name": "string",
"business_structure": "sole_proprietorship",
"email_address": "user@example.com",
"billing_email_address": "user@example.com",
"tax_identifier": "string",
"tax_identifier_verified": true,
"address": "string",
"city": "string",
"state": "string",
"zip_code": "string",
"country": "US",
"phone_number": "string",
"website": "string",
"industry": "string",
"refund_policy_url": "string",
"business_name": "string",
"status": "ACTIVE",
"partner_parent_id": "984844d9-4acc-441e-927d-8066c099157c",
"theme_mode": true,
"portal_purchase_enabled": true,
"pre_transaction_fee_commission": true,
"url_identifier": "string",
"vertical": "youth_sports",
"activation_date": "2019-08-24T14:15:22Z",
"is_test": true,
"travel_retailer_onboarding_complete": true,
"integrated_payments": true,
"client_clip_enabled": true,
"logo": "string"
},
"policy_documents": [
{
"document_type": "POLICY",
"url": "string"
}
],
"policy_status": "ACTIVE",
"issued_date": "2019-08-24T14:15:22Z",
"expiration_date": "string",
"effective_date": "string",
"quote_date": "2019-08-24T14:15:22Z",
"product": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "event-participation-cancellation-insurance",
"friendly_name": "string",
"abbreviation": "string",
"enabled": true,
"description": "string",
"peril_heading": "string",
"perils": [
"string"
],
"descriptors": [
"string"
],
"promotional_header": "string",
"promotional_description": "string",
"accept_action_text": "string",
"decline_action_text": "string",
"legal_disclaimer": "string",
"privacy_policy_url": "string",
"terms_conditions_url": "string",
"additional_policy_purchase_email_message": "string",
"carrier_logo_url": "string",
"carrier_name": "string",
"carrier_email": "string",
"carrier_phone": "string",
"claims_url": "string"
},
"endorsement_price_changes": 0,
"subscription_premium": {
"payments_required": 0,
"payment_amount": 0,
"can_cancel": true
},
"currency": "USD",
"language": "string",
"total": 0,
"taxes_and_fees": [
{
"order_item_transaction": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy": {
"type": "POLICY",
"premium_amount": 50,
"premium_amount_to_show": 0,
"policy_number": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string",
"street": "string",
"city": "string",
"postal_code": "string",
"country": "st",
"state": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"abbreviation": "string",
"country": "string",
"default_timezone_offset": "string",
"type": "string"
},
"customer": {
"email_address": "user@example.com",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"policy_status": "ACTIVE",
"issued_date": "2019-08-24T14:15:22Z",
"expiration_date": "2019-08-24T14:15:22Z",
"effective_date": "2019-08-24T14:15:22Z",
"quote_date": "2019-08-24T14:15:22Z",
"product": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "event-participation-cancellation-insurance",
"friendly_name": "string",
"abbreviation": "string",
"enabled": true,
"description": "string",
"peril_heading": "string",
"perils": [
"string"
],
"descriptors": [
"string"
],
"promotional_header": "string",
"promotional_description": "string",
"accept_action_text": "string",
"decline_action_text": "string",
"legal_disclaimer": "string",
"privacy_policy_url": "string",
"terms_conditions_url": "string",
"additional_policy_purchase_email_message": "string",
"carrier_logo_url": "string",
"carrier_name": "string",
"carrier_email": "string",
"carrier_phone": "string",
"claims_url": "string"
},
"policy_attributes": {},
"gross_insurance_price": 50,
"endorsement_price_changes": 0,
"subscription_premium": {
"payments_required": 0,
"payment_amount": 0,
"can_cancel": true
},
"currency": "USD",
"language": "string",
"total": 0,
"taxes_and_fees": [
{
"order_item_transaction": {},
"amount": 0,
"description": "string",
"type": "fee",
"included_in_premium": true,
"per_subscription_charge": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"version": 0,
"quote_id": "string",
"is_test": true,
"metadata": {
"property1": "string",
"property2": "string"
},
"checkout_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z"
},
"order": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"customer": {
"email_address": "user@example.com",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"order_item_transactions": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy": {
"type": "POLICY",
"premium_amount": 50,
"premium_amount_to_show": 0,
"policy_number": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string",
"street": "string",
"city": "string",
"postal_code": "string",
"country": "st",
"state": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"abbreviation": "string",
"country": "string",
"default_timezone_offset": "string",
"type": "string"
},
"customer": {
"email_address": "user@example.com",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"policy_status": "ACTIVE",
"issued_date": "2019-08-24T14:15:22Z",
"expiration_date": "2019-08-24T14:15:22Z",
"effective_date": "2019-08-24T14:15:22Z",
"quote_date": "2019-08-24T14:15:22Z",
"product": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "event-participation-cancellation-insurance",
"friendly_name": "string",
"abbreviation": "string",
"enabled": true,
"description": "string",
"peril_heading": "string",
"perils": [
"string"
],
"descriptors": [
"string"
],
"promotional_header": "string",
"promotional_description": "string",
"accept_action_text": "string",
"decline_action_text": "string",
"legal_disclaimer": "string",
"privacy_policy_url": "string",
"terms_conditions_url": "string",
"additional_policy_purchase_email_message": "string",
"carrier_logo_url": "string",
"carrier_name": "string",
"carrier_email": "string",
"carrier_phone": "string",
"claims_url": "string"
},
"policy_attributes": {},
"gross_insurance_price": 50,
"endorsement_price_changes": 0,
"subscription_premium": {
"payments_required": 0,
"payment_amount": 0,
"can_cancel": true
},
"currency": "USD",
"language": "string",
"total": 0,
"taxes_and_fees": [
{
"order_item_transaction": {},
"amount": 0,
"description": "string",
"type": "fee",
"included_in_premium": true,
"per_subscription_charge": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"version": 0,
"quote_id": "string",
"is_test": true,
"metadata": {
"property1": "string",
"property2": "string"
},
"checkout_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z"
},
"order": {},
"taxes_and_fees": [
{
"order_item_transaction": {},
"amount": 0,
"description": "string",
"type": "fee",
"included_in_premium": true,
"per_subscription_charge": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"item_total": 0,
"taxes_and_fees_amount": 0,
"item_sub_total": 0,
"estimated_allocated_transaction_fee": 0,
"chargeback_fee": 0,
"ar_accounting_period": "string",
"co_accounting_period": "string",
"transaction_status": "PENDING",
"transaction_type": "REFUND",
"transaction_amount": 0,
"payment_type": "CC",
"processor": "justifi",
"estimated_processor_transaction_fee": 0,
"processor_payment_method_id": "string",
"processor_payment_id": "string",
"processor_payout_id": "string",
"processor_payout_date": "2019-08-24T14:15:22Z",
"processor_account_id": "string",
"source_total": 0,
"source_currency": "USD",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"subscription": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"status": "string",
"payment_method": "string",
"payment_provider": "string",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"start_date": "2019-08-24",
"payments_required": 0,
"payment_amount": 0,
"orders": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"customer": {
"email_address": "user@example.com",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"order_item_transactions": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"policy": {
"type": "POLICY",
"premium_amount": 50,
"premium_amount_to_show": 0,
"policy_number": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email_address": "string",
"phone_number": "string",
"street": "string",
"city": "string",
"postal_code": "string",
"country": "st",
"state": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"abbreviation": "string",
"country": "string",
"default_timezone_offset": "string",
"type": "string"
},
"customer": {
"email_address": "user@example.com",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"policy_status": "ACTIVE",
"issued_date": "2019-08-24T14:15:22Z",
"expiration_date": "2019-08-24T14:15:22Z",
"effective_date": "2019-08-24T14:15:22Z",
"quote_date": "2019-08-24T14:15:22Z",
"product": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "event-participation-cancellation-insurance",
"friendly_name": "string",
"abbreviation": "string",
"enabled": true,
"description": "string",
"peril_heading": "string",
"perils": [
"string"
],
"descriptors": [
"string"
],
"promotional_header": "string",
"promotional_description": "string",
"accept_action_text": "string",
"decline_action_text": "string",
"legal_disclaimer": "string",
"privacy_policy_url": "string",
"terms_conditions_url": "string",
"additional_policy_purchase_email_message": "string",
"carrier_logo_url": "string",
"carrier_name": "string",
"carrier_email": "string",
"carrier_phone": "string",
"claims_url": "string"
},
"policy_attributes": {},
"gross_insurance_price": 50,
"endorsement_price_changes": 0,
"subscription_premium": {
"payments_required": 0,
"payment_amount": 0,
"can_cancel": true
},
"currency": "USD",
"language": "string",
"total": 0,
"taxes_and_fees": [
{
"order_item_transaction": {},
"amount": 0,
"description": "string",
"type": "fee",
"included_in_premium": true,
"per_subscription_charge": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"version": 0,
"quote_id": "string",
"is_test": true,
"metadata": {
"property1": "string",
"property2": "string"
},
"checkout_url": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"cancellation_date": "2019-08-24T14:15:22Z"
},
"order": {},
"taxes_and_fees": [
{
"order_item_transaction": {},
"amount": 0,
"description": "string",
"type": "fee",
"included_in_premium": true,
"per_subscription_charge": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"item_total": 0,
"taxes_and_fees_amount": 0,
"item_sub_total": 0,
"estimated_allocated_transaction_fee": 0,
"chargeback_fee": 0,
"ar_accounting_period": "string",
"co_accounting_period": "string",
"transaction_status": "PENDING",
"transaction_type": "REFUND",
"transaction_amount": 0,
"payment_type": "CC",
"processor": "justifi",
"estimated_processor_transaction_fee": 0,
"processor_payment_method_id": "string",
"processor_payment_id": "string",
"processor_payout_id": "string",
"processor_payout_date": "2019-08-24T14:15:22Z",
"processor_account_id": "string",
"source_total": 0,
"source_currency": "USD",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"subscription": {},
"is_initial_subscription": true,
"total": 0,
"sub_total": 0,
"taxes_and_fees_total": 0,
"currency": "USD",
"status": "REQUIRES_PAYMENT",
"placed_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"failed_payment_notification_count": 0,
"failed_payment_notification_last_sent": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_test": true
}
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"is_initial_subscription": true,
"total": 0,
"sub_total": 0,
"taxes_and_fees_total": 0,
"currency": "USD",
"status": "REQUIRES_PAYMENT",
"placed_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z",
"failed_payment_notification_count": 0,
"failed_payment_notification_last_sent": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"is_test": true
},
"taxes_and_fees": [
{
"order_item_transaction": {},
"amount": 0,
"description": "string",
"type": "fee",
"included_in_premium": true,
"per_subscription_charge": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"item_total": 0,
"taxes_and_fees_amount": 0,
"item_sub_total": 0,
"estimated_allocated_transaction_fee": 0,
"chargeback_fee": 0,
"ar_accounting_period": "string",
"co_accounting_period": "string",
"transaction_status": "PENDING",
"transaction_type": "REFUND",
"transaction_amount": 0,
"payment_type": "CC",
"processor": "justifi",
"estimated_processor_transaction_fee": 0,
"processor_payment_method_id": "string",
"processor_payment_id": "string",
"processor_payout_id": "string",
"processor_payout_date": "2019-08-24T14:15:22Z",
"processor_account_id": "string",
"source_total": 0,
"source_currency": "USD",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"amount": 0,
"description": "string",
"type": "fee",
"included_in_premium": true,
"per_subscription_charge": true,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"version": 0,
"quote_id": "string",
"offer_id": "d5a7a5b7-a4a3-49e7-9c69-b44d2cbe15cf",
"distribution_channel": "string",
"is_test": true,
"metadata": {
"property1": "string",
"property2": "string"
},
"checkout_url": "string",
"claims": [
{
"external_id": "string",
"reason": "string",
"status": "PENDING",
"submitted_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"payout_amount": 0
}
]
}
]{
"error": "string",
"error_code": "string",
"message": "string",
"reason": "string",
"status": 0
}{
"error": "string",
"error_code": "string",
"message": "string",
"reason": "string",
"status": 0
}