POST Policy/Purchase

This API issues insurance policies.

Request Information

URI Parameters

None.

Body Parameters

Provides the coverage and payment details for the insurance policy being requested.

Magnesium.Insurance.Contracts.Policy.PolicyRequest

Name	Type	Additional information
Payments	Collection of Magnesium.Insurance.Contracts.Policy.Payment	None.
Notes	Collection of Magnesium.Insurance.Contracts.Policy.Note	None.
Consents	Collection of Magnesium.Insurance.Contracts.Policy.Consent	None.
ClientData	Collection of Magnesium.Insurance.Contracts.Policy.ClientData	None.
Configuration	Magnesium.Insurance.Contracts.Policy.PolicyScope	None.
CurrentCoverage	Magnesium.Insurance.Contracts.Policy.CoverageRequestOfMagnesium.Insurance.Contracts.Policy.InsuredDetail	None.
FulfillmentPreference	Magnesium.Insurance.Contracts.Policy.MethodOfFulfillment	None.
Addresses	Collection of Magnesium.Insurance.Contracts.Policy.Address	None.
Contacts	Collection of Magnesium.Insurance.Contracts.Policy.Contact	None.
Marketing	Magnesium.Insurance.Contracts.Policy.MarketingDetail	None.

Request Formats

application/json, text/json

Sample:

{
  "Payments": [
    {
      "PaymentType": "CREDITCARD",
      "Amount": 45.0,
      "AccountIdentifier": "4111111111111111",
      "PaymentAuthorization": null,
      "TransactionIdentifier": null,
      "PayerName": "Test Tester",
      "PayeeName": null,
      "ExpiryMonth": "03",
      "ExpiryYear": "2024",
      "BillingAddress": {
        "AddressType": "HOME",
        "Address1": "4273 King St. East",
        "Address2": null,
        "City": "Kitchener",
        "Province": "ON",
        "PostalCode": "N2P2E9",
        "Country": "CA",
        "IssueFulfillment": false,
        "FulfillmentLanguage": "en"
      },
      "BillingContact": "5197422800",
      "CreditCardReference": null,
      "Issued": null,
      "Received": null,
      "CVV": "1234"
    }
  ],
  "Notes": [],
  "Consents": [],
  "ClientData": [],
  "Configuration": {
    "Agent": "SampleAgent",
    "ClientCode": "SampleClient",
    "Channel": "SampleChannel",
    "BrokerCode": "SampleBroker",
    "ISOCurrency": "CAD"
  },
  "CurrentCoverage": {
    "Product": "SampleProduct",
    "PurchaseDate": "2023-03-28T00:00:00-04:00",
    "PricingDate": "2023-03-28T00:00:00-04:00",
    "DepositDate": "2023-03-26T00:00:00-04:00",
    "AutoRenewPreference": false,
    "CommissionPercentage": 0.0,
    "IsVisitorsToCanada": false,
    "IsAnnual": false,
    "TravelDetails": {
      "TripOrigin": {
        "Country": null,
        "StateOrProvince": null,
        "AirportCode": null
      },
      "TripDestination": {
        "Country": null,
        "StateOrProvince": null,
        "AirportCode": null
      },
      "DepartureDateTime": null,
      "ReturnDateTime": null,
      "BookingType": "UNKNOWN",
      "BookingProvider": null,
      "TravelType": "UNKNOWN",
      "PassengerNameRecord": null,
      "LoyaltyRewardPlanName": null,
      "LoyaltyRewardPlanNumber": null,
      "LoyaltyRewardPlanTier": null,
      "TravelSegments": []
    },
    "SavedQuoteId": null,
    "SavedQuoteCode": null,
    "StartDate": "2023-04-07T05:49:28.6674182-04:00",
    "EndDate": "2023-04-17T00:00:00-04:00",
    "TopUpEffectiveDate": null,
    "VehicleCategory": "UNKNOWN",
    "TravelDestination": null,
    "DiscountCodes": [],
    "DeductibleCode": null,
    "ProvinceOfResidence": "ON",
    "PrimaryVisitingProvince": null,
    "Insured": [
      {
        "Salutation": null,
        "FirstName": "Test",
        "LastName": "Tester",
        "MiddleName": null,
        "MedicalSurveyAnswers": [],
        "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
  },
  "FulfillmentPreference": "UNKNOWN",
  "Addresses": [
    {
      "AddressType": "HOME",
      "Address1": "4273 King St. East",
      "Address2": null,
      "City": "Kitchener",
      "Province": "ON",
      "PostalCode": "N2P2E9",
      "Country": "CA",
      "IssueFulfillment": false,
      "FulfillmentLanguage": "en"
    }
  ],
  "Contacts": [
    {
      "ContactType": "EMAIL",
      "ContactData": "test.test@allianz-assistance.ca",
      "Note": null,
      "IssueFulfillment": true,
      "FulfillmentLanguage": "en"
    },
    {
      "ContactType": "HOMEPHONE",
      "ContactData": "5197422800",
      "Note": null,
      "IssueFulfillment": false,
      "FulfillmentLanguage": null
    }
  ],
  "Marketing": {
    "ConversionTracking": [],
    "SubscribeToMarketing": false
  }
}

Response Information

Resource Description

A object providing details of the insurance policy that has been issued, or details of the purchase failure if the request was not accepted.

System.Net.Http.HttpResponseMessage

Name	Type	Additional information
Version	System.Version	None.
Content	System.Net.Http.HttpContent	None.
StatusCode	System.Net.HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	System.Net.Http.HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "PolicyIssued": true,
  "PolicyNumber": "ABC0000012345",
  "PolicyId": 0,
  "Product": "SampleProduct",
  "ProductUrl": "https://api.allianz-assistance.ca/Offer/Product/SampleClient/SampleProduct",
  "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",
  "Payments": [
    {
      "PaymentCompleted": true,
      "AccountIdentifierLastFour": "1111",
      "GatewayMessage": "Transaction Normal",
      "BankMessage": "Approved",
      "Errors": null,
      "PaymentType": "CREDITCARD",
      "Amount": 110.0,
      "AccountIdentifier": "************1111",
      "PaymentAuthorization": "A12345",
      "TransactionIdentifier": "12345",
      "PayerName": "Test Tester",
      "PayeeName": null,
      "ExpiryMonth": "01",
      "ExpiryYear": "2024",
      "BillingAddress": {
        "AddressType": "BILLING",
        "Address1": "123 Test",
        "Address2": null,
        "City": "Kitchener",
        "Province": null,
        "PostalCode": null,
        "Country": "CA",
        "IssueFulfillment": false,
        "FulfillmentLanguage": null
      },
      "BillingContact": "5197422800",
      "CreditCardReference": null,
      "Issued": "2023-03-28T05:49:28.6694262-04:00",
      "Received": "2023-03-28T05:49:28.6694262-04:00",
      "CVV": ""
    }
  ],
  "Coverage": {
    "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
  },
  "Errors": []
}