Skip to main content

totalCoverage

/v2/private/purchase/truStage/totalCoverage

Available Methods​

  • POST

POST /v2/private/purchase/truStage/totalCoverage​

This endpoint will be called before Solution screen that includes the user's information.

This endpoint will call TruStage API to retrieve pricing information.

Params​

ParamTypeDescription
channelString Enum - ['Phone', 'Web']The channel will be used for TruStage API param
Example request body
body: {
  "channel": "Phone"
}

Returns​

The entire user object. user.purchase data will be updated and the truStage pricing array will be added. Pricing data will be used for coverage amount selection.

Example return object with user.purchase
user: {
  ...,
   "truStage": {
                "productSelected": {
                    "coverageAmount": "8000",
                    "productCode": "2016 SITERM80",
                    "submittedOn": "2023-03-20T14:12:18.730Z"
                },
                "pricing": [
                    {
                        "productCode": "2017 SITERM BRIDGED",
                        "coverageOptions": [
                            {
                                "productCode": "2016 SITERM80",
                                "coverage": 5000,
                                "premiums": [
                                    {
                                        "frequency": "Annual",
                                        "premium": 67.8
                                    },
                                    {
                                        "frequency": "Monthly",
                                        "premium": 5.65
                                    },
                                    {
                                        "frequency": "Quarterly",
                                        "premium": 16.95
                                    },
                                    {
                                        "frequency": "SemiAnnual",
                                        "premium": 33.9
                                    }
                                ]
                            },
                            {
                                "productCode": "2016 SITERM80",
                                "coverage": 6000,
                                "premiums": [
                                    {
                                        "frequency": "Annual",
                                        "premium": 75.36
                                    },
                                    {
                                        "frequency": "Monthly",
                                        "premium": 6.28
                                    },
                                    {
                                        "frequency": "Quarterly",
                                        "premium": 18.84
                                    },
                                    {
                                        "frequency": "SemiAnnual",
                                        "premium": 37.68
                                    }
                                ]
                            }
                        ],
                        "billingFrequencies": [
                            "Annual",
                            "Monthly",
                            "Quarterly",
                            "SemiAnnual"
                        ],
                        "errors": []
                    }
                ]
            }
}
info

For more detailed information please check TruStage API DOC.