Get quote

Consumer Request

application/json

Request Body required

typeOfQuote string required

Possible values: <= 20 characters, [Single Quote, Multi-Quote]

This will take values as 'Single Quote' or 'Multi-quote' and will help to identify the number of quote requests to be generated

quoteCategory string required
Possible values: <= 20 characters, [Premium, Sum Assured, Income]
Indicates whether a single quote or multiple quotes should be generated for the same request.
• Use Single-Quote when required to generate a quote for a specific product from a specific insurance company.
• Use Multi-Quote Generates quotes for multiple products across different insurance companies
includeBI string
Possible values: <= 20 characters, [withBI, withoutBI, OnlyBI]
This field indicates whether the quote is generated with BI, without BI, or for BI only. The BI URL, if applicable, is returned in a other section of the quote response.
• When the 1SB Quote API is called, the BI API on Manu is also triggered as part of the same request flow.
• When the 1SB Quote API is called, the BI API on Manu is not triggered.
• When the 1SB Quote API is called, only the BI API on the manufacturer (Manu) side is triggered.
alternateFreqRequired string
Possible values: <= 10 characters, [Yes, No]
Indicates whether quotes should also be generated for an alternate premium payment frequency in addition to the frequency provided by the user.
• Yes: System will generate multi-quotes based on payment frequency. One additional frequency will be included automatically as per system rules.
• No: Quote will be generated only for the provided payment frequency. Frequency Rules:
• If premium Payment Frequency is Monthly, Quarterly, or Half-Yearly, the system will generate quotes for the selected frequency and Yearly.
• If premium Payment Frequency is Yearly, the system will generate quotes for Yearly and Monthly.
outOfBoundConfig string

Possible values: <= 10 characters, [Yes, No]

Indicates whether the system should generate quotes for out-of-bound input values instead of rejecting the request.

• Yes: Quotes will be generated by auto-adjusting the out-of-bound parameter to the nearest allowed value as per product rules. The response will clearly indicate that the original input was out of bounds.

• No: Quotes will not be generated for out-of-bound values and the product may be excluded from the quote listing.

Example: - Customer inputs policyTerm = 40

• Product allows maximum policyTerm = 30
• System defaults policyTerm to 30 and generates a quote with an out-of-bound indicator in the response.

This helps ensure eligible products are not excluded from listing and allows the consumer application to inform the user appropriately.

additionalSetup object

This section will contain additional information regarding user and policy

currency string

Possible values: <= 5 characters, [AUD, NZD, USD, EUR, GBP, JPY, ZAR, CAD, CNY, ARS, BSD, BDT, BGN, BRL, CLP, KWD, COP, HRK, CZK, DKK, EGP, HKD, HUF, ISK, INR, IDR, ILS, KZT, KRW, CHF, MYR, MUR, MXN, NOK, PHP, PLN, QAR, RON, RUB, SAR, RSD, SGD, SEK, TWD, THB, TRY, UAH, VND, AED, MAD, PEN, UYU, OMR, BHD]

Currency in which policy will be purchased

userGeoLocation object

Possible values: <= 100 characters

Return a JSON object with latitude and longitude properties

latitude string

latitude

longitude string

longitude

userCountry string

Possible values: <= 5 characters, [AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, CV, KH, CM, CA, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CD, CK, CR, CI, HR, CU, CW, CY, CZ, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, SZ, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GO, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, XK, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, NC, NZ, NI, NE, NG, NU, NF, KP, MK, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, KR, SS, ES, LK, SD, SR, SJ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, US, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW]

Country of the user

userRegion string

Possible values: <= 30 characters

Region (State or Province) of the user

userLanguage string

Possible values: <= 20 characters

Language set by user on the consumer app

userIP string

Possible values: <= 20 characters

User IP address

userAgent string

Possible values: <= 50 characters

User's browser details

distributor object required
This section will give details of intermediary (Broker, corporate Agent or Bank acting as intermediary).The latest enum values for the below tags can be fetched using the Master Lookup API available in the Building Blocks section.
distributorID string required
Possible values: <= 20 characters
Distributor ID assign to each consumer by 1SB
agentID string required
Possible values: <= 30 characters
agent code. Eg. PoSP code or SP code provided by insurance company.
salesChannel string
Possible values: <= 20 characters, [Online, Others]
This is used by insurance companies to identify sales channel.
channelType string required
Possible values: <= 20 characters, [B2B, B2C]
Indicates if the transaction is B2B or B2C.
agentType string
Possible values: <= 20 characters, [POSP, SP, BQP]
Indicates if the agent type is POSP ,SP or BQP.
varFields object[]
Array [
fieldName string
Possible values: <= 50 characters
Additional fields for distributor section
fieldValue string
Possible values: <= 50 characters
Value of additional fields
]
personalInformation object required
Section to capture personal details of the life assured
individualDetails object[] required
This array will hold personal details of all life assured and proposer
Array [
memberType string required
Possible values: <= 30 characters, [Life Assured]
Specifies the role of the member for whom the details are being captured in the quote.
• Life Assured: Member whose life is covered under the policy.
• Proposer: Member who is proposing and paying for the policy (may be different from the Life Assured).
memberSequenceNumber integer required
Sequence number of members. This should be as unique for each member within each quote
title string
Possible values: <= 30 characters, [Mr, Mrs, Ms]
Title of Member.
firstName string
Possible values: <= 50 characters
First Name of Member
middleName string
Possible values: <= 50 characters
Middle Name of Member
lastName string
Possible values: <= 50 characters
Last Name of Member
gender string required
Possible values: <= 15 characters, [Male, Female, Transgender, Others]
Gender of Member.
dateOfBirth string required
Date of Birth of Member. Date is formatted string as per ISO 8601 standard. Format - YYYY-MM-DD
age integer
Possible values: <= 150 characters
Age of Member
maritalStatus string
Possible values: <= 30 characters, [Married, Single]
Marital status of Member.
qualification string
Possible values: <= 50 characters, [Post Graduate, Graduate, 12th, 10th, Diploma, Below 10th]
Education of Member.
occupation string
Possible values: <= 50 characters, [Salaried, Self-Employed, Non-working]
Occupation of Member.
annualIncome number required
Possible values: <= 15 characters
Annual Income of Member. Existing earnings per year.
email string
Possible values: <= 100 characters
Email ID of Member
mobileNumber number
Possible values: <= 10 characters
Mobile number of Member
tobacco string required
Possible values: <= 10 characters, [No, Yes]
Smoker/Non-Smoker status of Member
relationWithFirstLifeAssured string
Possible values: <= 30 characters
Specifies the relationship between the proposer and the first Life Assured in the quote. Examples include: Self, Spouse, Mother, Father, etc. This field is mandatory when typeOfQuote is set to Single Quote.
zipCode string required
Possible values: <= 10 characters
This is Pin code
state string
Possible values: <= 30 characters, [ANDAMAN AND NICOBAR, ANDHRA PRADESH, ARUNACHAL PRADESH, ASSAM, BIHAR, CHANDIGARH, DADRA AND NAGAR, DAMAN AND DIU, DELHI, GOA, GUJARAT, HIMACHAL PRADESH, JAMMU AND KASHMIR, KERALA, LAKSHADWEEP, MAHARASHTRA, MANIPUR, MEGHALAYA, NAGALAND, ORISSA, PUNJAB, RAJASTHAN, SIKKIM, TRIPURA, UTTAR PRADESH, JHARKHAND, UTTARAKHAND, TELANGANA, HARAYANA, KARNATAKA, MADHYA PRADESH, MIZORAM, PONDICHERRY, TAMIL NADU, WEST BENGAL, CHHATTISGARH]
State of Member
city string
Possible values: <= 50 characters
City of Member
residentStatus string
Possible values: <= 20 characters, [Resident Indian, NRI, OCI, PIO, Foreign National]
Resident status of the Member.
quoteAmount number
Possible values: <= 15 characters
Amount used for quote generation based on the selected quoteCategory.
• If quoteCategory is Sum Assured, this value represents the sum assured for the Life Assured.

• If quoteCategory is Premium, this value represents the premium amount for the Life Assured.

• If quoteCategory is Income, this field should NOT be populated. In this case, the income amount must be provided in DBPOption.incomeAmount.
This field is mandatory when: - typeOfQuote is Single Quote, and - memberType is Life Assured.
riderDetails object[]
List of riders selected for the insured member. This array is used to capture details of multiple riders applicable to an individual Life Assured. This field is required only when individual riders are applicable for the insured member. If no riders are selected, this array can be omitted or sent as empty.
varFields object[]
Array [
fieldName string
Possible values: <= 50 characters
Additional fields for individualDetails array
fieldValue string
Possible values: <= 50 characters
Value of additional fields
]
]
product object required
productType string required
Possible values: <= 30 characters
Specifies the Line of Business (LOB) or a group of similar products. The distributor can provide a generic product type, and the system (1SB) will automatically identify and select the relevant underlying products while creating the request for the manufacturer. This helps simplify integration by avoiding the need to pass individual product codes.
insuranceAndProducts object[]
Array to capture multiple insurance company codes and their specific product codes. This also allows the consumer to ask for quotes for a specific product of a specific company(s).
Array [
insuranceCompanyCode string
Possible values: <= 15 characters
Specifies the insurance company for which the quote should be generated. This field is used to restrict quote generation to a specific insurer instead of considering all eligible insurers. This field is mandatory when typeOfQuote is set to Single Quote.
productCode string[]
List of specific product codes for which the distributor wants quotes to be generated. This field allows restricting quote generation to only the selected products, instead of all eligible products under the given product type. This field is mandatory when typeOfQuote is set to Single Quote.
]
policyTerm integer
Duration (in years) for which the policy remains active and provides insurance coverage or benefits. This field is mandatory when typeOfQuote is set to Single Quote.
policyTermUnit string
Possible values: <= 15 characters
This is a futuristic field to allow policy term to be in days or months.
premiumPaymentOption string
Possible values: <= 20 characters, [1, 2, 3]
Specifies the premium payment option selected for the policy. This field is mandatory when typeOfQuote is set to Single Quote. Allowed values: - 1 (Single Pay): Premium for the entire policy term is paid once as a single lump-sum amount.
• 2 (Regular Pay): Premium is paid throughout the policy term. Premium Paying Term equals Policy Term.
• 3 (Limited Pay): Premium is paid for a limited number of years, which is less than the selected policy term.
premiumPaymentTerm integer
Possible values: <= 150 characters
Premium paying term is the total period (number of years or months) for which a policyholder has to pay premium, for a life policy. This field is mandatory for typeOfQuote= 'Single Quote'
premiumPaymentFrequency string
Possible values: <= 15 characters, [M, Q, HY, Y, S]
Specifies how often the policyholder pays the premium in a policy year. This field is mandatory when typeOfQuote is set to Single Quote. Frequency Codes: - M – Monthly - Q – Quarterly - HY – Half-Yearly - Y – Yearly - S – Single
planOption object
Possible values: <= 50 characters
Plan option selected and its details.
OptionSelected string
ID of the Plan Option selected. This field is mandatory for typeOfQuote = 'Single Quote' if a plan exists for the product selected.
varFields object[]
Other fields to be captured for plan option selected
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for planOption section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
coverOption object
Defines the type of Sum Assured structure selected for the policy and its associated attributes, if applicable.
• Level Sum Assured: Sum Assured remains constant throughout the policy term.
• Increasing Sum Assured: Sum Assured increases over the years during the policy term.
• Decreasing Sum Assured: Sum Assured decreases over the years during the policy term.
OptionSelected string
Possible values: <= 50 characters
ID of Cover Option selected. This field is mandatory for typeOfQuote= 'Single Quote'
varFields object[]
Array [
fieldName string
Possible values: <= 50 characters
Additional fields for coverOption array
fieldValue string
Possible values: <= 50 characters
Value of additional fields
]
DBPoption object
Defines the Death Benefit Payout (DBP) option, which determines how the death benefit amount will be paid to the nominee.
• Lump Sum: Entire death benefit is paid in a single payout.
• Income: Death benefit is paid as regular income for a specified period.
• Lump Sum + Income: Combination of lump sum payout and income payout, subject to product availability.
This section is mandatory when typeOfQuote is set to Single Quote.
OptionSelected string
Possible values: <= 30 characters
Death Benefit Payout Option selected.
lumpsumPayoutPercent number
Possible values: <= 1000 characters
This field refers to the percentage of death benefit amount to be paid out as lumpsum. Rest of the amount will be usually paid as an income.
lumpsumAmount number
Possible values: <= 15 characters
The amount paid out as lumpsum will be captured in this field
incomeAmount number
Possible values: <= 15 characters
This field will capture the amount of the income payout. A product can have a predefined value or product may give this as a choice to the customer
incomeFrequency string
Possible values: <= 30 characters
This field will capture the frequency of the income payout. A product can have a predefined value or product may give this as a choice to the customer
incomeTerm integer
This field will capture the term of the income payout. A product can have a predefined value or product may give this as a choice to the customer
incomeTermUnit string
Possible values: <= 15 characters
This field will capture the unit of the income payout term. A product can have a predefined value or product may give this as a choice to the customer
incomeIncreasingPercent integer
Possible values: <= 100 characters
If the death benefit payout is in the form of an increasing income, then the percentage of increase will be captured here
varFields object[]
Array [
fieldName string
Possible values: <= 50 characters
Additional fields for DBPOption section
fieldValue string
Possible values: <= 50 characters
Value of additional fields
]
AddOnSection object
returnOfPremium object
returnOfPremiumPercentage integer
Percentage of the total premiums paid that will be returned to the customer if the Return of Premium (ROP) option is selected.
• Send a value greater than 0 to opt for Return of Premium. - Send 0 if the Return of Premium option is not opted. This field is mandatory when typeOfQuote is set to Single Quote.
varFields object[]
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for returnOfPremium section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
AddOns object[]
Array [
OptionSelected string
Possible values: <= 20 characters
AddOn Option selected
addOnSumAssured number
Possible values: <= 15 characters
Sum assured corresponding to selected Option
varFields object[]
Other fields to be captured for AddOn benefits selected
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for AddOnBenefits section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
]
riderInformation object
Rider section to hold all rider related details available for products.
riderDetails object[]
Rider array to capture details of multiple riders
Array [
riderCode string
Possible values: <= 20 characters
riderCode to identify the rider selected
riderTerm integer
Possible values: <= 150 characters
Policy Term of the rider
riderPremiumPayingTerm integer
Possible values: <= 150 characters
Premium Paying Term of the rider
riderSA number
Possible values: <= 20 characters
Sum Assured pertaining to the rider
varFields object[]
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for rider array
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
]
newOptions object
Array created to capture any new type of option which may be introduced in the future.
newOptionName string
Possible values: <= 100 characters
Field will identify which type of option this is
optionValues object[]
This array will contain the details for various options available for each newOptionName
Array [
OptionSelected string
For each type of option, this will contain the value of Option selected
varFields object[]
Array to capture attributes of the option selected.
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for newOption array
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
]
varFields object[]
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for product section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
other object
keyFeatureDocLanguage
Possible values: <= 30 characters
Key Feature Document is a document which captures the details of the Insurance Product in simple language as required by the regulator and is usually 'shared with the customer along with Business Illustration. This field captures the language in which this document should be.
varFields object[]
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for other section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]

Responses

• 200
• 400
• 500

---

Consumer Response

application/json

Schema

Example (from schema)

---

Schema

data object required
Section to carry quote responses Enumvalue
request object
Entire request object to be replicated here.
quote object[] required
Possible values: >= 1
The product array will contain all details related to a product like premiums, income, sum assured, rider details etc.
Array [
insuranceAndProducts object
Section to hold details of insurance company and the product for which the following details are provided
insuranceCompanyCode string required
Possible values: <= 15 characters
This code identifies the insurance company for which quote is given.
productType string required
Possible values: <= 30 characters
This gives Line of Business of the product for which quote is generated.
productCode string required
Possible values: <= 15 characters
This field carries the productCode of the product for which quote is generated.
insuranceCompanyName string
Possible values: <= 15 characters
This field carries the insurance company which quote is generated.
productName string required
Possible values: <= 50 characters
This gives the Name of the product selected
productDetails object
Section to hold details regarding product parameters
premiumPaymentTerm number required
Possible values: <= 100 characters
Premium paying term is the total period (number of years or months) for which a policyholder has to pay premium, for a life policy.
policyTerm number required
Possible values: <= 1500 characters
Policy term is the period within which a policy remains active and offers protection/benefits
policyTermUnit string
Possible values: <= 15 characters
This is a futuristic field to allow policy term to be in days or months.
premiumPaymentFrequency string required
Possible values: <= 15 characters, [M, Q, HY, Y, S]
This is defined as the number of times during the policy year that you need to pay premiums. Frequency options are typically annual, semi-annual, quarterly and monthly.
premiumPaymentOption string required
Possible values: <= 20 characters, [1, 2, 3]
(1 stands for Single pay, 2 stands for Regular pay, 3 stands for Limited pay). With single Pay option, you have the option to pay the premium for the entire policy term at once as a lump-sum amount. In Regular Pay option, the premium paying term is the same as the Policy Term chosen. With Limited Pay option, the premium is paid for a limited number of years which is less than the policy term.
planOption object required
Plan option selected and its details
OptionSelected string
Possible values: <= 50 characters
ID of the Plan Option selected
planName string
Possible values: <= 50 characters
Plan Name selected
planDesc string
Possible values: <= 100 characters
Plan description
varFields object[]
Other fields to be captured for plan option selected
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for planOption section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
CoverOption object required
Cover option selected and its details
OptionSelected string
Possible values: <= 50 characters
ID of the Cover Option selected
SAChangePercent number nullable
Percentage change in Sum Assured, if applicable
optionName string
Possible values: <= 100 characters
Name of the cover option selected
optionDesc string
Possible values: <= 100 characters
Description of the cover option selected
levelCoverPeriod string
Possible values: <= 50 characters
Level cover period, if applicable
varFields object[]
Other fields to be captured for cover option selected
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for coverOption section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
DBPoption object required
Death Benefit Payout option selected and its details
OptionSelected string
Possible values: <= 50 characters
ID of the Death Benefit Payout Option selected
optionName string
Possible values: <= 100 characters
Name of the DBP option selected
optionDesc string
Possible values: <= 100 characters
Description of the DBP option selected
lumpsumPercent number
Possible values: <= 80 characters
This field refers to the percentage of death benefit amount to be paid out as lumpsum. Rest of the amount will be usually paid as an income.
lumpsumAmount number
The amount paid out as lumpsum will be captured in this field
incomePercent number
This field refers to the percentage of death benefit amount to be paid out as income. Rest of the amount will be usually paid as a lumpsum.
incomeAmount number
This field will capture the amount of the income payout. A product can have a predefined value or product may give this as a choice to the customer
incomeTerm integer
This field will capture the term of the income payout. A product can have a predefined value or product may give this as a choice to the customer
incomeTermUnit string
Possible values: <= 30 characters
This field will capture the unit of the income payout term. A product can have a predefined value or product may give this as a choice to the customer
incomeFrequency string
Possible values: <= 15 characters
This field will capture the frequency of the income payout. A product can have a predefined value or product may give this as a choice to the customer
varFields object[]
Other fields to be captured for DBP option selected
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for DBPOption section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
AddOnSection object required
Section to capture all add on related information
returnOfPremium object
Sub-section for return of premium details
returnOfPremiumPercentage number
% of total premiums paid to be received as return of premium
maturityBenefit number
Total benefit amount to be revived as return of premium
varFields object[]
Other fields to be captured for ROP option selected
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for Return of Premium section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
addOnSelected object[]
This array will hold details of addons selected
Array [
optionSelected string
Possible values: <= 50 characters
ID of the Addon selected
optionName string
Possible values: <= 100 characters
Name of the addon option selected
optionDesc string
Possible values: <= 100 characters
Description of the addon selected
addOnSumAssured number
Sum assured corresponding to selected Option
premiumIncludedFlag string
Possible values: <= 10 characters
Value of 'Yes' in this flag indicates that the addOn premium is included in the individual death benefit premium and the below premium fields will not be populated and premiums fields will not be present. If 'No' then the addOn specific premium is provided in below premium fields.
mandatoryInProduct string
Possible values: [Yes, No]
Indicates if add-on is mandatory in product
inbuiltFeature string
Possible values: [Yes, No]
Indicates if add-on is an inbuilt feature
premiumDetails object[]
Premium details for the selected add-on
Array [
mode string nullable
Premium payment mode
premiumValue number nullable
Premium amount before tax
tax object[]
Tax breakup
Array [
taxCode string nullable
Tax code
taxDescription string nullable
Tax description
taxValue number nullable
Tax value
taxPercent number nullable
Tax percentage
totalTax number nullable
Total tax amount
totalPremiumValue number nullable
Total premium including tax
varFields object[]
Other fields to be captured for AddOnSelected array
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for AddOnSelected array
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
]
]
]
newOptions object[]
Array created to capture any new type of option which may be introduced in the future.
Array [
newOptionName object[]
Field will identify which type of option this is
Array [
OptionSelected string
Possible values: <= 50 characters
For each type of option, this will contain the value of Option selected
optionName string
Possible values: <= 100 characters
Name of the new option selected
optionDesc string
Possible values: <= 100 characters
Description of the new selected
varFields object[]
Array to capture attributes of the new Option selected.
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for newOption array
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
]
]
rider object[]
Rider array will capture all the details for various riders under product section
Array [
ridercode string
Possible values: <= 15 characters
Rider code will help to identify the rider.
riderTerm integer
Policy term for rider
riderPremiumPayingTerm integer
Premium paying term of rider
riderSA number
Sum assured for rider
premiumDetails object[]
This array will contain rider premium and tax details for various modes of payment for the corresponding premium code.
Array [
mode string
Possible values: <= 15 characters
Mode is the premium payment frequency.
riderPremiumValue number
The rider premium value excluding taxes.
tax object[]
Tax array will help to capture multiple taxes applicable for each rider premium
Array [
taxCode string
Possible values: <= 30 characters
Tax code will help to identify the type of tax.
taxDescription string
Possible values: <= 50 characters
Description of the tax
taxValue number
Tax amount as per tax code
taxPercent number
Tax percentage
]
totalTax number
This field gives the sum of all applicable taxes.
totalPremiumValue number
The rider premium value including taxes.
]
varFields object[]
Array to capture attributes of the rider
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for rider section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
]
individualDetails object[]
This array will hold personal details of each life assured
Array [
memberSequenceNumber string
Possible values: <= 100 characters
Unique sequence number of member as by provided in request.
memberType string
Possible values: <= 100 characters
Unique member type as by provided in request.
age integer
Possible values: <= 100 characters
Age of the member
gender string
Possible values: <= 100 characters
Gender of the member
zipCode integer
Possible values: <= 5 characters
Zipcode
occupation string
Possible values: <= 100 characters
Age of the member
annualIncome integer
Possible values: <= 100 characters
annual income of the member
sumAssured number
Possible values: <= 100 characters
The sum assured amount is captured here.
relationWithFirstLifeAssured number
Possible values: <= 100 characters
Relation with First Life Assured.
premiumDetails object[]
This array will contain premium and tax details for various modes of payment for the corresponding premium code.
Array [
mode string
Possible values: <= 15 characters
Mode is the premium payment frequency.
premiumValue number
The premium value excluding taxes.
tax object[]
Tax array will help to capture multiple taxes applicable for each premium
Array [
taxCode string
Possible values: <= 30 characters
Tax code will help to identify the type of tax.
taxDescription string
Possible values: <= 50 characters
Description of the tax
taxValue number
Tax amount as per tax code
taxPercent number
Tax percentage
]
totalTax number
This field gives the sum of all applicable taxes.
totalPremiumValue number
The premium value including taxes.
]
rider object[]
Rider array will capture all the details for various riders at individual level
Array [
ridercode string
Possible values: <= 15 characters
Rider code will help to identify the rider.
riderTerm integer
Policy term for rider
riderPremiumPayingTerm integer
Premium paying term of rider
riderSA number
Sum assured for rider
premiumDetails object[]
This array will contain rider premium and tax details for various modes of payment for the corresponding premium code.
Array [
mode string
Possible values: <= 15 characters
Mode is the premium payment frequency.
riderPremiumValue number
The rider premium value excluding taxes.
tax object[]
Tax array will help to capture multiple taxes applicable for each rider premium
Array [
taxCode string
Possible values: <= 30 characters
Tax code will help to identify the type of tax.
taxDescription string
Possible values: <= 50 characters
Description of the tax
taxValue number
Tax amount as per tax code
taxPercent number
Tax percentage
]
totalRiderTax number
This field gives the sum of all applicable taxes.
totalRiderPremiumValue number
The rider premium value including taxes.
]
varFields object[]
Array to capture attributes of the rider
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for rider section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
]
varFields object[]
Other fields to be captured for individualDetails array
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for individualDetails array
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
]
totalPremiumDetails object[]
Total premium Details array will capture premium of product , Addon and Riders. This array will hold values only premium split between addons is available. Applicable only for Single Quote
Array [
premiumValue number
Possible values: <= 30 characters
The premium value excluding taxes.
premiumValueAddons number
Possible values: <= 30 characters
This field gives the sum of all applicable premium value excluding taxes for all the Addon.
premiumValueRider number
Possible values: <= 30 characters
This field gives the sum of all applicable premium value excluding taxes for all the Rider.
taxValue number
Possible values: <= 30 characters
Tax amount as per tax code
taxValueAddons number
Possible values: <= 30 characters
This field gives the sum of all applicable Tax amount as per tax code for all the Addon
taxValueRider number
Possible values: <= 30 characters
This field gives the sum of all applicable Tax amount as per tax code for all the Rider
totalPremiumValue number
Possible values: <= 30 characters
This field gives the sum of all applicable taxes.
totalTax number
Possible values: <= 30 characters
This field gives the sum of all applicable Premium excluding taxes.
totalPremiumWithTax number
Possible values: <= 30 characters
This field gives the sum of all applicable Premium including taxes.
varFields object[]
Variable array to hold any other parameters in supporting data section.
Array [
fieldName string
Possible values: <= 100 characters
Name of the variable field. This array will hold multiple values.
fieldType string
Possible values: <= 100 characters
This will specify if the parameter will have a single value or multiple values (array).
fieldValue object[]
Array for capturing values
Array [
value string
Possible values: <= 150 characters
Value of additional parameter
]
]
]
discount object[]
Details of discounts applied to the quotation or policy
Array [
discountPercentage double nullable
Percentage of discount applied
discountValue double nullable
Absolute discount value
totalDiscountAddon double nullable
Total discount applied on add-ons
totalDiscountPremiumValue double nullable
Total premium discount value
totalTotalDiscount double nullable
Total discount amount including all components
totalCumulatveDiscount double nullable
Cumulative discount across all discount types
varFields object[]
Dynamic or configurable discount fields
Array [
fieldName string nullable
Name of the dynamic discount field
fieldValue string nullable
Value of the dynamic discount field
]
]
trackInfo object
This section will contain all quote tracking information
manufacturerQuoteID string
Quote Response Id generated by manufacturer. This will be shared with consumer only in case of Single Quote
manuApplicationNo string
Quote Response No generated by manufacturer. This will be shared with consumer only in case of Single Quote
uniqueQuoteId string
unique Quote Response id generated by manufacturer. This will be shared with consumer only in case of Single Quote
varFields object[]
Array to capture additional fields of the trackInfo section
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for variable section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
supportingData object
This section will capture the additional supporting data for the product that consumer app can use for managing product related information on consumer UI.
validRanges object required
This section will contain the valid ranges of various parameters allowed for the product based on age.
PremiumPayingTerm object[]
Array for holding valid premium paying term values
Array [
value string
Valid Premium Paying Term values
]
SumAssured object
Section for holding valid Sum Assured values
min string
Possible values: <= 15 characters
Valid minimum Sum assured value
max string
Possible values: <= 15 characters
Valid maximum Sum assured value
multipleOf string
Possible values: <= 15 characters
Sum assured can only be a multiple of this value
PolicyTerm object
Section for holding valid Policy Term values
min string
Possible values: <= 150 characters
Valid minimum Policy Term value
max string
Possible values: <= 150 characters
Valid maximum Policy Term value
varFields object[]
Variable array to hold any other parameters.
Array [
fieldName string
Possible values: <= 50 characters
Name of the variable field. This array will hold multiple values.
fieldType string
Possible values: <= 50 characters
This will specify if the parameter will have a single value or multiple values (array).
fieldValue object[]
Array for capturing values
Array [
value string
Possible values: <= 150 characters
Value of additional parameter
]
]
invalidFeatureCombinations object[]
This array will capture all the combinations of options that are not allowed together.
Array [
Combo object[]
Array of values
Array [
fieldLevel string
Possible values: <= 100 characters
This will indicate if the field belongs to individual or product sections. Valid values are 'individualDetails', 'productDetails'.
memberSequenceNumber string
Possible values: <= 100 characters
Sequence number of member. This will carry value when fieldLevel is 'individualDetails'
fieldType string
Possible values: <= 100 characters
This will indicate if the field is an 'option' or a 'rider'
fieldValue string
Possible values: <= 150 characters
If fieldType is 'option' then this field will carry optionID, if fieldType is 'rider' then this field will carry value of rider product code.
]
]
outOfRangeDetails object[]
If the customer provides an input which is out of bound of product boundary conditions, 1SB will still provide a quote by changing the parameter. This array will indicate which parameter was out of bound and changed by 1SB to generate a valid quote.
Array [
fieldLevel string
Possible values: <= 100 characters
This will indicate if the field belongs to individual or product sections. Valid values are 'individualDetail', 'productDetails'
memberSequenceNumber string
Possible values: <= 100 characters
Sequence number of member. This will carry value when fieldLevel is 'individualDetails'
fieldType string
Possible values: <= 100 characters
This will indicate if the field is an 'option' or a 'rider'
fieldCode string
Possible values: <= 100 characters
If fieldType is 'option' then this field will carry optionID, if fieldType is 'rider' then this field will carry value of rider product code.
OutOfRangeFieldName string
Possible values: <= 100 characters
The name of the json field (parameter) which was out of range will be captured here. Example: product allows policy term only till 75 but customer has selected policy Term as 80. 1SB will default the policy term to 75 and send a quote. The name of the changed out of range parameter, 'policyTerm' in this case will be present in this field
]
Messages object required
All product related messages will be captured in this section
TypeofMedical string
Possible values: <= 100 characters
Type of medical which is applicable as per the customers age
ClaimSettlementPercent string
Possible values: <= 100 characters
Claim settlement ratio of the insurance company
ClaimSettlementTAT string
Possible values: <= 100 characters
Claim settlement TAT of the insurance company
productFeatures string
Possible values: <= 5000 characters
All product features will be shared via this field
brochureLink string
Possible values: <= 200 characters
The URL for the product brochure link will be shared in this field.
isWholeLifePlan string
Possible values: <= 10 characters
This field indicates if the product supports whole life plan option or not.
riderMedical string
Possible values: <= 10 characters
Does any of the selected riders need medical tests? If yes then this field will carry value as Yes.
Home_Medicals string
Possible values: <= 10 characters
This field indicates if the manufacturer supports home collection of samples for medical tests.
medicalExpensesDeductible string
Possible values: <= 10 characters
This field indicates if the manufacturer supports deduction or adjustment of expenses of the medical tests if the tests are paid for by the customer.
PolicyIssuanceTime string
Possible values: <= 5 characters
Average time required by the manufacturer to issue a policy (in number of days)
MarketingMessages object[]
This array will contain all other product and manufacturer related marketing messages or information.
Array [
Message string
Possible values: <= 500 characters
If fieldType is 'option' then this field will carry optionID, if fieldType is 'rider' then this field will carry value of rider product code.
]
Bonus object[]
This array will contain all other product and manufacturer related marketing messages or information.
Array [
bonusName string
Possible values: <= 500 characters
Bonus Name
bonusRate string
Possible values: <= 500 characters
Bonus Rate.
]
varFields object[]
Array to capture additional fields of the Messages section
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for variable section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
insCompanyLogo string required
Possible values: <= 500 characters
This fields will contain the logo of insurance company
productLogo string required
Possible values: <= 500 characters
This fields will contain the logo of insurance product if available
other object
All other details not related to product or personal information will be captured here.
biUrl string
Possible values: <= 100 characters
URL for the Benefit illustration
biNo string
Possible values: <= 500 characters
Benefit illustration Number
keyFeatureDocumentLanguage string
Possible values: <= 30 characters
Key Feature document language is stored here
varFields object[]
Array to capture additional fields of the other section
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for variable section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
varFields object[]
Array to capture additional fields of the quote array
Array [
fieldName string
Possible values: <= 100 characters
Additional fields for variable section
fieldValue string
Possible values: <= 100 characters
Value of additional fields
]
]
errors object[]

This array contains error messages in case of an error

reqId string required

Request Id for the quote assigned by 1SB

{
  "data": {
    "request": {},
    "quote": [
      {
        "insuranceAndProducts": {
          "insuranceCompanyCode": "EFGLife",
          "productType": "lifeTerm",
          "productCode": "string",
          "insuranceCompanyName": "string",
          "productName": "My Term Product"
        },
        "productDetails": {
          "premiumPaymentTerm": 20,
          "policyTerm": 20,
          "policyTermUnit": "Years",
          "premiumPaymentFrequency": "M",
          "premiumPaymentOption": 1,
          "planOption": {
            "OptionSelected": "13",
            "planName": "Life",
            "planDesc": "Under this option, the life assured is covered for death bennefit during the policy term, which can be accelerated in the case of diagnosis of terminal illness.",
            "varFields": [
              {
                "fieldName": "string",
                "fieldValue": "string"
              }
            ]
          },
          "CoverOption": {
            "OptionSelected": "4",
            "SAChangePercent": null,
            "optionName": "Level Sum Assured",
            "optionDesc": "Level Sum Assured",
            "levelCoverPeriod": "",
            "varFields": [
              {
                "fieldName": "string",
                "fieldValue": "string"
              }
            ]
          },
          "DBPoption": {
            "OptionSelected": "string",
            "optionName": "Lump sum payout",
            "optionDesc": "Lump sum payout",
            "lumpsumPercent": 60,
            "lumpsumAmount": 6000000,
            "incomePercent": 40,
            "incomeAmount": 4000000,
            "incomeTerm": 10,
            "incomeTermUnit": "Years",
            "incomeFrequency": "M",
            "varFields": [
              {
                "fieldName": "string",
                "fieldValue": "string"
              }
            ]
          },
          "AddOnSection": {
            "returnOfPremium": {
              "returnOfPremiumPercentage": 0,
              "maturityBenefit": 400000,
              "varFields": [
                {
                  "fieldName": "string",
                  "fieldValue": "string"
                }
              ]
            },
            "addOnSelected": [
              {
                "optionSelected": "string",
                "optionName": "Terminal Illness Benefit",
                "optionDesc": "Terminal Illness Benefit",
                "addOnSumAssured": 0,
                "premiumIncludedFlag": "string",
                "mandatoryInProduct": "No",
                "inbuiltFeature": "Yes",
                "premiumDetails": [
                  {
                    "mode": null,
                    "premiumValue": null,
                    "tax": [
                      {
                        "taxCode": null,
                        "taxDescription": null,
                        "taxValue": null,
                        "taxPercent": null,
                        "totalTax": null,
                        "totalPremiumValue": null,
                        "varFields": [
                          {
                            "fieldName": "string",
                            "fieldValue": "string"
                          }
                        ]
                      }
                    ]
                  }
                ]
              }
            ]
          },
          "newOptions": [
            {
              "newOptionName": [
                {
                  "OptionSelected": "string",
                  "optionName": "null",
                  "optionDesc": "null",
                  "varFields": [
                    {
                      "fieldName": "string",
                      "fieldValue": "string"
                    }
                  ]
                }
              ]
            }
          ]
        },
        "rider": [
          {
            "ridercode": "string",
            "riderTerm": 0,
            "riderPremiumPayingTerm": 0,
            "riderSA": 0,
            "premiumDetails": [
              {
                "mode": "string",
                "riderPremiumValue": 0,
                "tax": [
                  {
                    "taxCode": "string",
                    "taxDescription": "string",
                    "taxValue": 0,
                    "taxPercent": 0
                  }
                ],
                "totalTax": 0,
                "totalPremiumValue": 0
              }
            ],
            "varFields": [
              {
                "fieldName": "string",
                "fieldValue": "string"
              }
            ]
          }
        ],
        "individualDetails": [
          {
            "memberSequenceNumber": "1",
            "memberType": "Life Assured",
            "age": 25,
            "gender": "MALE",
            "zipCode": 400022,
            "occupation": "Salaried",
            "annualIncome": 1000000,
            "sumAssured": 100000000,
            "relationWithFirstLifeAssured": "Self",
            "premiumDetails": [
              {
                "mode": "Y",
                "premiumValue": 20000,
                "tax": [
                  {
                    "taxCode": "lifeTerm_GST",
                    "taxDescription": "GST",
                    "taxValue": 3600,
                    "taxPercent": 18
                  }
                ],
                "totalTax": 3600,
                "totalPremiumValue": 23600
              }
            ],
            "rider": [
              {
                "ridercode": "string",
                "riderTerm": 0,
                "riderPremiumPayingTerm": 0,
                "riderSA": 0,
                "premiumDetails": [
                  {
                    "mode": "string",
                    "riderPremiumValue": 0,
                    "tax": [
                      {
                        "taxCode": "string",
                        "taxDescription": "string",
                        "taxValue": 0,
                        "taxPercent": 0
                      }
                    ],
                    "totalRiderTax": 0,
                    "totalRiderPremiumValue": 0
                  }
                ],
                "varFields": [
                  {
                    "fieldName": "string",
                    "fieldValue": "string"
                  }
                ]
              }
            ],
            "varFields": [
              {
                "fieldName": "string",
                "fieldValue": "string"
              }
            ]
          }
        ],
        "totalPremiumDetails": [
          {
            "premiumValue": 12900,
            "premiumValueAddons": 1265,
            "premiumValueRider": 201,
            "taxValue": 1290,
            "taxValueAddons": 126,
            "taxValueRider": "Y20",
            "totalPremiumValue": 13677,
            "totalTax": 1877,
            "totalPremiumWithTax": 14989,
            "varFields": [
              {
                "fieldName": "string",
                "fieldType": "string",
                "fieldValue": [
                  {
                    "value": "string"
                  }
                ]
              }
            ]
          }
        ],
        "discount": [
          {
            "discountPercentage": 5.5,
            "discountValue": 1200,
            "totalDiscountAddon": 300,
            "totalDiscountPremiumValue": 1500,
            "totalTotalDiscount": 1800,
            "totalCumulatveDiscount": 2000,
            "varFields": [
              {
                "fieldName": "string",
                "fieldValue": "string"
              }
            ]
          }
        ],
        "trackInfo": {
          "manufacturerQuoteID": "string",
          "manuApplicationNo": "string",
          "uniqueQuoteId": "string",
          "varFields": [
            {
              "fieldName": "string",
              "fieldValue": "string"
            }
          ]
        },
        "supportingData": {
          "validRanges": {
            "PremiumPayingTerm": [
              {
                "value": "string"
              }
            ],
            "SumAssured": {
              "min": "string",
              "max": "string",
              "multipleOf": "string"
            },
            "PolicyTerm": {
              "min": "string",
              "max": "string"
            },
            "varFields": [
              {
                "fieldName": "string",
                "fieldType": "string",
                "fieldValue": [
                  {
                    "value": "string"
                  }
                ]
              }
            ]
          },
          "invalidFeatureCombinations": [
            {
              "Combo": [
                {
                  "fieldLevel": "string",
                  "memberSequenceNumber": "string",
                  "fieldType": "string",
                  "fieldValue": "string"
                }
              ]
            }
          ],
          "outOfRangeDetails": [
            {
              "fieldLevel": "string",
              "memberSequenceNumber": "string",
              "fieldType": "string",
              "fieldCode": "string",
              "OutOfRangeFieldName": "string"
            }
          ],
          "Messages": {
            "TypeofMedical": "string",
            "ClaimSettlementPercent": "string",
            "ClaimSettlementTAT": "string",
            "productFeatures": "string",
            "brochureLink": "string",
            "isWholeLifePlan": "Yes",
            "riderMedical": "Yes",
            "Home_Medicals": "Yes",
            "medicalExpensesDeductible": "Yes",
            "PolicyIssuanceTime": "15",
            "MarketingMessages": [
              {
                "Message": "string"
              }
            ],
            "Bonus": [
              {
                "bonusName": "string",
                "bonusRate": "string"
              }
            ],
            "varFields": [
              {
                "fieldName": "string",
                "fieldValue": "string"
              }
            ]
          },
          "insCompanyLogo": "string",
          "productLogo": "string"
        },
        "other": {
          "biUrl": "string",
          "biNo": "string",
          "keyFeatureDocumentLanguage": "string",
          "varFields": [
            {
              "fieldName": "string",
              "fieldValue": "string"
            }
          ]
        },
        "varFields": [
          {
            "fieldName": "string",
            "fieldValue": "string"
          }
        ]
      }
    ]
  },
  "errors": [
    {}
  ],
  "reqId": "string"
}

Consumer Response

application/json

Schema

Example (from schema)

---

Schema

data object

Section to carry quote responses

errors object[] required
This array contains error messages in case of an error
Array [
errorCode string
Possible values: <= 50 characters
In case error occurs, the error code will be stored here
errorDisplayMessage string
Possible values: <= 100 characters
In case error occurs, the error display message will be stored here
errorIdentifier string
Possible values: <= 20 characters
In case error occurs, the error identifier will be stored here
errorMessage string
Possible values: <= 100 characters
In case error occurs, the error message will be stored here
errorType string
Possible values: <= 10 characters
In case error occurs, the error type will be stored here
]
reqId string required

Request Id for the quote assigned by 1SB

{
  "data": {},
  "errors": [
    {
      "errorCode": "string",
      "errorDisplayMessage": "string",
      "errorIdentifier": "string",
      "errorMessage": "string",
      "errorType": "string"
    }
  ],
  "reqId": "string"
}

Consumer Response

application/json

Schema

Example (from schema)

---

Schema

data object

Section to carry quote responses

errors object[] required
This array contains error messages in case of an error
Array [
errorCode string
Possible values: <= 50 characters
In case error occurs, the error code will be stored here
errorDisplayMessage string
Possible values: <= 100 characters
In case error occurs, the error display message will be stored here
errorIdentifier string
Possible values: <= 20 characters
In case error occurs, the error identifier will be stored here
errorMessage string
Possible values: <= 100 characters
In case error occurs, the error message will be stored here
errorType string
Possible values: <= 10 characters
In case error occurs, the error type will be stored here
]
reqId string required

Request Id for the quote assigned by 1SB

{
  "data": {},
  "errors": [
    {
      "errorCode": "string",
      "errorDisplayMessage": "string",
      "errorIdentifier": "string",
      "errorMessage": "string",
      "errorType": "string"
    }
  ],
  "reqId": "string"
}

Loading...