Third Party APIs encompasses a suite of APIs designed to facilitate seamless integration and interaction with our insurance platform. These APIs provide third-party developers and partners with essential functionalities to access and manage data related to insurance quotes, applications, and sales. By leveraging these APIs, businesses can enhance their operational capabilities, streamline workflows, and improve customer experiences.
\nCurrently, InstaBrain offers APIs for the following insurance products:
\nInstaBrain Term with Living Benefits (Available Now)
\nPure Term (Available Now)
\nFinal Expense (Available Now)
\nEach product has its own Quote API endpoint with product-specific parameters. Details for each product's Quote API are available in their respective API documentation sections.
\nInstaBrain supports two integration methods depending on your technical requirements and desired user experience. Choose the method that best fits your needs:
\nBest for: Partners who want a quick integration without building custom UI, or don't have dedicated technical resources.
\nHow it works: Embed the InstaBrain application directly into your website using an iFrame. Users complete the entire quote and application process within the InstaBrain interface hosted on your domain.
\nImplementation:
\nhtml
\n<iframe src=\"{agentInstaBrainUrl}\" width=\"100%\" height=\"800px\" frameborder=\"0\"></iframe>\n\nSetup Requirements:
\nReplace {agentInstaBrainUrl} with your InstaBrain agent website URL Example: https://instabraindevelopment.instabrain.io
Contact InstaBrain to whitelist your host domain (required for iFrame access)
\nEnsure your website allows cross-origin iFrames
\nTest the integration across various browsers for compatibility
\nWhen to choose this method:
\nYou want minimal development effort
\nYou prefer InstaBrain's complete user interface and experience
\nYou don't need to customize the quote or application flow
\nYou want to get integrated quickly
\nBest for: Partners with technical teams who want to create custom user experiences and have full control over the user journey.
\nHow it works: Integrate InstaBrain's REST APIs to build your own quote and application interface. Users interact with your custom UI, while data is processed through InstaBrain's backend APIs.
\nIntegration Flow:
\nGet Quote → Use the Quote API for your desired product
\nEach product has its own Quote API endpoint
\nSend quote parameters that affect pricing (age, coverage amount, term length, etc.)
\nReceive quote details and a unique quoteResponseId
Start Application → Use the Start Application API with the quoteResponseId
Pass the quoteResponseId received from the Quote API
Receive opportunityId and application links in response
Complete Application → Direct users to InstaBrain's application interface
\nRedirect users to the application URL, OR
\nEmbed the application link in an iFrame on your platform
\nWhen to choose this method:
\nYou have a dedicated technical team
\nYou want to create custom user interfaces
\nYou need to control the user journey and data flow
\nYou want to integrate quotes into your existing systems
\nYou need flexibility in how data is collected and displayed
\nBefore making any API calls, you must obtain a JWT token using the Authorization API.
\nToken Validity: 30 minutes
\nUsage: Include the JWT token in the Authorization header as a Bearer token for all subsequent API requests
Documentation: Refer to the Authorization API page for detailed implementation
\nImportant: Design your system to handle token expiration by refreshing or requesting a new token after the 30-minute window.
\nUse the Quote API specific to your desired insurance product to generate quotes for users.
\nAvailable Products:
\nInstaBrain Term with Living Benefits
\nPure Term
\nFinal Expense
\nProcess:
\nSend quote parameters based on the product (age, coverage amount, term length, etc.)
\nReceive quote response including pricing and a unique quoteResponseId
Present the quote to your user through your custom UI
\nNote: Each product has different parameters and response structures. Refer to the specific Quote API documentation for detailed request/response formats and endpoints.
\nOnce a user decides to proceed with a quote, use the Start Application API to initiate the application process.
\nKey Information:
\nPass the quoteResponseId received from the Quote API
Optionally provide or override applicant information (firstName, lastName, email, phoneNumber)
\nReceive opportunityId and application links (agentLink, eAppAgentLink, applicantLink)
For detailed request/response structure and implementation: Refer to the Start Application API documentation page.
\nAfter receiving the Start Application response, you have two options:
\nOption A: Redirect to InstaBrain
\nRedirect the user to the applicantLink URL
User completes the application on InstaBrain's platform
\nOption B: Embed in iFrame
\napplicantLink in an iFrame on your platformhtml
\n<iframe src=\"{applicantLink}\" width=\"100%\" height=\"800px\" frameborder=\"0\"></iframe>\n\nFor Agents:
\nUse applicationLink for Conversational UI for Applicant.
Use agentLink for Conversational UI for Agent.
Use eAppAgentLink for E-App for Agent.
Base URL: https://api.instabrainsandbox.io/
Purpose:
\nTest your integration
\nDevelop and validate your implementation
\nNo real transactions or applications are processed
\nAccess:
\nRegister at: https://devportal.instabrainsandbox.io/third-party-questionnarie
\nReceive sandbox credentials via email
\nUse credentials to obtain JWT tokens for API access
\nAccess Process:
\nComplete and test your integration in the sandbox environment
\nContact InstaBrain for production migration review
\nInstaBrain will review your integration implementation
\nUpon approval, receive production credentials and base URL
\nInstaBrain will whitelist your production domain and IP addresses
\nImportant Notes:
\nProduction environment has strict security rules
\nDomain and IP whitelisting is required before go-live
\nManual approval process ensures integration quality and security
\nBase URL will be different from sandbox (provided during migration)
\nFor Direct Integration (iFrame):
\nRegister your organization at the registration portal
\nReceive your InstaBrain agent website URL
\nProvide your host domain to InstaBrain for whitelisting
\nImplement the iFrame on your website
\nTest across multiple browsers
\nRequest production access when ready
\nFor REST API Integration:
\nRegister at https://devportal.instabrainsandbox.io/third-party-questionnarie
\nReceive sandbox credentials and review API documentation
\nImplement Authentication API to obtain JWT tokens
\nIntegrate the Quote API for your desired product(s)
\nImplement the Start Application API
\nTest the complete flow in sandbox environment
\nRequest production migration review
\nReceive production credentials and migrate
\nIf you have any questions or need further assistance, please contact our support team:
\nEmail: helpdesk@instabrain.io
\nWe are here to help you maximize the value of our Third Party APIs and ensure a successful integration experience.
\nAuthentication Required? → Proceed to the Authorization API page
\nNeed Quote Details? → Review the Quote API documentation for your product
\nStarting Applications? → See the Start Application API page
\nTechnical Questions? → Contact helpdesk@instabrain.io
\nEndFragment
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Third Party APIs - Integration Overview","slug":"third-party-apis-integration-overview"}],"owner":"18938680","collectionId":"cc7b782e-c1e7-4828-b946-4ef8daa70354","publishedId":"2sAXqv6M2F","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3B78CE"},"publishDate":"2025-10-01T18:06:59.000Z"},"item":[{"name":"Authorization","item":[{"name":"Authorization","event":[{"listen":"test","script":{"id":"c26e775a-34bd-4b0f-b802-4af547de9df6","exec":["var jsonData = JSON.parse(responseBody);\r","console.log(jsonData);\r","pm.environment.set(\"jwtToken\", jsonData.value.jwtToken);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"9f259d9d-085d-433e-acc0-f4907aeeb1a2","protocolProfileBehavior":{"disableBodyPruning":true,"maxRedirects":150},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": 1,\r\n \"accessToken\": \"573D7DE9-E2B5-4227-B100-12D3960CACB6\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.instabrainsandbox.io/api/ThirdParty/auth","description":"In below table, detailed description of each request body parameter is mentioned
\nBased on above request, your will get below response for success with jwtToken:
jwtToken is required to pass for all other API calls as Bearer token and its validity is 30 minutes.If credentials are not valid then API will give error with 400 status code.
\n","urlObject":{"protocol":"https","path":["api","ThirdParty","auth"],"host":["api","instabrainsandbox","io"],"query":[],"variable":[]}},"response":[{"id":"792c3b8d-30e7-4537-afed-bb092b4dca55","name":"200 Ok","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": 111,\r\n \"accessToken\": \"74BFB77B-6134-4644-B252-63E1B206531A\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StageUrl}}/quickquoterv2/auth"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Sep 2024 13:31:25 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Request-Context","value":"appId=cid-v1:3b0fc24c-e7ef-4684-89b3-7ea9f684674d"},{"key":"Content-Security-Policy","value":"default-src 'self'; style-src 'self' 'unsafe-inline' https://fonts.googleapis.com https://cdnjs.cloudflare.com; script-src 'self' 'unsafe-inline'; font-src 'self' https://fonts.gstatic.com https://cdnjs.cloudflare.com; img-src 'self' https://instabrainwebappstorage.blob.core.windows.net; connect-src 'self' wss://localhost:50068; frame-ancestors 'self' https://*.instabrain-dev.io https://*.instabrainstage.io;"},{"key":"Permissions-Policy","value":"geolocation=();"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=b8kGNOWjn%2FVWBzDHw4DIeTJU%2FS93ANqeCF4vAk%2BdAnCw7bhZZMDlyuoaz%2BVYDTySsHw%2FAMAlZLdh0E7l7cafsx9YdWdfk0rDH7iWhJReMCKEEe6t0biC76UnF0zFCFQ%2FBiGEtSzi%2Fsg%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"expect-ct","value":"max-age=86400, enforce"},{"key":"referrer-policy","value":"same-origin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8c83227a598ec943-IAD"},{"key":"Content-Encoding","value":"br"}],"cookie":[],"responseTime":null,"body":"{\n \"flagStatus\": true,\n \"value\": {\n \"jwtToken\": \"eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJJZCI6IjhmZjc3OTllLTNiMGUtNDAwYS04ZjQyLTlkNDU3NDVmY2Q1NSIsInJvbGUiOiJBZ2VudCIsIlNjb3BlIjoiVGhpcmRQYXJ0eSIsIlVzZXJJZCI6IjExMSIsImF1ZCI6WyJodHRwOi8vbG9jYWxob3N0OjQyMDAvIiwiaHR0cDovL2xvY2FsaG9zdDo0NDAwIiwiaHR0cHM6Ly8qLmluc3RhYnJhaW5zdGFnZS5pbyJdLCJuYmYiOjE3MjcxODQ2ODUsImV4cCI6MTcyNzE4NjQ4NSwiaWF0IjoxNzI3MTg0Njg1LCJpc3MiOiJodHRwczovL2FwaS5pbnN0YWJyYWluc3RhZ2UuaW8vIn0.crBvfphCYBAOLmxiV7gD4xt5U56PJNiqLWOA6DfNoTMNDZdT-XGxkLlai0Sgt88Nqj6K2-CZgAQHMtmIc5bcMg\"\n },\n \"error\": null\n}"},{"id":"7e8d2fd8-da4c-44f0-bb0f-72b35541e4b6","name":"400 Bad Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"userId\": 11,\r\n \"accessToken\": \"74BFB77B-6134-4644-B252-63E1B206531A\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StageUrl}}/quickquoterv2/auth"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Sep 2024 13:40:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"59"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Request-Context","value":"appId=cid-v1:3b0fc24c-e7ef-4684-89b3-7ea9f684674d"},{"key":"Content-Security-Policy","value":"default-src 'self'; style-src 'self' 'unsafe-inline' https://fonts.googleapis.com https://cdnjs.cloudflare.com; script-src 'self' 'unsafe-inline'; font-src 'self' https://fonts.gstatic.com https://cdnjs.cloudflare.com; img-src 'self' https://instabrainwebappstorage.blob.core.windows.net; connect-src 'self' wss://localhost:50068; frame-ancestors 'self' https://*.instabrain-dev.io https://*.instabrainstage.io;"},{"key":"Permissions-Policy","value":"geolocation=();"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=JfneKnf06mnRZK1JelAW6eeMSQId5u9wHmliqDZrsfMy3bGzn26ddo7njo8VEomlttVolZ4Z5otYEXGw4oDd7aZ1H6HOCAYxRVLNkQkEyFQzZUGjdsBs3pk2PwmHXW6caXzBKWz5Uqg%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"expect-ct","value":"max-age=86400, enforce"},{"key":"referrer-policy","value":"same-origin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8c832ff8cfeb8009-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"flagStatus\": false,\n \"value\": null,\n \"error\": \"agentLoginError\"\n}"}],"_postman_id":"9f259d9d-085d-433e-acc0-f4907aeeb1a2"}],"id":"0045fba6-2a11-479e-985a-923e5f711a53","description":"The Authorization API is designed to generate a JWT (JSON Web Token) that serves as the key for authenticating and securing subsequent API requests. Upon successful invocation of this endpoint, a unique JWT token is returned. This token is required to access other APIs within the system.
\nThe JWT token must be included in the Authorization header as a Bearer token in all API calls that require authentication. This ensures that only authorized users or systems with a valid token can interact with protected endpoints. Without a valid JWT token in the Authorization header, the system will reject access to secured APIs.
\nIt’s important to note that the token is valid for 30 minutes from the time of issuance. Once the token expires, users must generate a new one by making another request to the Authorization API.
\nTo avoid interruptions, ensure your system is designed to handle token expiration by either refreshing the token or requesting a new one after the 30-minute window.
\n","_postman_id":"0045fba6-2a11-479e-985a-923e5f711a53"},{"name":"Third Party Quote","item":[{"name":"Get IB Term Quote","id":"c2c5ec76-5bf7-48a6-a1e2-0c0e48ffd00e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"faceAmount\": 100000,\n \"benefitPeriod\": 10,\n \"flagTobaccoUse\": false,\n \"gender\": \"Male\",\n \"stateCode\": \"AZ\",\n \"zipCode\": null,\n \"rateClass\": \"Preferred Plus\",\n \"healthClass\": null,\n \"height\": {\n \"feet\": 6,\n \"inches\": 1\n },\n \"weightInLbs\": 180,\n \"age\": 25,\n \"dateOfBirth\": \"2000-01-01\",\n \"riders\": [\n {\n \"rider\": \"ADB Rider\",\n \"riderFaceAmount\": 60000\n }\n ],\n \"paymentFreq\": \"Monthly\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"john.doe@gmail.com\",\n \"PhoneNum\": \"2341234567\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.instabrainsandbox.io/api/thirdpartyibtermquote/get","description":"In below table, detailed description of each request parameter is mentioned
\nWhen a request is invalid, the API responds with a 400 Bad Request status. This document outlines the possible error codes returned in such cases.
\nquoteAmount will give the premium requester has to pay for requested coverage amount.
selectedRiders.riderQuoteAmount, tells us the breakdown of the premium for rider.
If we subtract each rider riderQuoteAmount from “quoteAmount”, we will get base premium without riders.
In below table, detailed description of each request parameter is mentioned
\nWhen a request is invalid, the API responds with a 400 Bad Request status. This document outlines the possible error codes returned in such cases.
\nquoteAmount will give the premium requester has to pay for requested coverage amount.
selectedRiders.riderQuoteAmount, tells us the breakdown of the premium for rider.
If we subtract each rider riderQuoteAmount from “quoteAmount”, we will get base premium without riders.
In below table, detailed description of each request parameter is mentioned
\nWhen a request is invalid, the API responds with a 400 Bad Request status. This document outlines the possible error codes returned in such cases.
\n","urlObject":{"protocol":"https","path":["api","ThirdPartyIbFinalExpenseQuote","get"],"host":["api","instabrainstage","io"],"query":[],"variable":[]}},"response":[{"id":"59bd2f8b-1bfb-4477-9a32-dccef3985d23","name":"200 OK - Sample","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"faceAmount\": 15000,\r\n \"gender\": 1,\r\n \"stateCode\": \"AZ\",\r\n \"zipCode\": null,\r\n \"age\": 51,\r\n \"dateOfBirth\": \"1974-07-14\",\r\n \"paymentFreq\": \"Monthly\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"email\": \"john.doe@gmail.com\",\r\n \"phoneNum\": \"2341234567\",\r\n \"flagTobaccoUse\": true,\r\n \"height\": {\r\n \"feet\": 6,\r\n \"inches\": 1\r\n },\r\n \"weightInLbs\": 200\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StageUrl}}/ThirdPartyIbFinalExpenseQuote/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Sep 2024 16:25:22 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Request-Context","value":"appId=cid-v1:3b0fc24c-e7ef-4684-89b3-7ea9f684674d"},{"key":"Content-Security-Policy","value":"default-src 'self'; style-src 'self' 'unsafe-inline' https://fonts.googleapis.com https://cdnjs.cloudflare.com; script-src 'self' 'unsafe-inline'; font-src 'self' https://fonts.gstatic.com https://cdnjs.cloudflare.com; img-src 'self' https://instabrainwebappstorage.blob.core.windows.net; connect-src 'self' wss://localhost:50068; frame-ancestors 'self' https://*.instabrain-dev.io https://*.instabrainstage.io;"},{"key":"Permissions-Policy","value":"geolocation=();"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=g6RJZn1YnDyXqoOldvAtg71GucAVhLa3m9MxHsfVPw%2BTeyPnzZ%2B5NEcMPcRMWirItLMgP2sovEJWzgrU35Q29mqWA5rGOvGB3wT7%2FTmQWSh2ndxIsaUSGq2fzLE9dtgxhKpb3yZwixE%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"expect-ct","value":"max-age=86400, enforce"},{"key":"referrer-policy","value":"same-origin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8c8421463ddcc9a4-IAD"},{"key":"Content-Encoding","value":"br"},{"key":"Content-Type","value":"application/json","description":""},{"key":"Transfer-Encoding","value":"chunked"}],"cookie":[],"responseTime":null,"body":"{\n \"flagStatus\": true,\n \"value\": {\n \"productName\": \"Rapid Decision Final Expense\",\n \"selectedQuote\": {\n \"quoteResponseId\": \"3105e990-216d-4f26-b823-57a42633718e\",\n \"index\": 0,\n \"quoteAmount\": 78.99,\n \"premiumSaveWhenSelectingAnnual\": null,\n \"maxQuoteAmount\": null,\n \"minQuoteAmount\": null,\n \"farmersOverallBenefit\": null,\n \"farmersDetailsAfterEachBenefitPeriods\": [],\n \"faceAmount\": 15000,\n \"faceAmountLabel\": \"Coverage Amount\",\n \"benefitPeriod\": null,\n \"benefitPeriodUnit\": null,\n \"benefitPeriodLabel\": null,\n \"waitingPeriod\": null,\n \"waitingPeriodUnit\": null,\n \"waitingPeriodLabel\": null,\n \"paymentFrequency\": \"Monthly\",\n \"isMedicalRequired\": false,\n \"selectedRiders\": [],\n \"hint\": null,\n \"flagMultipleQuote\": false,\n \"quoteParts\": []\n }\n },\n \"error\": null\n}"},{"id":"27bd40b5-9e61-403b-a6b4-862b3f899540","name":"400 Bad Request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"faceAmount\": 15000,\r\n \"gender\": 1,\r\n \"stateCode\": \"AZ\",\r\n \"zipCode\": null,\r\n \"age\": 51,\r\n \"dateOfBirth\": \"1974-07-14\",\r\n \"paymentFreq\": \"Monthly\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"email\": \"john.doe@gmail.com\",\r\n \"phoneNum\": \"2341234567\",\r\n \"flagTobaccoUse\": true,\r\n \"height\": {\r\n \"feet\": 6,\r\n \"inches\": 1\r\n },\r\n \"weightInLbs\": 200\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StageUrl}}/ThirdPartyIbFinalExpenseQuote/get"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Sep 2024 19:19:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"61"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Request-Context","value":"appId=cid-v1:3b0fc24c-e7ef-4684-89b3-7ea9f684674d"},{"key":"Content-Security-Policy","value":"default-src 'self'; style-src 'self' 'unsafe-inline' https://fonts.googleapis.com https://cdnjs.cloudflare.com; script-src 'self' 'unsafe-inline'; font-src 'self' https://fonts.gstatic.com https://cdnjs.cloudflare.com; img-src 'self' https://instabrainwebappstorage.blob.core.windows.net; connect-src 'self' wss://localhost:50068; frame-ancestors 'self' https://*.instabrain-dev.io https://*.instabrainstage.io;"},{"key":"Permissions-Policy","value":"geolocation=();"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=yAmoxaDtTFWqVJQBHBsyzPBGhQxtUEZ1qm1JUdtHIGZi6MD%2BJqzaySeEPWfkOGhgULmozS4svxa5WktowjV%2F1B%2FV2w1zAL2punQ7G44%2FnA9j5eCjlinE2AtQf2%2FCRbVrOcsiG66Y0HE%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"expect-ct","value":"max-age=86400, enforce"},{"key":"referrer-policy","value":"same-origin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8c852027dd3d3b7e-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"flagStatus\": false,\n \"value\": null,\n \"error\": \"RiderNotAvailable\"\n}"},{"id":"7673e5d9-b858-459c-9a33-1537ea6b7241","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"faceAmount\": 15000,\r\n \"gender\": 1,\r\n \"stateCode\": \"AZ\",\r\n \"zipCode\": null,\r\n \"age\": 51,\r\n \"dateOfBirth\": \"1974-07-14\",\r\n \"paymentFreq\": \"Monthly\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"email\": \"john.doe@gmail.com\",\r\n \"phoneNum\": \"2341234567\",\r\n \"flagTobaccoUse\": true,\r\n \"height\": {\r\n \"feet\": 6,\r\n \"inches\": 1\r\n },\r\n \"weightInLbs\": 200\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StageUrl}}/ThirdPartyIbFinalExpenseQuote/get"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Sep 2024 16:14:32 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Report-To","value":"{\"endpoints\":[{\"url\":\"https:\\/\\/a.nel.cloudflare.com\\/report\\/v4?s=K4qo4q8K7v8OQVeCkPCILwVI%2BRtjmCRSI%2BMPxiJM%2BUcccNbMHoQVY2auU2Uu8cpeqsee6kowk2HTC1xLkQRIqQYzsR%2Fb7tNBUk8D%2B8Qp59PqPwcac1xfbHnWlh5mYbnnljXxpWWz5Uc%3D\"}],\"group\":\"cf-nel\",\"max_age\":604800}"},{"key":"NEL","value":"{\"success_fraction\":0,\"report_to\":\"cf-nel\",\"max_age\":604800}"},{"key":"expect-ct","value":"max-age=86400, enforce"},{"key":"referrer-policy","value":"same-origin"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"8c84116d0fac3968-IAD"}],"cookie":[],"responseTime":null,"body":"{\n \"flagStatus\": false,\n \"value\": null,\n \"error\": \"Logout\"\n}"}],"_postman_id":"512c6d64-bc44-4e51-b566-5dda8ff6a8bc"}],"id":"978af003-e64e-4999-9028-efab7e030eae","description":"The Get Quote API allows users to retrieve insurance quotes based on specified parameters. It is a POST request made to the below listed endpoints. Users must provide a detailed request payload, including key parameters such as coverage amount, benefit period, tobacco use status, personal details (name, age, etc.), and rider information.
\nInput Parameters: The API accepts various input fields to tailor the quote, including faceAmount, benefitPeriod, gender, stateCode, zipCode, and optional fields like firstName, lastName, and email.
Response Format: A successful request returns a structured response containing the quote amount, premium details, and selected riders. It provides insights into the coverage offered and associated costs.
\nError Handling: If the request fails, it returns a 400 status code with an error message indicating the nature of the issue.
\nThis API is essential for users seeking personalized insurance quotes, ensuring they receive tailored options based on their specific needs and preferences.
\n","_postman_id":"978af003-e64e-4999-9028-efab7e030eae"},{"name":"Third Party Consumer Quoter and Start Application (Obsolete)","item":[{"name":"Start Application","id":"dbe1484a-28fa-4a34-920a-d7439a8143dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"InstaBrainDevelopment.instabrainstage.io","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"quoteResponseId\": \"58d2c3be-87da-4891-aaf6-dd111fd359f3\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"email\": \"john.doe@gmail.com\",\r\n \"phoneNumber\": \"2341234567\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.instabrainsandbox.io/api/ThirdPartyIbTermStartApp/start-application","urlObject":{"protocol":"https","path":["api","ThirdPartyIbTermStartApp","start-application"],"host":["api","instabrainsandbox","io"],"query":[],"variable":[]}},"response":[{"id":"781c0e37-669e-4392-a22f-38c5b738d83b","name":"200 Ok","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"InstaBrainDevelopment.instabrainstage.io","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"quoteResponseId\": \"e7444832-02dd-4ed4-b747-b4d5e7feb2bd\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"email\": \"john.doe@gmail.com\",\r\n \"PhoneNumber\": \"2341234567\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StageUrl}}/thirdpartyibtermstartapp/start-application"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"flagStatus\": true,\n \"value\": {\n \"opportunityId\": \"string\",\n \"agentLink\": \"string\",\n \"eAppAgentLink\": \"string\",\n \"applicantLink\": \"string\"\n },\n \"error\": \"string\"\n}"},{"id":"a9c02298-f6e5-4790-9b51-c86047bc5f70","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"InstaBrainDevelopment.instabrainstage.io","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"quoteResponseId\": \"e7444832-02dd-4ed4-b747-b4d5e7feb2bd\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"email\": \"john.doe@gmail.com\",\r\n \"PhoneNumber\": \"2341234567\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StageUrl}}/thirdpartyibtermstartapp/start-application"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"flagStatus\": false,\n \"value\": null,\n \"error\": \"The Start Application API initiates the InstaBrain application process based on a specified quote. It is a POST request sent to the endpoint /api/ThirdPartyStartApp/start-application. This endpoint requires the quoteResponseId, which uniquely identifies the quote the user wishes to proceed with.
Input Parameters:
\nquoteResponseId (Required): A unique identifier for the quote associated with the application.
\nfirstName (Optional): The first name of the applicant.
\nlastName (Optional): The last name of the applicant.
\nemail (Optional): The email address of the applicant.
\nphoneNumber (Optional): The applicant's phone number, formatted as a 10-digit number.
\nPlease note that firstName, lastName provided here will override the information provided in the Quote API.
Response Format:
\n200 OK: A successful request returns a flagStatus of true, along with links for the agent and applicant to access the application interface.
agentLink: URL for the application’s Conversational UI for agents.
\neAppAgentLink: URL for the EApp UI for agents.
\napplicantLink: Direct link for the applicant.
\n400 Bad Request: If the request fails due to invalid input, the response includes a flagStatus of false, along with an error code.
401 Forbidden: Indicates the request is unauthorized.
\nThis API is critical for streamlining the application process, enabling agents and applicants to interact with the InstaBrain application effectively.
\n","_postman_id":"b785cec1-9444-4b49-81b1-6a0a2fc3e908"},{"name":"Third Party Consumer Quoter and Start Application","item":[{"name":"Start Application","id":"707fa921-434a-40e6-99ef-711c7e390465","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"Origin","value":"InstaBrainDevelopment.instabrainstage.io"}],"body":{"mode":"raw","raw":"{\r\n \"quoteResponseId\": \"58d2c3be-87da-4891-aaf6-dd111fd359f3\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"email\": \"john.doe@gmail.com\",\r\n \"phoneNumber\": \"2341234567\",\r\n \"proCode\": \"insta-term-pivot\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://api.instabrainsandbox.io/api/ThirdPartyStartApp/start-application","urlObject":{"protocol":"https","path":["api","ThirdPartyStartApp","start-application"],"host":["api","instabrainsandbox","io"],"query":[],"variable":[]}},"response":[{"id":"587d095a-4439-4390-9e51-9b315b552ac3","name":"200 Ok","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"InstaBrainDevelopment.instabrainstage.io"}],"body":{"mode":"raw","raw":"{\r\n \"quoteResponseId\": \"e7444832-02dd-4ed4-b747-b4d5e7feb2bd\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"email\": \"john.doe@gmail.com\",\r\n \"PhoneNumber\": \"2341234567\",\r\n \"ProCode\":\"insta-term-pivot\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StageUrl}}/ThirdPartyStartApp/start-application"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"flagStatus\": true,\n \"value\": {\n \"opportunityId\": \"string\",\n \"agentLink\": \"string\",\n \"eAppAgentLink\": \"string\",\n \"applicantLink\": \"string\"\n },\n \"error\": \"string\"\n}"},{"id":"a338cd70-faad-4f5b-9497-f655a9139d66","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Origin","value":"InstaBrainDevelopment.instabrainstage.io"}],"body":{"mode":"raw","raw":"{\r\n \"quoteResponseId\": \"e7444832-02dd-4ed4-b747-b4d5e7feb2bd\",\r\n \"firstName\": \"John\",\r\n \"lastName\": \"Doe\",\r\n \"email\": \"john.doe@gmail.com\",\r\n \"PhoneNumber\": \"2341234567\",\r\n \"ProCode\": \"insta-term-pivot\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{StageUrl}}/ThirdPartyStartApp/start-application"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"flagStatus\": false,\n \"value\": null,\n \"error\": \"The Start Application API initiates the InstaBrain application process based on a specified quote. It is a POST request sent to the endpoint /api/ThirdPartyStartApp/start-application. This endpoint requires the quoteResponseId, which uniquely identifies the quote the user wishes to proceed with.
Input Parameters:
\nquoteResponseId (Required): A unique identifier for the quote associated with the application.
\nfirstName (Optional): The first name of the applicant.
\nlastName (Optional): The last name of the applicant.
\nemail (Optional): The email address of the applicant.
\nphoneNumber (Optional): The applicant's phone number, formatted as a 10-digit number.
\nproCode (Optional): The product code if wanting to start a pivot product (if not passed normal product will start).
\nBelow is the mapping of proCode to their respective products:
\nInstaBrain Term Pivot => insta-term-pivot
\nInstaBrain Term to Pure Term => insta-term-to-pure-term
\nPure Term Pivot => PureTermPivot
\nRapid Decision Final Expense Pivot => FinalExpensePivot
\nPlease note that firstName, lastName provided here will override the information provided in the Quote API.
Response Format:
\n200 OK: A successful request returns a flagStatus of true, along with links for the agent and applicant to access the application interface.
agentLink: URL for the application’s Conversational UI for agents.
\neAppAgentLink: URL for the EApp UI for agents.
\napplicantLink: Direct link for the applicant.
\n400 Bad Request: If the request fails due to invalid input, the response includes a flagStatus of false, along with an error code.
401 Forbidden: Indicates the request is unauthorized.
\nThis API is critical for streamlining the application process, enabling agents and applicants to interact with the InstaBrain application effectively.
\n","_postman_id":"a94ca879-ef57-40af-b55b-3e21562218d2"},{"name":"Reporting APIs","item":[{"name":"Get Prospects","id":"eceffb2e-7da0-4d2d-b616-2c5176557cd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"startDate\": \"2024-08-07T18:55:39.749Z\",\r\n \"endDate\": \"2024-08-07T18:55:39.749Z\",\r\n \"userTimeZone\": \"America/New_York\",\r\n \"dayCount\": 0,\r\n \"pageSize\": 0,\r\n \"pageIndex\": 0,\r\n \"sort\": {\r\n \"value\": \"string\",\r\n \"sortDescending\": true\r\n },\r\n \"filters\": [\r\n {\r\n \"value\": \"string\",\r\n \"operator\": \"like\",\r\n \"field\": \"string\"\r\n }\r\n ],\r\n \"searchParam\": \"string\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.instabrainsandbox.io/api/thirdparty/get-prospects","description":"The get-prospects endpoint allows third parties to retrieve a list of insurance prospects within a specified date range. The response includes detailed information about each prospect's quote details.
\n\nProspects are the quotes generated through the
\nPOST api/ThirdPartyIbTermQuote/get🔗 endpoint but have not yet been converted to InstaBrain applications using thePOST api/ThirdPartyIbTermStartApp/start-application🔗 endpoint.
In below table, detailed description of each request parameter is mentioned
\n\n\nIf
\nstartDateandendDateare not provided, thedayCountparameter must be provided. The InstaBrain system will calculate the date range based on the dayCount value.
\n\nDo not pass
\npageSizeandpageIndexas null or 0. The API will return an error code.
Filtering, sorting and searching is enabled on all properties from response data model except riders. A Detailed guide to consume this feature available here 🔗
flagStatus: Indicates the success of the API call (true for success, false for failure).
prospectCount: The number of prospects returned.
prospects: An array of prospect objects, each containing
product: The title of the insurance product.
quoteId: Unique identifier for the quote.
quoteResponseId: Unique identifier for the quote response.
quoteAmount: The quoted premium amount.
faceAmount: The face amount of the insurance policy.
termLength: The length of the term in years.
riders: An array of riders added to the policy, each containing:
riderValue: The rider's code.
riderLabel: The rider's label to display.
riderQuoteAmount: The additional premium for the rider.
faceAmount: The face amount associated with the rider.
createdBy: ID of the agent who created the quote.
createdOn: The date and time the quote was created.
flagTobaccoUse: Whether the prospect uses products with tobacco.
gender: The gender of the prospect.
stateCode: The state where the prospect resides.
zipCode : The zip code of prospect
rateClass: The rate class of the prospect.
heightFt: The height of the prospect (in feet).
heightInch: The height of the prospect (in inches).
weightInLbs: The weight of the prospect in pounds.
age: The age of the prospect.
dateOfBirth: The date of birth of the prospect.
paymentFrequency: The frequency of payments.
The get-application endpoint allows users to retrieve a list of insurance application within a specified date range. The response includes detailed information about application quote and personal information of the applicant.
In below table, detailed description of each request parameter is mentioned
\n\n\nIf
\nstartDateandendDateare not provided, thedayCountparameter must be provided. The InstaBrain system will calculate the date range based on thedayCountvalue.
\n\nDo not pass
\npageSizeandpageIndexas null or 0. The API will return an error code.
Filtering, sorting and searching is enabled on all properties from response data model except riders. A Detailed guide to consume this feature available here 🔗
flagStatus: Indicates the success of the API call (true for success, false for failure).
applicationCount: The number of applications returned.
applicationResp: An array of application data.
applicationStatusId: Identifier of application status
applicationStatus: An application counts as per different application statuses in format {Status} {RateClass}: {Assessment Factor}. Ex. InProgress Preferred: Drug Use.
PivotSourceOpportunityUid: It represents the OpportunityUid for the first application where the Pivot flow had started (This will be null for products who aren't pivoted)
Eg: If the Pivot flow is Term => Pure Term => Accidental Death Benefit then the entry for Accidental Death Benefit will have Term application's opportunityUid as the PivotSourceOpportunityUid
For detailed guide on applicationStatusId and applicationStatus, refer to this guide.
\navailableFilters: An array of available filters, each containing:
value: The filter values available to display. If null, it means you can filter using any value.
operator: The recommended filter operator.
field: The filter field.
The Reporting APIs are designed to provide comprehensive access to various reporting functionalities related to insurance quotes and applications. This collection currently includes three key endpoints: get-application, get-prospects, and get-sales. These APIs enable users to retrieve and analyze data pertaining to insurance prospects, applications, and sales metrics, facilitating better decision-making and operational efficiency.
\nget-application: This endpoint retrieves detailed information about applications initiated through the system, allowing users to track their status and progress.
\nget-prospects: This endpoint allows third parties to retrieve a list of insurance prospects within a specified date range. It provides detailed information about each prospect's quote details, including relevant demographics and coverage options.
\nget-sales: This endpoint provides insights into sales performance, enabling users to analyze sales data over specific periods, identify trends, and optimize their sales strategies.
\nBy leveraging these APIs, businesses can gain insights into their performance metrics, monitor customer interactions, and optimize their sales processes.
\nAuthentication: Ensure you use the correct credentials and permissions for accessing the APIs. Tokens should be included in the authorization header of each request.
\nRequest Validation: Always validate your request parameters before sending them to the API to avoid unnecessary errors. Use correct data types and formats as specified in the API documentation.
\nDate Formats: Utilize ISO 8601 format for date parameters to ensure consistency and avoid parsing errors.
\nPagination: Implement pagination when retrieving large datasets to manage responses effectively. Use parameters like pageSize and pageIndex to control the amount of data returned in each call.
Error Handling: Develop robust error-handling mechanisms to manage different response codes. Log and handle common errors gracefully to improve user experience.
\nFiltering and Sorting: Use filtering and sorting options available in the API to refine results, making it easier to find specific data.
\nBy following these best practices, users can maximize the efficiency and reliability of their interactions with the Reporting APIs, ensuring a smooth integration into their applications and workflows.
\n","_postman_id":"de2f1f8b-0ce7-48ba-83e4-a04b0b2c601f"}],"event":[{"listen":"prerequest","script":{"id":"7186e694-e8f1-43ef-9f1f-20686c521c19","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"a7ab7f25-32c5-4e95-9ef9-0b2aee6bc9a1","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"jwtToken","value":""}]}