individualHealthCarePolicy
objectPMI Product Details
Quote ref ID. Any unique quote ref.
Adjustments to the book rates.
Payment mode. For e.g. B for direct debit.
Allowed values:BCA
Payment term, Specify how many times payment will be made in a year say, 12 for monthly payment, 4 for quarterly
Allowed values:1124
Adjustment to the book rates based on claims experience.
Type of PMI Policy.
Postcode for Policy Holder.
Date for which price is calculated. This needs to be treated same policy start date. Format e.g YYYY-MM-DD
Number of family groups in the policy.
This should be name of the channel who provided that particular sale. Can be set as Internet if unknown.
Agent code.
Original effective date of Policy. Format e.g YYYY-MM-DD
Product ID. Not in use.
Product version. Not in use.
Product description. HrSol for consumer policies.
Allowed values:HrSol
Type of transaction. New business , MTC or Renewal. Considered as New Business if left blank.
Allowed values:New BusinessMTCRenewal
Gross premium, this gets calculated by Business Rules Engine and sent back in response.
Gross premium, this gets calculated by Business Rules Engine and sent back in response.
Category of Members.
Show Child Parameters
Incentives applied, if any. Incentives need to be applied as applicable to the agent/broker ID that exists in Aviva. Currently there’s no API exposed externally to provide the list of incentives associated with your agent/broker ID so you should have received the applicable deals from Aviva Business Teams.
Show Child Parameters
Maximum allowed discount. Not in use.
The date against the tax is calculated.Format e.g YYYY-MM-DD
Name of the system which makes the price call. There must be an entry in Aviva’s systems for your system to call this API. You should ask for one if it’s the first time you’re integrating with this API.
Source of the request.
The price quoted by the competitor insurance companies for same kind of policy.
Previous Payment term.
Allowed values:1124
Previous Payment type.
Allowed values:BCA
Previous incentive details.
Show Child Parameters
Previous commercial discount.
Number of people of policy.
Requote flag to indicate whether it’s recalculation after changing the options etc. Applies only to Price Beater.
quote
objectQuote request
Quote ref ID. Any unique quote ref.
Adjustments to the book rates.
Payment mode. For e.g. B for direct debit.
Allowed values:BCA
Payment term, Specify how many times payment will be made in a year say, 12 for monthly payment, 4 for quarterly
Allowed values:1124
Adjustment to the book rates based on claims experience.
Type of PMI Policy.
Postcode for Policy Holder.
Date for which price is calculated. This needs to be treated same policy start date. Format e.g YYYY-MM-DD
Number of family groups in the policy.
This should be name of the channel who provided that particular sale. Can be set as Internet if unknown.
Agent code.
Original effective date of Policy. Format e.g YYYY-MM-DD
Product ID. Not in use.
Product version. Not in use.
Product description. HrSol for consumer policies.
Allowed values:HrSol
Type of transaction. New business , MTC or Renewal. Considered as New Business if left blank.
Allowed values:New BusinessMTCRenewal
Gross premium, this gets calculated by Business Rules Engine and sent back in response.
Gross premium, this gets calculated by Business Rules Engine and sent back in response.
Category of Members.
Show Child Parameters
Incentives applied, if any. Incentives need to be applied as applicable to the agent/broker ID that exists in Aviva. Currently there’s no API exposed externally to provide the list of incentives associated with your agent/broker ID so you should have received the applicable deals from Aviva Business Teams.
Show Child Parameters
Maximum allowed discount. Not in use.
The date against the tax is calculated.Format e.g YYYY-MM-DD
Name of the system which makes the price call. There must be an entry in Aviva’s systems for your system to call this API. You should ask for one if it’s the first time you’re integrating with this API.
Source of the request.
The price quoted by the competitor insurance companies for same kind of policy.
Previous Payment term.
Allowed values:1124
Previous Payment type.
Allowed values:BCA
Previous incentive details.
Show Child Parameters
Previous commercial discount.
Number of people of policy.
Requote flag to indicate whether it’s recalculation after changing the options etc. Applies only to Price Beater.
PreviousIncentive
objectPrevious incentive details.
Incentive ID.
Incentive parameter value such as 1, 2.
Incentive type such as NCD Uplift.
Allowed values:Price BeaterNCD UpliftgiftmonthsFreefreeOptionSwitchDecpsDiscount
Sub key for Incentive if any. Not used for New Business.
quoteResponse
objectPrice Response
Gross premium, this gets calculated by Business Rules Engine and sent back only in response.
Net premium, this gets calculated by Business Rules Engine and sent back only in response.
Category of Members.
Show Child Parameters
ProblemDetail
objectProblem detail exception.
An absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localisation.
The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
An human readable explanation specific to this occurrence of the problem.
An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
This is an Aviva extension type that could be used for sending common mapped business error codes back to the consumer