PRISM API Documentation
 
  • Client

    • Show/Hide
    • List Operations
    • Expand Operations
      • get api/V2/Client/Config

        • Documentation for 'GetClientConfig'.

        Implementation Notes

        Documentation for 'GetClientConfig'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

  • FullQuote

    • Show/Hide
    • List Operations
    • Expand Operations
      • get api/V2/FullQuote/{refno}

        • Documentation for 'RetrieveFullQuote'.

        Implementation Notes

        Documentation for 'RetrieveFullQuote'.

        Parameters

        Parameter Value Description
        refno Documentation for 'refno'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/FullQuote/{refno}/Document?method={method}

        • Documentation for 'GetFullQuoteDocument'.

        Implementation Notes

        Documentation for 'GetFullQuoteDocument'.

        Parameters

        Parameter Value Description
        refno Documentation for 'refno'.
        method Documentation for 'method'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/FullQuote/{refno}/Email?retrieveQuoteUrl={retrieveQuoteUrl}

        • Documentation for 'GetFullQuoteEmail'.

        Implementation Notes

        Documentation for 'GetFullQuoteEmail'.

        Parameters

        Parameter Value Description
        refno Documentation for 'refno'.
        retrieveQuoteUrl Documentation for 'retrieveQuoteUrl'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/FullQuote/{refno}/Retrieve/{securityToken}

        • Documentation for 'RetrieveFullQuote'.

        Implementation Notes

        Documentation for 'RetrieveFullQuote'.

        Parameters

        Parameter Value Description
        refno Documentation for 'refno'.
        securityToken Documentation for 'securityToken'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/FullQuote/{refno}/RetrieveDataForQuoteRetrieval?surname={surname}&dateOfBirth={dateOfBirth}

        • Documentation for 'RetrieveDataForQuoteRetrieval'.

        Implementation Notes

        Documentation for 'RetrieveDataForQuoteRetrieval'.

        Parameters

        Parameter Value Description
        refno Documentation for 'refno'.
        surname Documentation for 'surname'.
        dateOfBirth Documentation for 'dateOfBirth'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/FullQuote/{refno}/UpdateExternalSystems

        • Documentation for 'UpdateExternalSystems'.

        Implementation Notes

        Documentation for 'UpdateExternalSystems'.

        Parameters

        Parameter Value Description
        refno Documentation for 'refno'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/FullQuote/{refno}?securityToken={securityToken}

        • Documentation for 'RetrieveFullQuote'.

        Implementation Notes

        Documentation for 'RetrieveFullQuote'.

        Parameters

        Parameter Value Description
        refno Documentation for 'refno'.
        securityToken Documentation for 'securityToken'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/FullQuote/History?quoteId={quoteId}

        • Documentation for 'GetFullQuoteHistory'.

        Implementation Notes

        Documentation for 'GetFullQuoteHistory'.

        Parameters

        Parameter Value Description
        quoteId Documentation for 'quoteId'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/FullQuote/List

        • Documentation for 'ListCurrentFullQuotes'.

        Implementation Notes

        Documentation for 'ListCurrentFullQuotes'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/FullQuote?id={id}&includeHistory={includeHistory}&hasIncompatibleMedical={hasIncompatibleMedical}

        • Documentation for 'RetrieveFullQuoteById'.

        Implementation Notes

        Documentation for 'RetrieveFullQuoteById'.

        Parameters

        Parameter Value Description
        id Documentation for 'id'.
        includeHistory Documentation for 'includeHistory'.
        hasIncompatibleMedical Documentation for 'hasIncompatibleMedical'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/FullQuote/Cancel

        • Documentation for 'CancelFullQuote'.

        Implementation Notes

        Documentation for 'CancelFullQuote'.

        Parameters

        Parameter Value Description
        quote Documentation for 'quote'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/FullQuote/Options

        • Documentation for 'GetFullQuoteOptions'.

        Implementation Notes

        Documentation for 'GetFullQuoteOptions'.

        Parameters

        Parameter Value Description
        quote Documentation for 'quote'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/FullQuote/Search

        • Documentation for 'SearchFullQuote'.

        Implementation Notes

        Documentation for 'SearchFullQuote'.

        Parameters

        Parameter Value Description
        criteria Documentation for 'criteria'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/FullQuote?rescore={rescore}

        • Documentation for 'GetFullQuote'.

        Implementation Notes

        Documentation for 'GetFullQuote'.

        Parameters

        Parameter Value Description
        quote Documentation for 'quote'.
        rescore Documentation for 'rescore'.
        stage Documentation for 'stage'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • put api/V2/FullQuote

        • Documentation for 'SaveFullQuote'.

        Implementation Notes

        Documentation for 'SaveFullQuote'.

        Parameters

        Parameter Value Description
        quote Documentation for 'quote'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • put api/V2/FullQuote/Save

        • Documentation for 'SaveFullQuoteByCustomer'.

        Implementation Notes

        Documentation for 'SaveFullQuoteByCustomer'.

        Parameters

        Parameter Value Description
        quote Documentation for 'quote'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • put api/V2/FullQuote/SaveNonMedicalQuote?travellerIndex={travellerIndex}

        • Documentation for 'SaveNonMedicalQuote'.

        Implementation Notes

        Documentation for 'SaveNonMedicalQuote'.

        Parameters

        Parameter Value Description
        quote Documentation for 'quote'.
        travellerIndex Documentation for 'travellerIndex'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • put api/V2/FullQuote/SavePEAssessment

        • Documentation for 'SavePEAssessment'.

        Implementation Notes

        Documentation for 'SavePEAssessment'.

        Parameters

        Parameter Value Description
        quote Documentation for 'quote'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

  • Healix

    • Show/Hide
    • List Operations
    • Expand Operations
      • get api/V2/Healix/IsMentalConditionCovered

        • Documentation for 'IsMentalConditionCovered'.

        Implementation Notes

        Documentation for 'IsMentalConditionCovered'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Healix/Options

        • Documentation for 'Options'.

        Implementation Notes

        Documentation for 'Options'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Healix/PreScreeningQuestions

        • Documentation for 'PreScreeningQuestions'.

        Implementation Notes

        Documentation for 'PreScreeningQuestions'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Healix

        • Documentation for 'PersistScreening'.

        Implementation Notes

        Documentation for 'PersistScreening'.

        Parameters

        Parameter Value Description
        healixDto Documentation for 'healixDto'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Healix/GetVeriskWidgetSettings

        • Documentation for 'GetVeriskWidgetSettings'.

        Implementation Notes

        Documentation for 'GetVeriskWidgetSettings'.

        Parameters

        Parameter Value Description
        requestDto Documentation for 'requestDto'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Healix/HealixFatalQuestions

        • Documentation for 'HealixFatalQuestions'.

        Implementation Notes

        Documentation for 'HealixFatalQuestions'.

        Parameters

        Parameter Value Description
        peOptionDto Documentation for 'peOptionDto'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Healix/PePremium

        • Documentation for 'PePremium'.

        Implementation Notes

        Documentation for 'PePremium'.

        Parameters

        Parameter Value Description
        healixAssessmentDto Documentation for 'healixAssessmentDto'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Healix/PersistPreScreeningAnswers

        • Documentation for 'PersistPreScreeningAnswers'.

        Implementation Notes

        Documentation for 'PersistPreScreeningAnswers'.

        Parameters

        Parameter Value Description
        preScreeningAnswersRequest Documentation for 'preScreeningAnswersRequest'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Healix/PersistPreScreeningB2BAnswers

        • Documentation for 'PersistPreScreeningB2BAnswers'.

        Implementation Notes

        Documentation for 'PersistPreScreeningB2BAnswers'.

        Parameters

        Parameter Value Description
        preScreeningB2BAnswersRequest Documentation for 'preScreeningB2BAnswersRequest'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Healix/PersistScreeningResults

        • Documentation for 'PersistScreeningResults'.

        Implementation Notes

        Documentation for 'PersistScreeningResults'.

        Parameters

        Parameter Value Description
        screeningResultsRequestDto Documentation for 'screeningResultsRequestDto'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Healix/PreScreeningB2BQuestions

        • Documentation for 'PreScreeningB2BQuestions'.

        Implementation Notes

        Documentation for 'PreScreeningB2BQuestions'.

        Parameters

        Parameter Value Description
        requestDto Documentation for 'requestDto'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Healix/RegisterScreening

        • Documentation for 'RegisterScreening'.

        Implementation Notes

        Documentation for 'RegisterScreening'.

        Parameters

        Parameter Value Description
        screeningDto Documentation for 'screeningDto'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Healix/ScreeningUrl

        • Documentation for 'ScreeningUrl'.

        Implementation Notes

        Documentation for 'ScreeningUrl'.

        Parameters

        Parameter Value Description
        policyDto Documentation for 'policyDto'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Healix/UpdateNonMedicalStatus

        • Documentation for 'UpdateNonMedicalStatus'.

        Implementation Notes

        Documentation for 'UpdateNonMedicalStatus'.

        Parameters

        Parameter Value Description
        peAssessmentDto Documentation for 'peAssessmentDto'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

  • LeadData

    • Show/Hide
    • List Operations
    • Expand Operations
      • get api/V2/LeadData/JwtSsoVerificationDetails

        • Documentation for 'GetJwtSsoVerificationDetails'.

        Implementation Notes

        Documentation for 'GetJwtSsoVerificationDetails'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/LeadData/Retrieve?token={token}

        • Documentation for 'RetrieveLeadData'.

        Implementation Notes

        Documentation for 'RetrieveLeadData'.

        Parameters

        Parameter Value Description
        token Documentation for 'token'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/LeadData/RetrieveByBrandAndNameIdentifier

        • Documentation for 'RetrieveByBrandAndNameIdentifier'.

        Implementation Notes

        Documentation for 'RetrieveByBrandAndNameIdentifier'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/LeadData/EditRestrictions

        • Documentation for 'GetEditRestrictions'.

        Implementation Notes

        Documentation for 'GetEditRestrictions'.

        Parameters

        Parameter Value Description
        editRestrictions Documentation for 'editRestrictions'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • put api/V2/LeadData/LinkUuidWithQuoteRefNumber?token={token}&quoteReferenceNumber={quoteReferenceNumber}

        • Documentation for 'LinkUuidWithQuoteRefNumber'.

        Implementation Notes

        Documentation for 'LinkUuidWithQuoteRefNumber'.

        Parameters

        Parameter Value Description
        token Documentation for 'token'.
        quoteReferenceNumber Documentation for 'quoteReferenceNumber'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

  • Payment

    • Show/Hide
    • List Operations
    • Expand Operations
      • post api/V2/Payment/CreatePhonePaymentToken

        • Documentation for 'CreatePhonePaymentToken'.

        Implementation Notes

        Documentation for 'CreatePhonePaymentToken'.

        Parameters

        Parameter Value Description
        phonePayment Documentation for 'phonePayment'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Payment/CreatePhoneSession

        • Documentation for 'CreatePhoneSession'.

        Implementation Notes

        Documentation for 'CreatePhoneSession'.

        Parameters

        Parameter Value Description
        merchantId Documentation for 'merchantId'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Payment/CreateSession

        • Documentation for 'CreateWebSession'.

        Implementation Notes

        Documentation for 'CreateWebSession'.

        Parameters

        Parameter Value Description
        merchantId Documentation for 'merchantId'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Payment/PhoneSessionStatus

        • Documentation for 'GetPhoneSessionStatus'.

        Implementation Notes

        Documentation for 'GetPhoneSessionStatus'.

        Parameters

        Parameter Value Description
        session Documentation for 'session'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Payment/ResetPhoneSession

        • Documentation for 'ResetPhoneSession'.

        Implementation Notes

        Documentation for 'ResetPhoneSession'.

        Parameters

        Parameter Value Description
        session Documentation for 'session'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

  • Policy

    • Show/Hide
    • List Operations
    • Expand Operations
      • get api/V2/Policy/{policyReference}/Offline?clientId={clientId}

        • Documentation for 'GetOfflinePolicyDetails'.

        Implementation Notes

        Documentation for 'GetOfflinePolicyDetails'.

        Parameters

        Parameter Value Description
        clientId Documentation for 'clientId'.
        policyReference Documentation for 'policyReference'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Policy/{refno}/Document?method={method}&version={version}

        • Documentation for 'GetPolicyDocument'.

        Implementation Notes

        Documentation for 'GetPolicyDocument'.

        Parameters

        Parameter Value Description
        refno Documentation for 'refno'.
        method Documentation for 'method'.
        version Documentation for 'version'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Policy/{refno}/UpdateExternalSystems

        • Documentation for 'UpdateExternalSystems'.

        Implementation Notes

        Documentation for 'UpdateExternalSystems'.

        Parameters

        Parameter Value Description
        refno Documentation for 'refno'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Policy/{refno}?includeHistory={includeHistory}&clientId={clientId}&programBrandCode={programBrandCode}&isExactMatch={isExactMatch}

        • Documentation for 'GetPolicyDetailByClientRefNo'.

        Implementation Notes

        Documentation for 'GetPolicyDetailByClientRefNo'.

        Parameters

        Parameter Value Description
        refno Documentation for 'refno'.
        includeHistory Documentation for 'includeHistory'.
        clientId Documentation for 'clientId'.
        programBrandCode Documentation for 'programBrandCode'.
        isExactMatch Documentation for 'isExactMatch'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Policy/History?policyId={policyId}

        • Documentation for 'GetPolicyHistory'.

        Implementation Notes

        Documentation for 'GetPolicyHistory'.

        Parameters

        Parameter Value Description
        policyId Documentation for 'policyId'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Policy/List

        • Documentation for 'ListCurrentPolicies'.

        Implementation Notes

        Documentation for 'ListCurrentPolicies'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Policy?id={id}&includeHistory={includeHistory}

        • Documentation for 'GetPolicyDetailById'.

        Implementation Notes

        Documentation for 'GetPolicyDetailById'.

        Parameters

        Parameter Value Description
        id Documentation for 'id'.
        includeHistory Documentation for 'includeHistory'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Policy/CalculateEditRestrictions

        • Documentation for 'CalculateEditRestrictions'.

        Implementation Notes

        Documentation for 'CalculateEditRestrictions'.

        Parameters

        Parameter Value Description
        policy Documentation for 'policy'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Policy/Cancel

        • Documentation for 'CancelPolicy'.

        Implementation Notes

        Documentation for 'CancelPolicy'.

        Parameters

        Parameter Value Description
        policy Documentation for 'policy'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Policy/CancelWithLeadTime

        • Documentation for 'CancelPolicyWithLeadTime'.

        Implementation Notes

        Documentation for 'CancelPolicyWithLeadTime'.

        Parameters

        Parameter Value Description
        request Documentation for 'request'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Policy/Endorse

        • Documentation for 'EndorsePolicy'.

        Implementation Notes

        Documentation for 'EndorsePolicy'.

        Parameters

        Parameter Value Description
        policy Documentation for 'policy'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Policy/Purchase

        • Documentation for 'PurchasePolicy'.

        Implementation Notes

        Documentation for 'PurchasePolicy'.

        Parameters

        Parameter Value Description
        policy Documentation for 'policy'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Policy/SaveAccount

        • Documentation for 'SaveAccount'.

        Implementation Notes

        Documentation for 'SaveAccount'.

        Parameters

        Parameter Value Description
        policy Documentation for 'policy'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Policy/Search

        • Documentation for 'SearchPolicy'.

        Implementation Notes

        Documentation for 'SearchPolicy'.

        Parameters

        Parameter Value Description
        criteria Documentation for 'criteria'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Policy/SendPolicyDocumentationEmail

        • Documentation for 'SendPolicyDocumentationEmail'.

        Implementation Notes

        Documentation for 'SendPolicyDocumentationEmail'.

        Parameters

        Parameter Value Description
        request Documentation for 'request'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

  • Product

    • Show/Hide
    • List Operations
    • Expand Operations
      • get api/V2/Product/AgencySalesLink

        • Documentation for 'GetAgencySalesLink'.

        Implementation Notes

        Documentation for 'GetAgencySalesLink'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/AgencySalesLinkIdentifiers?linkId={linkId}

        • Documentation for 'GetAgencySalesLinkIdentifiers'.

        Implementation Notes

        Documentation for 'GetAgencySalesLinkIdentifiers'.

        Parameters

        Parameter Value Description
        linkId Documentation for 'linkId'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/AlternativeBins

        • Documentation for 'GetAlternativeBins'.

        Implementation Notes

        Documentation for 'GetAlternativeBins'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/Benefits?type={type}&level={level}

        • Documentation for 'GetProductBenefits'.

        Implementation Notes

        Documentation for 'GetProductBenefits'.

        Parameters

        Parameter Value Description
        type Documentation for 'type'.
        level Documentation for 'level'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/CardEligibleCoverLevels?insuranceTypeBriefCode={insuranceTypeBriefCode}

        • Documentation for 'GetCardEligibleCoverLevels'.

        Implementation Notes

        Documentation for 'GetCardEligibleCoverLevels'.

        Parameters

        Parameter Value Description
        insuranceTypeBriefCode Documentation for 'insuranceTypeBriefCode'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/Descriptions

        • Documentation for 'GetProductDescriptions'.

        Implementation Notes

        Documentation for 'GetProductDescriptions'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/Document?docType={docType}&method={method}&level={level}&issueDate={issueDate}

        • Documentation for 'GetProductDocument'.

        Implementation Notes

        Documentation for 'GetProductDocument'.

        Parameters

        Parameter Value Description
        docType Documentation for 'docType'.
        method Documentation for 'method'.
        level Documentation for 'level'.
        issueDate Documentation for 'issueDate'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/FrequentlyAskedQuestions

        • Documentation for 'GetFrequentlyAskedQuestions'.

        Implementation Notes

        Documentation for 'GetFrequentlyAskedQuestions'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/GetFsgBlurb

        • Documentation for 'GetFsgBlurb'.

        Implementation Notes

        Documentation for 'GetFsgBlurb'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/GetIvrIdentifier

        • Documentation for 'GetIvrIdentifier'.

        Implementation Notes

        Documentation for 'GetIvrIdentifier'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/GetIvrIdentifierPayment

        • Documentation for 'GetIvrIdentifierPayment'.

        Implementation Notes

        Documentation for 'GetIvrIdentifierPayment'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/HasAgencySalesLink

        • Documentation for 'HasAgencySalesLink'.

        Implementation Notes

        Documentation for 'HasAgencySalesLink'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/IsAccessToB2CSiteByAgencySalesLinkOnly

        • Documentation for 'IsAccessToB2CSiteByAgencySalesLinkOnly'.

        Implementation Notes

        Documentation for 'IsAccessToB2CSiteByAgencySalesLinkOnly'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/IsAgencySalesLinkEnabled

        • Documentation for 'IsAgencySalesLinkEnabled'.

        Implementation Notes

        Documentation for 'IsAgencySalesLinkEnabled'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/IsTravelArrangementEnabled

        • Documentation for 'GetIsTravelArrangementEnabled'.

        Implementation Notes

        Documentation for 'GetIsTravelArrangementEnabled'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/OptionBenefits?briefCode={briefCode}

        • Documentation for 'GetOptionBenefits'.

        Implementation Notes

        Documentation for 'GetOptionBenefits'.

        Parameters

        Parameter Value Description
        briefCode Documentation for 'briefCode'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/PaymentOptions?clientReferenceNumber={clientReferenceNumber}

        • Documentation for 'GetPaymentOptions'.

        Implementation Notes

        Documentation for 'GetPaymentOptions'.

        Parameters

        Parameter Value Description
        clientReferenceNumber Documentation for 'clientReferenceNumber'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/PlanDescriptions?briefCode={briefCode}

        • Documentation for 'GetPlanDescriptions'.

        Implementation Notes

        Documentation for 'GetPlanDescriptions'.

        Parameters

        Parameter Value Description
        briefCode Documentation for 'briefCode'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/PremiumExtraInfo?briefCode={briefCode}

        • Documentation for 'GetPremiumExtraInfo'.

        Implementation Notes

        Documentation for 'GetPremiumExtraInfo'.

        Parameters

        Parameter Value Description
        briefCode Documentation for 'briefCode'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/TourOperators

        • Documentation for 'GetTourOperators'.

        Implementation Notes

        Documentation for 'GetTourOperators'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Product/TravellerOptions

        • Documentation for 'GetTravellerOptions'.

        Implementation Notes

        Documentation for 'GetTravellerOptions'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

  • QuickQuote

    • Show/Hide
    • List Operations
    • Expand Operations
      • get api/V2/QuickQuote/Countries?region={region}

        • Documentation for 'GetCountries'.

        Implementation Notes

        Documentation for 'GetCountries'.

        Parameters

        Parameter Value Description
        region Documentation for 'region'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/QuickQuote/Options/Destinations?id={id}

        • Documentation for 'GetDestinationOptions'.

        Implementation Notes

        Documentation for 'GetDestinationOptions'.

        Parameters

        Parameter Value Description
        id Documentation for 'id'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/QuickQuote/Options?id={id}&coverLevel={coverLevel}

        • Documentation for 'GetQuickQuoteOptions'.

        Implementation Notes

        Documentation for 'GetQuickQuoteOptions'.

        Parameters

        Parameter Value Description
        id Documentation for 'id'.
        coverLevel Documentation for 'coverLevel'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/QuickQuote?id={id}&accessCode={accessCode}&affid={affid}

        • Documentation for 'GetBulkQuickQuoteWithAccessCode'.

        Implementation Notes

        Documentation for 'GetBulkQuickQuoteWithAccessCode'.

        Parameters

        Parameter Value Description
        id Documentation for 'id'.
        accessCode Documentation for 'accessCode'.
        affid Documentation for 'affid'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/QuickQuote

        • Documentation for 'GetBulkQuickQuote'.

        Implementation Notes

        Documentation for 'GetBulkQuickQuote'.

        Parameters

        Parameter Value Description
        quote Documentation for 'quote'.
        stage Documentation for 'stage'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/QuickQuote/{planId}

        • Documentation for 'GetQuickQuote'.

        Implementation Notes

        Documentation for 'GetQuickQuote'.

        Parameters

        Parameter Value Description
        planId Documentation for 'planId'.
        quote Documentation for 'quote'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/QuickQuote/Email

        • Documentation for 'SendQuickQuoteEmail'.

        Implementation Notes

        Documentation for 'SendQuickQuoteEmail'.

        Parameters

        Parameter Value Description
        emailQuote Documentation for 'emailQuote'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/QuickQuote/MultiTraveller

        • Documentation for 'GetBulkQuickQuoteMultiTraveller'.

        Implementation Notes

        Documentation for 'GetBulkQuickQuoteMultiTraveller'.

        Parameters

        Parameter Value Description
        multiTravellerQuotes Documentation for 'multiTravellerQuotes'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/QuickQuote/Print

        • Documentation for 'GetPrintDocuments'.

        Implementation Notes

        Documentation for 'GetPrintDocuments'.

        Parameters

        Parameter Value Description
        printQuote Documentation for 'printQuote'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

  • RefundQuestion

    • Show/Hide
    • List Operations
    • Expand Operations
      • get api/V2/RefundQuestion/Answers?policyId={policyId}

        • Documentation for 'GetAnswers'.

        Implementation Notes

        Documentation for 'GetAnswers'.

        Parameters

        Parameter Value Description
        policyId Documentation for 'policyId'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/RefundQuestion/Questions

        • Documentation for 'GetAllQuestions'.

        Implementation Notes

        Documentation for 'GetAllQuestions'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • put api/V2/RefundQuestion/Answer

        • Documentation for 'SaveRefundAnswer'.

        Implementation Notes

        Documentation for 'SaveRefundAnswer'.

        Parameters

        Parameter Value Description
        answer Documentation for 'answer'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

  • Search

    • Show/Hide
    • List Operations
    • Expand Operations
      • get api/V2/Search/PoliciesByAgent?brandId={brandId}&limit={limit}

        • Documentation for 'PoliciesByAgent'.

        Implementation Notes

        Documentation for 'PoliciesByAgent'.

        Parameters

        Parameter Value Description
        brandId Documentation for 'brandId'.
        limit Documentation for 'limit'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Search/QuotesByAgent?brandId={brandId}&limit={limit}

        • Documentation for 'QuotesByAgent'.

        Implementation Notes

        Documentation for 'QuotesByAgent'.

        Parameters

        Parameter Value Description
        brandId Documentation for 'brandId'.
        limit Documentation for 'limit'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Search/Policies?limit={limit}

        • Documentation for 'Policies'.

        Implementation Notes

        Documentation for 'Policies'.

        Parameters

        Parameter Value Description
        criteria Documentation for 'criteria'.
        limit Documentation for 'limit'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Search/Quotes?limit={limit}

        • Documentation for 'Quotes'.

        Implementation Notes

        Documentation for 'Quotes'.

        Parameters

        Parameter Value Description
        criteria Documentation for 'criteria'.
        limit Documentation for 'limit'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Search/QuotesAndPolicies?limit={limit}

        • Documentation for 'QuotesAndPolicies'.

        Implementation Notes

        Documentation for 'QuotesAndPolicies'.

        Parameters

        Parameter Value Description
        criteria Documentation for 'criteria'.
        limit Documentation for 'limit'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

  • Security

    • Show/Hide
    • List Operations
    • Expand Operations
      • get api/V2/Security/Agencies?brand={brand}&agency={agency}&provisioned={provisioned}&clientId={clientId}

        • Documentation for 'Agencies'.

        Implementation Notes

        Documentation for 'Agencies'.

        Parameters

        Parameter Value Description
        brand Documentation for 'brand'.
        agency Documentation for 'agency'.
        provisioned Documentation for 'provisioned'.
        clientId Documentation for 'clientId'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Security/CanRepresentExternalAgency?clientId={clientId}&brand={brand}

        • Documentation for 'CanRepresentExternalAgency'.

        Implementation Notes

        Documentation for 'CanRepresentExternalAgency'.

        Parameters

        Parameter Value Description
        clientId Documentation for 'clientId'.
        brand Documentation for 'brand'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Security/ProvisionedDefault

        • Documentation for 'ProvisionedDefault'.

        Implementation Notes

        Documentation for 'ProvisionedDefault'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Security/Default

        • Documentation for 'Default'.

        Implementation Notes

        Documentation for 'Default'.

        Parameters

        Parameter Value Description
        brandAgencyRequestDto Documentation for 'brandAgencyRequestDto'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Security/Login

        • Documentation for 'Login'.

        Implementation Notes

        Documentation for 'Login'.

        Parameters

        Parameter Value Description
        loginInput Documentation for 'loginInput'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Security/SelectAgency

        • Documentation for 'SelectAgency'.

        Implementation Notes

        Documentation for 'SelectAgency'.

        Parameters

        Parameter Value Description
        selectAgencyInput Documentation for 'selectAgencyInput'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Security/SelectBrand

        • Documentation for 'SelectBrand'.

        Implementation Notes

        Documentation for 'SelectBrand'.

        Parameters

        Parameter Value Description
        selectBrandInput Documentation for 'selectBrandInput'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

  • Survey

    • Show/Hide
    • List Operations
    • Expand Operations
      • get api/V2/Survey/List

        • Documentation for 'ListCurrentSurveys'.

        Implementation Notes

        Documentation for 'ListCurrentSurveys'.

        Parameters

        No parameters.


        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Survey/Response/{id}

        • Documentation for 'GetSurveyResponseById'.

        Implementation Notes

        Documentation for 'GetSurveyResponseById'.

        Parameters

        Parameter Value Description
        id Documentation for 'id'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • get api/V2/Survey?code={code}

        • Documentation for 'GetSurvey'.

        Implementation Notes

        Documentation for 'GetSurvey'.

        Parameters

        Parameter Value Description
        code Documentation for 'code'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • put api/V2/Survey/Response

        • Documentation for 'SaveSurveyResponse'.

        Implementation Notes

        Documentation for 'SaveSurveyResponse'.

        Parameters

        Parameter Value Description
        response Documentation for 'response'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

  • WorkflowInstance

    • Show/Hide
    • List Operations
    • Expand Operations
      • get api/V2/Workflow/{instanceId}

        • Documentation for 'GetInstance'.

        Implementation Notes

        Documentation for 'GetInstance'.

        Parameters

        Parameter Value Description
        instanceId Documentation for 'instanceId'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Workflow

        • Documentation for 'SearchInstances'.

        Implementation Notes

        Documentation for 'SearchInstances'.

        Parameters

        Parameter Value Description
        instanceDto Documentation for 'instanceDto'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Workflow/Cancel

        • Documentation for 'CancelInstance'.

        Implementation Notes

        Documentation for 'CancelInstance'.

        Parameters

        Parameter Value Description
        instanceDto Documentation for 'instanceDto'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Workflow/Retry

        • Documentation for 'RetryInstance'.

        Implementation Notes

        Documentation for 'RetryInstance'.

        Parameters

        Parameter Value Description
        instanceDto Documentation for 'instanceDto'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers

      • post api/V2/Workflow/Terminate

        • Documentation for 'TerminateInstance'.

        Implementation Notes

        Documentation for 'TerminateInstance'.

        Parameters

        Parameter Value Description
        instanceDto Documentation for 'instanceDto'.

        Hide Response Throbber

        Request URL

        Response Body

        Response Code

        Response Headers



[ base url: https://uat-prism-api.agaassistance.com.au:443, version: 2.9.21+1229.Branch.release-wafchanges.Sha.e2b4ded76c6ae7cf7c7e17f72031df4eb422c081 ]