{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"cc7b782e-c1e7-4828-b946-4ef8daa70354","name":"Third Party APIs (Live in URL)","description":"# Third Party APIs - Integration Overview\n\nThird 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.\n\n## Available Products\n\nCurrently, InstaBrain offers APIs for the following insurance products:\n\n- **InstaBrain Term with Living Benefits** (Available Now)\n    \n- **Pure Term** (Available Now)\n    \n- **Final Expense** (Available Now)\n    \n- **GIGDB — Guaranteed Issue Guaranteed Death Benefit** (Available Now)\n    \n- **ADB — Accidental Death Benefit** (Available Now)\n    \n\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.\n\n---\n\n## Integration Methods\n\nInstaBrain supports two integration methods depending on your technical requirements and desired user experience. Choose the method that best fits your needs:\n\n### Method 1: Direct Integration (iFrame Embed)\n\n**Best for:** Partners who want a quick integration without building custom UI, or don't have dedicated technical resources.\n\n**How 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.\n\n**Implementation:**\n\nhtml\n\n```\n<iframe src=\"{agentInstaBrainUrl}\" width=\"100%\" height=\"800px\" frameborder=\"0\"></iframe>\n\n ```\n\n**Setup Requirements:**\n\n1. Replace `{agentInstaBrainUrl}` with your InstaBrain agent website URL Example: `https://instabraindevelopment.instabrain.io`\n    \n2. Contact InstaBrain to whitelist your host domain (required for iFrame access)\n    \n3. Ensure your website allows cross-origin iFrames\n    \n4. Test the integration across various browsers for compatibility\n    \n\n**When to choose this method:**\n\n- You want minimal development effort\n    \n- You prefer InstaBrain's complete user interface and experience\n    \n- You don't need to customize the quote or application flow\n    \n- You want to get integrated quickly\n    \n\n---\n\n### Method 2: REST API Integration\n\n**Best for:** Partners with technical teams who want to create custom user experiences and have full control over the user journey.\n\n**How 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.\n\n**Integration Flow:**\n\n1. **Get Quote** → Use the Quote API for your desired product\n    \n    - Each product has its own Quote API endpoint\n        \n    - Send quote parameters that affect pricing (age, coverage amount, term length, etc.)\n        \n    - Receive quote details and a unique `quoteResponseId`\n        \n2. **Start Application** → Use the Start Application API with the `quoteResponseId`\n    \n    - Pass the `quoteResponseId` received from the Quote API\n        \n    - Receive `opportunityId` and application links in response\n        \n3. **Complete Application** → Direct users to InstaBrain's application interface (For IB Term, Pure Term and Final Expense)\n    \n    - Redirect users to the application URL, OR\n        \n    - Embed the application link in an iFrame on your platform\n        \n4. **Complete Application** → Use Payment, Sign and Submit APIs to complete the application and get the policy number (For GIGDB and ADB)\n    \n\n**When to choose this method:**\n\n- You have a dedicated technical team\n    \n- You want to create custom user interfaces\n    \n- You need to control the user journey and data flow\n    \n- You want to integrate quotes into your existing systems\n    \n- You need flexibility in how data is collected and displayed\n    \n\n---\n\n## REST API Integration Details for IB Term, Pure Term and Final Expense\n\n### Step 1: Authenticate\n\nBefore making any API calls, you must obtain a JWT token using the Authorization API.\n\n- **Token Validity:** 30 minutes\n    \n- **Usage:** Include the JWT token in the `Authorization` header as a Bearer token for all subsequent API requests\n    \n- **Documentation:** Refer to the Authorization API page for detailed implementation\n    \n\n**Important:** Design your system to handle token expiration by refreshing or requesting a new token after the 30-minute window.\n\n---\n\n### Step 2: Get a Quote\n\nUse the Quote API specific to your desired insurance product to generate quotes for users.\n\n**Available Products:**\n\n- InstaBrain Term with Living Benefits\n    \n- Pure Term\n    \n- Final Expense\n    \n\n**Process:**\n\n1. Send quote parameters based on the product (age, coverage amount, term length, etc.)\n    \n2. Receive quote response including pricing and a unique `quoteResponseId`\n    \n3. Present the quote to your user through your custom UI\n    \n\n**Note:** Each product has different parameters and response structures. Refer to the specific Quote API documentation for detailed request/response formats and endpoints.\n\n---\n\n### Step 3: Start the Application\n\nOnce a user decides to proceed with a quote, use the Start Application API to initiate the application process.\n\n**Key Information:**\n\n- Pass the `quoteResponseId` received from the Quote API\n    \n- Optionally provide or override applicant information (firstName, lastName, email, phoneNumber)\n    \n- Receive `opportunityId` and application links (agentLink, eAppAgentLink, applicantLink)\n    \n\n**For detailed request/response structure and implementation:** Refer to the Start Application API documentation page.\n\n---\n\n### Step 4: Present the Application to Users\n\nAfter receiving the Start Application response, you have two options:\n\n**Option A: Redirect to InstaBrain**\n\n- Redirect the user to the `applicantLink` URL\n    \n- User completes the application on InstaBrain's platform\n    \n\n**Option B: Embed in iFrame**\n\n- Embed the `applicantLink` in an iFrame on your platform\n    \n\nhtml\n\n``` html\n<iframe src=\"{applicantLink}\" width=\"100%\" height=\"800px\" frameborder=\"0\"></iframe>\n\n ```\n\n- User completes the application within your website\n    \n\n**For Agents:**\n\n- Use `applicationLink` for Conversational UI for Applicant.\n    \n- Use `agentLink` for Conversational UI for Agent.\n    \n- Use `eAppAgentLink` for E-App for Agent.\n    \n\n---\n\n---\n\n## REST API Integration Details for GIGDB and ADB\n\nGIGDB and ADB use a fully API-driven flow — unlike IB Term / Pure Term / Final Expense, there is no redirect to an InstaBrain-hosted application UI. All steps are completed via direct API calls.\n\n### Step 1: Authenticate\n\nObtain a JWT token using the Authorization API (same as IB Term / Pure Term / Final Expense).\n\n- **Token Validity:** 30 minutes\n    \n- **Usage:** Include as a Bearer token in the `Authorization` header for all subsequent requests\n    \n\n---\n\n### Step 2: (Optional) Rider Lookup — ADB only\n\nCall the Rider Lookup endpoint to retrieve available rider codes for the applicant's state before calling the Quote API. This step is not applicable for GIGDB.\n\n---\n\n### Step 3: Get a Quote\n\nCall the Quote API for the desired product to generate a premium quote.\n\n- **ADB:** `POST /api/ThirdPartyIbAdbQuote/get`\n    \n- **GIGDB:** `POST /api/ThirdPartyIbGigdbQuote/get`\n    \n\nReceive a `quoteResponseId` to use in Start Application.\n\n---\n\n### Step 4: (Optional) Update Quote\n\nIf the applicant wants to change face amount, payment frequency, or riders (ADB only), call the Update Quote endpoint before proceeding.\n\n- **ADB:** `POST /api/ThirdPartyIbAdbQuote/update`\n    \n- **GIGDB:** `POST /api/ThirdPartyIbGigdbQuote/update`\n    \n\n---\n\n### Step 5: Start Application\n\nSubmit applicant details and the `quoteResponseId` to start the application. Receive an `opportunityId` used in all subsequent steps.\n\n- **ADB:** `POST /api/ThirdPartyAdbApplication/start-application`\n    \n- **GIGDB:** `POST /api/ThirdPartyGigdbApplication/start-application`\n    \n\nIf `isDeclined: true` is returned, stop — do not proceed. If `isQuoteChanged: true` (GIGDB only), re-show the updated premium to the applicant before continuing.\n\n---\n\n### Step 6: Save EFT Payment\n\nSave the applicant's bank account details for premium payment.\n\n`POST /api/ThirdPartyPayment/save-eft-payment`\n\n---\n\n### Step 7: Prepare Signing Docs\n\nRetrieve available delivery channels and prepare e-signature documents.\n\n`GET /api/ThirdPartySecureSign/get-delivery-channels-and-prepare-docs`\n\nIf `isSignCompleted: true` is returned, skip Steps 8–9 and go directly to Final Submit.\n\n---\n\n### Step 8: Send PIN (+ Optional Resend)\n\nSend a PIN to the applicant via their chosen delivery channel.\n\n- Send: `POST /api/ThirdPartySecureSign/send-pin-and-get-documents-link`\n    \n- Resend (optional): `POST /api/ThirdPartySecureSign/resend-pin`\n    \n\n---\n\n### Step 9: Verify PIN\n\nThe applicant enters the PIN to complete the e-signature process.\n\n`POST /api/ThirdPartySecureSign/verify-pin`\n\n---\n\n### Step 10: Final Submit\n\nSubmit the completed, signed application to the carrier.\n\n`POST /api/ThirdPartyApplication/final-submit`\n\nReturns a `policyNumber` confirming the policy has been issued.\n\n---\n\n## Environment Information\n\n### Sandbox Environment\n\n**Base URL:** `https://api.instabrainsandbox.io/`\n\n**Purpose:**\n\n- Test your integration\n    \n- Develop and validate your implementation\n    \n- No real transactions or applications are processed\n    \n\n**Access:**\n\n- Register at: [https://devportal.instabrainsandbox.io/third-party-questionnarie](https://devportal.instabrainsandbox.io/third-party-questionnarie)\n    \n- Receive sandbox credentials via email\n    \n- Use credentials to obtain JWT tokens for API access\n    \n\n### Production Environment\n\n**Access Process:**\n\n1. Complete and test your integration in the sandbox environment\n    \n2. Contact InstaBrain for production migration review\n    \n3. InstaBrain will review your integration implementation\n    \n4. Upon approval, receive production credentials and base URL\n    \n5. InstaBrain will whitelist your production domain and IP addresses\n    \n\n**Important Notes:**\n\n- Production environment has strict security rules\n    \n- Domain and IP whitelisting is required before go-live\n    \n- Manual approval process ensures integration quality and security\n    \n- Base URL will be different from sandbox (provided during migration)\n    \n\n---\n\n## Getting Started Checklist\n\n**For Direct Integration (iFrame):**\n\n- Register your organization at the registration portal\n    \n- Receive your InstaBrain agent website URL\n    \n- Provide your host domain to InstaBrain for whitelisting\n    \n- Implement the iFrame on your website\n    \n- Test across multiple browsers\n    \n- Request production access when ready\n    \n\n**For REST API Integration:**\n\n- Register at [https://devportal.instabrainsandbox.io/third-party-questionnarie](https://devportal.instabrainsandbox.io/third-party-questionnarie)\n    \n- Receive sandbox credentials and review API documentation\n    \n- Implement Authentication API to obtain JWT tokens\n    \n- Integrate the Quote API for your desired product(s)\n    \n- Implement the Start Application API\n    \n- Test the complete flow in sandbox environment\n    \n- Request production migration review\n    \n- Receive production credentials and migrate\n    \n\n---\n\n## Support and Assistance\n\nIf you have any questions or need further assistance, please contact our support team:\n\n**Email:** [helpdesk@instabrain.io](https://mailto:helpdesk@instabrain.io)\n\nWe are here to help you maximize the value of our Third Party APIs and ensure a successful integration experience.\n\n---\n\n## Next Steps\n\n- **Authentication Required?** → Proceed to the **Authorization API** page\n    \n- **Need Quote Details?** → Review the **Quote API** documentation for your product\n    \n- **Starting Applications?** → See the **Start Application API** page\n    \n- **Technical Questions?** → Contact [helpdesk@instabrain.io](https://mailto:helpdesk@instabrain.io)\n    \n\nEndFragment","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"18938680","team":5387073,"collectionId":"cc7b782e-c1e7-4828-b946-4ef8daa70354","publishedId":"2sAXqv6M2F","public":true,"publicUrl":"https://api-docs.instabrainsandbox.io","privateUrl":"https://go.postman.co/documentation/18938680-cc7b782e-c1e7-4828-b946-4ef8daa70354","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3B78CE"},"documentationLayout":"classic-single-column","customisation":{"metaTags":[{"name":"description","value":"Streamline your integration with InstaBrain's powerful Third Party APIs for insurance solutions"},{"name":"title","value":"InstaBrain Third Party APIs"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/776b45a9-600c-46fe-8389-a522583bffcc/aWJfbG9nby5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"3B78CE"}},{"name":"light","logo":"https://content.pstmn.io/776b45a9-600c-46fe-8389-a522583bffcc/aWJfbG9nby5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"3B78CE"}}]}},"version":"8.10.1","publishDate":"2025-10-01T18:06:59.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"InstaBrain Third Party APIs","description":"Streamline your integration with InstaBrain's powerful Third Party APIs for insurance solutions"},"logos":{"logoLight":"https://content.pstmn.io/776b45a9-600c-46fe-8389-a522583bffcc/aWJfbG9nby5wbmc=","logoDark":"https://content.pstmn.io/776b45a9-600c-46fe-8389-a522583bffcc/aWJfbG9nby5wbmc="}},"statusCode":200},"environments":[{"name":"Sandbox","id":"aecfea42-e1bd-428d-9f4e-d194cb792eb6","owner":"18938680","values":[{"key":"jwtToken","value":"","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/7545062c9018a2ebc67b82152354fb9e5c007399ac409165cea176a2848b8fa5","favicon":"https://instabrainsandbox.io/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Sandbox","value":"18938680-aecfea42-e1bd-428d-9f4e-d194cb792eb6"}],"canonicalUrl":"https://api-docs.instabrainsandbox.io/view/metadata/2sAXqv6M2F"}