Member
objectThis is actual member number if calling system is GMS and some sequence number in case of other consumers.
Relation of the member to the primary member e.g self,partner,child.
Allowed values:selfpartnerchild
Member’s effective date in the policy. Format e.g YYYY-MM-DD
Gender of the member. values M/F
Allowed values:MF
Member’s date of birth. Format e.g YYYY-MM-DD. Can be left blank if age is supplied as either age or dateOfBirth is required.
Member’s postcode
Wellness Discount (if any) for member
Member underwriting type. For Virgin Business - FMU/NMORI. For Swicth Business - CMORI/CME/MHD.
Allowed values:FMUNMORICMECMORIMHD
Gross premium for member
Net premium for member
Insurance Premium Tax for member
Age of member. Can be left blank if dateOfBirth is supplied as either age or dateOfBirth is required.
Member’s premium breakdown
Show Child Parameters
No Claim Discount level for Member. If NCD Uplift incentive is applied then you must send the uplifted NCD to us. See below rules for calculating the NCD. * Virgin Business = 12, * Switch Business = Less than 1 year claims free = 8, 1 year claims free = 9, 2 years claims free = 10, 3 years claims free = 10, 4 years claims free = 11, 5 years claims free or never claimed = 12
Protected No Claim discount indicator.
Allowed values:YN
Any previous wellness discount for member.
Previous No Claim Discount level for Member.
Previous protected No Claim discount indicator.
Allowed values:YN
Previous net premium for member.
Previous capping and colarring for Member.
Current capping and colarring for Member.
Member Tenure.
Inception date for Member. Format e.g YYYY-MM-DD
Indicates if member is needed or not in the policy.
Postcode Code band for MTCs, this gets calculated automatically by API for New Business based on postcode supplied for members.
Indicates if Postcode band needs to be calculated by API or not. Applies only to MTC & Renewals.
Number of claims free years for Member.
MemberCategory
objectCategory of Members.
Member Category ID
Name of Member Category.
List of benefit options to be included in policy.
Show Child Parameters
Family Unit details
Show Child Parameters
MemberTaxDetail
objectMember’s premium breakdown
Member’s net premium
Member’s tax amount
Member’s tax rate
Option
objectBenefit Option ID. Can be left blank.
Benefit option name.
Allowed values:HospitalListDentalandOpticalGPReferredServicesSixWeekOPtionReducedOutpatientLimitExcessPsychiatricSpeedyDiagnosticsProtectedNCD
Benefit option value. Values below are in same order as of their names above.
Allowed values:Core (Key), Extended, Signature, Trust, Expert SelectNo, YesNo, YesNo, YesNo, 500 , 1000No, 100, 200, 500, 1000, 3000, 5000No, YesNo, YesNo, Yes
Option Type ID. Not in use.
Option Type Name. Not in use.
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.