Authorization in headers is mandatory in all APIs
\npartnerCode is mandatory where ever defined
\nproductCode is mandatory where ever defined
\nadditionalFields in request body of each API will return the same data in response
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15674949","collectionId":"f8550fc6-f1af-4405-8566-9f0b9d2bf7f7","publishedId":"UVXgLcot","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-01-11T06:16:10.000Z"},"item":[{"name":"Plans","item":[{"name":"Get Plans","id":"fc843620-a231-4497-8d30-406943c116f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"apiKey clientKey:clientSecret","description":"Bimaplan assigned clientKey:clientSecret pair for the company
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"partnerCode","value":"partnerCode","description":"Bimaplan assigned partnercode
\n","type":"text"}],"url":"{{gateway_url}}/api/v1/plans","description":"\n\n\n\n\n\nAPI used to get a list of all plans available to the partner
\n\n","urlObject":{"path":["api","v1","plans"],"host":["{{gateway_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc843620-a231-4497-8d30-406943c116f5"},{"name":"Get Plan Details","id":"0ed18558-5a8f-48c3-986b-24d4e910ef9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"apiKey clientKey:clientSecret","type":"text","description":"Bimaplan assigned clientKey:clientSecret pair for the company
\n"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"partnerCode","value":"partnerCode","description":"Bimaplan assigned partnercode
\n","type":"text"}],"url":"{{gateway_url}}/api/v1/plans/details/:productCode","description":"\n\n\n\n\n\nAPI used to get extensive details of a particular plan
\n\n","urlObject":{"path":["api","v1","plans","details",":productCode"],"host":["{{gateway_url}}"],"query":[],"variable":[{"id":"ede07fcf-38b0-41af-9c21-eb950b12dcd0","description":{"content":"One of the productCode received in plans API call response
\n","type":"text/plain"},"type":"any","value":"productCode","key":"productCode"}]}},"response":[],"_postman_id":"0ed18558-5a8f-48c3-986b-24d4e910ef9d"}],"id":"fbee995a-a331-472d-bdb1-9f01bd320bf3","_postman_id":"fbee995a-a331-472d-bdb1-9f01bd320bf3","description":""},{"name":"Proposal and Policy","item":[{"name":"Get Quotation","id":"65a2a1fc-6b3c-4489-93d5-49363a8136aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"apiKey clientKey:clientSecret","type":"text","description":"Bimaplan assigned clientKey:clientSecret pair for the company
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partnerCode\": \"String\",\n \"productCode\": \"String\",\n \"userDetails\": {\n \"firstName\": \"String\",\n \"lastName\": \"String\",\n \"mobileNumber\": \"String\",\n \"email\": \"String\"\n },\n \"planSpecifics\": {\n \"loanDetails\": {\n \"loanAccountNumber\": \"String\",\n \"loanAmount\": \"String\",\n \"interestRate\": \"String\",\n \"loanTenure\": \"String\",\n \"policyTerm\" : \"String\",\n \"premiumFunding\": \"String(Yes/No)\",\n \"loanSanctionDate\": \"String (Format: DD-MM-YYYY)\",\n \"loanDisbursementDate\": \"String(Format: DD-MM-YYYY)\"\n },\n \"sumAssured\": \"String\",\n \"benefitOptions\": \"Array\"\n },\n \"additionalFields\": {\n \"dummyField1\": \"String\",\n \"dummyField2\": \"String\"\n }\n}"},"url":"{{gateway_url}}/api/v1/get-premium","description":"\n\n\n\n\n\nAPI used to get quotation for a particular insurance plan
\n| Parameter | \nDescription | \nOptional (O) / Mandatory (M) / Optional Mandatory (OM) | \n Datatype | \n
|---|---|---|---|
| partnerCode | \nBimaplan assigned partner code | \nM | \nString | \n
| productCode | \nBimaplan generated 6 characters code. | \nM | \nString | \n
| userDetails | \nThis includes all the required user details fields used for calculating the quotation | \nM | \nComplex | \n
| firstName | \nFirst name the primary customer | \nM | \nString | \n
| lastName | \nLast name of the primary customer | \nM | \nString | \n
| mobileNumber | \nA valid 10 digit mobile number | \nM | \nString | \n
| A valid email ID | \n0 | \nString | \n|
| planSpecifics | \nThese details are required to calculate the exact premium. The bigger the sum insured and more the dependents, higher the premium. | \nM | \nComplex | \n
| loanDetails | \nAll the details required to issue loan insurance. | \nOM | \nComplex | \n
| loanAccountNumber | \nLoan Account Number to issue loan insurance. | \nOM | \nString | \n
| loanAmount | \nActual Loan amount to issue loan insurance. | \nOM | \nString | \n
| interestRate | \nInterest Rates to be applied on Loan amount to issue loan insurance. | \nOM | \nString | \n
| loanTenure | \nLoan tenure for which the loan is issued. | \nOM | \nString | \n
| policyTerm | \nTerm for which the policy is issued. | \nOM | \nString | \n
| premiumFunding | \nPremium Funding is available or not. Yes & No are the only options to be filled from. | \nOM | \nString | \n
| loanSanctionDate | \nDate when the loan was sanctioned in DD-MM-YYYY format | \nOM | \nString | \n
| loanDisbursementDate | \nDate when the loan was disbursed in DD-MM-YYYY format | \nOM | \nString | \n
| sumAssured | \nArray of all the benefits chosen from the plan to get Quotation. Higher the benefit chosen, higher will be the premium. | \nM | \nArray | \n
| benefitOptions | \nArray of all the benefits chosen from the plan to get Quotation. Higher the benefit chosen, higher will be the premium. | \nM | \nArray | \n
| additionalFields | \nThese are additional fields which the API response will send back as it is. These might required fields for the integrator. | \nO | \nComplex | \n
Bimaplan assigned clientKey:clientSecret pair for the company
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partnerCode\": \"String\",\n \"productCode\": \"String\",\n \"externalReferenceNumber\": \"String\",\n \"applicantDetails\": {\n \"firstName\": \"String\",\n \"lastName\": \"String\",\n \"dateOfBirth\": \"String (Format: DD-MM-YYYY)\",\n \"gender\": \"String\",\n \"email\": \"String\",\n \"mobileNumber\": \"String\",\n \"addressLine1\": \"String\",\n \"addressLine2\": \"String\",\n \"city\": \"String\",\n \"state\": \"String\",\n \"pinCode\": \"String\",\n \"occupation\": \"String\",\n \"govtDocumentType\": \"String\",\n \"documentNumber\": \"String\",\n \"isApplicantInGoodHealth\": \"String\"\n },\n \"planSpecifics\": {\n \"loanDetails\": {\n \"loanAccountNumber\": \"String\",\n \"loanAmount\": \"String\",\n \"interestRate\": \"String\",\n \"loanTenure\": \"String\",\n \"policyTerm\" : \"String\",\n \"premiumFunding\": \"String\",\n \"loanSanctionDate\": \"String (Format: DD-MM-YYYY)\",\n \"loanDisbursementDate\": \"String (Format: DD-MM-YYYY)\"\n },\n \"sumAssured\": \"String\",\n \"benefitOptions\": \"Array\",\n \"packageName\": \"String\"\n },\n \"nomineeDetails\": [\n {\n \"firstName\": \"String\",\n \"lastName\": \"String\",\n \"relationship\": \"String\",\n \"dateOfBirth\": \"String\",\n \"gender\": \"String\",\n \"mobileNumber\": \"String\",\n \"nomineeAddressLine1\": \"String\",\n \"nomineeAddressLine2\": \"String\",\n \"nomineeCity\": \"String\",\n \"nomineeState\": \"String\",\n \"nomineePincode\": \"String\",\n \"percentageShare\": \"String\"\n }\n ],\n \"additionalFields\": {\n \"dummyField1\": \"String\",\n \"dummyField2\": \"String\"\n }\n}"},"url":"{{gateway_url}}/api/v1/submit-proposal","description":"\n\n\n\n\n\nAPI used to submit a proposal. This will generate and return an application number
\n| Parameter | \nDescription | \nOptional(O)/ Mandatory(M)/ Optional Mandatory (OM) | \n Datatype | \n
|---|---|---|---|
| partnerCode | \nBimaplan assigned partner code | \nM | \nString | \n
| productCode | \nBimaplan generated 6 characters code. | \nM | \nString | \n
| externalReferenceNumber | \nPartner end data deduplication(de-dupe) ID/Number | \nM | \nNumber | \n
| applicantDetails | \nMain Applicant details | \nM | \nComplex | \n
| firstName | \nMain Applicant's firstName | \nM | \nString | \n
| lastName | \nMain Applicant's lastName | \nM | \nString | \n
| dateOfBirth | \nMain Applicant's dateOfBirth | \nM | \nString | \n
| gender | \nMain Applicant's gender | \nM | \nString | \n
| Main Applicant's emailID | \nO | \nString | \n|
| mobile | \nMain Applicant's mobile number | \nM | \nString | \n
| addressLine1 | \nMain Applicant's address. Accepts House Number, Stress Name etc. | \nM | \nString | \n
| addressLine2 | \nMain Applicant's address. Accepts Area Name/Village Name/Town/Taluka. | \nM | \nString | \n
| city | \nMain Applicant's city/district. | \nM | \nString | \n
| state | \nMain Applicant's state. | \nM | \nString | \n
| pinCode | \nMain Applicant's pin-code. Should be a 6 characters pin-code only | \nM | \nString | \n
| occupation | \nMain Applicant's occupation. | \nM | \nString | \n
| govtDocumentType | \nMain Applicant's govtDocumentType. It should be one of the below: PAN DRIVING_LICENSE VOTER_ID | \n M | \nString | \n
| documentNumber | \nMain Applicant's documentNumber for the selected govtDocumentType | \nM | \nString | \n
| isApplicantInGoodHealth | \nMain Applicant's health declaration status. It can either be Yes or No. | \nM | \nString | \n
| planSpecifics | \nThese details are required to calculate the exact premium. The bigger the sum insured and more the dependents, higher the premium. | \nM | \nComplex | \n
| loanDetails | \nAll the details required to issue loan insurance. | \nOM | \nComplex | \n
| loanAccountNumber | \nLoan Account Number to issue loan insurance. | \nOM | \nString | \n
| loanAmount | \nActual Loan amount to issue loan insurance. | \nOM | \nString | \n
| interestRate | \nInterest Rates to be applied on Loan amount to issue loan insurance. | \nOM | \nString | \n
| loanTenure | \nLoan tenure for which the loan is issued. | \nOM | \nString | \n
| policyTerm | \nTerm for which the policy is issued. | \nOM | \nString | \n
| premiumFunding | \n Premium Funding is available or not. It should be one of the below: Yes No | \n OM | \nString | \n
| loanSanctionDate | \nDate when the loan was sanctioned in DD-MM-YYYY format | \nOM | \nString | \n
| loanDisbursementDate | \nDate when the loan was disbursed in DD-MM-YYYY format | \nOM | \nString | \n
| sumAssured | \nArray of all the benefits chosen from the plan to get Quotation. Higher the benefit chosen, higher will be the premium. | \nM | \nArray | \n
| benefitOptions | \nArray of all the benefits chosen from the plan to get Quotation. Higher the benefit chosen, higher will be the premium. | \nM | \nArray | \n
| packageName | \nPass packageName here ex: \"Option 1\"/\"Option 2\"/\"Option 3\" etc. These mappings will be shared offline with the partner | \nM | \nString | \n
| nomineeDetails | \nArray of nominees details | \nM | \nComplex | \n
| firstName | \nNominee's firstName | \nM | \nString | \n
| lastName | \nNominee's lastName | \nM | \nString | \n
| relationship | \n Nominee's relationship with the Main Applicant. It should be one of the below: \nSelf \nHusband \nWife \nSpouse \nSon \nDaughter \nChild \nFather \nMother \nFather-in-law \nMother-in-law \nSon-in-Law \nDaughter-in-Law \n | \n M | \nString | \n
| dateOfBirth | \nNominee's date of birth in DD-MM-YYYY format. | \nO | \nString | \n
| gender | \n Nominee's gender. It should be one of the below: Male Female Other | \n O | \nString | \n
| mobile | \nNominee's mobile | \nO | \nString | \n
| nomineeAddressLine1 | \nNominee's address. Accepts House Number, Stress Name etc. | \nO | \nString | \n
| nomineeAddressLine2 | \nNominee's address. Accepts Area Name/Village Name/Town/Taluka. | \nO | \nString | \n
| nomineeCity | \nNominee's city/district. | \nO | \nString | \n
| nomineeState | \nNominee's state. | \nO | \nString | \n
| nomineePincode | \nNominee's pin-code. Should be a 6 characters pin-code only | \nO | \nString | \n
| percentageShare | \nNominee's share of percentage in case of claims. Do not include \"%\" with number. Example: {\"percentageShare\" : \"55.55\"} | \n O | \nString | \n
| additionalFields | \nThese are additional fields which the API response will send back as it is. These might required fields for the integrator. | \nO | \nComplex | \n
Bimaplan assigned clientKey:clientSecret pair for the company
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partnerCode\": \"String\",\n\t\"productCode\": \"String\",\n \"applicationNumber\": \"String\",\n \"additionalFields\": {\n \"dummyField1\": \"String\",\n \"dummyField2\": \"String\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gateway_url}}/api/v1/policies/download","description":"\n\n\n\n\n\nAPI used download the policies against submitted proposal. In case the product for which proposal was submitted has more than 1 plan, say 3, then 3 policyNumbers and policyUrls will be returned in response
\n| Parameter | \nDescription | \n\n | Datatype | \n
|---|---|---|---|
| partnerCode | \nBimaplan assigned partner code | \nM | \nString | \n
| productCode | \nBimaplan generated 6 characters code. | \nM | \nString | \n
| applicationNumber | \napplicationNumber received in Submit Proposal API call response. | \nM | \nString | \n
| additionalFields | \nThese are additional fields which the API response will send back as it is. | \nO | \nComplex | \n
Bimaplan assigned clientKey:clientSecret pair for the company
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partnerCode\": \"Partner Code\",\n \"productCode\": \"Product Code\",\n \"proposalDetails\": [\n {\n \"externalReferenceNumber\": \"String\",\n \"applicantDetails\": {\n \"firstName\": \"String\",\n \"lastName\": \"String\",\n \"dateOfBirth\": \"String (Format: DD-MM-YYYY)\",\n \"gender\": \"String\",\n \"email\": \"String\",\n \"mobileNumber\": \"String\",\n \"addressLine1\": \"String\",\n \"addressLine2\": \"String\",\n \"city\": \"String\",\n \"state\": \"String\",\n \"pinCode\": \"String\",\n \"occupation\": \"String\",\n \"govtDocumentType\": \"String\",\n \"documentNumber\": \"String\",\n \"isApplicantInGoodHealth\": \"String\"\n },\n \"planSpecifics\": {\n \"loanDetails\": {\n \"loanAccountNumber\": \"String\",\n\t\t\t\t\t\"loanAmount\": \"String\",\n \"interestRate\": \"String\",\n \"loanTenure\": \"String\",\n\t\t\t\t\t\"premiumFunding\": \"String\",\n \"loanSanctionDate\": \"String (Format: DD-MM-YYYY)\",\n \"loanDisbursementDate\": \"String (Format: DD-MM-YYYY)\"\n },\n \"sumAssured\": \"String\",\n \"benefitOptions\": \"Array\"\n },\n \"nomineeDetails\": [\n {\n \"firstName\": \"String\",\n \"lastName\": \"String\",\n \"relationship\": \"String\",\n \"dateOfBirth\": \"String (Format: DD-MM-YYYY)\",\n \"gender\": \"String\",\n \"mobileNumber\": \"String\",\n \"nomineeAddressLine1\": \"String\",\n \"nomineeAddressLine2\": \"String\",\n \"nomineeCity\": \"String\",\n \"nomineeState\": \"String\",\n \"nomineePincode\": \"String\",\n \"percentageShare\": \"String\"\n }\n ],\n \"additionalFields\": {\n \"dummyField1\": \"String\",\n \"dummyField2\": \"String\"\n }\n } \n ]\n}"},"url":"{{gateway_url}}/api/v1/bulk-submit-proposal","description":"\n\n\n\n\n\n\nAPI used to submit a proposal in bulk. This will generate and return an application number.
\n| Parameter | \nDescription | \nOptional(O)/ Mandatory(M)/ Optional Mandatory (OM) | \n Datatype | \n
|---|---|---|---|
| partnerCode | \nBimaplan assigned partner code | \nM | \nString | \n
| productCode | \nBimaplan generated 6 characters code. | \nM | \nString | \n
| proposalDetails | \nArray of proposals for bulk submission | \nM | \nArray | \n
| externalReferenceNumber | \nPartner end data deduplication(de-dupe) ID/Number | \nM | \nNumber | \n
| applicantDetails | \nMain Applicant details | \nM | \nComplex | \n
| firstName | \nMain Applicant's firstName | \nM | \nString | \n
| lastName | \nMain Applicant's lastName | \nM | \nString | \n
| dateOfBirth | \nMain Applicant's dateOfBirth | \nM | \nString | \n
| gender | \nMain Applicant's gender | \nM | \nString | \n
| Main Applicant's emailID | \nO | \nString | \n|
| mobile | \nMain Applicant's mobile number | \nM | \nString | \n
| addressLine1 | \nMain Applicant's address. Accepts House Number, Stress Name etc. | \nM | \nString | \n
| addressLine2 | \nMain Applicant's address. Accepts Area Name/Village Name/Town/Taluka. | \nM | \nString | \n
| city | \nMain Applicant's city/district. | \nM | \nString | \n
| state | \nMain Applicant's state. | \nM | \nString | \n
| pinCode | \nMain Applicant's pin-code. Should be a 6 characters pin-code only | \nM | \nString | \n
| occupation | \nMain Applicant's occupation. | \nM | \nString | \n
| govtDocumentType | \nMain Applicant's govtDocumentType. It should be one of the below: PAN DRIVING_LICENSE VOTER_ID | \n M | \nString | \n
| documentNumber | \nMain Applicant's documentNumber for the selected govtDocumentType | \nM | \nString | \n
| isApplicantInGoodHealth | \nMain Applicant's health declaration status. It can either be Yes or No. | \nM | \nString | \n
| planSpecifics | \nThese details are required to calculate the exact premium. The bigger the sum insured and more the dependents, higher the premium. | \nM | \nComplex | \n
| loanDetails | \nAll the details required to issue loan insurance. | \nOM | \nComplex | \n
| loanAccountNumber | \nLoan Account Number to issue loan insurance. | \nOM | \nString | \n
| loanAmount | \nActual Loan amount to issue loan insurance. | \nOM | \nString | \n
| interestRate | \nInterest Rates to be applied on Loan amount to issue loan insurance. | \nOM | \nString | \n
| loanTenure | \nLoan tenure for which the loan is issued. | \nOM | \nString | \n
| policyTerm | \nTerm for which the policy is issued. | \nOM | \nString | \n
| premiumFunding | \n Premium Funding is available or not. It should be one of the below: Yes No | \n OM | \nString | \n
| loanSanctionDate | \nDate when the loan was sanctioned in DD-MM-YYYY format | \nOM | \nString | \n
| loanDisbursementDate | \nDate when the loan was disbursed in DD-MM-YYYY format | \nOM | \nString | \n
| sumAssured | \nArray of all the benefits chosen from the plan to get Quotation. Higher the benefit chosen, higher will be the premium. | \nM | \nArray | \n
| benefitOptions | \nArray of all the benefits chosen from the plan to get Quotation. Higher the benefit chosen, higher will be the premium. | \nM | \nArray | \n
| nomineeDetails | \nArray of nominees details | \nM | \nComplex | \n
| firstName | \nNominee's firstName | \nM | \nString | \n
| lastName | \nNominee's lastName | \nM | \nString | \n
| relationship | \n Nominee's relationship with the Main Applicant. It should be one of the below: \nSelf \nHusband \nWife \nSpouse \nSon \nDaughter \nChild \nFather \nMother \nFather-in-law \nMother-in-law \nSon-in-Law \nDaughter-in-Law \n | \n M | \nString | \n
| dateOfBirth | \nNominee's date of birth in DD-MM-YYYY format. | \nO | \nString | \n
| gender | \n Nominee's gender. It should be one of the below: Male Female Other | \n O | \nString | \n
| mobile | \nNominee's mobile | \nO | \nString | \n
| nomineeAddressLine1 | \nNominee's address. Accepts House Number, Stress Name etc. | \nO | \nString | \n
| nomineeAddressLine2 | \nNominee's address. Accepts Area Name/Village Name/Town/Taluka. | \nO | \nString | \n
| nomineeCity | \nNominee's city/district. | \nO | \nString | \n
| nomineeState | \nNominee's state. | \nO | \nString | \n
| nomineePincode | \nNominee's pin-code. Should be a 6 characters pin-code only | \nO | \nString | \n
| percentageShare | \nNominee's share of percentage in case of claims. Do not include \"%\" with number. Example: {\"percentageShare\" : \"55.55\"} | \n O | \nString | \n
| additionalFields | \nThese are additional fields which the API response will send back as it is. These might required fields for the integrator. | \nO | \nComplex | \n
Bimaplan assigned clientKey:clientSecret pair for the company
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"productCode\": \"String\",\n \"partnerCode\": \"String\",\n \"externalReferenceNumber\": \"String\",\n \"applicationNumber\": \"String\",\n \"cancelPlanNames\": [],\n \"cancellationReasons\": [\n \"Reason 1\",\n \"Reason 2\"\n ]\n}"},"url":"{{gateway_url}}/api/v1/policies/cancel","urlObject":{"path":["api","v1","policies","cancel"],"host":["{{gateway_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"df61f3b9-6795-484a-baea-5605316fc088"}],"id":"38d8de36-bef4-42bd-af50-4346df412329","_postman_id":"38d8de36-bef4-42bd-af50-4346df412329","description":""},{"name":"Consent","item":[{"name":"Send Lead Consent","id":"39180bed-e977-4fcf-90dc-50e60753695f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"apiKey clientKey:clientSecret","type":"text","description":"Bimaplan assigned clientKey:clientSecret pair for the company
\n"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"partnercode","value":"partnerCode","type":"text","description":"Bimaplan assigned partnercode
\n"}],"body":{"mode":"raw","raw":"{\n \"partnerCode\": \"String\",\n \"productCode\": \"String\",\n \"firstName\": \"String\",\n \"lastName\": \"String\",\n \"mobileNumber\": \"String\",\n \"referenceId\": \"String\",\n \"referenceIdType\": \"LoanAccountNumber\",\n \"additionalFields\": {\n \"clientUserId\": \"String\",\n \"clientReqId\": \"String\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{gateway_url}}/api/v1/send-consent","description":"\n\n\n\n\n\nAPI to send a customer consent form message to the customer
\n| Parameter | \nDescription | \nOptional(O)/ Mandatory(M)/ Optional Mandatory (OM) | \n Datatype | \n
|---|---|---|---|
| partnerCode | \nBimaplan assigned partner code | \nM | \nString | \n
| productCode | \nBimaplan generated 6 characters code. | \nM | \nString | \n
| firstName | \nMain Applicant's firstName | \nM | \nString | \n
| lastName | \nMain Applicant's lastName | \nM | \nString | \n
| mobile | \nMain Applicant's mobile number | \nM | \nString | \n
| referenceIdType | \nType of reference for issuing the loan viz-a-viz \"LoanAccountNumber\" | \nM | \nString | \n
| referenceId | \nReference Number for the given referenceIdType above, viz-a-viz actual\"LoanAccountNumber\" | \nM | \nString | \n
| additionalFields | \nThese are additional fields which the API response will send back as it is. These might required fields for the integrator. | \nO | \nComplex | \n
Bimaplan assigned clientKey:clientSecret pair for the company
\n"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"partnerCode","value":"partnerCode","type":"text","description":"Bimaplan assigned partnercode
\n"}],"url":"{{gateway_url}}/api/v1/consent-status/:productCode/:consentId","description":"\n\n\n\n\n\nAPI used check the submitted customer consent
\n\n","urlObject":{"path":["api","v1","consent-status",":productCode",":consentId"],"host":["{{gateway_url}}"],"query":[],"variable":[{"id":"36756f1b-038f-4849-8fc9-7c90f1993956","description":{"content":"productCode for which the consent was requested
\n","type":"text/plain"},"type":"any","value":"productCode","key":"productCode"},{"id":"a8ab4e88-a31a-4ed5-afbd-54819634923c","description":{"content":"consentId received in send-consent API call response
\n","type":"text/plain"},"type":"any","value":"consentId","key":"consentId"}]}},"response":[],"_postman_id":"d88e27a1-524f-4b3e-94cd-ca3870576d4d"}],"id":"9f141da3-8f5f-4248-8dec-76ce1879badc","_postman_id":"9f141da3-8f5f-4248-8dec-76ce1879badc","description":""},{"name":"Callback/Notify Webhook","item":[{"name":"Notify","id":"ba4b9f5a-a463-4587-a702-e4e35cf079fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"coiNumber\": \"String\",\n \"certificateUrl\": \"String\",\n \"applicationNumber\": \"String\",\n \"referenceId\": \"String\",\n \"referenceIdType\": \"LoanAccountNumber\",\n \"externalReferenceNumber\": \"String\",\n \"status\": \"SUCCESS\"/\"FAILED\",\n \"failureReason\": [\"String1\", \"String2\"],\n \"timestamp\": \"String epoch\"\n}","options":{"raw":{"language":"json"}}},"url":"{{your_custom_endpoint}}","description":"\n\n\n\n\n\n\nThis is a webhook which is to be defined for Bimaplan to Notify when the Policy/COI is issued. Bimaplan will send the mentioned request body to notify.
\n\n| Parameter | \nDescription | \nOptional(O)/ Mandatory(M)/ Optional Mandatory (OM) | \n Datatype | \n
|---|---|---|---|
| coiNumber | \nCertificate Of Issuance Number | \nM | \nString | \n
| certificateUrl | \nBimaplan generated COI certificate URL/Link. This is a downloadable link. | \nM | \nString | \n
| applicationNumber | \nThis is the applicationNumber which was returned in Submit Proposal API call response. | \nM | \nString | \n
| referenceIdType | \nType of reference for issuing the loan viz-a-viz \"LoanAccountNumber\" | \nM | \nString | \n
| referenceId | \nReference Number for the given referenceIdType above, viz-a-viz actual\"LoanAccountNumber\" | \nM | \nString | \n
| externalReferenceNumber | \nExternal Reference Number given in Submit Proposal Request. This can be used for de-dupe logic at partners end. | \nM | \nString | \n
| status | \nStatus of the Submit Proposal. It can either be \"SUCCESS\"/\"FAILED\" | \nM | \nString | \n
| failureReason | \nReasons for failure of the proposal. | \nM | \nArray | \n
| timestamp | \nEpoch timestamp when the proposal was either successful or failed. | \nM | \nString | \n
API to renew a policy. On an accepted request, it returns back a renewal id along with other renewal details. The renewal status will be either Initiated or Failed in this API. For a successful renewal, the partner will be notified via a callback/notify webhook. They can also check the renewal status using the renewal id with the Get Renewal Status API.
\n","urlObject":{"path":["api","v1","renew-policy"],"host":["{{gateway_url}}"],"query":[],"variable":[]}},"response":[{"id":"21f320d3-03ce-402a-8572-34198f1826b7","name":"Accepted Request - Initiated","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"apiKey clientKey:clientSecret","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partnerCode\": \"String\",\n \"productCode\": \"String\",\n \"applicationNumber\": \"String\",\n \"policyNumber\": [\"String1\", \"String2\"]\n}"},"url":"{{gateway_url}}/api/v1/renew-policy"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Renewal request accepted\",\n \"entity\": {\n \"renewalDetails\":[\n {\n \"status\": \"Initiated\",\n \"renewalId\": \"Z4GZO2xx\",\n \"requestedOn\": \"21/10/2022 09:41:48 AM\",\n \"message\": \"Renewal initiated for application number: BLVL67xx & policy number: 107405xx\"\n },\n {\n \"status\": \"Initiated\",\n \"renewalId\": \"8687QPxx\",\n \"requestedOn\": \"21/10/2022 09:41:48 AM\",\n \"message\": \"Renewal initiated for application number: BLVL67xx & policy number: 107405xx\"\n },\n {\n \"status\": \"Initiated\",\n \"renewalId\": \"TAG32Oxx\",\n \"requestedOn\": \"21/10/2022 09:41:48 AM\",\n \"message\": \"Renewal initiated for application number: BLVL67xx & policy number: 107405xx\"\n }\n ]\n }\n}"},{"id":"301c5e27-f133-4761-a8be-99a3eefb3cf3","name":"Accepted Request - Failed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"apiKey clientKey:clientSecret","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partnerCode\": \"String\",\n \"productCode\": \"String\",\n \"applicationNumber\": \"String\",\n \"policyNumber\": [\"String1\", \"String2\"]\n}"},"url":"{{gateway_url}}/api/v1/renew-policy"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Renewal request accepted\",\n \"entity\": {\n \"renewalDetails\":[\n {\n \"status\": \"Failed\",\n \"requestId\": \"DW4PXYxx\",\n \"requestedOn\": \"21/10/2022 09:44:31 AM\",\n \"message\": \"FAILED to renew. xxx...\"\n }\n ]\n }\n}"},{"id":"a06a7b53-8300-4a8d-a5a6-b6eddb175681","name":"Failed Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"apiKey clientKey:clientSecret","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"partnerCode\": \"String\",\n \"productCode\": \"String\",\n \"applicationNumber\": \"String\",\n \"policyNumber\": [\"String1\", \"String2\"]\n}"},"url":"{{gateway_url}}/api/v1/renew-policy"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 400,\n \"message\": \"Renewal request failed\",\n \"entity\": {\n \"status\": \"Failed\",\n \"message\": \"xxx cannot be empty\"\n }\n}"}],"_postman_id":"f424f51b-2ab6-4281-8c93-c05e6924aca6"},{"name":"Get Renewal Status","id":"d190e468-adb0-4531-9dd3-48cbab234570","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"apiKey clientKey:clientSecret","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{gateway_url}}/api/v1/renewal-status/:renewalId","description":"API to get renewal status of a policy. For a successful request, you receive the renewal details. There are three renewal status: Initiated, Renewed, Failed
\n","urlObject":{"path":["api","v1","renewal-status",":renewalId"],"host":["{{gateway_url}}"],"query":[],"variable":[{"description":{"content":"Renewal Id generated on Renew Policy API response
\n","type":"text/plain"},"type":"any","value":null,"key":"renewalId"}]}},"response":[{"id":"0850e87f-4444-48cc-8f6f-9cabea18e82d","name":"Initiated","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"apiKey clientKey:clientSecret","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{gateway_url}}/api/v1/renewal-status/:renewalId","host":["{{gateway_url}}"],"path":["api","v1","renewal-status",":renewalId"],"variable":[{"key":"renewalId","value":null,"description":"Renewal Id generated on Renew Policy API response"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Renewal status fetched\",\n \"entity\": {\n \"renewalId\": \"NG5SKCxx\",\n \"applicationNumber\": \"BLVL67xx\",\n \"policyNumber\": \"107405xx\",\n \"status\": \"Initiated\",\n \"messsage\":\"\",\n \"requestedOn\": \"20-Oct-2022 12:06:05 PM\",\n \"updatedOn\": \"20-Oct-2022 12:06:05 PM\",\n \"renewedOn\": null,\n \"nextRenewalOn\": null\n }\n}"},{"id":"5a50110e-f393-4885-b25e-091b9b7cd757","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"apiKey clientKey:clientSecret","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{gateway_url}}/api/v1/renewal-status/:renewalId","host":["{{gateway_url}}"],"path":["api","v1","renewal-status",":renewalId"],"variable":[{"key":"renewalId","value":null}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Renewal status fetched\",\n \"entity\": {\n \"renewalId\": \"NG5SKCxx\",\n \"applicationNumber\": \"BLVL67xx\",\n \"policyNumber\": \"107405xx\",\n \"status\": \"Renewed\",\n \"message\": \"\",\n \"requestedOn\": \"20-Oct-2022 12:06:05 PM\",\n \"updatedOn\": \"20-Oct-2022 12:06:05 PM\",\n \"renewedOn\": \"20-Oct-2022 12:15:00 PM\",\n \"nextRenewalOn\": \"31-Oct-2023 12:15:00 PM\"\n }\n}"},{"id":"05a83106-41a7-495e-8e0e-a83db361cf44","name":"Failed","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"apiKey clientKey:clientSecret","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{gateway_url}}/api/v1/renewal-status/:renewalId","host":["{{gateway_url}}"],"path":["api","v1","renewal-status",":renewalId"],"variable":[{"key":"renewalId","value":null,"description":"Renewal Id generated on Renew Policy API response"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"message\": \"Renewal status fetched\",\n \"entity\": {\n \"renewalId\": \"NG5SKCxx\",\n \"applicationNumber\": \"BLVL67xx\",\n \"policyNumber\": \"107405xx\",\n \"status\": \"Failed\",\n \"message\": \"FAILED to renew. xxx...\",\n \"requestedOn\": \"20-Oct-2022 12:06:05 PM\",\n \"updatedOn\": \"20-Oct-2022 12:06:05 PM\",\n \"renewedOn\": null,\n \"nextRenewalOn\": null\n }\n}"}],"_postman_id":"d190e468-adb0-4531-9dd3-48cbab234570"}],"id":"763d1ed3-365f-4c96-be2e-236c138b0d35","_postman_id":"763d1ed3-365f-4c96-be2e-236c138b0d35","description":""}]}