Freshtix

Create booking

POST /api/partners/{partner_id}/quotes/{quote_id}/bookings

The Create Booking API endpoint allows partners to convert a quote into a booking. Partners can provide necessary details about the policyholder and insured parties to finalise the booking process. This endpoint requires a valid access token obtained from the Authentication.

Path parameters

Parameter	Type	Description
partner_id	string	The partner identifier provided during onboarding
quote_id	string	Unique identifier of the quote returned in the widget

Headers

Name	Value
Accept	application/json
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
policy_holder.first_name	string	First name
policy_holder.last_name	string	Last name
policy_holder.country	string	Two letters country code
policy_holder.email	string	Email address
policy_holder.phone	string	Phone number
policy_holder.address1	string	Address line 1
policy_holder.address2	string	Address line 2
policy_holder.city	string	City of residence
policy_holder.region	string	Region
policy_holder.postcode	string	Postcode
quotes	array
quotes[].id	string	Unique identifier of the quote policy
quotes[].brightwrite_details.bw_experiment_id	string	ID of the BrightWrite experiment
quotes[].brightwrite_details.bw_variant_id	string	ID of the experiment variant generated for the customer
quotes[].brightwrite_details.bw_device_id	string	ID of the customer device
quotes[].insured	array	A list of insured
quotes[].insured[].first_name	string	First name
quotes[].insured[].last_name	string	Last name
quotes[].insured[].email	string	Email address
quotes[].insured[].country	string	Two letters country code
quotes[].insured[].address1	string	Address line 1
quotes[].insured[].address2	string	Address line 2
quotes[].insured[].city	string	City of residence
quotes[].insured[].region	string	Region
quotes[].insured[].postcode	string	Postcode
quotes[].insured[].phone	string	Phone number
quotes[].insured[].birth_date	string	Date of birth
quotes[].insured[].company	string	Company name

{
    "policy_holder": {
        "first_name": "Kaitlin",
        "last_name": "Brown",
        "country": "AU",
        "email": "[email protected]",
        "phone": "[phone]",
        "address1": "50827 Halvorson Way"
        "city": "Sydney",
        "region": "NSW",
        "postcode": "68988-3838"
    },
    "quotes": [
        {
            "id": "9696f4be-0938-4e1e-9915-b8caf116b223",
            "insured":
            [
                {
                    "first_name": "Kaitlin",
                    "last_name": "Brown",
                    "email": "[email protected]",
                    "country": "AU",
                    "address1": "50827 Halvorson Way",
                    "city": "Sydney",
                    "region": "NSW",
                    "postcode": "68988-3838",
                    "phone": "[phone]",
                    "birth_date": "1953-06-23",
                    "company": "Gibson LLC"
                }
            ]
        }
    ]
}

Response

🟢 201

{
    "data": {
        "provider_reference": "NULKR-DDKPL-INS",
        "language": "en-us",
        "provider_customer_id": null,
        "status": "Active",
        "currency": "USD",
        "price": 59.64,
        "security_token": "kzEuw-7g4XC-rE68C-2btrf",
        "created_at": "2024-08-29T00:10:06.000000Z",
        "updated_at": "2024-08-29T00:10:06.000000Z",
        "is_instant_booking": false,
        "policies": [
            {
                "status": "Active",
                "policy_start_date": "2024-08-29T00:00:00.000000Z",
                "policy_end_date": "2024-09-28T00:00:00.000000Z",
                "price": 59.64,
                "tax": 0,
                "commission": 34.08,
                "cover_amount": null,
                "policy_type": "event_ticket_protection",
                "policy_code": "FTMUSV01",
                "policy_version": "a7a8ee25-19fd-492a-9b96-e3d6ce402b26",
                "policy_content": {
                    "title": "Booking Refund Protection",
                    "header": null,
                    "description": "N/A",
                    "optout_msg": "",
                    "inclusions": [],
                    "exclusions": [],
                    "disclaimer": "This refund protection product is administered by XCover. By clicking the button you agree that you have read and accept the terms and conditions.",
                    "disclaimer_html": "<p data-block-key=\"cgh44\">This refund protection product is administered by XCover. By clicking the button you agree that you have read and accept the <a href=\"https://www.xcover.com/en-us/pds/NULKR-DDKPL-INS?policy_type=event_ticket_protection_v1\" rel=\"noopener noreferrer\" target=\"_blank\">terms and conditions.</a></p>",
                    "payment_disclaimer": "",
                    "in_path_disclaimer": "",
                    "extra_content": []
                },
                "claim_selector_id": null,
                "pds_url": "https://www.xcover.com/en-us/pds/NULKR-DDKPL-INS?policy_type=event_ticket_protection_v1",
                "extra_fields": {
                    "seller_entity": "Cover Genius Insurance Services LLC",
                    "event_datetime": "2024-09-28T00:09:55.502Z",
                    "event_cost": "852",
                    "retail_price": "59.64000000000000567546010188",
                    "uw_fee": "4.792499999999999822641871816",
                    "reinsurer_fee": "14.37749999999999946792561545",
                    "partner_commission": "34.08000000000000070943251274",
                    "coverage_group": "US-Plan A",
                    "cg_booking_fee": "6.38999999999999999999999999"
                },
                "confirmed_at": "2024-08-29T00:10:05.000000Z",
                "cancelled_at": null,
                "created_at": "2024-08-29T00:10:06.000000Z",
                "updated_at": "2024-08-29T00:10:06.000000Z",
                "id": "dd50d4eb-9ce0-4737-8d0c-39ac068c23de"
            }
        ],
        "policyholder": {
            "first_name": "Kaitlin",
            "last_name": "Brown",
            "email": "[email protected]",
            "phone": "[phone]",
            "country": "US",
            "date_of_birth": null,
            "address1": "50827 Halvorson Way",
            "address2": null,
            "city": "Sydney",
            "region": "NSW",
            "postcode": "68988-3838",
            "created_at": "2024-08-29T00:10:06.000000Z",
            "updated_at": "2024-08-29T00:10:06.000000Z",
            "id": "dce3cebe-2281-439f-aba1-94fac7cd5a33"
        },
        "id": "874b9dea-9df2-40f8-80a8-6e639708bbff",
        "partner": {
            "uuid": "723a4302-cd8d-4bd4-b012-486525167b4b",
            "name": "Freshtix"
        },
        "quote": {
            "uuid": "89c653ef-233c-472a-9f97-fdbde40d965f"
        },
        "cancellations": []
    }
}

🔴 401

{
    "message": "Unauthenticated."
}

🔴 422

{
    "message": "The request is invalid."
}