POST Offer

Issues an insurance offer. The products included in the response are dependent on client configuration and eligibility based on the requested coverage.

Request Information

URI Parameters

None.

Body Parameters

The OfferRequest which defines the details of the insurance coverage being requested.

Magnesium.Insurance.Contracts.Offers.OfferRequest

Name	Type	Additional information
Configuration	Magnesium.Insurance.Contracts.Offers.OfferScope	None.
Coverage	Magnesium.Insurance.Contracts.Offers.CoverageRequest	None.
ResponseConstraints	Magnesium.Insurance.Contracts.Offers.OfferConstraints	None.

Request Formats

application/json, text/json, text/html

Sample:

{
  "Configuration": {
    "ClientCode": "SampleClient",
    "Channel": "SampleChannel",
    "BrokerCode": "SampleBroker",
    "ISOCurrency": "CAD"
  },
  "Coverage": {
    "PurchaseDate": "2023-03-27T00:00:00-04:00",
    "PricingDate": "2023-03-27T00:00:00-04:00",
    "SavedQuoteId": null,
    "SavedQuoteCode": null,
    "StartDate": "2023-04-07T00:00:00-04:00",
    "EndDate": "2023-04-17T00:00:00-04:00",
    "TopUpEffectiveDate": null,
    "VehicleCategory": "NONE",
    "TravelDestination": "YVR",
    "DiscountCodes": [
      "SampleDiscountCode"
    ],
    "DeductibleCode": null,
    "ProvinceOfResidence": "ON",
    "PrimaryVisitingProvince": null,
    "Insured": [
      {
        "DateOfBirth": "1993-03-28T00:00:00-05:00",
        "Age": null,
        "CoverageAmount": 500.0,
        "Deductible": 0.0,
        "MedicalSurvey": {
          "SurveyScore": null,
          "ScoringReference": null,
          "VerificationToken": null,
          "MedicalSurveyAnswers": []
        },
        "MedicalSurveyCode": null,
        "PreExs": [],
        "IsPrimaryInsured": true
      }
    ],
    "CoverageCategory": "INDIVIDUAL",
    "TaxExemption": false
  },
  "ResponseConstraints": {
    "Products": [],
    "Categories": []
  }
}

Response Information

Resource Description

An instance providing coverage and pricing details for all products that match the requested configuration and coverage parameters.

Magnesium.Insurance.Contracts.Offers.InsuranceOffer

Name	Type	Additional information
OfferToken	string	None.
Configuration	Magnesium.Insurance.Contracts.Offers.OfferScope	None.
MarketingContent	Magnesium.Insurance.Contracts.Offers.MarketingDetail	None.
OfferCategories	Collection of Magnesium.Insurance.Contracts.Offers.ProductCategory	None.
ExcludedProducts	Collection of Magnesium.Insurance.Contracts.Offers.ProductOffer	None.

Response Formats

application/json, text/json

Sample:

{
  "OfferToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJPZmZlcklkIjoxMjM0NSwiQ2xpZW50IjoiU2FtcGxlQ2xpZW50IiwiQ2hhbm5lbCI6IlNhbXBsZUNoYW5uZWwiLCJCcm9rZXIiOiJTYW1wbGVCcm9rZXIifQ.y2BhPu025JRYvWaGQ_2ChsybhArxGqujjRBUyuv5-80",
  "Configuration": {
    "ClientCode": "SampleClient",
    "Channel": "SampleChannel",
    "BrokerCode": "SampleBroker",
    "ISOCurrency": "CAD"
  },
  "MarketingContent": {
    "InsuranceHeader": "Sample Header",
    "InsuranceDescription": "Sample Description",
    "InsuranceFooter": "Sample Footer"
  },
  "OfferCategories": [
    {
      "Name": "TravelSingleTrip",
      "DisplayName": "Single Trip Plans",
      "Description": "Travel insurance products for a specific trip",
      "Products": [
        {
          "Product": {
            "CertificateUrl": "https://api.allianz-assistance.ca/Offer/Product/SampleClient/SampleProduct/Certificate",
            "DistributionGuideUrl": "https://api.allianz-assistance.ca/Offer/Product/SampleClient/SampleProduct/DistributionGuide",
            "ExclusionsUrl": "https://api.allianz-assistance.ca/Offer/Product/SampleClient/SampleProduct/Exclusions",
            "Description": "Sample Product Description",
            "IsAnnual": false,
            "IsVisitorsToCanada": false,
            "IncludesTripCan": false,
            "IsMedical": false,
            "UseStartDateForEffectiveDate": false,
            "SupportsRenewal": false,
            "CanBeToppedUp": false,
            "CanPurchase": false,
            "CanRenew": false,
            "Commission": {
              "Percentage": 0.0,
              "Description": null
            },
            "Benefits": [
              {
                "Name": "Sample Benefit Name",
                "Limit": "Sample Benefit Limit"
              },
              {
                "Name": "Sample Benefit Name 2",
                "Limit": "Sample Benefit Limit 2"
              }
            ],
            "Consents": [],
            "Appropriateness": null,
            "Name": "Sampple Insurance Product",
            "ProductCode": "SampleProduct"
          },
          "Insured": [
            {
              "InsuredSequence": 0,
              "Insured": {
                "DateOfBirth": "1993-03-28T00:00:00-05:00",
                "Age": null,
                "CoverageAmount": 500.0,
                "Deductible": 0.0,
                "MedicalSurvey": {
                  "SurveyScore": null,
                  "ScoringReference": null,
                  "VerificationToken": null,
                  "MedicalSurveyAnswers": []
                },
                "MedicalSurveyCode": null,
                "PreExs": [],
                "IsPrimaryInsured": true
              },
              "Premium": 0.0,
              "Deductible": null,
              "MedicalSurveyCode": null,
              "ExactPrice": true,
              "IsEligibleForAutoRenewal": true
            }
          ],
          "DeclinedInsured": [],
          "Premium": 110.0,
          "AdminFee": {
            "Amount": 0.0,
            "AdminFeeCode": "",
            "Province": null
          },
          "Tax": 8.8,
          "Total": 118.8,
          "PremiumDetail": {
            "BasePremium": 100.0,
            "Discounts": [
              {
                "Code": "SampleDiscountCode",
                "Description": "Sample Discount Description",
                "AdjustmentPercentage": 0.0,
                "AdjustmentAmount": 10.0
              }
            ],
            "Adjustments": [],
            "AdminFee": {
              "Amount": 0.0,
              "AdminFeeCode": "",
              "Province": null
            },
            "NetPremium": 110.0,
            "Taxes": [
              {
                "AppliesTo": "PREMIUM",
                "CalculationMethod": "AddedToPrice",
                "Province": "ON",
                "Code": "RST",
                "Description": "Retail Sales Tax",
                "AdjustmentPercentage": 8.0,
                "AdjustmentAmount": 8.8
              }
            ],
            "Total": 118.8
          },
          "ExactPrice": true,
          "IsMedicallyUnderwritten": false,
          "IsGHIPLimitExceeded": false,
          "Note": null
        }
      ],
      "ExclusiveProductStream": false
    }
  ],
  "ExcludedProducts": []
}