Get quote
Consumer Request
Request Body required
- Array [
- ]
- Array [
- Array [
- Array [
- ]
- ]
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- ]
- ]
- Array [
- Array [
- ]
- ]
- Array [
- ]
- Array [
- ]
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
Possible values: <= 20 characters, [Premium, Sum Assured, Income]
This field tells if the quoteAmount provided is a Sum Assured, or a Premium, or an Income.
Possible values: <= 10 characters, [Yes, No]
If the consumer wants payment frequency related multi-quote, this field should carry the values 'Yes' else 'No'. Example for frequency related multi-quote : If customer inputs premiumPaymentFrequency as 'Monthly', 'Quarterly', or 'Half-Yearly', then 1SB will provide premium for given as well as 'Yearly' frequency. If customer inputs premiumPaymentFrequency as 'Yearly', 1SB will provide premium for 'Yearly' as well as 'Monthly' frequency.
Possible values: <= 10 characters, [Yes, No]
If the distributor wants quotes for 'Out of Bound' cases, this field should carry the values 'Yes' else 'No'. Example for 'Out of Bound' case: If the customer inputs policyTerm as 40 but the product only allows max policyTerm as 30, 1SB will default the policyTerm to 30 and generate a quote indicating that policyTerm parameter is out of bound. Consumer App can showcase this quote to consumer to ensure that a particular product is not eliminated from listing.
additionalSetup object
This section will contain additional information regarding user and policy
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
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
Possible values: <= 30 characters
Region (State or Province) of the user
Possible values: <= 20 characters
Language set by user on the consumer app
Possible values: <= 20 characters
User IP address
Possible values: <= 50 characters
User's browser details
userGeoLocation object
Return a JSON object with latitude and longitude properties to point to location of user
Possible values: <= 50 characters
Latitude in Decimal degrees
Possible values: <= 50 characters
LOngitude in Decimal degrees
distributor object required
This section will give details of intermediary (Broker, corporate Agent or Bank acting as intermediary)
Possible values: <= 20 characters
Distributor ID assign to each consumer by 1SB
Possible values: <= 30 characters
agent code. Eg. PoSP code or SP code provided by insurance company.
Possible values: <= 20 characters, [Online, Others]
This is used by insurance companies to identify sales channel.
Possible values: <= 20 characters, [B2B, B2C]
Indicates if the transaction is B2B or B2C.
Possible values: <= 20 characters, [POSP, SP, BQP]
Indicates if the agent type is POSP ,SP or BQP.
varFields object[]
Possible values: <= 50 characters
Additional fields for distributor section
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
Possible values: <= 30 characters
Indicates if the information is being captured for life assured or proposer.
This is the sequence number to be assigned by consumer app to each member of IndividualDetail Array. This should be a unique value (greater than 0) for each member within each quote.
Possible values: <= 30 characters, [Mr, Mrs, Ms]
Title of Member.
Possible values: <= 50 characters
First Name of Member
Possible values: <= 50 characters
Middle Name of Member
Possible values: <= 50 characters
Last Name of Member
Possible values: <= 15 characters, [Male, Female, Transgender, Others]
Gender of Member.
Date of Birth of Member. Date is formatted string as per ISO 8601 standard. Format - YYYY-MM-DD
Possible values: <= 150 characters
Age of Member
Possible values: <= 30 characters, [Married, Single]
Marital status of Member.
Possible values: <= 50 characters, [Post Graduate, Graduate, 12th, 10th, Diploma, Below 10th]
Education of Member.
Possible values: <= 50 characters, [Salaried, Self-Employed, Non-working]
Occupation of Member.
Possible values: <= 15 characters
Annual Income of Member. Existing earnings per year.
Possible values: <= 100 characters
Email ID of Member
Possible values: <= 10 characters
Mobile number of Member
Possible values: <= 10 characters, [No, Yes]
Smoker/Non-Smoker status of Member
Possible values: <= 30 characters
Relationship of life assured with Proposer. example: Self, Spouse, mother, father etc. This field is mandatory for typeOfQuote= 'Single Quote'
Possible values: <= 10 characters
This is Pin code
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, NOST, HARAYANA, KARNATAKA, MADHYA PRADESH, MIZORAM, PONDICHERRY, TAMIL NADU, WEST BENGAL, CHHATTISGARH]
State of Member
Possible values: <= 50 characters
City of Member
Possible values: <= 15 characters
Amount based on Quote Category. Can be the amount corresponding to Sum Assured and Premium for the person insured. In case quoteCategory is Income, then the amount should be captured under DBPOption incomeAmount. This field is mandatory for typeOfQuote = 'Single quote' and 'memberType = '1' (Life assured)
riderDetails object[]
Rider array to capture details of multiple riders for each insured
Possible values: <= 20 characters
riderCode to identify the rider selected
Possible values: <= 150 characters
Policy Term of the rider
Possible values: <= 150 characters
Premium Paying Term of the rider
Possible values: <= 20 characters
Sum Assured pertaining to the rider
varFields object[]
Possible values: <= 50 characters
Additional fields for rider array
Possible values: <= 50 characters
Value of additional fields
varFields object[]
Possible values: <= 50 characters
Additional fields for individualDetails array
Possible values: <= 50 characters
Value of additional fields
product object required
Possible values: <= 30 characters
This gives Line of Business or similar products put in one group. Distributor can provide generic LOB and 1SB can pick in relevant products while creating request for Manufacturer
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).
Possible values: <= 15 characters
This is to provide quotes from selected companies. This field is mandatory for typeOfQuote= 'Single Quote'
Option for distributor to ask for quotes for specific products only. This field is mandatory for typeOfQuote= 'Single Quote'
Possible values: [nonParticipating, Participating, ULIP]
This field will help to filter savings products between participating, nonParticipating and ULIP. If no input is sent in this field, 1SB will respond with all products savings products available mentioned in insuranceAndProducts array
Policy term is the period within which a policy remains active and offers protection/benefits. This field is mandatory for typeOfQuote= 'Single Quote'
Possible values: <= 15 characters
This is a futuristic field to allow policy term to be in days or months.
Possible values: <= 20 characters, [1, 2, 3]
(Send 1 for Single pay, 2 for Regular pay, 3 for Limited pay). This field is mandatory for typeOfQuote= 'Single Quote'. 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.
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'
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. This field is mandatory for typeOfQuote= 'Single Quote'
planOption object
Possible values: <= 50 characters
Plan option selected and its details.
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
Possible values: <= 100 characters
Additional fields for planOption section
Possible values: <= 100 characters
Value of additional fields
coverOption object required
This section will tell what kind of Sum Assured is Opted for and its attributes if any. Level Sum Assured means that the Sum Assured remains the same throughout the policy term. Increasing or Decreasing Sum Assured means that the Sum Assured will increase or decrease through the years during the policy term
Possible values: <= 50 characters
ID of Cover Option selected. This field is mandatory for typeOfQuote= 'Single Quote'
In case an increasing or decreasing Sum Assured cover option is selected, this field will capture the percentage change (increase or decrease) on Sum Assured
varFields object[]
Possible values: <= 50 characters
Additional fields for coverOption array
Possible values: <= 50 characters
Value of additional fields
DBPoption object required
This section tells how the death benefit should be paid out and additional details regarding it. Lumpsum means the entire amount is paid in one go. Income means the death benefit amount will be paid out as an income for a specific period. Combination of Lumpsum and Income can also be chosen as per availability under the product. This field is mandatory for typeOfQuote= 'Single Quote'
Possible values: <= 30 characters
Death Benefit Payout Option selected.
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.
Possible values: <= 15 characters
The amount paid out as lumpsum will be captured in this field
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
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
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
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
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[]
Possible values: <= 50 characters
Additional fields for DBPOption section
Possible values: <= 50 characters
Value of additional fields
AddOnSection object required
returnOfPremium object
If the Return of Premium option is opted then, send the percentage of total premiums paid that the customer wants to receive as return of premium. If customer doesnt want to opt for Return of Premium then consumer should send value as 0. This field is mandatory for 'Single Quote'
varFields object[]
Possible values: <= 100 characters
Additional fields for returnOfPremium section
Possible values: <= 100 characters
Value of additional fields
AddOns object[]
Possible values: <= 20 characters
AddOn Option selected
Possible values: <= 15 characters
Sum assured corresponding to selected Option
varFields object[]
Other fields to be captured for AddOn benefits selected
Possible values: <= 100 characters
Additional fields for AddOnBenefits section
Possible values: <= 100 characters
Value of additional fields
suitability object required
Possible values: <= 10 characters, [Yes, No]
This tag is for end consumer to bypass the suitability matrix
Possible values: <= 15 characters
Select your risk taking preference
Possible values: <= 20 characters
Provide the lie stage where this policy is being taken for
Possible values: <= 20 characters
What is the Goal for taking this Policy
varFields object[] required
Other fields to be captured for suitability section
Possible values: <= 100 characters
Additional fields for suitability section
Possible values: <= 100 characters
Value of additional fields
maturityBenefit object required
This section tells how should the maturity be paid out and additional details regarding it
Possible values: <= 20 characters
Maturity Benefit Payout Option selected
Possible values: <= 15 characters
The amount paid out as lumpsum will be captured in this field
Possible values: <= 5 characters
This field will carry the number of years after which lumpsum will be paid out after policy inception
Possible values: <= 3 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.
Possible values: <= 15 characters
The amount paid out as income will be captured in this field
Possible values: <= 10 characters
This field will carry the number of years after policy inception, after which income pay out will start
Possible values: <= 15 characters
The frequency at which income will be paid out.
Possible values: <= 5 characters
The duration for which the income will be paid out
Possible values: <= 15 characters
This field tells if the incomeTerm is in months, years, etc
varFields undefined[] required
Possible values: <= 50 characters
Additional fields for distributor section
Possible values: <= 50 characters
Value of additional fields
riderInformation object required
Rider section to hold all rider related details
riderDetails object[]
Rider array to capture details of multiple riders
Possible values: <= 20 characters
riderCode to identify the rider selected
Possible values: <= 150 characters
Policy Term of the rider
Possible values: <= 150 characters
Premium Paying Term of the rider
Possible values: <= 20 characters
Sum Assured pertaining to the rider
varFields object[]
Possible values: <= 100 characters
Additional fields for rider array
Possible values: <= 100 characters
Value of additional fields
newOptions object required
Array created to capture any new type of option which may be introduced in the future.
Possible values: <= 100 characters
Field will identify which type of option this is
optionValues object[] required
This array will contain the details for various options available for each newOptionName
For each type of option, this will contain the value of Option selected
varFields object[]
Array to capture attributes of the option selected.
Possible values: <= 100 characters
Additional fields for newOption array
Possible values: <= 100 characters
Value of additional fields
varFields object[] required
Possible values: <= 100 characters
Additional fields for product section
Possible values: <= 100 characters
Value of additional fields
other object
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[] required
Possible values: <= 100 characters
Additional fields for other section
Possible values: <= 100 characters
Value of additional fields
- 200
- 400
- 500
Consumer Response
Schema
Request Id for the quote assigned by 1SB
data object required
Section to carry quote acknowledgement. Quote details are returned via the Quote Poll API.
Always null in the Get Quote response. Use the Quote Poll API with reqId to retrieve quotes.
Journey Id assigned by 1SB for the quote journey
errors object
Error details in case of an error
Possible values: <= 50 characters
In case error occurs, the error code will be stored here
Possible values: <= 100 characters
In case error occurs, the error message will be stored here
{
"reqId": "string",
"data": {
"quote": null,
"journey_id": "string"
},
"errors": {
"errorCode": "string",
"errorMessage": "string"
}
}
Consumer Response
Schema
- Array [
- ]
Section to carry quote responses
errors object[] required
This array contains error messages in case of an error
Possible values: <= 50 characters
In case error occurs, the error code will be stored here
Possible values: <= 100 characters
In case error occurs, the error display message will be stored here
Possible values: <= 20 characters
In case error occurs, the error identifier will be stored here
Possible values: <= 100 characters
In case error occurs, the error message will be stored here
Possible values: <= 10 characters
In case error occurs, the error type will be stored here
Request Id for the quote assigned by 1SB
{
"data": {},
"errors": [
{
"errorCode": "string",
"errorDisplayMessage": "string",
"errorIdentifier": "string",
"errorMessage": "string",
"errorType": "string"
}
],
"reqId": "string"
}
Consumer Response
Schema
- Array [
- ]
Section to carry quote responses
errors object[] required
This array contains error messages in case of an error
Possible values: <= 50 characters
In case error occurs, the error code will be stored here
Possible values: <= 100 characters
In case error occurs, the error display message will be stored here
Possible values: <= 20 characters
In case error occurs, the error identifier will be stored here
Possible values: <= 100 characters
In case error occurs, the error message will be stored here
Possible values: <= 10 characters
In case error occurs, the error type will be stored here
Request Id for the quote assigned by 1SB
{
"data": {},
"errors": [
{
"errorCode": "string",
"errorDisplayMessage": "string",
"errorIdentifier": "string",
"errorMessage": "string",
"errorType": "string"
}
],
"reqId": "string"
}