Instant Booking
The Instant Booking endpoint is available to partners who meet strict criteria outlined by Cover Genius. Please contact your assigned Client Solutions Engineer (CSE) to discuss use of the Instant Booking endpoint.
If a customer has chosen to purchase the insurance product(s) offered through your platform then a call to the Instant Booking endpoint should be issued after the insurance premium has been calculated and payment has been captured.
Make an Instant Booking
POST https://api.xcover.com/x/partners/:partner_id/instant_booking/
The payload consists of information necessary to issue the policy (widely varying depending on policy type) and policyholder information
Path Parameters
| Name | Type | Description |
|---|---|---|
partner_id | string | Unique Partner Code |
Headers
| Name | Type | Description |
|---|---|---|
Content-Type | string | application/json |
Date | string | Current Datetime |
Authorization | string | HMAC Signature |
X-Api-Key | string | API Key |
{
"id": "string",
"status": "string",
"currency": "str",
"total_price": 0,
"total_price_formatted": "string",
"partner_transaction_id": "string",
"created_at": "2021-01-04T17:10:37Z",
"updated_at": "2021-01-04T17:10:37Z",
"pds_url": "http://example.com",
"security_token": "string",
"quotes": [
{
"id": "string",
"policy_start_date": "2021-01-04T17:10:37Z",
"policy_end_date": "2021-01-04T17:10:37Z",
"status": "string",
"price": 0,
"price_formatted": "string",
"policy": {
"policy_type": "string",
"policy_name": "string",
"policy_code": "string",
"policy_version": "string",
"category": "string",
"content": {
"title": "string",
"header": "string",
"description": "string",
"optout_msg": "string",
"inclusions": [
{
"title": "string",
"description": "string"
}
],
"exclusions": [
{
"title": "string",
"description": "string"
}
],
"disclaimer": "string",
"disclaimer_html": "string",
"payment_disclaimer": "string",
"in_path_disclaimer": "string"
},
"underwriter": {
"disclaimer": "string",
"name": "string"
}
},
"insured": [
{
"id": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "[email protected]",
"country": "AF",
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"phone": "string",
"age": 0,
"birth_date": "2021-01-04",
"metadata": {
"property1": "string",
"property2": "string"
},
"company": "string"
}
],
"tax": {
"total_tax": 0,
"total_amount_without_tax": 0,
"total_tax_formatted": "string",
"total_amount_without_tax_formatted": "string",
"taxes": [
{
"tax_amount": 0,
"tax_code": "string",
"tax_amount_formatted": "string"
}
]
},
"duration": "string",
"benefits": [
{
"description": "string",
"limit_description": "string",
"limit": 0,
"limit_policy_currency": 0,
"limit_formatted": "string",
"limit_policy_currency_formatted": "string",
"limit_per_unit": 0,
"limit_per_unit_policy_currency": 0,
"limit_per_unit_formatted": "string",
"limit_per_unit_policy_currency_formatted": "string",
"excess_description": "string",
"excess": 0,
"excess_policy_currency": 0,
"excess_formatted": "string",
"excess_policy_currency_formatted": "string",
"minimum_claim_amount": 0,
"minimum_claim_amount_policy_currency": 0,
"minimum_claim_amount_formatted": "string",
"minimum_claim_amount_policy_currency_formatted": "string"
}
],
"commission": {
"total_commission": 0,
"total_commission_formatted": "string"
},
"created_at": "2021-01-04T17:10:37Z",
"confirmed_at": "2021-01-04T17:10:37Z",
"updated_at": "2021-01-04T17:10:37Z",
"cancelled_at": "2021-01-04T17:10:37Z",
"is_renewable": true,
"cover_amount": 0,
"cover_amount_formatted": "string",
"pds_url": "http://example.com",
"attachments": "string",
"files": "string",
"extra_fields": {
"property1": "string",
"property2": "string"
},
"next_renewal": {
"id": "string",
"package_id": "string",
"quote_id": "string",
"status": "string",
"start_date": "2021-01-04T17:10:37Z",
"notification_date": "2021-01-04T17:10:37Z",
"due_date": "2021-01-04T17:10:37Z",
"expiry_date": "2021-01-04T17:10:37Z",
"cancelled_on": "2021-01-04T17:10:37Z",
"paid_on": "2021-01-04T17:10:37Z",
"created_at": "2021-01-04T17:10:37Z"
},
"can_be_cancelled": true,
"errors": [
"string"
]
}
],
"coi": {
"pdf": "http://example.com",
"url": "http://example.com"
},
"account_url": "http://example.com",
"policyholder": {
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "[email protected]",
"phone": "string",
"country": "AF",
"age": 0,
"address1": "string",
"address2": "string",
"city": "string",
"postcode": "string",
"region": "string",
"secondary_email": "[email protected]",
"birth_date": "2021-01-04",
"company": "string",
"tax_payer_id": "string"
},
"total_tax": 0,
"total_tax_formatted": "string",
"total_premium": 0,
"total_premium_formatted": "string"
}{
"currency": "USD",
"customer_language": "en",
"request": [
{
"policy_type": "parcel_insurance",
"policy_type_version": "1",
"policy_start_date": "2021-03-07T09:25:00+00:00",
"shipping_cost": 0.0,
"order_total": 0.0,
"shipping_date": "2021-03-07T09:25:00+00:00",
"carrier": "Fedex",
"carrier_service_name": "Fedex",
"declared_value": 4000.0,
"delivery_confirmation_type": "None",
"delivery_confirmation_price": 0,
"partner_price": 30.0,
"sender": {
"first_name": "Homer",
"last_name": "Simpson",
"company_name": "The Simpsons LLC",
"address1": "742 Evergreen Terrace",
"city": "Springfield",
"postcode": "98122",
"region": "WA",
"country": "US",
"email": "[email protected]"
},
"receiver": {
"first_name": "Charles Montgomery",
"last_name": "Burns",
"company_name": "Springfield Nuclear Power Plant",
"address1": "100 Industrial Way",
"city": "Sprinfield",
"postcode": "98122",
"region": "WA",
"country": "US",
"email": "[email protected]"
},
"tracking_reference": "SNDR5152",
"tracking_url": "http://www.tracking-example-url.com/tracking/SNDR5152",
"packages": [
{
"declared_value": 4000.0,
"description": "Test",
"type": "Package",
"width": 2.0,
"height": 2.0,
"length": 2.0,
"weight": 1.0,
"items": [],
"tracking_reference": "SNDR5152",
"tracking_url": "http://www.tracking-example-url.com/tracking/SNDR5152"
}
]
}
],
"policyholder": {
"first_name": "Homer",
"last_name": "Simpson",
"address1": "742 Evergreen Terrace",
"city": "Springfield",
"postcode": "98122",
"region": "WA",
"country": "US",
"email": "[email protected]"
}
}
Last updated
